modelcontainer

package
v0.20240510.1003452 Latest Latest
Warning

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

Go to latest
Published: May 10, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-04-01/modelcontainer Documentation

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

Client Initialization

client := modelcontainer.NewModelContainerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ModelContainerClient.CreateOrUpdate

ctx := context.TODO()
id := modelcontainer.NewModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue")

payload := modelcontainer.ModelContainerResource{
	// ...
}


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

ctx := context.TODO()
id := modelcontainer.NewModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue")

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

ctx := context.TODO()
id := modelcontainer.NewModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue")

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

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

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

Example Usage: ModelContainerClient.RegistryModelContainersCreateOrUpdate

ctx := context.TODO()
id := modelcontainer.NewRegistryModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "modelValue")

payload := modelcontainer.ModelContainerResource{
	// ...
}


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

Example Usage: ModelContainerClient.RegistryModelContainersDelete

ctx := context.TODO()
id := modelcontainer.NewRegistryModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "modelValue")

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

Example Usage: ModelContainerClient.RegistryModelContainersGet

ctx := context.TODO()
id := modelcontainer.NewRegistryModelID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "modelValue")

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

Example Usage: ModelContainerClient.RegistryModelContainersList

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

// alternatively `client.RegistryModelContainersList(ctx, id, modelcontainer.DefaultRegistryModelContainersListOperationOptions())` can be used to do batched pagination
items, err := client.RegistryModelContainersListComplete(ctx, id, modelcontainer.DefaultRegistryModelContainersListOperationOptions())
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 ValidateModelID

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

ValidateModelID checks that 'input' can be parsed as a Model 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 ValidateRegistryModelID

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

ValidateRegistryModelID checks that 'input' can be parsed as a Registry Model 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 CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationOptions

type ListOperationOptions struct {
	Count        *int64
	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

type ListOperationResponse

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

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 ModelContainer

type ModelContainer 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 ModelContainerClient

type ModelContainerClient struct {
	Client *resourcemanager.Client
}

func NewModelContainerClientWithBaseURI

func NewModelContainerClientWithBaseURI(sdkApi sdkEnv.Api) (*ModelContainerClient, error)

func (ModelContainerClient) CreateOrUpdate

CreateOrUpdate ...

func (ModelContainerClient) Delete

func (c ModelContainerClient) Delete(ctx context.Context, id ModelId) (result DeleteOperationResponse, err error)

Delete ...

func (ModelContainerClient) Get

Get ...

func (ModelContainerClient) List

List ...

func (ModelContainerClient) ListComplete

ListComplete retrieves all the results into a single object

func (ModelContainerClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ModelContainerClient) RegistryModelContainersCreateOrUpdate

RegistryModelContainersCreateOrUpdate ...

func (ModelContainerClient) RegistryModelContainersCreateOrUpdateThenPoll

func (c ModelContainerClient) RegistryModelContainersCreateOrUpdateThenPoll(ctx context.Context, id RegistryModelId, input ModelContainerResource) error

RegistryModelContainersCreateOrUpdateThenPoll performs RegistryModelContainersCreateOrUpdate then polls until it's completed

func (ModelContainerClient) RegistryModelContainersDelete

func (c ModelContainerClient) RegistryModelContainersDelete(ctx context.Context, id RegistryModelId) (result RegistryModelContainersDeleteOperationResponse, err error)

RegistryModelContainersDelete ...

func (ModelContainerClient) RegistryModelContainersDeleteThenPoll

func (c ModelContainerClient) RegistryModelContainersDeleteThenPoll(ctx context.Context, id RegistryModelId) error

RegistryModelContainersDeleteThenPoll performs RegistryModelContainersDelete then polls until it's completed

func (ModelContainerClient) RegistryModelContainersGet

func (c ModelContainerClient) RegistryModelContainersGet(ctx context.Context, id RegistryModelId) (result RegistryModelContainersGetOperationResponse, err error)

RegistryModelContainersGet ...

func (ModelContainerClient) RegistryModelContainersList

RegistryModelContainersList ...

func (ModelContainerClient) RegistryModelContainersListComplete

RegistryModelContainersListComplete retrieves all the results into a single object

func (ModelContainerClient) RegistryModelContainersListCompleteMatchingPredicate

RegistryModelContainersListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ModelContainerResource

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

type ModelContainerResourceOperationPredicate

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

func (ModelContainerResourceOperationPredicate) Matches

type ModelId

type ModelId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	ModelName         string
}

ModelId is a struct representing the Resource ID for a Model

func NewModelID

func NewModelID(subscriptionId string, resourceGroupName string, workspaceName string, modelName string) ModelId

NewModelID returns a new ModelId struct

func ParseModelID

func ParseModelID(input string) (*ModelId, error)

ParseModelID parses 'input' into a ModelId

func ParseModelIDInsensitively

func ParseModelIDInsensitively(input string) (*ModelId, error)

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

func (*ModelId) FromParseResult

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

func (ModelId) ID

func (id ModelId) ID() string

ID returns the formatted Model ID

func (ModelId) Segments

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

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

func (ModelId) String

func (id ModelId) String() string

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

type RegistryModelContainersCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ModelContainerResource
}

type RegistryModelContainersDeleteOperationResponse

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

type RegistryModelContainersGetOperationResponse

type RegistryModelContainersGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ModelContainerResource
}

type RegistryModelContainersListCompleteResult

type RegistryModelContainersListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ModelContainerResource
}

type RegistryModelContainersListOperationOptions

type RegistryModelContainersListOperationOptions struct {
	ListViewType *ListViewType
	Skip         *string
}

func DefaultRegistryModelContainersListOperationOptions

func DefaultRegistryModelContainersListOperationOptions() RegistryModelContainersListOperationOptions

func (RegistryModelContainersListOperationOptions) ToHeaders

func (RegistryModelContainersListOperationOptions) ToOData

func (RegistryModelContainersListOperationOptions) ToQuery

type RegistryModelContainersListOperationResponse

type RegistryModelContainersListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ModelContainerResource
}

type RegistryModelId

type RegistryModelId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
	ModelName         string
}

RegistryModelId is a struct representing the Resource ID for a Registry Model

func NewRegistryModelID

func NewRegistryModelID(subscriptionId string, resourceGroupName string, registryName string, modelName string) RegistryModelId

NewRegistryModelID returns a new RegistryModelId struct

func ParseRegistryModelID

func ParseRegistryModelID(input string) (*RegistryModelId, error)

ParseRegistryModelID parses 'input' into a RegistryModelId

func ParseRegistryModelIDInsensitively

func ParseRegistryModelIDInsensitively(input string) (*RegistryModelId, error)

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

func (*RegistryModelId) FromParseResult

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

func (RegistryModelId) ID

func (id RegistryModelId) ID() string

ID returns the formatted Registry Model ID

func (RegistryModelId) Segments

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

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

func (RegistryModelId) String

func (id RegistryModelId) String() string

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

Jump to

Keyboard shortcuts

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