modelversion

package
v0.20240516.1091934 Latest Latest
Warning

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

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

README

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

The modelversion 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/modelversion"

Client Initialization

client := modelversion.NewModelVersionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ModelVersionClient.CreateOrUpdate

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

payload := modelversion.ModelVersionResource{
	// ...
}


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

ctx := context.TODO()
id := modelversion.NewModelVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue", "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: ModelVersionClient.Get

ctx := context.TODO()
id := modelversion.NewModelVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "modelValue", "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: ModelVersionClient.List

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

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

Example Usage: ModelVersionClient.Publish

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

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


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

Example Usage: ModelVersionClient.RegistryModelVersionsCreateOrGetStartPendingUpload

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

payload := modelversion.PendingUploadRequestDto{
	// ...
}


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

Example Usage: ModelVersionClient.RegistryModelVersionsCreateOrUpdate

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

payload := modelversion.ModelVersionResource{
	// ...
}


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

Example Usage: ModelVersionClient.RegistryModelVersionsDelete

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

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

Example Usage: ModelVersionClient.RegistryModelVersionsGet

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

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

Example Usage: ModelVersionClient.RegistryModelVersionsList

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

// alternatively `client.RegistryModelVersionsList(ctx, id, modelversion.DefaultRegistryModelVersionsListOperationOptions())` can be used to do batched pagination
items, err := client.RegistryModelVersionsListComplete(ctx, id, modelversion.DefaultRegistryModelVersionsListOperationOptions())
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 PossibleValuesForPendingUploadCredentialType

func PossibleValuesForPendingUploadCredentialType() []string

func PossibleValuesForPendingUploadType

func PossibleValuesForPendingUploadType() []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 ValidateModelVersionID

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

ValidateModelVersionID checks that 'input' can be parsed as a Model Version 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 ValidateRegistryModelVersionID

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

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

type BlobReferenceForConsumptionDto struct {
	BlobUri             *string                    `json:"blobUri,omitempty"`
	Credential          PendingUploadCredentialDto `json:"credential"`
	StorageAccountArmId *string                    `json:"storageAccountArmId,omitempty"`
}

func (*BlobReferenceForConsumptionDto) UnmarshalJSON

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

type CreateOrUpdateOperationResponse

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

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 FlavorData

type FlavorData struct {
	Data *map[string]string `json:"data,omitempty"`
}

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationOptions

type ListOperationOptions struct {
	Description  *string
	Feed         *string
	ListViewType *ListViewType
	Offset       *int64
	OrderBy      *string
	Properties   *string
	Skip         *string
	Tags         *string
	Top          *int64
	Version      *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        *[]ModelVersionResource
}

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 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 ModelVersion

type ModelVersion struct {
	Description       *string                 `json:"description,omitempty"`
	Flavors           *map[string]FlavorData  `json:"flavors,omitempty"`
	IsAnonymous       *bool                   `json:"isAnonymous,omitempty"`
	IsArchived        *bool                   `json:"isArchived,omitempty"`
	JobName           *string                 `json:"jobName,omitempty"`
	ModelType         *string                 `json:"modelType,omitempty"`
	ModelUri          *string                 `json:"modelUri,omitempty"`
	Properties        *map[string]string      `json:"properties,omitempty"`
	ProvisioningState *AssetProvisioningState `json:"provisioningState,omitempty"`
	Stage             *string                 `json:"stage,omitempty"`
	Tags              *map[string]string      `json:"tags,omitempty"`
}

type ModelVersionClient

type ModelVersionClient struct {
	Client *resourcemanager.Client
}

func NewModelVersionClientWithBaseURI

func NewModelVersionClientWithBaseURI(sdkApi sdkEnv.Api) (*ModelVersionClient, error)

func (ModelVersionClient) CreateOrUpdate

CreateOrUpdate ...

func (ModelVersionClient) Delete

Delete ...

func (ModelVersionClient) Get

Get ...

func (ModelVersionClient) List

List ...

func (ModelVersionClient) ListComplete

ListComplete retrieves all the results into a single object

func (ModelVersionClient) ListCompleteMatchingPredicate

func (c ModelVersionClient) ListCompleteMatchingPredicate(ctx context.Context, id ModelId, options ListOperationOptions, predicate ModelVersionResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ModelVersionClient) Publish

Publish ...

func (ModelVersionClient) PublishThenPoll

func (c ModelVersionClient) PublishThenPoll(ctx context.Context, id ModelVersionId, input DestinationAsset) error

PublishThenPoll performs Publish then polls until it's completed

func (ModelVersionClient) RegistryModelVersionsCreateOrGetStartPendingUpload

RegistryModelVersionsCreateOrGetStartPendingUpload ...

func (ModelVersionClient) RegistryModelVersionsCreateOrUpdate

RegistryModelVersionsCreateOrUpdate ...

func (ModelVersionClient) RegistryModelVersionsCreateOrUpdateThenPoll

func (c ModelVersionClient) RegistryModelVersionsCreateOrUpdateThenPoll(ctx context.Context, id RegistryModelVersionId, input ModelVersionResource) error

RegistryModelVersionsCreateOrUpdateThenPoll performs RegistryModelVersionsCreateOrUpdate then polls until it's completed

func (ModelVersionClient) RegistryModelVersionsDelete

RegistryModelVersionsDelete ...

func (ModelVersionClient) RegistryModelVersionsDeleteThenPoll

func (c ModelVersionClient) RegistryModelVersionsDeleteThenPoll(ctx context.Context, id RegistryModelVersionId) error

RegistryModelVersionsDeleteThenPoll performs RegistryModelVersionsDelete then polls until it's completed

func (ModelVersionClient) RegistryModelVersionsGet

RegistryModelVersionsGet ...

func (ModelVersionClient) RegistryModelVersionsList

RegistryModelVersionsList ...

func (ModelVersionClient) RegistryModelVersionsListComplete

RegistryModelVersionsListComplete retrieves all the results into a single object

func (ModelVersionClient) RegistryModelVersionsListCompleteMatchingPredicate

RegistryModelVersionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ModelVersionId

type ModelVersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	ModelName         string
	VersionName       string
}

ModelVersionId is a struct representing the Resource ID for a Model Version

func NewModelVersionID

func NewModelVersionID(subscriptionId string, resourceGroupName string, workspaceName string, modelName string, versionName string) ModelVersionId

NewModelVersionID returns a new ModelVersionId struct

func ParseModelVersionID

func ParseModelVersionID(input string) (*ModelVersionId, error)

ParseModelVersionID parses 'input' into a ModelVersionId

func ParseModelVersionIDInsensitively

func ParseModelVersionIDInsensitively(input string) (*ModelVersionId, error)

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

func (*ModelVersionId) FromParseResult

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

func (ModelVersionId) ID

func (id ModelVersionId) ID() string

ID returns the formatted Model Version ID

func (ModelVersionId) Segments

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

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

func (ModelVersionId) String

func (id ModelVersionId) String() string

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

type ModelVersionResource

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

type ModelVersionResourceOperationPredicate

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

func (ModelVersionResourceOperationPredicate) Matches

type PendingUploadCredentialDto

type PendingUploadCredentialDto interface {
}

type PendingUploadCredentialType

type PendingUploadCredentialType string
const (
	PendingUploadCredentialTypeSAS PendingUploadCredentialType = "SAS"
)

func (*PendingUploadCredentialType) UnmarshalJSON

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

type PendingUploadRequestDto

type PendingUploadRequestDto struct {
	PendingUploadId   *string            `json:"pendingUploadId,omitempty"`
	PendingUploadType *PendingUploadType `json:"pendingUploadType,omitempty"`
}

type PendingUploadResponseDto

type PendingUploadResponseDto struct {
	BlobReferenceForConsumption *BlobReferenceForConsumptionDto `json:"blobReferenceForConsumption,omitempty"`
	PendingUploadId             *string                         `json:"pendingUploadId,omitempty"`
	PendingUploadType           *PendingUploadType              `json:"pendingUploadType,omitempty"`
}

type PendingUploadType

type PendingUploadType string
const (
	PendingUploadTypeNone                   PendingUploadType = "None"
	PendingUploadTypeTemporaryBlobReference PendingUploadType = "TemporaryBlobReference"
)

func (*PendingUploadType) UnmarshalJSON

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

type PublishOperationResponse

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

type RawPendingUploadCredentialDtoImpl

type RawPendingUploadCredentialDtoImpl struct {
	Type   string
	Values map[string]interface{}
}

RawPendingUploadCredentialDtoImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

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 RegistryModelVersionId

type RegistryModelVersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
	ModelName         string
	VersionName       string
}

RegistryModelVersionId is a struct representing the Resource ID for a Registry Model Version

func NewRegistryModelVersionID

func NewRegistryModelVersionID(subscriptionId string, resourceGroupName string, registryName string, modelName string, versionName string) RegistryModelVersionId

NewRegistryModelVersionID returns a new RegistryModelVersionId struct

func ParseRegistryModelVersionID

func ParseRegistryModelVersionID(input string) (*RegistryModelVersionId, error)

ParseRegistryModelVersionID parses 'input' into a RegistryModelVersionId

func ParseRegistryModelVersionIDInsensitively

func ParseRegistryModelVersionIDInsensitively(input string) (*RegistryModelVersionId, error)

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

func (*RegistryModelVersionId) FromParseResult

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

func (RegistryModelVersionId) ID

ID returns the formatted Registry Model Version ID

func (RegistryModelVersionId) Segments

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

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

func (RegistryModelVersionId) String

func (id RegistryModelVersionId) String() string

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

type RegistryModelVersionsCreateOrGetStartPendingUploadOperationResponse

type RegistryModelVersionsCreateOrGetStartPendingUploadOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PendingUploadResponseDto
}

type RegistryModelVersionsCreateOrUpdateOperationResponse

type RegistryModelVersionsCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ModelVersionResource
}

type RegistryModelVersionsDeleteOperationResponse

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

type RegistryModelVersionsGetOperationResponse

type RegistryModelVersionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ModelVersionResource
}

type RegistryModelVersionsListCompleteResult

type RegistryModelVersionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ModelVersionResource
}

type RegistryModelVersionsListOperationOptions

type RegistryModelVersionsListOperationOptions struct {
	Description  *string
	ListViewType *ListViewType
	OrderBy      *string
	Properties   *string
	Skip         *string
	Tags         *string
	Top          *int64
	Version      *string
}

func DefaultRegistryModelVersionsListOperationOptions

func DefaultRegistryModelVersionsListOperationOptions() RegistryModelVersionsListOperationOptions

func (RegistryModelVersionsListOperationOptions) ToHeaders

func (RegistryModelVersionsListOperationOptions) ToOData

func (RegistryModelVersionsListOperationOptions) ToQuery

type RegistryModelVersionsListOperationResponse

type RegistryModelVersionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ModelVersionResource
}

type SASCredentialDto

type SASCredentialDto struct {
	SasUri *string `json:"sasUri,omitempty"`
}

func (SASCredentialDto) MarshalJSON

func (s SASCredentialDto) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

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