customizationtasks

package
v0.20250303.1135340 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 3, 2025 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2025-02-01/customizationtasks Documentation

The customizationtasks SDK allows for interaction with Azure Resource Manager devcenter (API Version 2025-02-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2025-02-01/customizationtasks"

Client Initialization

client := customizationtasks.NewCustomizationTasksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CustomizationTasksClient.Get

ctx := context.TODO()
id := customizationtasks.NewTaskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterName", "catalogName", "taskName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CustomizationTasksClient.GetErrorDetails

ctx := context.TODO()
id := customizationtasks.NewTaskID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterName", "catalogName", "taskName")

read, err := client.GetErrorDetails(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CustomizationTasksClient.ListByCatalog

ctx := context.TODO()
id := customizationtasks.NewDevCenterCatalogID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterName", "catalogName")

// alternatively `client.ListByCatalog(ctx, id)` can be used to do batched pagination
items, err := client.ListByCatalogComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCatalogResourceValidationStatus 

func PossibleValuesForCatalogResourceValidationStatus() []string

func PossibleValuesForCustomizationTaskInputType 

func PossibleValuesForCustomizationTaskInputType() []string

func ValidateDevCenterCatalogID 

func ValidateDevCenterCatalogID(input interface{}, key string) (warnings []string, errors []error)

ValidateDevCenterCatalogID checks that 'input' can be parsed as a Dev Center Catalog ID

func ValidateTaskID 

func ValidateTaskID(input interface{}, key string) (warnings []string, errors []error)

ValidateTaskID checks that 'input' can be parsed as a Task ID

Types

type CatalogErrorDetails 

type CatalogErrorDetails struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type CatalogResourceValidationErrorDetails 

type CatalogResourceValidationErrorDetails struct {
	Errors *[]CatalogErrorDetails `json:"errors,omitempty"`
}

type CatalogResourceValidationStatus 

type CatalogResourceValidationStatus string
const (
	CatalogResourceValidationStatusFailed    CatalogResourceValidationStatus = "Failed"
	CatalogResourceValidationStatusPending   CatalogResourceValidationStatus = "Pending"
	CatalogResourceValidationStatusSucceeded CatalogResourceValidationStatus = "Succeeded"
	CatalogResourceValidationStatusUnknown   CatalogResourceValidationStatus = "Unknown"
)

func (*CatalogResourceValidationStatus) UnmarshalJSON 

func (s *CatalogResourceValidationStatus) UnmarshalJSON(bytes []byte) error

type CustomizationTask 

type CustomizationTask struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *CustomizationTaskProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type CustomizationTaskInput 

type CustomizationTaskInput struct {
	Description *string                     `json:"description,omitempty"`
	Required    *bool                       `json:"required,omitempty"`
	Type        *CustomizationTaskInputType `json:"type,omitempty"`
}

type CustomizationTaskInputType 

type CustomizationTaskInputType string
const (
	CustomizationTaskInputTypeBoolean CustomizationTaskInputType = "boolean"
	CustomizationTaskInputTypeNumber  CustomizationTaskInputType = "number"
	CustomizationTaskInputTypeString  CustomizationTaskInputType = "string"
)

func (*CustomizationTaskInputType) UnmarshalJSON 

func (s *CustomizationTaskInputType) UnmarshalJSON(bytes []byte) error

type CustomizationTaskOperationPredicate 

type CustomizationTaskOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (CustomizationTaskOperationPredicate) Matches 

func (p CustomizationTaskOperationPredicate) Matches(input CustomizationTask) bool

type CustomizationTaskProperties 

type CustomizationTaskProperties struct {
	Inputs           *map[string]CustomizationTaskInput `json:"inputs,omitempty"`
	Timeout          *int64                             `json:"timeout,omitempty"`
	ValidationStatus *CatalogResourceValidationStatus   `json:"validationStatus,omitempty"`
}

type CustomizationTasksClient 

type CustomizationTasksClient struct {
	Client *resourcemanager.Client
}

func NewCustomizationTasksClientWithBaseURI 

func NewCustomizationTasksClientWithBaseURI(sdkApi sdkEnv.Api) (*CustomizationTasksClient, error)

func (CustomizationTasksClient) Get 

func (c CustomizationTasksClient) Get(ctx context.Context, id TaskId) (result GetOperationResponse, err error)

Get ...

func (CustomizationTasksClient) GetErrorDetails 

func (c CustomizationTasksClient) GetErrorDetails(ctx context.Context, id TaskId) (result GetErrorDetailsOperationResponse, err error)

GetErrorDetails ...

func (CustomizationTasksClient) ListByCatalog 

func (c CustomizationTasksClient) ListByCatalog(ctx context.Context, id DevCenterCatalogId) (result ListByCatalogOperationResponse, err error)

ListByCatalog ...

func (CustomizationTasksClient) ListByCatalogComplete 

func (c CustomizationTasksClient) ListByCatalogComplete(ctx context.Context, id DevCenterCatalogId) (ListByCatalogCompleteResult, error)

ListByCatalogComplete retrieves all the results into a single object

func (CustomizationTasksClient) ListByCatalogCompleteMatchingPredicate 

func (c CustomizationTasksClient) ListByCatalogCompleteMatchingPredicate(ctx context.Context, id DevCenterCatalogId, predicate CustomizationTaskOperationPredicate) (result ListByCatalogCompleteResult, err error)

ListByCatalogCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DevCenterCatalogId 

type DevCenterCatalogId struct {
	SubscriptionId    string
	ResourceGroupName string
	DevCenterName     string
	CatalogName       string
}

DevCenterCatalogId is a struct representing the Resource ID for a Dev Center Catalog

func NewDevCenterCatalogID 

func NewDevCenterCatalogID(subscriptionId string, resourceGroupName string, devCenterName string, catalogName string) DevCenterCatalogId

NewDevCenterCatalogID returns a new DevCenterCatalogId struct

func ParseDevCenterCatalogID 

func ParseDevCenterCatalogID(input string) (*DevCenterCatalogId, error)

ParseDevCenterCatalogID parses 'input' into a DevCenterCatalogId

func ParseDevCenterCatalogIDInsensitively 

func ParseDevCenterCatalogIDInsensitively(input string) (*DevCenterCatalogId, error)

ParseDevCenterCatalogIDInsensitively parses 'input' case-insensitively into a DevCenterCatalogId note: this method should only be used for API response data and not user input

func (*DevCenterCatalogId) FromParseResult 

func (id *DevCenterCatalogId) FromParseResult(input resourceids.ParseResult) error

func (DevCenterCatalogId) ID 

func (id DevCenterCatalogId) ID() string

ID returns the formatted Dev Center Catalog ID

func (DevCenterCatalogId) Segments 

func (id DevCenterCatalogId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Dev Center Catalog ID

func (DevCenterCatalogId) String 

func (id DevCenterCatalogId) String() string

String returns a human-readable description of this Dev Center Catalog ID

type GetErrorDetailsOperationResponse 

type GetErrorDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CatalogResourceValidationErrorDetails
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomizationTask
}

type ListByCatalogCompleteResult 

type ListByCatalogCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CustomizationTask
}

type ListByCatalogCustomPager 

type ListByCatalogCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByCatalogCustomPager) NextPageLink() *odata.Link

type ListByCatalogOperationResponse 

type ListByCatalogOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CustomizationTask
}

type TaskId 

type TaskId struct {
	SubscriptionId    string
	ResourceGroupName string
	DevCenterName     string
	CatalogName       string
	TaskName          string
}

TaskId is a struct representing the Resource ID for a Task

func NewTaskID 

func NewTaskID(subscriptionId string, resourceGroupName string, devCenterName string, catalogName string, taskName string) TaskId

NewTaskID returns a new TaskId struct

func ParseTaskID 

func ParseTaskID(input string) (*TaskId, error)

ParseTaskID parses 'input' into a TaskId

func ParseTaskIDInsensitively 

func ParseTaskIDInsensitively(input string) (*TaskId, error)

ParseTaskIDInsensitively parses 'input' case-insensitively into a TaskId note: this method should only be used for API response data and not user input

func (*TaskId) FromParseResult 

func (id *TaskId) FromParseResult(input resourceids.ParseResult) error

func (TaskId) ID 

func (id TaskId) ID() string

ID returns the formatted Task ID

func (TaskId) Segments 

func (id TaskId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Task ID

func (TaskId) String 

func (id TaskId) String() string

String returns a human-readable description of this Task ID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.