componentcontainer

package
v0.20241104.1140654 Latest Latest
Warning

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

 Go to latest Published: Nov 4, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-10-01/componentcontainer Documentation

The componentcontainer SDK allows for interaction with Azure Resource Manager machinelearningservices (API Version 2024-10-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/machinelearningservices/2024-10-01/componentcontainer"

Client Initialization

client := componentcontainer.NewComponentContainerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ComponentContainerClient.CreateOrUpdate

ctx := context.TODO()
id := componentcontainer.NewComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "componentName")

payload := componentcontainer.ComponentContainerResource{
	// ...
}


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

Example Usage: ComponentContainerClient.Delete

ctx := context.TODO()
id := componentcontainer.NewComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "componentName")

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

Example Usage: ComponentContainerClient.Get

ctx := context.TODO()
id := componentcontainer.NewComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "componentName")

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: ComponentContainerClient.List

ctx := context.TODO()
id := componentcontainer.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName")

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

Example Usage: ComponentContainerClient.RegistryComponentContainersCreateOrUpdate

ctx := context.TODO()
id := componentcontainer.NewRegistryComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "componentName")

payload := componentcontainer.ComponentContainerResource{
	// ...
}


if err := client.RegistryComponentContainersCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ComponentContainerClient.RegistryComponentContainersDelete

ctx := context.TODO()
id := componentcontainer.NewRegistryComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "componentName")

if err := client.RegistryComponentContainersDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ComponentContainerClient.RegistryComponentContainersGet

ctx := context.TODO()
id := componentcontainer.NewRegistryComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "componentName")

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

Example Usage: ComponentContainerClient.RegistryComponentContainersList

ctx := context.TODO()
id := componentcontainer.NewRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName")

// alternatively `client.RegistryComponentContainersList(ctx, id, componentcontainer.DefaultRegistryComponentContainersListOperationOptions())` can be used to do batched pagination
items, err := client.RegistryComponentContainersListComplete(ctx, id, componentcontainer.DefaultRegistryComponentContainersListOperationOptions())
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 PossibleValuesForAssetProvisioningState 

func PossibleValuesForAssetProvisioningState() []string

func PossibleValuesForListViewType 

func PossibleValuesForListViewType() []string

func ValidateComponentID 

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

ValidateComponentID checks that 'input' can be parsed as a Component ID

func ValidateRegistryComponentID 

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

ValidateRegistryComponentID checks that 'input' can be parsed as a Registry Component ID

func ValidateRegistryID 

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

ValidateRegistryID checks that 'input' can be parsed as a Registry ID

func ValidateWorkspaceID 

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

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type AssetProvisioningState 

type AssetProvisioningState string
const (
	AssetProvisioningStateCanceled  AssetProvisioningState = "Canceled"
	AssetProvisioningStateCreating  AssetProvisioningState = "Creating"
	AssetProvisioningStateDeleting  AssetProvisioningState = "Deleting"
	AssetProvisioningStateFailed    AssetProvisioningState = "Failed"
	AssetProvisioningStateSucceeded AssetProvisioningState = "Succeeded"
	AssetProvisioningStateUpdating  AssetProvisioningState = "Updating"
)

func (*AssetProvisioningState) UnmarshalJSON 

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

type ComponentContainer 

type ComponentContainer struct {
	Description       *string                 `json:"description,omitempty"`
	IsArchived        *bool                   `json:"isArchived,omitempty"`
	LatestVersion     *string                 `json:"latestVersion,omitempty"`
	NextVersion       *string                 `json:"nextVersion,omitempty"`
	Properties        *map[string]string      `json:"properties,omitempty"`
	ProvisioningState *AssetProvisioningState `json:"provisioningState,omitempty"`
	Tags              *map[string]string      `json:"tags,omitempty"`
}

type ComponentContainerClient 

type ComponentContainerClient struct {
	Client *resourcemanager.Client
}

func NewComponentContainerClientWithBaseURI 

func NewComponentContainerClientWithBaseURI(sdkApi sdkEnv.Api) (*ComponentContainerClient, error)

func (ComponentContainerClient) CreateOrUpdate 

func (c ComponentContainerClient) CreateOrUpdate(ctx context.Context, id ComponentId, input ComponentContainerResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ComponentContainerClient) Delete 

func (c ComponentContainerClient) Delete(ctx context.Context, id ComponentId) (result DeleteOperationResponse, err error)

Delete ...

func (ComponentContainerClient) Get 

func (c ComponentContainerClient) Get(ctx context.Context, id ComponentId) (result GetOperationResponse, err error)

Get ...

func (ComponentContainerClient) List 

func (c ComponentContainerClient) List(ctx context.Context, id WorkspaceId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (ComponentContainerClient) ListComplete 

func (c ComponentContainerClient) ListComplete(ctx context.Context, id WorkspaceId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ComponentContainerClient) ListCompleteMatchingPredicate 

func (c ComponentContainerClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, options ListOperationOptions, predicate ComponentContainerResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ComponentContainerClient) RegistryComponentContainersCreateOrUpdate 

func (c ComponentContainerClient) RegistryComponentContainersCreateOrUpdate(ctx context.Context, id RegistryComponentId, input ComponentContainerResource) (result RegistryComponentContainersCreateOrUpdateOperationResponse, err error)

RegistryComponentContainersCreateOrUpdate ...

func (ComponentContainerClient) RegistryComponentContainersCreateOrUpdateThenPoll 

func (c ComponentContainerClient) RegistryComponentContainersCreateOrUpdateThenPoll(ctx context.Context, id RegistryComponentId, input ComponentContainerResource) error

RegistryComponentContainersCreateOrUpdateThenPoll performs RegistryComponentContainersCreateOrUpdate then polls until it's completed

func (ComponentContainerClient) RegistryComponentContainersDelete 

func (c ComponentContainerClient) RegistryComponentContainersDelete(ctx context.Context, id RegistryComponentId) (result RegistryComponentContainersDeleteOperationResponse, err error)

RegistryComponentContainersDelete ...

func (ComponentContainerClient) RegistryComponentContainersDeleteThenPoll 

func (c ComponentContainerClient) RegistryComponentContainersDeleteThenPoll(ctx context.Context, id RegistryComponentId) error

RegistryComponentContainersDeleteThenPoll performs RegistryComponentContainersDelete then polls until it's completed

func (ComponentContainerClient) RegistryComponentContainersGet 

func (c ComponentContainerClient) RegistryComponentContainersGet(ctx context.Context, id RegistryComponentId) (result RegistryComponentContainersGetOperationResponse, err error)

RegistryComponentContainersGet ...

func (ComponentContainerClient) RegistryComponentContainersList 

func (c ComponentContainerClient) RegistryComponentContainersList(ctx context.Context, id RegistryId, options RegistryComponentContainersListOperationOptions) (result RegistryComponentContainersListOperationResponse, err error)

RegistryComponentContainersList ...

func (ComponentContainerClient) RegistryComponentContainersListComplete 

func (c ComponentContainerClient) RegistryComponentContainersListComplete(ctx context.Context, id RegistryId, options RegistryComponentContainersListOperationOptions) (RegistryComponentContainersListCompleteResult, error)

RegistryComponentContainersListComplete retrieves all the results into a single object

func (ComponentContainerClient) RegistryComponentContainersListCompleteMatchingPredicate 

func (c ComponentContainerClient) RegistryComponentContainersListCompleteMatchingPredicate(ctx context.Context, id RegistryId, options RegistryComponentContainersListOperationOptions, predicate ComponentContainerResourceOperationPredicate) (result RegistryComponentContainersListCompleteResult, err error)

RegistryComponentContainersListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ComponentContainerResource 

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

type ComponentContainerResourceOperationPredicate 

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

func (ComponentContainerResourceOperationPredicate) Matches 

func (p ComponentContainerResourceOperationPredicate) Matches(input ComponentContainerResource) bool

type ComponentId 

type ComponentId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	ComponentName     string
}

ComponentId is a struct representing the Resource ID for a Component

func NewComponentID 

func NewComponentID(subscriptionId string, resourceGroupName string, workspaceName string, componentName string) ComponentId

NewComponentID returns a new ComponentId struct

func ParseComponentID 

func ParseComponentID(input string) (*ComponentId, error)

ParseComponentID parses 'input' into a ComponentId

func ParseComponentIDInsensitively 

func ParseComponentIDInsensitively(input string) (*ComponentId, error)

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

func (*ComponentId) FromParseResult 

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

func (ComponentId) ID 

func (id ComponentId) ID() string

ID returns the formatted Component ID

func (ComponentId) Segments 

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

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

func (ComponentId) String 

func (id ComponentId) String() string

String returns a human-readable description of this Component ID

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ComponentContainerResource
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ComponentContainerResource
}

type ListCustomPager 

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

type ListOperationOptions 

type ListOperationOptions struct {
	ListViewType *ListViewType
	Skip         *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ComponentContainerResource
}

type ListViewType 

type ListViewType string
const (
	ListViewTypeActiveOnly   ListViewType = "ActiveOnly"
	ListViewTypeAll          ListViewType = "All"
	ListViewTypeArchivedOnly ListViewType = "ArchivedOnly"
)

func (*ListViewType) UnmarshalJSON 

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

type RegistryComponentContainersCreateOrUpdateOperationResponse 

type RegistryComponentContainersCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ComponentContainerResource
}

type RegistryComponentContainersDeleteOperationResponse 

type RegistryComponentContainersDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type RegistryComponentContainersGetOperationResponse 

type RegistryComponentContainersGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ComponentContainerResource
}

type RegistryComponentContainersListCompleteResult 

type RegistryComponentContainersListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ComponentContainerResource
}

type RegistryComponentContainersListCustomPager 

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

type RegistryComponentContainersListOperationOptions 

type RegistryComponentContainersListOperationOptions struct {
	Skip *string
}

func DefaultRegistryComponentContainersListOperationOptions 

func DefaultRegistryComponentContainersListOperationOptions() RegistryComponentContainersListOperationOptions

func (RegistryComponentContainersListOperationOptions) ToHeaders 

func (o RegistryComponentContainersListOperationOptions) ToHeaders() *client.Headers

func (RegistryComponentContainersListOperationOptions) ToOData 

func (o RegistryComponentContainersListOperationOptions) ToOData() *odata.Query

func (RegistryComponentContainersListOperationOptions) ToQuery 

func (o RegistryComponentContainersListOperationOptions) ToQuery() *client.QueryParams

type RegistryComponentContainersListOperationResponse 

type RegistryComponentContainersListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ComponentContainerResource
}

type RegistryComponentId 

type RegistryComponentId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
	ComponentName     string
}

RegistryComponentId is a struct representing the Resource ID for a Registry Component

func NewRegistryComponentID 

func NewRegistryComponentID(subscriptionId string, resourceGroupName string, registryName string, componentName string) RegistryComponentId

NewRegistryComponentID returns a new RegistryComponentId struct

func ParseRegistryComponentID 

func ParseRegistryComponentID(input string) (*RegistryComponentId, error)

ParseRegistryComponentID parses 'input' into a RegistryComponentId

func ParseRegistryComponentIDInsensitively 

func ParseRegistryComponentIDInsensitively(input string) (*RegistryComponentId, error)

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

func (*RegistryComponentId) FromParseResult 

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

func (RegistryComponentId) ID 

func (id RegistryComponentId) ID() string

ID returns the formatted Registry Component ID

func (RegistryComponentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Registry Component ID

func (RegistryComponentId) String 

func (id RegistryComponentId) String() string

String returns a human-readable description of this Registry Component ID

type RegistryId 

type RegistryId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
}

RegistryId is a struct representing the Resource ID for a Registry

func NewRegistryID 

func NewRegistryID(subscriptionId string, resourceGroupName string, registryName string) RegistryId

NewRegistryID returns a new RegistryId struct

func ParseRegistryID 

func ParseRegistryID(input string) (*RegistryId, error)

ParseRegistryID parses 'input' into a RegistryId

func ParseRegistryIDInsensitively 

func ParseRegistryIDInsensitively(input string) (*RegistryId, error)

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

func (*RegistryId) FromParseResult 

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

func (RegistryId) ID 

func (id RegistryId) ID() string

ID returns the formatted Registry ID

func (RegistryId) Segments 

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

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

func (RegistryId) String 

func (id RegistryId) String() string

String returns a human-readable description of this Registry ID

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

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

func (*WorkspaceId) FromParseResult 

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

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

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

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

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace 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.