componentversion

package
v0.20231108.1152235 Latest Latest
Warning

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

Go to latest
Published: Nov 8, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2023-10-01/componentversion Documentation

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

Client Initialization

client := componentversion.NewComponentVersionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ComponentVersionClient.CreateOrUpdate

ctx := context.TODO()
id := componentversion.NewComponentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "componentValue", "versionValue")

payload := componentversion.ComponentVersionResource{
	// ...
}


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: ComponentVersionClient.Delete

ctx := context.TODO()
id := componentversion.NewComponentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "componentValue", "versionValue")

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: ComponentVersionClient.Get

ctx := context.TODO()
id := componentversion.NewComponentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "componentValue", "versionValue")

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

ctx := context.TODO()
id := componentversion.NewComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "componentValue")

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

Example Usage: ComponentVersionClient.Publish

ctx := context.TODO()
id := componentversion.NewComponentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "componentValue", "versionValue")

payload := componentversion.DestinationAsset{
	// ...
}


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

Example Usage: ComponentVersionClient.RegistryComponentVersionsCreateOrUpdate

ctx := context.TODO()
id := componentversion.NewRegistryComponentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "componentValue", "versionValue")

payload := componentversion.ComponentVersionResource{
	// ...
}


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

Example Usage: ComponentVersionClient.RegistryComponentVersionsDelete

ctx := context.TODO()
id := componentversion.NewRegistryComponentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "componentValue", "versionValue")

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

Example Usage: ComponentVersionClient.RegistryComponentVersionsGet

ctx := context.TODO()
id := componentversion.NewRegistryComponentVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "componentValue", "versionValue")

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

Example Usage: ComponentVersionClient.RegistryComponentVersionsList

ctx := context.TODO()
id := componentversion.NewRegistryComponentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "componentValue")

// alternatively `client.RegistryComponentVersionsList(ctx, id, componentversion.DefaultRegistryComponentVersionsListOperationOptions())` can be used to do batched pagination
items, err := client.RegistryComponentVersionsListComplete(ctx, id, componentversion.DefaultRegistryComponentVersionsListOperationOptions())
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 ValidateComponentVersionID

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

ValidateComponentVersionID checks that 'input' can be parsed as a Component Version 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 ValidateRegistryComponentVersionID

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

ValidateRegistryComponentVersionID checks that 'input' can be parsed as a Registry Component Version 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 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) 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 ComponentVersion

type ComponentVersion struct {
	ComponentSpec     *interface{}            `json:"componentSpec,omitempty"`
	Description       *string                 `json:"description,omitempty"`
	IsAnonymous       *bool                   `json:"isAnonymous,omitempty"`
	IsArchived        *bool                   `json:"isArchived,omitempty"`
	Properties        *map[string]string      `json:"properties,omitempty"`
	ProvisioningState *AssetProvisioningState `json:"provisioningState,omitempty"`
	Tags              *map[string]string      `json:"tags,omitempty"`
}

type ComponentVersionClient

type ComponentVersionClient struct {
	Client *resourcemanager.Client
}

func NewComponentVersionClientWithBaseURI

func NewComponentVersionClientWithBaseURI(sdkApi sdkEnv.Api) (*ComponentVersionClient, error)

func (ComponentVersionClient) CreateOrUpdate

CreateOrUpdate ...

func (ComponentVersionClient) Delete

Delete ...

func (ComponentVersionClient) Get

Get ...

func (ComponentVersionClient) List

List ...

func (ComponentVersionClient) ListComplete

ListComplete retrieves all the results into a single object

func (ComponentVersionClient) ListCompleteMatchingPredicate

func (c ComponentVersionClient) ListCompleteMatchingPredicate(ctx context.Context, id ComponentId, options ListOperationOptions, predicate ComponentVersionResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ComponentVersionClient) Publish

Publish ...

func (ComponentVersionClient) PublishThenPoll

PublishThenPoll performs Publish then polls until it's completed

func (ComponentVersionClient) RegistryComponentVersionsCreateOrUpdate

RegistryComponentVersionsCreateOrUpdate ...

func (ComponentVersionClient) RegistryComponentVersionsCreateOrUpdateThenPoll

func (c ComponentVersionClient) RegistryComponentVersionsCreateOrUpdateThenPoll(ctx context.Context, id RegistryComponentVersionId, input ComponentVersionResource) error

RegistryComponentVersionsCreateOrUpdateThenPoll performs RegistryComponentVersionsCreateOrUpdate then polls until it's completed

func (ComponentVersionClient) RegistryComponentVersionsDelete

RegistryComponentVersionsDelete ...

func (ComponentVersionClient) RegistryComponentVersionsDeleteThenPoll

func (c ComponentVersionClient) RegistryComponentVersionsDeleteThenPoll(ctx context.Context, id RegistryComponentVersionId) error

RegistryComponentVersionsDeleteThenPoll performs RegistryComponentVersionsDelete then polls until it's completed

func (ComponentVersionClient) RegistryComponentVersionsGet

RegistryComponentVersionsGet ...

func (ComponentVersionClient) RegistryComponentVersionsList

RegistryComponentVersionsList ...

func (ComponentVersionClient) RegistryComponentVersionsListComplete

RegistryComponentVersionsListComplete retrieves all the results into a single object

func (ComponentVersionClient) RegistryComponentVersionsListCompleteMatchingPredicate

RegistryComponentVersionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ComponentVersionId

type ComponentVersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	ComponentName     string
	VersionName       string
}

ComponentVersionId is a struct representing the Resource ID for a Component Version

func NewComponentVersionID

func NewComponentVersionID(subscriptionId string, resourceGroupName string, workspaceName string, componentName string, versionName string) ComponentVersionId

NewComponentVersionID returns a new ComponentVersionId struct

func ParseComponentVersionID

func ParseComponentVersionID(input string) (*ComponentVersionId, error)

ParseComponentVersionID parses 'input' into a ComponentVersionId

func ParseComponentVersionIDInsensitively

func ParseComponentVersionIDInsensitively(input string) (*ComponentVersionId, error)

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

func (ComponentVersionId) ID

func (id ComponentVersionId) ID() string

ID returns the formatted Component Version ID

func (ComponentVersionId) Segments

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

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

func (ComponentVersionId) String

func (id ComponentVersionId) String() string

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

type ComponentVersionResource

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

type ComponentVersionResourceOperationPredicate

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

func (ComponentVersionResourceOperationPredicate) Matches

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type DestinationAsset

type DestinationAsset struct {
	DestinationName    *string `json:"destinationName,omitempty"`
	DestinationVersion *string `json:"destinationVersion,omitempty"`
	RegistryName       *string `json:"registryName,omitempty"`
}

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []ComponentVersionResource
}

type ListOperationOptions

type ListOperationOptions struct {
	ListViewType *ListViewType
	OrderBy      *string
	Skip         *string
	Top          *int64
}

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

type ListOperationResponse

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

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 PublishOperationResponse

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

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) 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 RegistryComponentVersionId

type RegistryComponentVersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
	ComponentName     string
	VersionName       string
}

RegistryComponentVersionId is a struct representing the Resource ID for a Registry Component Version

func NewRegistryComponentVersionID

func NewRegistryComponentVersionID(subscriptionId string, resourceGroupName string, registryName string, componentName string, versionName string) RegistryComponentVersionId

NewRegistryComponentVersionID returns a new RegistryComponentVersionId struct

func ParseRegistryComponentVersionID

func ParseRegistryComponentVersionID(input string) (*RegistryComponentVersionId, error)

ParseRegistryComponentVersionID parses 'input' into a RegistryComponentVersionId

func ParseRegistryComponentVersionIDInsensitively

func ParseRegistryComponentVersionIDInsensitively(input string) (*RegistryComponentVersionId, error)

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

func (RegistryComponentVersionId) ID

ID returns the formatted Registry Component Version ID

func (RegistryComponentVersionId) Segments

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

func (RegistryComponentVersionId) String

func (id RegistryComponentVersionId) String() string

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

type RegistryComponentVersionsCreateOrUpdateOperationResponse

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

type RegistryComponentVersionsDeleteOperationResponse

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

type RegistryComponentVersionsGetOperationResponse

type RegistryComponentVersionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ComponentVersionResource
}

type RegistryComponentVersionsListCompleteResult

type RegistryComponentVersionsListCompleteResult struct {
	Items []ComponentVersionResource
}

type RegistryComponentVersionsListOperationOptions

type RegistryComponentVersionsListOperationOptions struct {
	OrderBy *string
	Skip    *string
	Top     *int64
}

func DefaultRegistryComponentVersionsListOperationOptions

func DefaultRegistryComponentVersionsListOperationOptions() RegistryComponentVersionsListOperationOptions

func (RegistryComponentVersionsListOperationOptions) ToHeaders

func (RegistryComponentVersionsListOperationOptions) ToOData

func (RegistryComponentVersionsListOperationOptions) ToQuery

type RegistryComponentVersionsListOperationResponse

type RegistryComponentVersionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ComponentVersionResource
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL