armmachinelearning

package module
v2.0.0 Latest Latest
Warning

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

Go to latest
Published: Jun 10, 2022 License: MIT Imports: 17 Imported by: 64

README

Azure Machine Learning Module for Go

PkgGoDev

The armmachinelearning module provides operations for working with Azure Machine Learning.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Machine Learning module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearning/armmachinelearning

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Machine Learning. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Machine Learning modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armmachinelearning.NewUsagesClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions{
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armmachinelearning.NewUsagesClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Machine Learning label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AKS

type AKS struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// AKS properties
	Properties *AKSSchemaProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AKS - A Machine Learning compute based on AKS.

func (*AKS) GetCompute

func (a *AKS) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type AKS.

func (AKS) MarshalJSON

func (a AKS) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AKS.

func (*AKS) UnmarshalJSON

func (a *AKS) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AKS.

type AKSSchema

type AKSSchema struct {
	// AKS properties
	Properties *AKSSchemaProperties `json:"properties,omitempty"`
}

type AKSSchemaProperties

type AKSSchemaProperties struct {
	// Number of agents
	AgentCount *int32 `json:"agentCount,omitempty"`

	// Agent virtual machine size
	AgentVMSize *string `json:"agentVmSize,omitempty"`

	// AKS networking configuration for vnet
	AksNetworkingConfiguration *AksNetworkingConfiguration `json:"aksNetworkingConfiguration,omitempty"`

	// Cluster full qualified domain name
	ClusterFqdn *string `json:"clusterFqdn,omitempty"`

	// Intended usage of the cluster
	ClusterPurpose *ClusterPurpose `json:"clusterPurpose,omitempty"`

	// Load Balancer Subnet
	LoadBalancerSubnet *string `json:"loadBalancerSubnet,omitempty"`

	// Load Balancer Type
	LoadBalancerType *LoadBalancerType `json:"loadBalancerType,omitempty"`

	// SSL configuration
	SSLConfiguration *SSLConfiguration `json:"sslConfiguration,omitempty"`

	// READ-ONLY; System services
	SystemServices []*SystemService `json:"systemServices,omitempty" azure:"ro"`
}

AKSSchemaProperties - AKS properties

func (AKSSchemaProperties) MarshalJSON

func (a AKSSchemaProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AKSSchemaProperties.

type AccountKeyDatastoreCredentials

type AccountKeyDatastoreCredentials struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType `json:"credentialsType,omitempty"`

	// REQUIRED; [Required] Storage account secrets.
	Secrets *AccountKeyDatastoreSecrets `json:"secrets,omitempty"`
}

AccountKeyDatastoreCredentials - Account key datastore credentials configuration.

func (*AccountKeyDatastoreCredentials) GetDatastoreCredentials

func (a *AccountKeyDatastoreCredentials) GetDatastoreCredentials() *DatastoreCredentials

GetDatastoreCredentials implements the DatastoreCredentialsClassification interface for type AccountKeyDatastoreCredentials.

func (AccountKeyDatastoreCredentials) MarshalJSON

func (a AccountKeyDatastoreCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountKeyDatastoreCredentials.

func (*AccountKeyDatastoreCredentials) UnmarshalJSON

func (a *AccountKeyDatastoreCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountKeyDatastoreCredentials.

type AccountKeyDatastoreSecrets

type AccountKeyDatastoreSecrets struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	SecretsType *SecretsType `json:"secretsType,omitempty"`

	// Storage account key.
	Key *string `json:"key,omitempty"`
}

AccountKeyDatastoreSecrets - Datastore account key secrets.

func (*AccountKeyDatastoreSecrets) GetDatastoreSecrets

func (a *AccountKeyDatastoreSecrets) GetDatastoreSecrets() *DatastoreSecrets

GetDatastoreSecrets implements the DatastoreSecretsClassification interface for type AccountKeyDatastoreSecrets.

func (AccountKeyDatastoreSecrets) MarshalJSON

func (a AccountKeyDatastoreSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AccountKeyDatastoreSecrets.

func (*AccountKeyDatastoreSecrets) UnmarshalJSON

func (a *AccountKeyDatastoreSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AccountKeyDatastoreSecrets.

type AksComputeSecrets

type AksComputeSecrets struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// Content of kubeconfig file that can be used to connect to the Kubernetes cluster.
	AdminKubeConfig *string `json:"adminKubeConfig,omitempty"`

	// Image registry pull secret.
	ImagePullSecretName *string `json:"imagePullSecretName,omitempty"`

	// Content of kubeconfig file that can be used to connect to the Kubernetes cluster.
	UserKubeConfig *string `json:"userKubeConfig,omitempty"`
}

AksComputeSecrets - Secrets related to a Machine Learning compute based on AKS.

func (*AksComputeSecrets) GetComputeSecrets

func (a *AksComputeSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type AksComputeSecrets.

func (*AksComputeSecrets) UnmarshalJSON

func (a *AksComputeSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AksComputeSecrets.

type AksComputeSecretsProperties

type AksComputeSecretsProperties struct {
	// Content of kubeconfig file that can be used to connect to the Kubernetes cluster.
	AdminKubeConfig *string `json:"adminKubeConfig,omitempty"`

	// Image registry pull secret.
	ImagePullSecretName *string `json:"imagePullSecretName,omitempty"`

	// Content of kubeconfig file that can be used to connect to the Kubernetes cluster.
	UserKubeConfig *string `json:"userKubeConfig,omitempty"`
}

AksComputeSecretsProperties - Properties of AksComputeSecrets

type AksNetworkingConfiguration

type AksNetworkingConfiguration struct {
	// An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified
	// in serviceCidr.
	DNSServiceIP *string `json:"dnsServiceIP,omitempty"`

	// A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes
	// service address range.
	DockerBridgeCidr *string `json:"dockerBridgeCidr,omitempty"`

	// A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
	ServiceCidr *string `json:"serviceCidr,omitempty"`

	// Virtual network subnet resource ID the compute nodes belong to
	SubnetID *string `json:"subnetId,omitempty"`
}

AksNetworkingConfiguration - Advance configuration for AKS networking

type AllocationState

type AllocationState string

AllocationState - Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.

const (
	AllocationStateResizing AllocationState = "Resizing"
	AllocationStateSteady   AllocationState = "Steady"
)

func PossibleAllocationStateValues

func PossibleAllocationStateValues() []AllocationState

PossibleAllocationStateValues returns the possible values for the AllocationState const type.

type AmlCompute

type AmlCompute struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// Properties of AmlCompute
	Properties *AmlComputeProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AmlCompute - An Azure Machine Learning compute.

func (*AmlCompute) GetCompute

func (a *AmlCompute) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type AmlCompute.

func (AmlCompute) MarshalJSON

func (a AmlCompute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AmlCompute.

func (*AmlCompute) UnmarshalJSON

func (a *AmlCompute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AmlCompute.

type AmlComputeNodeInformation

type AmlComputeNodeInformation struct {
	// READ-ONLY; ID of the compute node.
	NodeID *string `json:"nodeId,omitempty" azure:"ro"`

	// READ-ONLY; State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.
	NodeState *NodeState `json:"nodeState,omitempty" azure:"ro"`

	// READ-ONLY; SSH port number of the node.
	Port *int32 `json:"port,omitempty" azure:"ro"`

	// READ-ONLY; Private IP address of the compute node.
	PrivateIPAddress *string `json:"privateIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; Public IP address of the compute node.
	PublicIPAddress *string `json:"publicIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; ID of the Experiment running on the node, if any else null.
	RunID *string `json:"runId,omitempty" azure:"ro"`
}

AmlComputeNodeInformation - Compute node information related to a AmlCompute.

type AmlComputeNodesInformation

type AmlComputeNodesInformation struct {
	// READ-ONLY; The continuation token.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The collection of returned AmlCompute nodes details.
	Nodes []*AmlComputeNodeInformation `json:"nodes,omitempty" azure:"ro"`
}

AmlComputeNodesInformation - Result of AmlCompute Nodes

type AmlComputeProperties

type AmlComputeProperties struct {
	// Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that
	// the compute nodes will have public IPs provisioned. false - Indicates that the
	// compute nodes will have a private endpoint and no public IPs.
	EnableNodePublicIP *bool `json:"enableNodePublicIp,omitempty"`

	// Network is isolated or not
	IsolatedNetwork *bool `json:"isolatedNetwork,omitempty"`

	// Compute OS Type
	OSType *OsType `json:"osType,omitempty"`

	// A property bag containing additional properties.
	PropertyBag interface{} `json:"propertyBag,omitempty"`

	// State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes
	// of the cluster. Enabled - Indicates that the public ssh port is open on all
	// nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is
	// defined, else is open all public nodes. It can be default only during cluster
	// creation time, after creation it will be either enabled or disabled.
	RemoteLoginPortPublicAccess *RemoteLoginPortPublicAccess `json:"remoteLoginPortPublicAccess,omitempty"`

	// Scale settings for AML Compute
	ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`

	// Virtual network subnet resource ID the compute nodes belong to.
	Subnet *ResourceID `json:"subnet,omitempty"`

	// Credentials for an administrator user account that will be created on each compute node.
	UserAccountCredentials *UserAccountCredentials `json:"userAccountCredentials,omitempty"`

	// Virtual Machine priority
	VMPriority *VMPriority `json:"vmPriority,omitempty"`

	// Virtual Machine Size
	VMSize *string `json:"vmSize,omitempty"`

	// Virtual Machine image for AML Compute - windows only
	VirtualMachineImage *VirtualMachineImage `json:"virtualMachineImage,omitempty"`

	// READ-ONLY; Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There
	// are no changes to the number of compute nodes in the compute in progress. A compute
	// enters this state when it is created and when no operations are being performed on the compute to change the number of
	// compute nodes. resizing - Indicates that the compute is resizing; that is,
	// compute nodes are being added to or removed from the compute.
	AllocationState *AllocationState `json:"allocationState,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute entered its current allocation state.
	AllocationStateTransitionTime *time.Time `json:"allocationStateTransitionTime,omitempty" azure:"ro"`

	// READ-ONLY; The number of compute nodes currently assigned to the compute.
	CurrentNodeCount *int32 `json:"currentNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Collection of errors encountered by various compute nodes during node setup.
	Errors []*ErrorResponse `json:"errors,omitempty" azure:"ro"`

	// READ-ONLY; Counts of various node states on the compute.
	NodeStateCounts *NodeStateCounts `json:"nodeStateCounts,omitempty" azure:"ro"`

	// READ-ONLY; The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes
	// the target node count for the ongoing resize operation. If the allocationState is steady,
	// this property denotes the target node count for the previous resize operation.
	TargetNodeCount *int32 `json:"targetNodeCount,omitempty" azure:"ro"`
}

AmlComputeProperties - AML Compute properties

func (AmlComputeProperties) MarshalJSON

func (a AmlComputeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AmlComputeProperties.

func (*AmlComputeProperties) UnmarshalJSON

func (a *AmlComputeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AmlComputeProperties.

type AmlComputeSchema

type AmlComputeSchema struct {
	// Properties of AmlCompute
	Properties *AmlComputeProperties `json:"properties,omitempty"`
}

AmlComputeSchema - Properties(top level) of AmlCompute

type AmlOperation

type AmlOperation struct {
	// Display name of operation
	Display *AmlOperationDisplay `json:"display,omitempty"`

	// Indicates whether the operation applies to data-plane
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
}

AmlOperation - Azure Machine Learning workspace REST API operation

type AmlOperationDisplay

type AmlOperationDisplay struct {
	// The description for the operation.
	Description *string `json:"description,omitempty"`

	// The operation that users can perform.
	Operation *string `json:"operation,omitempty"`

	// The resource provider name: Microsoft.MachineLearningExperimentation
	Provider *string `json:"provider,omitempty"`

	// The resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

AmlOperationDisplay - Display name of operation

type AmlOperationListResult

type AmlOperationListResult struct {
	// List of AML workspace operations supported by the AML workspace resource provider.
	Value []*AmlOperation `json:"value,omitempty"`
}

AmlOperationListResult - An array of operations supported by the resource provider.

type AmlToken

type AmlToken struct {
	// REQUIRED; [Required] Specifies the type of identity framework.
	IdentityType *IdentityConfigurationType `json:"identityType,omitempty"`
}

AmlToken - AML Token identity configuration.

func (*AmlToken) GetIdentityConfiguration

func (a *AmlToken) GetIdentityConfiguration() *IdentityConfiguration

GetIdentityConfiguration implements the IdentityConfigurationClassification interface for type AmlToken.

func (AmlToken) MarshalJSON

func (a AmlToken) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AmlToken.

func (*AmlToken) UnmarshalJSON

func (a *AmlToken) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AmlToken.

type AmlUserFeature

type AmlUserFeature struct {
	// Describes the feature for user experience
	Description *string `json:"description,omitempty"`

	// Specifies the feature name
	DisplayName *string `json:"displayName,omitempty"`

	// Specifies the feature ID
	ID *string `json:"id,omitempty"`
}

AmlUserFeature - Features enabled for a workspace

type ApplicationSharingPolicy

type ApplicationSharingPolicy string

ApplicationSharingPolicy - Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.

const (
	ApplicationSharingPolicyPersonal ApplicationSharingPolicy = "Personal"
	ApplicationSharingPolicyShared   ApplicationSharingPolicy = "Shared"
)

func PossibleApplicationSharingPolicyValues

func PossibleApplicationSharingPolicyValues() []ApplicationSharingPolicy

PossibleApplicationSharingPolicyValues returns the possible values for the ApplicationSharingPolicy const type.

type AssetBase

type AssetBase struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

func (AssetBase) MarshalJSON

func (a AssetBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AssetBase.

type AssetContainer

type AssetContainer struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string `json:"latestVersion,omitempty" azure:"ro"`

	// READ-ONLY; The next auto incremental version
	NextVersion *string `json:"nextVersion,omitempty" azure:"ro"`
}

func (AssetContainer) MarshalJSON

func (a AssetContainer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AssetContainer.

type AssetJobInput

type AssetJobInput struct {
	// REQUIRED; [Required] Input Asset URI.
	URI *string `json:"uri,omitempty"`

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode `json:"mode,omitempty"`
}

AssetJobInput - Asset input type.

type AssetJobOutput

type AssetJobOutput struct {
	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode `json:"mode,omitempty"`

	// Output Asset URI.
	URI *string `json:"uri,omitempty"`
}

AssetJobOutput - Asset output type.

type AssetReferenceBase

type AssetReferenceBase struct {
	// REQUIRED; [Required] Specifies the type of asset reference.
	ReferenceType *ReferenceType `json:"referenceType,omitempty"`
}

AssetReferenceBase - Base definition for asset references.

func (*AssetReferenceBase) GetAssetReferenceBase

func (a *AssetReferenceBase) GetAssetReferenceBase() *AssetReferenceBase

GetAssetReferenceBase implements the AssetReferenceBaseClassification interface for type AssetReferenceBase.

type AssetReferenceBaseClassification

type AssetReferenceBaseClassification interface {
	// GetAssetReferenceBase returns the AssetReferenceBase content of the underlying type.
	GetAssetReferenceBase() *AssetReferenceBase
}

AssetReferenceBaseClassification provides polymorphic access to related types. Call the interface's GetAssetReferenceBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AssetReferenceBase, *DataPathAssetReference, *IDAssetReference, *OutputPathAssetReference

type AssignedUser

type AssignedUser struct {
	// REQUIRED; User’s AAD Object Id.
	ObjectID *string `json:"objectId,omitempty"`

	// REQUIRED; User’s AAD Tenant Id.
	TenantID *string `json:"tenantId,omitempty"`
}

AssignedUser - A user that can be assigned to a compute instance.

type AutoPauseProperties

type AutoPauseProperties struct {
	DelayInMinutes *int32 `json:"delayInMinutes,omitempty"`
	Enabled        *bool  `json:"enabled,omitempty"`
}

AutoPauseProperties - Auto pause properties

type AutoScaleProperties

type AutoScaleProperties struct {
	Enabled      *bool  `json:"enabled,omitempty"`
	MaxNodeCount *int32 `json:"maxNodeCount,omitempty"`
	MinNodeCount *int32 `json:"minNodeCount,omitempty"`
}

AutoScaleProperties - Auto scale properties

type Autosave

type Autosave string

Autosave - Auto save settings.

const (
	AutosaveLocal  Autosave = "Local"
	AutosaveNone   Autosave = "None"
	AutosaveRemote Autosave = "Remote"
)

func PossibleAutosaveValues

func PossibleAutosaveValues() []Autosave

PossibleAutosaveValues returns the possible values for the Autosave const type.

type AzureBlobDatastore

type AzureBlobDatastore struct {
	// REQUIRED; [Required] Account credentials.
	Credentials DatastoreCredentialsClassification `json:"credentials,omitempty"`

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType `json:"datastoreType,omitempty"`

	// Storage account name.
	AccountName *string `json:"accountName,omitempty"`

	// Storage account container name.
	ContainerName *string `json:"containerName,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Azure cloud endpoint for the storage account.
	Endpoint *string `json:"endpoint,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Protocol used to communicate with the storage account.
	Protocol *string `json:"protocol,omitempty"`

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity `json:"serviceDataAccessAuthIdentity,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool `json:"isDefault,omitempty" azure:"ro"`
}

AzureBlobDatastore - Azure Blob datastore configuration.

func (*AzureBlobDatastore) GetDatastoreProperties

func (a *AzureBlobDatastore) GetDatastoreProperties() *DatastoreProperties

GetDatastoreProperties implements the DatastorePropertiesClassification interface for type AzureBlobDatastore.

func (AzureBlobDatastore) MarshalJSON

func (a AzureBlobDatastore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureBlobDatastore.

func (*AzureBlobDatastore) UnmarshalJSON

func (a *AzureBlobDatastore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureBlobDatastore.

type AzureDataLakeGen1Datastore

type AzureDataLakeGen1Datastore struct {
	// REQUIRED; [Required] Account credentials.
	Credentials DatastoreCredentialsClassification `json:"credentials,omitempty"`

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType `json:"datastoreType,omitempty"`

	// REQUIRED; [Required] Azure Data Lake store name.
	StoreName *string `json:"storeName,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity `json:"serviceDataAccessAuthIdentity,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool `json:"isDefault,omitempty" azure:"ro"`
}

AzureDataLakeGen1Datastore - Azure Data Lake Gen1 datastore configuration.

func (*AzureDataLakeGen1Datastore) GetDatastoreProperties

func (a *AzureDataLakeGen1Datastore) GetDatastoreProperties() *DatastoreProperties

GetDatastoreProperties implements the DatastorePropertiesClassification interface for type AzureDataLakeGen1Datastore.

func (AzureDataLakeGen1Datastore) MarshalJSON

func (a AzureDataLakeGen1Datastore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureDataLakeGen1Datastore.

func (*AzureDataLakeGen1Datastore) UnmarshalJSON

func (a *AzureDataLakeGen1Datastore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureDataLakeGen1Datastore.

type AzureDataLakeGen2Datastore

type AzureDataLakeGen2Datastore struct {
	// REQUIRED; [Required] Storage account name.
	AccountName *string `json:"accountName,omitempty"`

	// REQUIRED; [Required] Account credentials.
	Credentials DatastoreCredentialsClassification `json:"credentials,omitempty"`

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType `json:"datastoreType,omitempty"`

	// REQUIRED; [Required] The name of the Data Lake Gen2 filesystem.
	Filesystem *string `json:"filesystem,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Azure cloud endpoint for the storage account.
	Endpoint *string `json:"endpoint,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Protocol used to communicate with the storage account.
	Protocol *string `json:"protocol,omitempty"`

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity `json:"serviceDataAccessAuthIdentity,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool `json:"isDefault,omitempty" azure:"ro"`
}

AzureDataLakeGen2Datastore - Azure Data Lake Gen2 datastore configuration.

func (*AzureDataLakeGen2Datastore) GetDatastoreProperties

func (a *AzureDataLakeGen2Datastore) GetDatastoreProperties() *DatastoreProperties

GetDatastoreProperties implements the DatastorePropertiesClassification interface for type AzureDataLakeGen2Datastore.

func (AzureDataLakeGen2Datastore) MarshalJSON

func (a AzureDataLakeGen2Datastore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureDataLakeGen2Datastore.

func (*AzureDataLakeGen2Datastore) UnmarshalJSON

func (a *AzureDataLakeGen2Datastore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureDataLakeGen2Datastore.

type AzureFileDatastore

type AzureFileDatastore struct {
	// REQUIRED; [Required] Storage account name.
	AccountName *string `json:"accountName,omitempty"`

	// REQUIRED; [Required] Account credentials.
	Credentials DatastoreCredentialsClassification `json:"credentials,omitempty"`

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType `json:"datastoreType,omitempty"`

	// REQUIRED; [Required] The name of the Azure file share that the datastore points to.
	FileShareName *string `json:"fileShareName,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Azure cloud endpoint for the storage account.
	Endpoint *string `json:"endpoint,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Protocol used to communicate with the storage account.
	Protocol *string `json:"protocol,omitempty"`

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity `json:"serviceDataAccessAuthIdentity,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool `json:"isDefault,omitempty" azure:"ro"`
}

AzureFileDatastore - Azure File datastore configuration.

func (*AzureFileDatastore) GetDatastoreProperties

func (a *AzureFileDatastore) GetDatastoreProperties() *DatastoreProperties

GetDatastoreProperties implements the DatastorePropertiesClassification interface for type AzureFileDatastore.

func (AzureFileDatastore) MarshalJSON

func (a AzureFileDatastore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFileDatastore.

func (*AzureFileDatastore) UnmarshalJSON

func (a *AzureFileDatastore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFileDatastore.

type BanditPolicy

type BanditPolicy struct {
	// REQUIRED; [Required] Name of policy configuration
	PolicyType *EarlyTerminationPolicyType `json:"policyType,omitempty"`

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32 `json:"delayEvaluation,omitempty"`

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32 `json:"evaluationInterval,omitempty"`

	// Absolute distance allowed from the best performing run.
	SlackAmount *float32 `json:"slackAmount,omitempty"`

	// Ratio of the allowed distance from the best performing run.
	SlackFactor *float32 `json:"slackFactor,omitempty"`
}

BanditPolicy - Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation

func (*BanditPolicy) GetEarlyTerminationPolicy

func (b *BanditPolicy) GetEarlyTerminationPolicy() *EarlyTerminationPolicy

GetEarlyTerminationPolicy implements the EarlyTerminationPolicyClassification interface for type BanditPolicy.

func (BanditPolicy) MarshalJSON

func (b BanditPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BanditPolicy.

func (*BanditPolicy) UnmarshalJSON

func (b *BanditPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BanditPolicy.

type BatchDeployment

type BatchDeployment struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *BatchDeploymentProperties `json:"properties,omitempty"`

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string `json:"kind,omitempty"`

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

func (BatchDeployment) MarshalJSON

func (b BatchDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BatchDeployment.

type BatchDeploymentProperties

type BatchDeploymentProperties struct {
	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration `json:"codeConfiguration,omitempty"`

	// Compute target for batch inference operation.
	Compute *string `json:"compute,omitempty"`

	// Description of the endpoint deployment.
	Description *string `json:"description,omitempty"`

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string `json:"environmentId,omitempty"`

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range
	// is [-1, int.MaxValue]. For FileDataset, this value is the count of file
	// failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures
	// during batch inference will be ignored.
	ErrorThreshold *int32 `json:"errorThreshold,omitempty"`

	// Logging level for batch inference operation.
	LoggingLevel *BatchLoggingLevel `json:"loggingLevel,omitempty"`

	// Indicates maximum number of parallelism per instance.
	MaxConcurrencyPerInstance *int32 `json:"maxConcurrencyPerInstance,omitempty"`

	// Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For
	// TabularDataset, this is the size of the records in bytes, per mini-batch.
	MiniBatchSize *int64 `json:"miniBatchSize,omitempty"`

	// Reference to the model asset for the endpoint deployment.
	Model AssetReferenceBaseClassification `json:"model,omitempty"`

	// Indicates how the output will be organized.
	OutputAction *BatchOutputAction `json:"outputAction,omitempty"`

	// Customized output file name for append_row output action.
	OutputFileName *string `json:"outputFileName,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`

	// Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
	Resources *ResourceConfiguration `json:"resources,omitempty"`

	// Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.
	RetrySettings *BatchRetrySettings `json:"retrySettings,omitempty"`

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BatchDeploymentProperties - Batch inference settings per deployment.

func (BatchDeploymentProperties) MarshalJSON

func (b BatchDeploymentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BatchDeploymentProperties.

func (*BatchDeploymentProperties) UnmarshalJSON

func (b *BatchDeploymentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BatchDeploymentProperties.

type BatchDeploymentTrackedResourceArmPaginatedResult

type BatchDeploymentTrackedResourceArmPaginatedResult struct {
	// The link to the next page of BatchDeployment objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type BatchDeployment.
	Value []*BatchDeployment `json:"value,omitempty"`
}

BatchDeploymentTrackedResourceArmPaginatedResult - A paginated list of BatchDeployment entities.

type BatchDeploymentsClient

type BatchDeploymentsClient struct {
	// contains filtered or unexported fields
}

BatchDeploymentsClient contains the methods for the BatchDeployments group. Don't use this type directly, use NewBatchDeploymentsClient() instead.

func NewBatchDeploymentsClient

func NewBatchDeploymentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BatchDeploymentsClient, error)

NewBatchDeploymentsClient creates a new instance of BatchDeploymentsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*BatchDeploymentsClient) BeginCreateOrUpdate

func (client *BatchDeploymentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, body BatchDeployment, options *BatchDeploymentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[BatchDeploymentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates/updates a batch inference deployment (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name deploymentName - The identifier for the Batch inference deployment. body - Batch inference deployment definition object. options - BatchDeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the BatchDeploymentsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchDeployment/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	"testDeploymentName",
	armmachinelearning.BatchDeployment{
		Location: to.Ptr("string"),
		Tags:     map[string]*string{},
		Identity: &armmachinelearning.ManagedServiceIdentity{
			Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
			UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
				"string": {},
			},
		},
		Kind: to.Ptr("string"),
		Properties: &armmachinelearning.BatchDeploymentProperties{
			Description: to.Ptr("string"),
			CodeConfiguration: &armmachinelearning.CodeConfiguration{
				CodeID:        to.Ptr("string"),
				ScoringScript: to.Ptr("string"),
			},
			EnvironmentID: to.Ptr("string"),
			EnvironmentVariables: map[string]*string{
				"string": to.Ptr("string"),
			},
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Compute:                   to.Ptr("string"),
			ErrorThreshold:            to.Ptr[int32](1),
			LoggingLevel:              to.Ptr(armmachinelearning.BatchLoggingLevelInfo),
			MaxConcurrencyPerInstance: to.Ptr[int32](1),
			MiniBatchSize:             to.Ptr[int64](1),
			Model: &armmachinelearning.IDAssetReference{
				ReferenceType: to.Ptr(armmachinelearning.ReferenceTypeID),
				AssetID:       to.Ptr("string"),
			},
			OutputAction:   to.Ptr(armmachinelearning.BatchOutputActionSummaryOnly),
			OutputFileName: to.Ptr("string"),
			Resources: &armmachinelearning.ResourceConfiguration{
				InstanceCount: to.Ptr[int32](1),
				InstanceType:  to.Ptr("string"),
				Properties: map[string]interface{}{
					"string": map[string]interface{}{
						"cd3c37dc-2876-4ca4-8a54-21bd7619724a": nil,
					},
				},
			},
			RetrySettings: &armmachinelearning.BatchRetrySettings{
				MaxRetries: to.Ptr[int32](1),
				Timeout:    to.Ptr("PT5M"),
			},
		},
		SKU: &armmachinelearning.SKU{
			Name:     to.Ptr("string"),
			Capacity: to.Ptr[int32](1),
			Family:   to.Ptr("string"),
			Size:     to.Ptr("string"),
			Tier:     to.Ptr(armmachinelearning.SKUTierFree),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BatchDeploymentsClient) BeginDelete

func (client *BatchDeploymentsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, options *BatchDeploymentsClientBeginDeleteOptions) (*runtime.Poller[BatchDeploymentsClientDeleteResponse], error)

BeginDelete - Delete Batch Inference deployment (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Endpoint name deploymentName - Inference deployment identifier. options - BatchDeploymentsClientBeginDeleteOptions contains the optional parameters for the BatchDeploymentsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchDeployment/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	"testDeploymentName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*BatchDeploymentsClient) BeginUpdate

BeginUpdate - Update a batch inference deployment (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name deploymentName - The identifier for the Batch inference deployment. body - Batch inference deployment definition object. options - BatchDeploymentsClientBeginUpdateOptions contains the optional parameters for the BatchDeploymentsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchDeployment/update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	"testDeploymentName",
	armmachinelearning.PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties{
		Properties: &armmachinelearning.PartialBatchDeployment{
			Description: to.Ptr("string"),
		},
		Tags: map[string]*string{},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BatchDeploymentsClient) Get

func (client *BatchDeploymentsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, options *BatchDeploymentsClientGetOptions) (BatchDeploymentsClientGetResponse, error)

Get - Gets a batch inference deployment by id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Endpoint name deploymentName - The identifier for the Batch deployments. options - BatchDeploymentsClientGetOptions contains the optional parameters for the BatchDeploymentsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchDeployment/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	"testDeploymentName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BatchDeploymentsClient) NewListPager

func (client *BatchDeploymentsClient) NewListPager(resourceGroupName string, workspaceName string, endpointName string, options *BatchDeploymentsClientListOptions) *runtime.Pager[BatchDeploymentsClientListResponse]

NewListPager - Lists Batch inference deployments in the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Endpoint name options - BatchDeploymentsClientListOptions contains the optional parameters for the BatchDeploymentsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchDeployment/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	"testEndpointName",
	&armmachinelearning.BatchDeploymentsClientListOptions{OrderBy: to.Ptr("string"),
		Top:  to.Ptr[int32](1),
		Skip: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type BatchDeploymentsClientBeginCreateOrUpdateOptions

type BatchDeploymentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BatchDeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the BatchDeploymentsClient.BeginCreateOrUpdate method.

type BatchDeploymentsClientBeginDeleteOptions

type BatchDeploymentsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BatchDeploymentsClientBeginDeleteOptions contains the optional parameters for the BatchDeploymentsClient.BeginDelete method.

type BatchDeploymentsClientBeginUpdateOptions

type BatchDeploymentsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BatchDeploymentsClientBeginUpdateOptions contains the optional parameters for the BatchDeploymentsClient.BeginUpdate method.

type BatchDeploymentsClientCreateOrUpdateResponse

type BatchDeploymentsClientCreateOrUpdateResponse struct {
	BatchDeployment
}

BatchDeploymentsClientCreateOrUpdateResponse contains the response from method BatchDeploymentsClient.CreateOrUpdate.

type BatchDeploymentsClientDeleteResponse

type BatchDeploymentsClientDeleteResponse struct {
}

BatchDeploymentsClientDeleteResponse contains the response from method BatchDeploymentsClient.Delete.

type BatchDeploymentsClientGetOptions

type BatchDeploymentsClientGetOptions struct {
}

BatchDeploymentsClientGetOptions contains the optional parameters for the BatchDeploymentsClient.Get method.

type BatchDeploymentsClientGetResponse

type BatchDeploymentsClientGetResponse struct {
	BatchDeployment
}

BatchDeploymentsClientGetResponse contains the response from method BatchDeploymentsClient.Get.

type BatchDeploymentsClientListOptions

type BatchDeploymentsClientListOptions struct {
	// Ordering of list.
	OrderBy *string
	// Continuation token for pagination.
	Skip *string
	// Top of list.
	Top *int32
}

BatchDeploymentsClientListOptions contains the optional parameters for the BatchDeploymentsClient.List method.

type BatchDeploymentsClientListResponse

type BatchDeploymentsClientListResponse struct {
	BatchDeploymentTrackedResourceArmPaginatedResult
}

BatchDeploymentsClientListResponse contains the response from method BatchDeploymentsClient.List.

type BatchDeploymentsClientUpdateResponse

type BatchDeploymentsClientUpdateResponse struct {
	BatchDeployment
}

BatchDeploymentsClientUpdateResponse contains the response from method BatchDeploymentsClient.Update.

type BatchEndpoint

type BatchEndpoint struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *BatchEndpointProperties `json:"properties,omitempty"`

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string `json:"kind,omitempty"`

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

func (BatchEndpoint) MarshalJSON

func (b BatchEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BatchEndpoint.

type BatchEndpointDefaults

type BatchEndpointDefaults struct {
	// Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the
	// endpoint scoring URL is invoked.
	DeploymentName *string `json:"deploymentName,omitempty"`
}

BatchEndpointDefaults - Batch endpoint default values

type BatchEndpointProperties

type BatchEndpointProperties struct {
	// REQUIRED; [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication.
	// 'Key' doesn't expire but 'AMLToken' does.
	AuthMode *EndpointAuthMode `json:"authMode,omitempty"`

	// Default values for Batch Endpoint
	Defaults *BatchEndpointDefaults `json:"defaults,omitempty"`

	// Description of the inference endpoint.
	Description *string `json:"description,omitempty"`

	// EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be
	// retrieved using the ListKeys API.
	Keys *EndpointAuthKeys `json:"keys,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`

	// READ-ONLY; Provisioning state for the endpoint.
	ProvisioningState *EndpointProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Endpoint URI.
	ScoringURI *string `json:"scoringUri,omitempty" azure:"ro"`

	// READ-ONLY; Endpoint Swagger URI.
	SwaggerURI *string `json:"swaggerUri,omitempty" azure:"ro"`
}

BatchEndpointProperties - Batch endpoint configuration.

func (BatchEndpointProperties) MarshalJSON

func (b BatchEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BatchEndpointProperties.

type BatchEndpointTrackedResourceArmPaginatedResult

type BatchEndpointTrackedResourceArmPaginatedResult struct {
	// The link to the next page of BatchEndpoint objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type BatchEndpoint.
	Value []*BatchEndpoint `json:"value,omitempty"`
}

BatchEndpointTrackedResourceArmPaginatedResult - A paginated list of BatchEndpoint entities.

type BatchEndpointsClient

type BatchEndpointsClient struct {
	// contains filtered or unexported fields
}

BatchEndpointsClient contains the methods for the BatchEndpoints group. Don't use this type directly, use NewBatchEndpointsClient() instead.

func NewBatchEndpointsClient

func NewBatchEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*BatchEndpointsClient, error)

NewBatchEndpointsClient creates a new instance of BatchEndpointsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*BatchEndpointsClient) BeginCreateOrUpdate

func (client *BatchEndpointsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, body BatchEndpoint, options *BatchEndpointsClientBeginCreateOrUpdateOptions) (*runtime.Poller[BatchEndpointsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a batch inference endpoint (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Name for the Batch inference endpoint. body - Batch inference endpoint definition object. options - BatchEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the BatchEndpointsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchEndpoint/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	armmachinelearning.BatchEndpoint{
		Location: to.Ptr("string"),
		Tags:     map[string]*string{},
		Identity: &armmachinelearning.ManagedServiceIdentity{
			Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
			UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
				"string": {},
			},
		},
		Kind: to.Ptr("string"),
		Properties: &armmachinelearning.BatchEndpointProperties{
			Description: to.Ptr("string"),
			AuthMode:    to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Defaults: &armmachinelearning.BatchEndpointDefaults{
				DeploymentName: to.Ptr("string"),
			},
		},
		SKU: &armmachinelearning.SKU{
			Name:     to.Ptr("string"),
			Capacity: to.Ptr[int32](1),
			Family:   to.Ptr("string"),
			Size:     to.Ptr("string"),
			Tier:     to.Ptr(armmachinelearning.SKUTierFree),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BatchEndpointsClient) BeginDelete

func (client *BatchEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, options *BatchEndpointsClientBeginDeleteOptions) (*runtime.Poller[BatchEndpointsClientDeleteResponse], error)

BeginDelete - Delete Batch Inference Endpoint (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference Endpoint name. options - BatchEndpointsClientBeginDeleteOptions contains the optional parameters for the BatchEndpointsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchEndpoint/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx,
	"resourceGroup-1234",
	"testworkspace",
	"testBatchEndpoint",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*BatchEndpointsClient) BeginUpdate

BeginUpdate - Update a batch inference endpoint (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Name for the Batch inference endpoint. body - Mutable batch inference endpoint definition object. options - BatchEndpointsClientBeginUpdateOptions contains the optional parameters for the BatchEndpointsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchEndpoint/update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	armmachinelearning.PartialMinimalTrackedResourceWithIdentity{
		Tags: map[string]*string{},
		Identity: &armmachinelearning.PartialManagedServiceIdentity{
			Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
			UserAssignedIdentities: map[string]interface{}{
				"string": map[string]interface{}{},
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BatchEndpointsClient) Get

func (client *BatchEndpointsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, options *BatchEndpointsClientGetOptions) (BatchEndpointsClientGetResponse, error)

Get - Gets a batch inference endpoint by name. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Name for the Batch Endpoint. options - BatchEndpointsClientGetOptions contains the optional parameters for the BatchEndpointsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchEndpoint/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BatchEndpointsClient) ListKeys

func (client *BatchEndpointsClient) ListKeys(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, options *BatchEndpointsClientListKeysOptions) (BatchEndpointsClientListKeysResponse, error)

ListKeys - Lists batch Inference Endpoint keys. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference Endpoint name. options - BatchEndpointsClientListKeysOptions contains the optional parameters for the BatchEndpointsClient.ListKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchEndpoint/listKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListKeys(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BatchEndpointsClient) NewListPager

func (client *BatchEndpointsClient) NewListPager(resourceGroupName string, workspaceName string, options *BatchEndpointsClientListOptions) *runtime.Pager[BatchEndpointsClientListResponse]

NewListPager - Lists Batch inference endpoint in the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - BatchEndpointsClientListOptions contains the optional parameters for the BatchEndpointsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/BatchEndpoint/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewBatchEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	&armmachinelearning.BatchEndpointsClientListOptions{Count: to.Ptr[int32](1),
		Skip: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type BatchEndpointsClientBeginCreateOrUpdateOptions

type BatchEndpointsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BatchEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the BatchEndpointsClient.BeginCreateOrUpdate method.

type BatchEndpointsClientBeginDeleteOptions

type BatchEndpointsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BatchEndpointsClientBeginDeleteOptions contains the optional parameters for the BatchEndpointsClient.BeginDelete method.

type BatchEndpointsClientBeginUpdateOptions

type BatchEndpointsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BatchEndpointsClientBeginUpdateOptions contains the optional parameters for the BatchEndpointsClient.BeginUpdate method.

type BatchEndpointsClientCreateOrUpdateResponse

type BatchEndpointsClientCreateOrUpdateResponse struct {
	BatchEndpoint
}

BatchEndpointsClientCreateOrUpdateResponse contains the response from method BatchEndpointsClient.CreateOrUpdate.

type BatchEndpointsClientDeleteResponse

type BatchEndpointsClientDeleteResponse struct {
}

BatchEndpointsClientDeleteResponse contains the response from method BatchEndpointsClient.Delete.

type BatchEndpointsClientGetOptions

type BatchEndpointsClientGetOptions struct {
}

BatchEndpointsClientGetOptions contains the optional parameters for the BatchEndpointsClient.Get method.

type BatchEndpointsClientGetResponse

type BatchEndpointsClientGetResponse struct {
	BatchEndpoint
}

BatchEndpointsClientGetResponse contains the response from method BatchEndpointsClient.Get.

type BatchEndpointsClientListKeysOptions

type BatchEndpointsClientListKeysOptions struct {
}

BatchEndpointsClientListKeysOptions contains the optional parameters for the BatchEndpointsClient.ListKeys method.

type BatchEndpointsClientListKeysResponse

type BatchEndpointsClientListKeysResponse struct {
	EndpointAuthKeys
}

BatchEndpointsClientListKeysResponse contains the response from method BatchEndpointsClient.ListKeys.

type BatchEndpointsClientListOptions

type BatchEndpointsClientListOptions struct {
	// Number of endpoints to be retrieved in a page of results.
	Count *int32
	// Continuation token for pagination.
	Skip *string
}

BatchEndpointsClientListOptions contains the optional parameters for the BatchEndpointsClient.List method.

type BatchEndpointsClientListResponse

type BatchEndpointsClientListResponse struct {
	BatchEndpointTrackedResourceArmPaginatedResult
}

BatchEndpointsClientListResponse contains the response from method BatchEndpointsClient.List.

type BatchEndpointsClientUpdateResponse

type BatchEndpointsClientUpdateResponse struct {
	BatchEndpoint
}

BatchEndpointsClientUpdateResponse contains the response from method BatchEndpointsClient.Update.

type BatchLoggingLevel

type BatchLoggingLevel string

BatchLoggingLevel - Log verbosity for batch inferencing. Increasing verbosity order for logging is : Warning, Info and Debug. The default value is Info.

const (
	BatchLoggingLevelDebug   BatchLoggingLevel = "Debug"
	BatchLoggingLevelInfo    BatchLoggingLevel = "Info"
	BatchLoggingLevelWarning BatchLoggingLevel = "Warning"
)

func PossibleBatchLoggingLevelValues

func PossibleBatchLoggingLevelValues() []BatchLoggingLevel

PossibleBatchLoggingLevelValues returns the possible values for the BatchLoggingLevel const type.

type BatchOutputAction

type BatchOutputAction string

BatchOutputAction - Enum to determine how batch inferencing will handle output

const (
	BatchOutputActionAppendRow   BatchOutputAction = "AppendRow"
	BatchOutputActionSummaryOnly BatchOutputAction = "SummaryOnly"
)

func PossibleBatchOutputActionValues

func PossibleBatchOutputActionValues() []BatchOutputAction

PossibleBatchOutputActionValues returns the possible values for the BatchOutputAction const type.

type BatchRetrySettings

type BatchRetrySettings struct {
	// Maximum retry count for a mini-batch
	MaxRetries *int32 `json:"maxRetries,omitempty"`

	// Invocation timeout for a mini-batch, in ISO 8601 format.
	Timeout *string `json:"timeout,omitempty"`
}

BatchRetrySettings - Retry settings for a batch inference operation.

type BayesianSamplingAlgorithm

type BayesianSamplingAlgorithm struct {
	// REQUIRED; [Required] The algorithm used for generating hyperparameter values, along with configuration properties
	SamplingAlgorithmType *SamplingAlgorithmType `json:"samplingAlgorithmType,omitempty"`
}

BayesianSamplingAlgorithm - Defines a Sampling Algorithm that generates values based on previous values

func (*BayesianSamplingAlgorithm) GetSamplingAlgorithm

func (b *BayesianSamplingAlgorithm) GetSamplingAlgorithm() *SamplingAlgorithm

GetSamplingAlgorithm implements the SamplingAlgorithmClassification interface for type BayesianSamplingAlgorithm.

func (BayesianSamplingAlgorithm) MarshalJSON

func (b BayesianSamplingAlgorithm) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BayesianSamplingAlgorithm.

func (*BayesianSamplingAlgorithm) UnmarshalJSON

func (b *BayesianSamplingAlgorithm) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BayesianSamplingAlgorithm.

type BillingCurrency

type BillingCurrency string

BillingCurrency - Three lettered code specifying the currency of the VM price. Example: USD

const (
	BillingCurrencyUSD BillingCurrency = "USD"
)

func PossibleBillingCurrencyValues

func PossibleBillingCurrencyValues() []BillingCurrency

PossibleBillingCurrencyValues returns the possible values for the BillingCurrency const type.

type BuildContext

type BuildContext struct {
	// REQUIRED; [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation
	// and may return blob or Git URIs.
	ContextURI *string `json:"contextUri,omitempty"`

	// Path to the Dockerfile in the build context.
	DockerfilePath *string `json:"dockerfilePath,omitempty"`
}

BuildContext - Configuration settings for Docker build context

type Caching

type Caching string

Caching - Caching type of Data Disk.

const (
	CachingNone      Caching = "None"
	CachingReadOnly  Caching = "ReadOnly"
	CachingReadWrite Caching = "ReadWrite"
)

func PossibleCachingValues

func PossibleCachingValues() []Caching

PossibleCachingValues returns the possible values for the Caching const type.

type CertificateDatastoreCredentials

type CertificateDatastoreCredentials struct {
	// REQUIRED; [Required] Service principal client ID.
	ClientID *string `json:"clientId,omitempty"`

	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType `json:"credentialsType,omitempty"`

	// REQUIRED; [Required] Service principal secrets.
	Secrets *CertificateDatastoreSecrets `json:"secrets,omitempty"`

	// REQUIRED; [Required] ID of the tenant to which the service principal belongs.
	TenantID *string `json:"tenantId,omitempty"`

	// REQUIRED; [Required] Thumbprint of the certificate used for authentication.
	Thumbprint *string `json:"thumbprint,omitempty"`

	// Authority URL used for authentication.
	AuthorityURL *string `json:"authorityUrl,omitempty"`

	// Resource the service principal has access to.
	ResourceURL *string `json:"resourceUrl,omitempty"`
}

CertificateDatastoreCredentials - Certificate datastore credentials configuration.

func (*CertificateDatastoreCredentials) GetDatastoreCredentials

func (c *CertificateDatastoreCredentials) GetDatastoreCredentials() *DatastoreCredentials

GetDatastoreCredentials implements the DatastoreCredentialsClassification interface for type CertificateDatastoreCredentials.

func (CertificateDatastoreCredentials) MarshalJSON

func (c CertificateDatastoreCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateDatastoreCredentials.

func (*CertificateDatastoreCredentials) UnmarshalJSON

func (c *CertificateDatastoreCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateDatastoreCredentials.

type CertificateDatastoreSecrets

type CertificateDatastoreSecrets struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	SecretsType *SecretsType `json:"secretsType,omitempty"`

	// Service principal certificate.
	Certificate *string `json:"certificate,omitempty"`
}

CertificateDatastoreSecrets - Datastore certificate secrets.

func (*CertificateDatastoreSecrets) GetDatastoreSecrets

func (c *CertificateDatastoreSecrets) GetDatastoreSecrets() *DatastoreSecrets

GetDatastoreSecrets implements the DatastoreSecretsClassification interface for type CertificateDatastoreSecrets.

func (CertificateDatastoreSecrets) MarshalJSON

func (c CertificateDatastoreSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateDatastoreSecrets.

func (*CertificateDatastoreSecrets) UnmarshalJSON

func (c *CertificateDatastoreSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateDatastoreSecrets.

type ClusterPurpose

type ClusterPurpose string

ClusterPurpose - Intended usage of the cluster

const (
	ClusterPurposeDenseProd ClusterPurpose = "DenseProd"
	ClusterPurposeDevTest   ClusterPurpose = "DevTest"
	ClusterPurposeFastProd  ClusterPurpose = "FastProd"
)

func PossibleClusterPurposeValues

func PossibleClusterPurposeValues() []ClusterPurpose

PossibleClusterPurposeValues returns the possible values for the ClusterPurpose const type.

type ClusterUpdateParameters

type ClusterUpdateParameters struct {
	// The properties of the amlCompute.
	Properties *ClusterUpdateProperties `json:"properties,omitempty"`
}

ClusterUpdateParameters - AmlCompute update parameters.

func (ClusterUpdateParameters) MarshalJSON

func (c ClusterUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ClusterUpdateParameters.

type ClusterUpdateProperties

type ClusterUpdateProperties struct {
	// Properties of ClusterUpdate
	Properties *ScaleSettingsInformation `json:"properties,omitempty"`
}

ClusterUpdateProperties - The properties of a amlCompute that need to be updated.

type CodeConfiguration

type CodeConfiguration struct {
	// REQUIRED; [Required] The script to execute on startup. eg. "score.py"
	ScoringScript *string `json:"scoringScript,omitempty"`

	// ARM resource ID of the code asset.
	CodeID *string `json:"codeId,omitempty"`
}

CodeConfiguration - Configuration for a scoring code asset.

type CodeContainer

type CodeContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *CodeContainerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

CodeContainer - Azure Resource Manager resource envelope.

type CodeContainerProperties

type CodeContainerProperties struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string `json:"latestVersion,omitempty" azure:"ro"`

	// READ-ONLY; The next auto incremental version
	NextVersion *string `json:"nextVersion,omitempty" azure:"ro"`
}

CodeContainerProperties - Container for code asset versions.

func (CodeContainerProperties) MarshalJSON

func (c CodeContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CodeContainerProperties.

type CodeContainerResourceArmPaginatedResult

type CodeContainerResourceArmPaginatedResult struct {
	// The link to the next page of CodeContainer objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type CodeContainer.
	Value []*CodeContainer `json:"value,omitempty"`
}

CodeContainerResourceArmPaginatedResult - A paginated list of CodeContainer entities.

type CodeContainersClient

type CodeContainersClient struct {
	// contains filtered or unexported fields
}

CodeContainersClient contains the methods for the CodeContainers group. Don't use this type directly, use NewCodeContainersClient() instead.

func NewCodeContainersClient

func NewCodeContainersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CodeContainersClient, error)

NewCodeContainersClient creates a new instance of CodeContainersClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*CodeContainersClient) CreateOrUpdate

func (client *CodeContainersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, body CodeContainer, options *CodeContainersClientCreateOrUpdateOptions) (CodeContainersClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. body - Container entity to create or update. options - CodeContainersClientCreateOrUpdateOptions contains the optional parameters for the CodeContainersClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeContainer/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"testrg123",
	"testworkspace",
	"testContainer",
	armmachinelearning.CodeContainer{
		Properties: &armmachinelearning.CodeContainerProperties{
			Description: to.Ptr("string"),
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*CodeContainersClient) Delete

func (client *CodeContainersClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *CodeContainersClientDeleteOptions) (CodeContainersClientDeleteResponse, error)

Delete - Delete container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - CodeContainersClientDeleteOptions contains the optional parameters for the CodeContainersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeContainer/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"testrg123",
	"testworkspace",
	"testContainer",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*CodeContainersClient) Get

func (client *CodeContainersClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *CodeContainersClientGetOptions) (CodeContainersClientGetResponse, error)

Get - Get container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - CodeContainersClientGetOptions contains the optional parameters for the CodeContainersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeContainer/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"testrg123",
	"testworkspace",
	"testContainer",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*CodeContainersClient) NewListPager

func (client *CodeContainersClient) NewListPager(resourceGroupName string, workspaceName string, options *CodeContainersClientListOptions) *runtime.Pager[CodeContainersClientListResponse]

NewListPager - List containers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - CodeContainersClientListOptions contains the optional parameters for the CodeContainersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeContainer/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg123",
	"testworkspace",
	&armmachinelearning.CodeContainersClientListOptions{Skip: nil})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type CodeContainersClientCreateOrUpdateOptions

type CodeContainersClientCreateOrUpdateOptions struct {
}

CodeContainersClientCreateOrUpdateOptions contains the optional parameters for the CodeContainersClient.CreateOrUpdate method.

type CodeContainersClientCreateOrUpdateResponse

type CodeContainersClientCreateOrUpdateResponse struct {
	CodeContainer
}

CodeContainersClientCreateOrUpdateResponse contains the response from method CodeContainersClient.CreateOrUpdate.

type CodeContainersClientDeleteOptions

type CodeContainersClientDeleteOptions struct {
}

CodeContainersClientDeleteOptions contains the optional parameters for the CodeContainersClient.Delete method.

type CodeContainersClientDeleteResponse

type CodeContainersClientDeleteResponse struct {
}

CodeContainersClientDeleteResponse contains the response from method CodeContainersClient.Delete.

type CodeContainersClientGetOptions

type CodeContainersClientGetOptions struct {
}

CodeContainersClientGetOptions contains the optional parameters for the CodeContainersClient.Get method.

type CodeContainersClientGetResponse

type CodeContainersClientGetResponse struct {
	CodeContainer
}

CodeContainersClientGetResponse contains the response from method CodeContainersClient.Get.

type CodeContainersClientListOptions

type CodeContainersClientListOptions struct {
	// Continuation token for pagination.
	Skip *string
}

CodeContainersClientListOptions contains the optional parameters for the CodeContainersClient.List method.

type CodeContainersClientListResponse

type CodeContainersClientListResponse struct {
	CodeContainerResourceArmPaginatedResult
}

CodeContainersClientListResponse contains the response from method CodeContainersClient.List.

type CodeVersion

type CodeVersion struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *CodeVersionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

CodeVersion - Azure Resource Manager resource envelope.

type CodeVersionProperties

type CodeVersionProperties struct {
	// Uri where code is located
	CodeURI *string `json:"codeUri,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

CodeVersionProperties - Code asset version details.

func (CodeVersionProperties) MarshalJSON

func (c CodeVersionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CodeVersionProperties.

type CodeVersionResourceArmPaginatedResult

type CodeVersionResourceArmPaginatedResult struct {
	// The link to the next page of CodeVersion objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type CodeVersion.
	Value []*CodeVersion `json:"value,omitempty"`
}

CodeVersionResourceArmPaginatedResult - A paginated list of CodeVersion entities.

type CodeVersionsClient

type CodeVersionsClient struct {
	// contains filtered or unexported fields
}

CodeVersionsClient contains the methods for the CodeVersions group. Don't use this type directly, use NewCodeVersionsClient() instead.

func NewCodeVersionsClient

func NewCodeVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CodeVersionsClient, error)

NewCodeVersionsClient creates a new instance of CodeVersionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*CodeVersionsClient) CreateOrUpdate

func (client *CodeVersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, body CodeVersion, options *CodeVersionsClientCreateOrUpdateOptions) (CodeVersionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. body - Version entity to create or update. options - CodeVersionsClientCreateOrUpdateOptions contains the optional parameters for the CodeVersionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeVersion/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	armmachinelearning.CodeVersion{
		Properties: &armmachinelearning.CodeVersionProperties{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
			IsAnonymous: to.Ptr(false),
			CodeURI:     to.Ptr("https://blobStorage/folderName"),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*CodeVersionsClient) Delete

func (client *CodeVersionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *CodeVersionsClientDeleteOptions) (CodeVersionsClientDeleteResponse, error)

Delete - Delete version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. options - CodeVersionsClientDeleteOptions contains the optional parameters for the CodeVersionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeVersion/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*CodeVersionsClient) Get

func (client *CodeVersionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *CodeVersionsClientGetOptions) (CodeVersionsClientGetResponse, error)

Get - Get version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. options - CodeVersionsClientGetOptions contains the optional parameters for the CodeVersionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeVersion/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*CodeVersionsClient) NewListPager

func (client *CodeVersionsClient) NewListPager(resourceGroupName string, workspaceName string, name string, options *CodeVersionsClientListOptions) *runtime.Pager[CodeVersionsClientListResponse]

NewListPager - List versions. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - CodeVersionsClientListOptions contains the optional parameters for the CodeVersionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/CodeVersion/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewCodeVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	"string",
	&armmachinelearning.CodeVersionsClientListOptions{OrderBy: to.Ptr("string"),
		Top:  to.Ptr[int32](1),
		Skip: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type CodeVersionsClientCreateOrUpdateOptions

type CodeVersionsClientCreateOrUpdateOptions struct {
}

CodeVersionsClientCreateOrUpdateOptions contains the optional parameters for the CodeVersionsClient.CreateOrUpdate method.

type CodeVersionsClientCreateOrUpdateResponse

type CodeVersionsClientCreateOrUpdateResponse struct {
	CodeVersion
}

CodeVersionsClientCreateOrUpdateResponse contains the response from method CodeVersionsClient.CreateOrUpdate.

type CodeVersionsClientDeleteOptions

type CodeVersionsClientDeleteOptions struct {
}

CodeVersionsClientDeleteOptions contains the optional parameters for the CodeVersionsClient.Delete method.

type CodeVersionsClientDeleteResponse

type CodeVersionsClientDeleteResponse struct {
}

CodeVersionsClientDeleteResponse contains the response from method CodeVersionsClient.Delete.

type CodeVersionsClientGetOptions

type CodeVersionsClientGetOptions struct {
}

CodeVersionsClientGetOptions contains the optional parameters for the CodeVersionsClient.Get method.

type CodeVersionsClientGetResponse

type CodeVersionsClientGetResponse struct {
	CodeVersion
}

CodeVersionsClientGetResponse contains the response from method CodeVersionsClient.Get.

type CodeVersionsClientListOptions

type CodeVersionsClientListOptions struct {
	// Ordering of list.
	OrderBy *string
	// Continuation token for pagination.
	Skip *string
	// Maximum number of records to return.
	Top *int32
}

CodeVersionsClientListOptions contains the optional parameters for the CodeVersionsClient.List method.

type CodeVersionsClientListResponse

type CodeVersionsClientListResponse struct {
	CodeVersionResourceArmPaginatedResult
}

CodeVersionsClientListResponse contains the response from method CodeVersionsClient.List.

type CommandJob

type CommandJob struct {
	// REQUIRED; [Required] The command to execute on startup of the job. eg. "python train.py"
	Command *string `json:"command,omitempty"`

	// REQUIRED; [Required] The ARM resource ID of the Environment specification for the job.
	EnvironmentID *string `json:"environmentId,omitempty"`

	// REQUIRED; [Required] Specifies the type of job.
	JobType *JobType `json:"jobType,omitempty"`

	// ARM resource ID of the code asset.
	CodeID *string `json:"codeId,omitempty"`

	// ARM resource ID of the compute resource.
	ComputeID *string `json:"computeId,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Display name of job.
	DisplayName *string `json:"displayName,omitempty"`

	// Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.
	Distribution DistributionConfigurationClassification `json:"distribution,omitempty"`

	// Environment variables included in the job.
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
	ExperimentName *string `json:"experimentName,omitempty"`

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification `json:"identity,omitempty"`

	// Mapping of input data bindings used in the job.
	Inputs map[string]JobInputClassification `json:"inputs,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// Command Job limit.
	Limits *CommandJobLimits `json:"limits,omitempty"`

	// Mapping of output data bindings used in the job.
	Outputs map[string]JobOutputClassification `json:"outputs,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Compute Resource configuration for the job.
	Resources *ResourceConfiguration `json:"resources,omitempty"`

	// List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
	Services map[string]*JobService `json:"services,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Input parameters.
	Parameters interface{} `json:"parameters,omitempty" azure:"ro"`

	// READ-ONLY; Status of the job.
	Status *JobStatus `json:"status,omitempty" azure:"ro"`
}

CommandJob - Command job definition.

func (*CommandJob) GetJobBaseProperties

func (c *CommandJob) GetJobBaseProperties() *JobBaseProperties

GetJobBaseProperties implements the JobBasePropertiesClassification interface for type CommandJob.

func (CommandJob) MarshalJSON

func (c CommandJob) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CommandJob.

func (*CommandJob) UnmarshalJSON

func (c *CommandJob) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CommandJob.

type CommandJobLimits

type CommandJobLimits struct {
	// REQUIRED; [Required] JobLimit type.
	JobLimitsType *JobLimitsType `json:"jobLimitsType,omitempty"`

	// The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as
	// low as Seconds.
	Timeout *string `json:"timeout,omitempty"`
}

CommandJobLimits - Command Job limit class.

func (*CommandJobLimits) GetJobLimits

func (c *CommandJobLimits) GetJobLimits() *JobLimits

GetJobLimits implements the JobLimitsClassification interface for type CommandJobLimits.

func (CommandJobLimits) MarshalJSON

func (c CommandJobLimits) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CommandJobLimits.

func (*CommandJobLimits) UnmarshalJSON

func (c *CommandJobLimits) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CommandJobLimits.

type ComponentContainer

type ComponentContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *ComponentContainerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ComponentContainer - Azure Resource Manager resource envelope.

type ComponentContainerProperties

type ComponentContainerProperties struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string `json:"latestVersion,omitempty" azure:"ro"`

	// READ-ONLY; The next auto incremental version
	NextVersion *string `json:"nextVersion,omitempty" azure:"ro"`
}

ComponentContainerProperties - Component container definition.

func (ComponentContainerProperties) MarshalJSON

func (c ComponentContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComponentContainerProperties.

type ComponentContainerResourceArmPaginatedResult

type ComponentContainerResourceArmPaginatedResult struct {
	// The link to the next page of ComponentContainer objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type ComponentContainer.
	Value []*ComponentContainer `json:"value,omitempty"`
}

ComponentContainerResourceArmPaginatedResult - A paginated list of ComponentContainer entities.

type ComponentContainersClient

type ComponentContainersClient struct {
	// contains filtered or unexported fields
}

ComponentContainersClient contains the methods for the ComponentContainers group. Don't use this type directly, use NewComponentContainersClient() instead.

func NewComponentContainersClient

func NewComponentContainersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ComponentContainersClient, error)

NewComponentContainersClient creates a new instance of ComponentContainersClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ComponentContainersClient) CreateOrUpdate

CreateOrUpdate - Create or update container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. body - Container entity to create or update. options - ComponentContainersClientCreateOrUpdateOptions contains the optional parameters for the ComponentContainersClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentContainer/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	armmachinelearning.ComponentContainer{
		Properties: &armmachinelearning.ComponentContainerProperties{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComponentContainersClient) Delete

Delete - Delete container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. options - ComponentContainersClientDeleteOptions contains the optional parameters for the ComponentContainersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentContainer/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*ComponentContainersClient) Get

Get - Get container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. options - ComponentContainersClientGetOptions contains the optional parameters for the ComponentContainersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentContainer/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComponentContainersClient) NewListPager

func (client *ComponentContainersClient) NewListPager(resourceGroupName string, workspaceName string, options *ComponentContainersClientListOptions) *runtime.Pager[ComponentContainersClientListResponse]

NewListPager - List component containers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - ComponentContainersClientListOptions contains the optional parameters for the ComponentContainersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentContainer/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	&armmachinelearning.ComponentContainersClientListOptions{Skip: nil,
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ComponentContainersClientCreateOrUpdateOptions

type ComponentContainersClientCreateOrUpdateOptions struct {
}

ComponentContainersClientCreateOrUpdateOptions contains the optional parameters for the ComponentContainersClient.CreateOrUpdate method.

type ComponentContainersClientCreateOrUpdateResponse

type ComponentContainersClientCreateOrUpdateResponse struct {
	ComponentContainer
}

ComponentContainersClientCreateOrUpdateResponse contains the response from method ComponentContainersClient.CreateOrUpdate.

type ComponentContainersClientDeleteOptions

type ComponentContainersClientDeleteOptions struct {
}

ComponentContainersClientDeleteOptions contains the optional parameters for the ComponentContainersClient.Delete method.

type ComponentContainersClientDeleteResponse

type ComponentContainersClientDeleteResponse struct {
}

ComponentContainersClientDeleteResponse contains the response from method ComponentContainersClient.Delete.

type ComponentContainersClientGetOptions

type ComponentContainersClientGetOptions struct {
}

ComponentContainersClientGetOptions contains the optional parameters for the ComponentContainersClient.Get method.

type ComponentContainersClientGetResponse

type ComponentContainersClientGetResponse struct {
	ComponentContainer
}

ComponentContainersClientGetResponse contains the response from method ComponentContainersClient.Get.

type ComponentContainersClientListOptions

type ComponentContainersClientListOptions struct {
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Continuation token for pagination.
	Skip *string
}

ComponentContainersClientListOptions contains the optional parameters for the ComponentContainersClient.List method.

type ComponentContainersClientListResponse

type ComponentContainersClientListResponse struct {
	ComponentContainerResourceArmPaginatedResult
}

ComponentContainersClientListResponse contains the response from method ComponentContainersClient.List.

type ComponentVersion

type ComponentVersion struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *ComponentVersionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ComponentVersion - Azure Resource Manager resource envelope.

type ComponentVersionProperties

type ComponentVersionProperties struct {
	// Defines Component definition details.
	ComponentSpec interface{} `json:"componentSpec,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

ComponentVersionProperties - Definition of a component version: defines resources that span component types.

func (ComponentVersionProperties) MarshalJSON

func (c ComponentVersionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComponentVersionProperties.

type ComponentVersionResourceArmPaginatedResult

type ComponentVersionResourceArmPaginatedResult struct {
	// The link to the next page of ComponentVersion objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type ComponentVersion.
	Value []*ComponentVersion `json:"value,omitempty"`
}

ComponentVersionResourceArmPaginatedResult - A paginated list of ComponentVersion entities.

type ComponentVersionsClient

type ComponentVersionsClient struct {
	// contains filtered or unexported fields
}

ComponentVersionsClient contains the methods for the ComponentVersions group. Don't use this type directly, use NewComponentVersionsClient() instead.

func NewComponentVersionsClient

func NewComponentVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ComponentVersionsClient, error)

NewComponentVersionsClient creates a new instance of ComponentVersionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ComponentVersionsClient) CreateOrUpdate

func (client *ComponentVersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, body ComponentVersion, options *ComponentVersionsClientCreateOrUpdateOptions) (ComponentVersionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. version - Version identifier. body - Version entity to create or update. options - ComponentVersionsClientCreateOrUpdateOptions contains the optional parameters for the ComponentVersionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentVersion/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	armmachinelearning.ComponentVersion{
		Properties: &armmachinelearning.ComponentVersionProperties{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
			IsAnonymous: to.Ptr(false),
			ComponentSpec: map[string]interface{}{
				"8ced901b-d826-477d-bfef-329da9672513": nil,
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComponentVersionsClient) Delete

func (client *ComponentVersionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *ComponentVersionsClientDeleteOptions) (ComponentVersionsClientDeleteResponse, error)

Delete - Delete version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. version - Version identifier. options - ComponentVersionsClientDeleteOptions contains the optional parameters for the ComponentVersionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentVersion/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*ComponentVersionsClient) Get

func (client *ComponentVersionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *ComponentVersionsClientGetOptions) (ComponentVersionsClientGetResponse, error)

Get - Get version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. version - Version identifier. options - ComponentVersionsClientGetOptions contains the optional parameters for the ComponentVersionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentVersion/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComponentVersionsClient) NewListPager

func (client *ComponentVersionsClient) NewListPager(resourceGroupName string, workspaceName string, name string, options *ComponentVersionsClientListOptions) *runtime.Pager[ComponentVersionsClientListResponse]

NewListPager - List component versions. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Component name. options - ComponentVersionsClientListOptions contains the optional parameters for the ComponentVersionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ComponentVersion/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComponentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	"string",
	&armmachinelearning.ComponentVersionsClientListOptions{OrderBy: to.Ptr("string"),
		Top:          to.Ptr[int32](1),
		Skip:         nil,
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ComponentVersionsClientCreateOrUpdateOptions

type ComponentVersionsClientCreateOrUpdateOptions struct {
}

ComponentVersionsClientCreateOrUpdateOptions contains the optional parameters for the ComponentVersionsClient.CreateOrUpdate method.

type ComponentVersionsClientCreateOrUpdateResponse

type ComponentVersionsClientCreateOrUpdateResponse struct {
	ComponentVersion
}

ComponentVersionsClientCreateOrUpdateResponse contains the response from method ComponentVersionsClient.CreateOrUpdate.

type ComponentVersionsClientDeleteOptions

type ComponentVersionsClientDeleteOptions struct {
}

ComponentVersionsClientDeleteOptions contains the optional parameters for the ComponentVersionsClient.Delete method.

type ComponentVersionsClientDeleteResponse

type ComponentVersionsClientDeleteResponse struct {
}

ComponentVersionsClientDeleteResponse contains the response from method ComponentVersionsClient.Delete.

type ComponentVersionsClientGetOptions

type ComponentVersionsClientGetOptions struct {
}

ComponentVersionsClientGetOptions contains the optional parameters for the ComponentVersionsClient.Get method.

type ComponentVersionsClientGetResponse

type ComponentVersionsClientGetResponse struct {
	ComponentVersion
}

ComponentVersionsClientGetResponse contains the response from method ComponentVersionsClient.Get.

type ComponentVersionsClientListOptions

type ComponentVersionsClientListOptions struct {
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Ordering of list.
	OrderBy *string
	// Continuation token for pagination.
	Skip *string
	// Maximum number of records to return.
	Top *int32
}

ComponentVersionsClientListOptions contains the optional parameters for the ComponentVersionsClient.List method.

type ComponentVersionsClientListResponse

type ComponentVersionsClientListResponse struct {
	ComponentVersionResourceArmPaginatedResult
}

ComponentVersionsClientListResponse contains the response from method ComponentVersionsClient.List.

type Compute

type Compute struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

Compute - Machine Learning compute object.

func (*Compute) GetCompute

func (c *Compute) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type Compute.

func (Compute) MarshalJSON

func (c Compute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Compute.

func (*Compute) UnmarshalJSON

func (c *Compute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Compute.

type ComputeClassification

type ComputeClassification interface {
	// GetCompute returns the Compute content of the underlying type.
	GetCompute() *Compute
}

ComputeClassification provides polymorphic access to related types. Call the interface's GetCompute() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AKS, *AmlCompute, *Compute, *ComputeInstance, *DataFactory, *DataLakeAnalytics, *Databricks, *HDInsight, *Kubernetes, - *SynapseSpark, *VirtualMachine

type ComputeClient

type ComputeClient struct {
	// contains filtered or unexported fields
}

ComputeClient contains the methods for the Compute group. Don't use this type directly, use NewComputeClient() instead.

func NewComputeClient

func NewComputeClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ComputeClient, error)

NewComputeClient creates a new instance of ComputeClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ComputeClient) BeginCreateOrUpdate

func (client *ComputeClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, parameters ComputeResource, options *ComputeClientBeginCreateOrUpdateOptions) (*runtime.Poller[ComputeClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. parameters - Payload with Machine Learning compute definition. options - ComputeClientBeginCreateOrUpdateOptions contains the optional parameters for the ComputeClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/createOrUpdate/KubernetesCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	armmachinelearning.ComputeResource{
		Properties: &armmachinelearning.Kubernetes{
			Description: to.Ptr("some compute"),
			ComputeType: to.Ptr(armmachinelearning.ComputeTypeKubernetes),
			ResourceID:  to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2"),
			Properties: &armmachinelearning.KubernetesProperties{
				DefaultInstanceType: to.Ptr("defaultInstanceType"),
				InstanceTypes: map[string]*armmachinelearning.InstanceTypeSchema{
					"defaultInstanceType": {
						Resources: &armmachinelearning.InstanceTypeSchemaResources{
							Limits: map[string]*string{
								"cpu":            to.Ptr("1"),
								"memory":         to.Ptr("4Gi"),
								"nvidia.com/gpu": nil,
							},
							Requests: map[string]*string{
								"cpu":            to.Ptr("1"),
								"memory":         to.Ptr("4Gi"),
								"nvidia.com/gpu": nil,
							},
						},
					},
				},
				Namespace: to.Ptr("default"),
			},
		},
		Location: to.Ptr("eastus"),
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComputeClient) BeginDelete

func (client *ComputeClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, underlyingResourceAction UnderlyingResourceAction, options *ComputeClientBeginDeleteOptions) (*runtime.Poller[ComputeClientDeleteResponse], error)

BeginDelete - Deletes specified Machine Learning compute. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. underlyingResourceAction - Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'. options - ComputeClientBeginDeleteOptions contains the optional parameters for the ComputeClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	armmachinelearning.UnderlyingResourceActionDelete,
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ComputeClient) BeginRestart

func (client *ComputeClient) BeginRestart(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, options *ComputeClientBeginRestartOptions) (*runtime.Poller[ComputeClientRestartResponse], error)

BeginRestart - Posts a restart action to a compute instance If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. options - ComputeClientBeginRestartOptions contains the optional parameters for the ComputeClient.BeginRestart method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/restart.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginRestart(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ComputeClient) BeginStart

func (client *ComputeClient) BeginStart(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, options *ComputeClientBeginStartOptions) (*runtime.Poller[ComputeClientStartResponse], error)

BeginStart - Posts a start action to a compute instance If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. options - ComputeClientBeginStartOptions contains the optional parameters for the ComputeClient.BeginStart method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/start.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStart(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ComputeClient) BeginStop

func (client *ComputeClient) BeginStop(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, options *ComputeClientBeginStopOptions) (*runtime.Poller[ComputeClientStopResponse], error)

BeginStop - Posts a stop action to a compute instance If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. options - ComputeClientBeginStopOptions contains the optional parameters for the ComputeClient.BeginStop method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/stop.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStop(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ComputeClient) BeginUpdate

func (client *ComputeClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, parameters ClusterUpdateParameters, options *ComputeClientBeginUpdateOptions) (*runtime.Poller[ComputeClientUpdateResponse], error)

BeginUpdate - Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. parameters - Additional parameters for cluster update. options - ComputeClientBeginUpdateOptions contains the optional parameters for the ComputeClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/patch.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	armmachinelearning.ClusterUpdateParameters{
		Properties: &armmachinelearning.ClusterUpdateProperties{
			Properties: &armmachinelearning.ScaleSettingsInformation{
				ScaleSettings: &armmachinelearning.ScaleSettings{
					MaxNodeCount:                to.Ptr[int32](4),
					MinNodeCount:                to.Ptr[int32](4),
					NodeIdleTimeBeforeScaleDown: to.Ptr("PT5M"),
				},
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComputeClient) Get

func (client *ComputeClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, options *ComputeClientGetOptions) (ComputeClientGetResponse, error)

Get - Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. options - ComputeClientGetOptions contains the optional parameters for the ComputeClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/get/AKSCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComputeClient) ListKeys

func (client *ComputeClient) ListKeys(ctx context.Context, resourceGroupName string, workspaceName string, computeName string, options *ComputeClientListKeysOptions) (ComputeClientListKeysResponse, error)

ListKeys - Gets secrets related to Machine Learning compute (storage keys, service credentials, etc). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. options - ComputeClientListKeysOptions contains the optional parameters for the ComputeClient.ListKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/listKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListKeys(ctx,
	"testrg123",
	"workspaces123",
	"compute123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ComputeClient) NewListNodesPager

func (client *ComputeClient) NewListNodesPager(resourceGroupName string, workspaceName string, computeName string, options *ComputeClientListNodesOptions) *runtime.Pager[ComputeClientListNodesResponse]

NewListNodesPager - Get the details (e.g IP address, port etc) of all the compute nodes in the compute. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. options - ComputeClientListNodesOptions contains the optional parameters for the ComputeClient.ListNodes method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/listNodes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListNodesPager("testrg123",
	"workspaces123",
	"compute123",
	nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Nodes {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ComputeClient) NewListPager

func (client *ComputeClient) NewListPager(resourceGroupName string, workspaceName string, options *ComputeClientListOptions) *runtime.Pager[ComputeClientListResponse]

NewListPager - Gets computes in specified workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - ComputeClientListOptions contains the optional parameters for the ComputeClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Compute/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg123",
	"workspaces123",
	&armmachinelearning.ComputeClientListOptions{Skip: nil})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ComputeClientBeginCreateOrUpdateOptions

type ComputeClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ComputeClientBeginCreateOrUpdateOptions contains the optional parameters for the ComputeClient.BeginCreateOrUpdate method.

type ComputeClientBeginDeleteOptions

type ComputeClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ComputeClientBeginDeleteOptions contains the optional parameters for the ComputeClient.BeginDelete method.

type ComputeClientBeginRestartOptions

type ComputeClientBeginRestartOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ComputeClientBeginRestartOptions contains the optional parameters for the ComputeClient.BeginRestart method.

type ComputeClientBeginStartOptions

type ComputeClientBeginStartOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ComputeClientBeginStartOptions contains the optional parameters for the ComputeClient.BeginStart method.

type ComputeClientBeginStopOptions

type ComputeClientBeginStopOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ComputeClientBeginStopOptions contains the optional parameters for the ComputeClient.BeginStop method.

type ComputeClientBeginUpdateOptions

type ComputeClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ComputeClientBeginUpdateOptions contains the optional parameters for the ComputeClient.BeginUpdate method.

type ComputeClientCreateOrUpdateResponse

type ComputeClientCreateOrUpdateResponse struct {
	ComputeResource
}

ComputeClientCreateOrUpdateResponse contains the response from method ComputeClient.CreateOrUpdate.

type ComputeClientDeleteResponse

type ComputeClientDeleteResponse struct {
}

ComputeClientDeleteResponse contains the response from method ComputeClient.Delete.

type ComputeClientGetOptions

type ComputeClientGetOptions struct {
}

ComputeClientGetOptions contains the optional parameters for the ComputeClient.Get method.

type ComputeClientGetResponse

type ComputeClientGetResponse struct {
	ComputeResource
}

ComputeClientGetResponse contains the response from method ComputeClient.Get.

type ComputeClientListKeysOptions

type ComputeClientListKeysOptions struct {
}

ComputeClientListKeysOptions contains the optional parameters for the ComputeClient.ListKeys method.

type ComputeClientListKeysResponse

type ComputeClientListKeysResponse struct {
	ComputeSecretsClassification
}

ComputeClientListKeysResponse contains the response from method ComputeClient.ListKeys.

func (*ComputeClientListKeysResponse) UnmarshalJSON

func (c *ComputeClientListKeysResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeClientListKeysResponse.

type ComputeClientListNodesOptions

type ComputeClientListNodesOptions struct {
}

ComputeClientListNodesOptions contains the optional parameters for the ComputeClient.ListNodes method.

type ComputeClientListNodesResponse

type ComputeClientListNodesResponse struct {
	AmlComputeNodesInformation
}

ComputeClientListNodesResponse contains the response from method ComputeClient.ListNodes.

type ComputeClientListOptions

type ComputeClientListOptions struct {
	// Continuation token for pagination.
	Skip *string
}

ComputeClientListOptions contains the optional parameters for the ComputeClient.List method.

type ComputeClientListResponse

type ComputeClientListResponse struct {
	PaginatedComputeResourcesList
}

ComputeClientListResponse contains the response from method ComputeClient.List.

type ComputeClientRestartResponse

type ComputeClientRestartResponse struct {
}

ComputeClientRestartResponse contains the response from method ComputeClient.Restart.

type ComputeClientStartResponse

type ComputeClientStartResponse struct {
}

ComputeClientStartResponse contains the response from method ComputeClient.Start.

type ComputeClientStopResponse

type ComputeClientStopResponse struct {
}

ComputeClientStopResponse contains the response from method ComputeClient.Stop.

type ComputeClientUpdateResponse

type ComputeClientUpdateResponse struct {
	ComputeResource
}

ComputeClientUpdateResponse contains the response from method ComputeClient.Update.

type ComputeInstance

type ComputeInstance struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// Properties of ComputeInstance
	Properties *ComputeInstanceProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ComputeInstance - An Azure Machine Learning compute instance.

func (*ComputeInstance) GetCompute

func (c *ComputeInstance) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type ComputeInstance.

func (ComputeInstance) MarshalJSON

func (c ComputeInstance) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeInstance.

func (*ComputeInstance) UnmarshalJSON

func (c *ComputeInstance) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstance.

type ComputeInstanceApplication

type ComputeInstanceApplication struct {
	// Name of the ComputeInstance application.
	DisplayName *string `json:"displayName,omitempty"`

	// Application' endpoint URI.
	EndpointURI *string `json:"endpointUri,omitempty"`
}

ComputeInstanceApplication - Defines an Aml Instance application and its connectivity endpoint URI.

type ComputeInstanceAuthorizationType

type ComputeInstanceAuthorizationType string

ComputeInstanceAuthorizationType - The Compute Instance Authorization type. Available values are personal (default).

const (
	ComputeInstanceAuthorizationTypePersonal ComputeInstanceAuthorizationType = "personal"
)

func PossibleComputeInstanceAuthorizationTypeValues

func PossibleComputeInstanceAuthorizationTypeValues() []ComputeInstanceAuthorizationType

PossibleComputeInstanceAuthorizationTypeValues returns the possible values for the ComputeInstanceAuthorizationType const type.

type ComputeInstanceConnectivityEndpoints

type ComputeInstanceConnectivityEndpoints struct {
	// READ-ONLY; Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).
	PrivateIPAddress *string `json:"privateIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; Public IP Address of this ComputeInstance.
	PublicIPAddress *string `json:"publicIpAddress,omitempty" azure:"ro"`
}

ComputeInstanceConnectivityEndpoints - Defines all connectivity endpoints and properties for an ComputeInstance.

type ComputeInstanceContainer

type ComputeInstanceContainer struct {
	// Auto save settings.
	Autosave *Autosave `json:"autosave,omitempty"`

	// Environment information of this container.
	Environment *ComputeInstanceEnvironmentInfo `json:"environment,omitempty"`

	// Information of GPU.
	Gpu *string `json:"gpu,omitempty"`

	// Name of the ComputeInstance container.
	Name *string `json:"name,omitempty"`

	// network of this container.
	Network *Network `json:"network,omitempty"`

	// READ-ONLY; services of this containers.
	Services []interface{} `json:"services,omitempty" azure:"ro"`
}

ComputeInstanceContainer - Defines an Aml Instance container.

func (ComputeInstanceContainer) MarshalJSON

func (c ComputeInstanceContainer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceContainer.

type ComputeInstanceCreatedBy

type ComputeInstanceCreatedBy struct {
	// READ-ONLY; Uniquely identifies the user within his/her organization.
	UserID *string `json:"userId,omitempty" azure:"ro"`

	// READ-ONLY; Name of the user.
	UserName *string `json:"userName,omitempty" azure:"ro"`

	// READ-ONLY; Uniquely identifies user' Azure Active Directory organization.
	UserOrgID *string `json:"userOrgId,omitempty" azure:"ro"`
}

ComputeInstanceCreatedBy - Describes information on user who created this ComputeInstance.

type ComputeInstanceDataDisk

type ComputeInstanceDataDisk struct {
	// Caching type of Data Disk.
	Caching *Caching `json:"caching,omitempty"`

	// The initial disk size in gigabytes.
	DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`

	// The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.
	Lun *int32 `json:"lun,omitempty"`

	// type of this storage account.
	StorageAccountType *StorageAccountType `json:"storageAccountType,omitempty"`
}

ComputeInstanceDataDisk - Defines an Aml Instance DataDisk.

type ComputeInstanceDataMount

type ComputeInstanceDataMount struct {
	// who this data mount created by.
	CreatedBy *string `json:"createdBy,omitempty"`

	// Error of this data mount.
	Error *string `json:"error,omitempty"`

	// Mount Action.
	MountAction *MountAction `json:"mountAction,omitempty"`

	// name of the ComputeInstance data mount.
	MountName *string `json:"mountName,omitempty"`

	// Path of this data mount.
	MountPath *string `json:"mountPath,omitempty"`

	// Mount state.
	MountState *MountState `json:"mountState,omitempty"`

	// The time when the disk mounted.
	MountedOn *time.Time `json:"mountedOn,omitempty"`

	// Source of the ComputeInstance data mount.
	Source *string `json:"source,omitempty"`

	// Data source type.
	SourceType *SourceType `json:"sourceType,omitempty"`
}

ComputeInstanceDataMount - Defines an Aml Instance DataMount.

func (ComputeInstanceDataMount) MarshalJSON

func (c ComputeInstanceDataMount) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceDataMount.

func (*ComputeInstanceDataMount) UnmarshalJSON

func (c *ComputeInstanceDataMount) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceDataMount.

type ComputeInstanceEnvironmentInfo

type ComputeInstanceEnvironmentInfo struct {
	// name of environment.
	Name *string `json:"name,omitempty"`

	// version of environment.
	Version *string `json:"version,omitempty"`
}

ComputeInstanceEnvironmentInfo - Environment information

type ComputeInstanceLastOperation

type ComputeInstanceLastOperation struct {
	// Name of the last operation.
	OperationName *OperationName `json:"operationName,omitempty"`

	// Operation status.
	OperationStatus *OperationStatus `json:"operationStatus,omitempty"`

	// Time of the last operation.
	OperationTime *time.Time `json:"operationTime,omitempty"`

	// Trigger of operation.
	OperationTrigger *OperationTrigger `json:"operationTrigger,omitempty"`
}

ComputeInstanceLastOperation - The last operation on ComputeInstance.

func (ComputeInstanceLastOperation) MarshalJSON

func (c ComputeInstanceLastOperation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceLastOperation.

func (*ComputeInstanceLastOperation) UnmarshalJSON

func (c *ComputeInstanceLastOperation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceLastOperation.

type ComputeInstanceProperties

type ComputeInstanceProperties struct {
	// Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator
	// can access applications on this compute instance. When Shared, any workspace
	// user can access applications on this instance depending on his/her assigned role.
	ApplicationSharingPolicy *ApplicationSharingPolicy `json:"applicationSharingPolicy,omitempty"`

	// The Compute Instance Authorization type. Available values are personal (default).
	ComputeInstanceAuthorizationType *ComputeInstanceAuthorizationType `json:"computeInstanceAuthorizationType,omitempty"`

	// Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that
	// the compute nodes will have public IPs provisioned. false - Indicates that the
	// compute nodes will have a private endpoint and no public IPs.
	EnableNodePublicIP *bool `json:"enableNodePublicIp,omitempty"`

	// Settings for a personal compute instance.
	PersonalComputeInstanceSettings *PersonalComputeInstanceSettings `json:"personalComputeInstanceSettings,omitempty"`

	// Specifies policy and settings for SSH access.
	SSHSettings *ComputeInstanceSSHSettings `json:"sshSettings,omitempty"`

	// Details of customized scripts to execute for setting up the cluster.
	SetupScripts *SetupScripts `json:"setupScripts,omitempty"`

	// Virtual network subnet resource ID the compute nodes belong to.
	Subnet *ResourceID `json:"subnet,omitempty"`

	// Virtual Machine Size
	VMSize *string `json:"vmSize,omitempty"`

	// READ-ONLY; Describes available applications and their endpoints on this ComputeInstance.
	Applications []*ComputeInstanceApplication `json:"applications,omitempty" azure:"ro"`

	// READ-ONLY; Describes all connectivity endpoints available for this ComputeInstance.
	ConnectivityEndpoints *ComputeInstanceConnectivityEndpoints `json:"connectivityEndpoints,omitempty" azure:"ro"`

	// READ-ONLY; Describes informations of containers on this ComputeInstance.
	Containers []*ComputeInstanceContainer `json:"containers,omitempty" azure:"ro"`

	// READ-ONLY; Describes information on user who created this ComputeInstance.
	CreatedBy *ComputeInstanceCreatedBy `json:"createdBy,omitempty" azure:"ro"`

	// READ-ONLY; Describes informations of dataDisks on this ComputeInstance.
	DataDisks []*ComputeInstanceDataDisk `json:"dataDisks,omitempty" azure:"ro"`

	// READ-ONLY; Describes informations of dataMounts on this ComputeInstance.
	DataMounts []*ComputeInstanceDataMount `json:"dataMounts,omitempty" azure:"ro"`

	// READ-ONLY; Collection of errors encountered on this ComputeInstance.
	Errors []*ErrorResponse `json:"errors,omitempty" azure:"ro"`

	// READ-ONLY; The last operation on ComputeInstance.
	LastOperation *ComputeInstanceLastOperation `json:"lastOperation,omitempty" azure:"ro"`

	// READ-ONLY; The list of schedules to be applied on the computes.
	Schedules *ComputeSchedules `json:"schedules,omitempty" azure:"ro"`

	// READ-ONLY; The current state of this ComputeInstance.
	State *ComputeInstanceState `json:"state,omitempty" azure:"ro"`

	// READ-ONLY; ComputeInstance version.
	Versions *ComputeInstanceVersion `json:"versions,omitempty" azure:"ro"`
}

ComputeInstanceProperties - Compute Instance properties

func (ComputeInstanceProperties) MarshalJSON

func (c ComputeInstanceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceProperties.

type ComputeInstanceSSHSettings

type ComputeInstanceSSHSettings struct {
	// Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs.
	AdminPublicKey *string `json:"adminPublicKey,omitempty"`

	// State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance.
	// Enabled - Indicates that the public ssh port is open and accessible
	// according to the VNet/subnet policy if applicable.
	SSHPublicAccess *SSHPublicAccess `json:"sshPublicAccess,omitempty"`

	// READ-ONLY; Describes the admin user name.
	AdminUserName *string `json:"adminUserName,omitempty" azure:"ro"`

	// READ-ONLY; Describes the port for connecting through SSH.
	SSHPort *int32 `json:"sshPort,omitempty" azure:"ro"`
}

ComputeInstanceSSHSettings - Specifies policy and settings for SSH access.

type ComputeInstanceSchema

type ComputeInstanceSchema struct {
	// Properties of ComputeInstance
	Properties *ComputeInstanceProperties `json:"properties,omitempty"`
}

ComputeInstanceSchema - Properties(top level) of ComputeInstance

type ComputeInstanceState

type ComputeInstanceState string

ComputeInstanceState - Current state of an ComputeInstance.

const (
	ComputeInstanceStateCreateFailed    ComputeInstanceState = "CreateFailed"
	ComputeInstanceStateCreating        ComputeInstanceState = "Creating"
	ComputeInstanceStateDeleting        ComputeInstanceState = "Deleting"
	ComputeInstanceStateJobRunning      ComputeInstanceState = "JobRunning"
	ComputeInstanceStateRestarting      ComputeInstanceState = "Restarting"
	ComputeInstanceStateRunning         ComputeInstanceState = "Running"
	ComputeInstanceStateSettingUp       ComputeInstanceState = "SettingUp"
	ComputeInstanceStateSetupFailed     ComputeInstanceState = "SetupFailed"
	ComputeInstanceStateStarting        ComputeInstanceState = "Starting"
	ComputeInstanceStateStopped         ComputeInstanceState = "Stopped"
	ComputeInstanceStateStopping        ComputeInstanceState = "Stopping"
	ComputeInstanceStateUnknown         ComputeInstanceState = "Unknown"
	ComputeInstanceStateUnusable        ComputeInstanceState = "Unusable"
	ComputeInstanceStateUserSettingUp   ComputeInstanceState = "UserSettingUp"
	ComputeInstanceStateUserSetupFailed ComputeInstanceState = "UserSetupFailed"
)

func PossibleComputeInstanceStateValues

func PossibleComputeInstanceStateValues() []ComputeInstanceState

PossibleComputeInstanceStateValues returns the possible values for the ComputeInstanceState const type.

type ComputeInstanceVersion

type ComputeInstanceVersion struct {
	// Runtime of compute instance.
	Runtime *string `json:"runtime,omitempty"`
}

ComputeInstanceVersion - Version of computeInstance.

type ComputePowerAction

type ComputePowerAction string

ComputePowerAction - The compute power action.

const (
	ComputePowerActionStart ComputePowerAction = "Start"
	ComputePowerActionStop  ComputePowerAction = "Stop"
)

func PossibleComputePowerActionValues

func PossibleComputePowerActionValues() []ComputePowerAction

PossibleComputePowerActionValues returns the possible values for the ComputePowerAction const type.

type ComputeResource

type ComputeResource struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// Compute properties
	Properties ComputeClassification `json:"properties,omitempty"`

	// The sku of the workspace.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ComputeResource - Machine Learning compute object wrapped into ARM resource envelope.

func (ComputeResource) MarshalJSON

func (c ComputeResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeResource.

func (*ComputeResource) UnmarshalJSON

func (c *ComputeResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeResource.

type ComputeResourceSchema

type ComputeResourceSchema struct {
	// Compute properties
	Properties ComputeClassification `json:"properties,omitempty"`
}

func (ComputeResourceSchema) MarshalJSON

func (c ComputeResourceSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeResourceSchema.

func (*ComputeResourceSchema) UnmarshalJSON

func (c *ComputeResourceSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeResourceSchema.

type ComputeSchedules

type ComputeSchedules struct {
	// The list of compute start stop schedules to be applied.
	ComputeStartStop []*ComputeStartStopSchedule `json:"computeStartStop,omitempty"`
}

ComputeSchedules - The list of schedules to be applied on the computes

func (ComputeSchedules) MarshalJSON

func (c ComputeSchedules) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComputeSchedules.

type ComputeSecrets

type ComputeSecrets struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`
}

ComputeSecrets - Secrets related to a Machine Learning compute. Might differ for every type of compute.

func (*ComputeSecrets) GetComputeSecrets

func (c *ComputeSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type ComputeSecrets.

type ComputeSecretsClassification

type ComputeSecretsClassification interface {
	// GetComputeSecrets returns the ComputeSecrets content of the underlying type.
	GetComputeSecrets() *ComputeSecrets
}

ComputeSecretsClassification provides polymorphic access to related types. Call the interface's GetComputeSecrets() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AksComputeSecrets, *ComputeSecrets, *DatabricksComputeSecrets, *VirtualMachineSecrets

type ComputeStartStopSchedule

type ComputeStartStopSchedule struct {
	// The compute power action.
	Action   *ComputePowerAction `json:"action,omitempty"`
	Schedule *ScheduleBase       `json:"schedule,omitempty"`

	// READ-ONLY; Schedule id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The current deployment state of schedule.
	ProvisioningStatus *ProvisioningStatus `json:"provisioningStatus,omitempty" azure:"ro"`
}

ComputeStartStopSchedule - Compute start stop schedule properties

type ComputeType

type ComputeType string

ComputeType - The type of compute

const (
	ComputeTypeAKS               ComputeType = "AKS"
	ComputeTypeAmlCompute        ComputeType = "AmlCompute"
	ComputeTypeComputeInstance   ComputeType = "ComputeInstance"
	ComputeTypeDataFactory       ComputeType = "DataFactory"
	ComputeTypeDataLakeAnalytics ComputeType = "DataLakeAnalytics"
	ComputeTypeDatabricks        ComputeType = "Databricks"
	ComputeTypeHDInsight         ComputeType = "HDInsight"
	ComputeTypeKubernetes        ComputeType = "Kubernetes"
	ComputeTypeSynapseSpark      ComputeType = "SynapseSpark"
	ComputeTypeVirtualMachine    ComputeType = "VirtualMachine"
)

func PossibleComputeTypeValues

func PossibleComputeTypeValues() []ComputeType

PossibleComputeTypeValues returns the possible values for the ComputeType const type.

type ConnectionAuthType

type ConnectionAuthType string

ConnectionAuthType - Authentication type of the connection target

const (
	ConnectionAuthTypeManagedIdentity  ConnectionAuthType = "ManagedIdentity"
	ConnectionAuthTypeNone             ConnectionAuthType = "None"
	ConnectionAuthTypePAT              ConnectionAuthType = "PAT"
	ConnectionAuthTypeSAS              ConnectionAuthType = "SAS"
	ConnectionAuthTypeUsernamePassword ConnectionAuthType = "UsernamePassword"
)

func PossibleConnectionAuthTypeValues

func PossibleConnectionAuthTypeValues() []ConnectionAuthType

PossibleConnectionAuthTypeValues returns the possible values for the ConnectionAuthType const type.

type ConnectionCategory

type ConnectionCategory string

ConnectionCategory - Category of the connection

const (
	ConnectionCategoryContainerRegistry ConnectionCategory = "ContainerRegistry"
	ConnectionCategoryGit               ConnectionCategory = "Git"
	ConnectionCategoryPythonFeed        ConnectionCategory = "PythonFeed"
)

func PossibleConnectionCategoryValues

func PossibleConnectionCategoryValues() []ConnectionCategory

PossibleConnectionCategoryValues returns the possible values for the ConnectionCategory const type.

type ContainerResourceRequirements

type ContainerResourceRequirements struct {
	// Container resource limit info:
	ContainerResourceLimits *ContainerResourceSettings `json:"containerResourceLimits,omitempty"`

	// Container resource request info:
	ContainerResourceRequests *ContainerResourceSettings `json:"containerResourceRequests,omitempty"`
}

ContainerResourceRequirements - Resource requirements for each container instance within an online deployment.

type ContainerResourceSettings

type ContainerResourceSettings struct {
	// Number of vCPUs request/limit for container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	CPU *string `json:"cpu,omitempty"`

	// Number of Nvidia GPU cards request/limit for container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	Gpu *string `json:"gpu,omitempty"`

	// Memory size request/limit for container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	Memory *string `json:"memory,omitempty"`
}

type ContainerType

type ContainerType string
const (
	ContainerTypeInferenceServer    ContainerType = "InferenceServer"
	ContainerTypeStorageInitializer ContainerType = "StorageInitializer"
)

func PossibleContainerTypeValues

func PossibleContainerTypeValues() []ContainerType

PossibleContainerTypeValues returns the possible values for the ContainerType const type.

type CosmosDbSettings

type CosmosDbSettings struct {
	// The throughput of the collections in cosmosdb database
	CollectionsThroughput *int32 `json:"collectionsThroughput,omitempty"`
}

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CredentialsType

type CredentialsType string

CredentialsType - Enum to determine the datastore credentials type.

const (
	CredentialsTypeAccountKey       CredentialsType = "AccountKey"
	CredentialsTypeCertificate      CredentialsType = "Certificate"
	CredentialsTypeNone             CredentialsType = "None"
	CredentialsTypeSas              CredentialsType = "Sas"
	CredentialsTypeServicePrincipal CredentialsType = "ServicePrincipal"
)

func PossibleCredentialsTypeValues

func PossibleCredentialsTypeValues() []CredentialsType

PossibleCredentialsTypeValues returns the possible values for the CredentialsType const type.

type CustomModelJobInput

type CustomModelJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// REQUIRED; [Required] Input Asset URI.
	URI *string `json:"uri,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode `json:"mode,omitempty"`
}

func (*CustomModelJobInput) GetJobInput

func (c *CustomModelJobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type CustomModelJobInput.

func (CustomModelJobInput) MarshalJSON

func (c CustomModelJobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomModelJobInput.

func (*CustomModelJobInput) UnmarshalJSON

func (c *CustomModelJobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomModelJobInput.

type CustomModelJobOutput

type CustomModelJobOutput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobOutputType *JobOutputType `json:"jobOutputType,omitempty"`

	// Description for the output.
	Description *string `json:"description,omitempty"`

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode `json:"mode,omitempty"`

	// Output Asset URI.
	URI *string `json:"uri,omitempty"`
}

func (*CustomModelJobOutput) GetJobOutput

func (c *CustomModelJobOutput) GetJobOutput() *JobOutput

GetJobOutput implements the JobOutputClassification interface for type CustomModelJobOutput.

func (CustomModelJobOutput) MarshalJSON

func (c CustomModelJobOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomModelJobOutput.

func (*CustomModelJobOutput) UnmarshalJSON

func (c *CustomModelJobOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomModelJobOutput.

type DataContainer

type DataContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *DataContainerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DataContainer - Azure Resource Manager resource envelope.

type DataContainerProperties

type DataContainerProperties struct {
	// REQUIRED; [Required] Specifies the type of data.
	DataType *DataType `json:"dataType,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string `json:"latestVersion,omitempty" azure:"ro"`

	// READ-ONLY; The next auto incremental version
	NextVersion *string `json:"nextVersion,omitempty" azure:"ro"`
}

DataContainerProperties - Container for data asset versions.

func (DataContainerProperties) MarshalJSON

func (d DataContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataContainerProperties.

type DataContainerResourceArmPaginatedResult

type DataContainerResourceArmPaginatedResult struct {
	// The link to the next page of DataContainer objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type DataContainer.
	Value []*DataContainer `json:"value,omitempty"`
}

DataContainerResourceArmPaginatedResult - A paginated list of DataContainer entities.

type DataContainersClient

type DataContainersClient struct {
	// contains filtered or unexported fields
}

DataContainersClient contains the methods for the DataContainers group. Don't use this type directly, use NewDataContainersClient() instead.

func NewDataContainersClient

func NewDataContainersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataContainersClient, error)

NewDataContainersClient creates a new instance of DataContainersClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DataContainersClient) CreateOrUpdate

func (client *DataContainersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, body DataContainer, options *DataContainersClientCreateOrUpdateOptions) (DataContainersClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. body - Container entity to create or update. options - DataContainersClientCreateOrUpdateOptions contains the optional parameters for the DataContainersClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataContainer/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"testrg123",
	"workspace123",
	"datacontainer123",
	armmachinelearning.DataContainer{
		Properties: &armmachinelearning.DataContainerProperties{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"properties1": to.Ptr("value1"),
				"properties2": to.Ptr("value2"),
			},
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
			DataType: to.Ptr(armmachinelearning.DataType("UriFile")),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DataContainersClient) Delete

func (client *DataContainersClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *DataContainersClientDeleteOptions) (DataContainersClientDeleteResponse, error)

Delete - Delete container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. options - DataContainersClientDeleteOptions contains the optional parameters for the DataContainersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataContainer/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"testrg123",
	"workspace123",
	"datacontainer123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*DataContainersClient) Get

func (client *DataContainersClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *DataContainersClientGetOptions) (DataContainersClientGetResponse, error)

Get - Get container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. options - DataContainersClientGetOptions contains the optional parameters for the DataContainersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataContainer/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"testrg123",
	"workspace123",
	"datacontainer123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DataContainersClient) NewListPager

func (client *DataContainersClient) NewListPager(resourceGroupName string, workspaceName string, options *DataContainersClientListOptions) *runtime.Pager[DataContainersClientListResponse]

NewListPager - List data containers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - DataContainersClientListOptions contains the optional parameters for the DataContainersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataContainer/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg123",
	"workspace123",
	&armmachinelearning.DataContainersClientListOptions{Skip: nil,
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type DataContainersClientCreateOrUpdateOptions

type DataContainersClientCreateOrUpdateOptions struct {
}

DataContainersClientCreateOrUpdateOptions contains the optional parameters for the DataContainersClient.CreateOrUpdate method.

type DataContainersClientCreateOrUpdateResponse

type DataContainersClientCreateOrUpdateResponse struct {
	DataContainer
}

DataContainersClientCreateOrUpdateResponse contains the response from method DataContainersClient.CreateOrUpdate.

type DataContainersClientDeleteOptions

type DataContainersClientDeleteOptions struct {
}

DataContainersClientDeleteOptions contains the optional parameters for the DataContainersClient.Delete method.

type DataContainersClientDeleteResponse

type DataContainersClientDeleteResponse struct {
}

DataContainersClientDeleteResponse contains the response from method DataContainersClient.Delete.

type DataContainersClientGetOptions

type DataContainersClientGetOptions struct {
}

DataContainersClientGetOptions contains the optional parameters for the DataContainersClient.Get method.

type DataContainersClientGetResponse

type DataContainersClientGetResponse struct {
	DataContainer
}

DataContainersClientGetResponse contains the response from method DataContainersClient.Get.

type DataContainersClientListOptions

type DataContainersClientListOptions struct {
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Continuation token for pagination.
	Skip *string
}

DataContainersClientListOptions contains the optional parameters for the DataContainersClient.List method.

type DataContainersClientListResponse

type DataContainersClientListResponse struct {
	DataContainerResourceArmPaginatedResult
}

DataContainersClientListResponse contains the response from method DataContainersClient.List.

type DataFactory

type DataFactory struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

DataFactory - A DataFactory compute.

func (*DataFactory) GetCompute

func (d *DataFactory) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type DataFactory.

func (DataFactory) MarshalJSON

func (d DataFactory) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataFactory.

func (*DataFactory) UnmarshalJSON

func (d *DataFactory) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataFactory.

type DataLakeAnalytics

type DataLakeAnalytics struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool                              `json:"disableLocalAuth,omitempty"`
	Properties       *DataLakeAnalyticsSchemaProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

DataLakeAnalytics - A DataLakeAnalytics compute.

func (*DataLakeAnalytics) GetCompute

func (d *DataLakeAnalytics) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type DataLakeAnalytics.

func (DataLakeAnalytics) MarshalJSON

func (d DataLakeAnalytics) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataLakeAnalytics.

func (*DataLakeAnalytics) UnmarshalJSON

func (d *DataLakeAnalytics) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataLakeAnalytics.

type DataLakeAnalyticsSchema

type DataLakeAnalyticsSchema struct {
	Properties *DataLakeAnalyticsSchemaProperties `json:"properties,omitempty"`
}

type DataLakeAnalyticsSchemaProperties

type DataLakeAnalyticsSchemaProperties struct {
	// DataLake Store Account Name
	DataLakeStoreAccountName *string `json:"dataLakeStoreAccountName,omitempty"`
}

type DataPathAssetReference

type DataPathAssetReference struct {
	// REQUIRED; [Required] Specifies the type of asset reference.
	ReferenceType *ReferenceType `json:"referenceType,omitempty"`

	// ARM resource ID of the datastore where the asset is located.
	DatastoreID *string `json:"datastoreId,omitempty"`

	// The path of the file/directory in the datastore.
	Path *string `json:"path,omitempty"`
}

DataPathAssetReference - Reference to an asset via its path in a datastore.

func (*DataPathAssetReference) GetAssetReferenceBase

func (d *DataPathAssetReference) GetAssetReferenceBase() *AssetReferenceBase

GetAssetReferenceBase implements the AssetReferenceBaseClassification interface for type DataPathAssetReference.

func (DataPathAssetReference) MarshalJSON

func (d DataPathAssetReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataPathAssetReference.

func (*DataPathAssetReference) UnmarshalJSON

func (d *DataPathAssetReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataPathAssetReference.

type DataType

type DataType string

DataType - Enum to determine the type of data.

const (
	DataTypeMltable   DataType = "mltable"
	DataTypeURIFile   DataType = "uri_file"
	DataTypeURIFolder DataType = "uri_folder"
)

func PossibleDataTypeValues

func PossibleDataTypeValues() []DataType

PossibleDataTypeValues returns the possible values for the DataType const type.

type DataVersionBase

type DataVersionBase struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties DataVersionBasePropertiesClassification `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DataVersionBase - Azure Resource Manager resource envelope.

func (DataVersionBase) MarshalJSON

func (d DataVersionBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataVersionBase.

func (*DataVersionBase) UnmarshalJSON

func (d *DataVersionBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataVersionBase.

type DataVersionBaseProperties

type DataVersionBaseProperties struct {
	// REQUIRED; [Required] Specifies the type of data.
	DataType *DataType `json:"dataType,omitempty"`

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20220501.Assets.DataVersionBase.DataType
	DataURI *string `json:"dataUri,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

DataVersionBaseProperties - Data version base definition

func (*DataVersionBaseProperties) GetDataVersionBaseProperties

func (d *DataVersionBaseProperties) GetDataVersionBaseProperties() *DataVersionBaseProperties

GetDataVersionBaseProperties implements the DataVersionBasePropertiesClassification interface for type DataVersionBaseProperties.

func (DataVersionBaseProperties) MarshalJSON

func (d DataVersionBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataVersionBaseProperties.

type DataVersionBasePropertiesClassification

type DataVersionBasePropertiesClassification interface {
	// GetDataVersionBaseProperties returns the DataVersionBaseProperties content of the underlying type.
	GetDataVersionBaseProperties() *DataVersionBaseProperties
}

DataVersionBasePropertiesClassification provides polymorphic access to related types. Call the interface's GetDataVersionBaseProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DataVersionBaseProperties, *MLTableData, *URIFileDataVersion, *URIFolderDataVersion

type DataVersionBaseResourceArmPaginatedResult

type DataVersionBaseResourceArmPaginatedResult struct {
	// The link to the next page of DataVersionBase objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type DataVersionBase.
	Value []*DataVersionBase `json:"value,omitempty"`
}

DataVersionBaseResourceArmPaginatedResult - A paginated list of DataVersionBase entities.

type DataVersionsClient

type DataVersionsClient struct {
	// contains filtered or unexported fields
}

DataVersionsClient contains the methods for the DataVersions group. Don't use this type directly, use NewDataVersionsClient() instead.

func NewDataVersionsClient

func NewDataVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataVersionsClient, error)

NewDataVersionsClient creates a new instance of DataVersionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DataVersionsClient) CreateOrUpdate

func (client *DataVersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, body DataVersionBase, options *DataVersionsClientCreateOrUpdateOptions) (DataVersionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. version - Version identifier. body - Version entity to create or update. options - DataVersionsClientCreateOrUpdateOptions contains the optional parameters for the DataVersionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataVersionBase/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	armmachinelearning.DataVersionBase{
		Properties: &armmachinelearning.URIFileDataVersion{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
			IsAnonymous: to.Ptr(false),
			DataType:    to.Ptr(armmachinelearning.DataTypeURIFile),
			DataURI:     to.Ptr("string"),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DataVersionsClient) Delete

func (client *DataVersionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *DataVersionsClientDeleteOptions) (DataVersionsClientDeleteResponse, error)

Delete - Delete version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. version - Version identifier. options - DataVersionsClientDeleteOptions contains the optional parameters for the DataVersionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataVersionBase/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*DataVersionsClient) Get

func (client *DataVersionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *DataVersionsClientGetOptions) (DataVersionsClientGetResponse, error)

Get - Get version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. version - Version identifier. options - DataVersionsClientGetOptions contains the optional parameters for the DataVersionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataVersionBase/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DataVersionsClient) NewListPager

func (client *DataVersionsClient) NewListPager(resourceGroupName string, workspaceName string, name string, options *DataVersionsClientListOptions) *runtime.Pager[DataVersionsClientListResponse]

NewListPager - List data versions in the data container If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Data container's name options - DataVersionsClientListOptions contains the optional parameters for the DataVersionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/DataVersionBase/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDataVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	"string",
	&armmachinelearning.DataVersionsClientListOptions{OrderBy: to.Ptr("string"),
		Top:          to.Ptr[int32](1),
		Skip:         nil,
		Tags:         to.Ptr("string"),
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type DataVersionsClientCreateOrUpdateOptions

type DataVersionsClientCreateOrUpdateOptions struct {
}

DataVersionsClientCreateOrUpdateOptions contains the optional parameters for the DataVersionsClient.CreateOrUpdate method.

type DataVersionsClientCreateOrUpdateResponse

type DataVersionsClientCreateOrUpdateResponse struct {
	DataVersionBase
}

DataVersionsClientCreateOrUpdateResponse contains the response from method DataVersionsClient.CreateOrUpdate.

type DataVersionsClientDeleteOptions

type DataVersionsClientDeleteOptions struct {
}

DataVersionsClientDeleteOptions contains the optional parameters for the DataVersionsClient.Delete method.

type DataVersionsClientDeleteResponse

type DataVersionsClientDeleteResponse struct {
}

DataVersionsClientDeleteResponse contains the response from method DataVersionsClient.Delete.

type DataVersionsClientGetOptions

type DataVersionsClientGetOptions struct {
}

DataVersionsClientGetOptions contains the optional parameters for the DataVersionsClient.Get method.

type DataVersionsClientGetResponse

type DataVersionsClientGetResponse struct {
	DataVersionBase
}

DataVersionsClientGetResponse contains the response from method DataVersionsClient.Get.

type DataVersionsClientListOptions

type DataVersionsClientListOptions struct {
	// [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived
	// entities.
	ListViewType *ListViewType
	// Please choose OrderBy value from ['createdtime', 'modifiedtime']
	OrderBy *string
	// Continuation token for pagination.
	Skip *string
	// Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2
	Tags *string
	// Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default
	// page size count will be returned
	Top *int32
}

DataVersionsClientListOptions contains the optional parameters for the DataVersionsClient.List method.

type DataVersionsClientListResponse

type DataVersionsClientListResponse struct {
	DataVersionBaseResourceArmPaginatedResult
}

DataVersionsClientListResponse contains the response from method DataVersionsClient.List.

type Databricks

type Databricks struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// Properties of Databricks
	Properties *DatabricksProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

Databricks - A DataFactory compute.

func (*Databricks) GetCompute

func (d *Databricks) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type Databricks.

func (Databricks) MarshalJSON

func (d Databricks) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Databricks.

func (*Databricks) UnmarshalJSON

func (d *Databricks) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Databricks.

type DatabricksComputeSecrets

type DatabricksComputeSecrets struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// access token for databricks account.
	DatabricksAccessToken *string `json:"databricksAccessToken,omitempty"`
}

DatabricksComputeSecrets - Secrets related to a Machine Learning compute based on Databricks.

func (*DatabricksComputeSecrets) GetComputeSecrets

func (d *DatabricksComputeSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type DatabricksComputeSecrets.

func (*DatabricksComputeSecrets) UnmarshalJSON

func (d *DatabricksComputeSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatabricksComputeSecrets.

type DatabricksComputeSecretsProperties

type DatabricksComputeSecretsProperties struct {
	// access token for databricks account.
	DatabricksAccessToken *string `json:"databricksAccessToken,omitempty"`
}

DatabricksComputeSecretsProperties - Properties of Databricks Compute Secrets

type DatabricksProperties

type DatabricksProperties struct {
	// Databricks access token
	DatabricksAccessToken *string `json:"databricksAccessToken,omitempty"`

	// Workspace Url
	WorkspaceURL *string `json:"workspaceUrl,omitempty"`
}

DatabricksProperties - Properties of Databricks

type DatabricksSchema

type DatabricksSchema struct {
	// Properties of Databricks
	Properties *DatabricksProperties `json:"properties,omitempty"`
}

type Datastore

type Datastore struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties DatastorePropertiesClassification `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Datastore - Azure Resource Manager resource envelope.

func (Datastore) MarshalJSON

func (d Datastore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Datastore.

func (*Datastore) UnmarshalJSON

func (d *Datastore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Datastore.

type DatastoreCredentials

type DatastoreCredentials struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType `json:"credentialsType,omitempty"`
}

DatastoreCredentials - Base definition for datastore credentials.

func (*DatastoreCredentials) GetDatastoreCredentials

func (d *DatastoreCredentials) GetDatastoreCredentials() *DatastoreCredentials

GetDatastoreCredentials implements the DatastoreCredentialsClassification interface for type DatastoreCredentials.

type DatastoreCredentialsClassification

type DatastoreCredentialsClassification interface {
	// GetDatastoreCredentials returns the DatastoreCredentials content of the underlying type.
	GetDatastoreCredentials() *DatastoreCredentials
}

DatastoreCredentialsClassification provides polymorphic access to related types. Call the interface's GetDatastoreCredentials() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AccountKeyDatastoreCredentials, *CertificateDatastoreCredentials, *DatastoreCredentials, *NoneDatastoreCredentials, - *SasDatastoreCredentials, *ServicePrincipalDatastoreCredentials

type DatastoreProperties

type DatastoreProperties struct {
	// REQUIRED; [Required] Account credentials.
	Credentials DatastoreCredentialsClassification `json:"credentials,omitempty"`

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType `json:"datastoreType,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool `json:"isDefault,omitempty" azure:"ro"`
}

DatastoreProperties - Base definition for datastore contents configuration.

func (*DatastoreProperties) GetDatastoreProperties

func (d *DatastoreProperties) GetDatastoreProperties() *DatastoreProperties

GetDatastoreProperties implements the DatastorePropertiesClassification interface for type DatastoreProperties.

func (DatastoreProperties) MarshalJSON

func (d DatastoreProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DatastoreProperties.

func (*DatastoreProperties) UnmarshalJSON

func (d *DatastoreProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatastoreProperties.

type DatastorePropertiesClassification

type DatastorePropertiesClassification interface {
	// GetDatastoreProperties returns the DatastoreProperties content of the underlying type.
	GetDatastoreProperties() *DatastoreProperties
}

DatastorePropertiesClassification provides polymorphic access to related types. Call the interface's GetDatastoreProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureBlobDatastore, *AzureDataLakeGen1Datastore, *AzureDataLakeGen2Datastore, *AzureFileDatastore, *DatastoreProperties

type DatastoreResourceArmPaginatedResult

type DatastoreResourceArmPaginatedResult struct {
	// The link to the next page of Datastore objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type Datastore.
	Value []*Datastore `json:"value,omitempty"`
}

DatastoreResourceArmPaginatedResult - A paginated list of Datastore entities.

type DatastoreSecrets

type DatastoreSecrets struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	SecretsType *SecretsType `json:"secretsType,omitempty"`
}

DatastoreSecrets - Base definition for datastore secrets.

func (*DatastoreSecrets) GetDatastoreSecrets

func (d *DatastoreSecrets) GetDatastoreSecrets() *DatastoreSecrets

GetDatastoreSecrets implements the DatastoreSecretsClassification interface for type DatastoreSecrets.

type DatastoreSecretsClassification

type DatastoreSecretsClassification interface {
	// GetDatastoreSecrets returns the DatastoreSecrets content of the underlying type.
	GetDatastoreSecrets() *DatastoreSecrets
}

DatastoreSecretsClassification provides polymorphic access to related types. Call the interface's GetDatastoreSecrets() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AccountKeyDatastoreSecrets, *CertificateDatastoreSecrets, *DatastoreSecrets, *SasDatastoreSecrets, *ServicePrincipalDatastoreSecrets

type DatastoreType

type DatastoreType string

DatastoreType - Enum to determine the datastore contents type.

const (
	DatastoreTypeAzureBlob         DatastoreType = "AzureBlob"
	DatastoreTypeAzureDataLakeGen1 DatastoreType = "AzureDataLakeGen1"
	DatastoreTypeAzureDataLakeGen2 DatastoreType = "AzureDataLakeGen2"
	DatastoreTypeAzureFile         DatastoreType = "AzureFile"
)

func PossibleDatastoreTypeValues

func PossibleDatastoreTypeValues() []DatastoreType

PossibleDatastoreTypeValues returns the possible values for the DatastoreType const type.

type DatastoresClient

type DatastoresClient struct {
	// contains filtered or unexported fields
}

DatastoresClient contains the methods for the Datastores group. Don't use this type directly, use NewDatastoresClient() instead.

func NewDatastoresClient

func NewDatastoresClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DatastoresClient, error)

NewDatastoresClient creates a new instance of DatastoresClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DatastoresClient) CreateOrUpdate

func (client *DatastoresClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, body Datastore, options *DatastoresClientCreateOrUpdateOptions) (DatastoresClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update datastore. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Datastore name. body - Datastore entity to create or update. options - DatastoresClientCreateOrUpdateOptions contains the optional parameters for the DatastoresClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Datastore/AzureDataLakeGen1WServicePrincipal/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDatastoresClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	armmachinelearning.Datastore{
		Properties: &armmachinelearning.AzureDataLakeGen1Datastore{
			Description: to.Ptr("string"),
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
			Credentials: &armmachinelearning.ServicePrincipalDatastoreCredentials{
				CredentialsType: to.Ptr(armmachinelearning.CredentialsTypeServicePrincipal),
				AuthorityURL:    to.Ptr("string"),
				ClientID:        to.Ptr("00000000-1111-2222-3333-444444444444"),
				ResourceURL:     to.Ptr("string"),
				Secrets: &armmachinelearning.ServicePrincipalDatastoreSecrets{
					SecretsType:  to.Ptr(armmachinelearning.SecretsTypeServicePrincipal),
					ClientSecret: to.Ptr("string"),
				},
				TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
			},
			DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureDataLakeGen1),
			StoreName:     to.Ptr("string"),
		},
	},
	&armmachinelearning.DatastoresClientCreateOrUpdateOptions{SkipValidation: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DatastoresClient) Delete

func (client *DatastoresClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *DatastoresClientDeleteOptions) (DatastoresClientDeleteResponse, error)

Delete - Delete datastore. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Datastore name. options - DatastoresClientDeleteOptions contains the optional parameters for the DatastoresClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Datastore/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDatastoresClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*DatastoresClient) Get

func (client *DatastoresClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *DatastoresClientGetOptions) (DatastoresClientGetResponse, error)

Get - Get datastore. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Datastore name. options - DatastoresClientGetOptions contains the optional parameters for the DatastoresClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Datastore/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDatastoresClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DatastoresClient) ListSecrets

func (client *DatastoresClient) ListSecrets(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *DatastoresClientListSecretsOptions) (DatastoresClientListSecretsResponse, error)

ListSecrets - Get datastore secrets. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Datastore name. options - DatastoresClientListSecretsOptions contains the optional parameters for the DatastoresClient.ListSecrets method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Datastore/listSecrets.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDatastoresClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListSecrets(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DatastoresClient) NewListPager

func (client *DatastoresClient) NewListPager(resourceGroupName string, workspaceName string, options *DatastoresClientListOptions) *runtime.Pager[DatastoresClientListResponse]

NewListPager - List datastores. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - DatastoresClientListOptions contains the optional parameters for the DatastoresClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Datastore/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewDatastoresClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	&armmachinelearning.DatastoresClientListOptions{Skip: nil,
		Count:     to.Ptr[int32](1),
		IsDefault: to.Ptr(false),
		Names: []string{
			"string"},
		SearchText: to.Ptr("string"),
		OrderBy:    to.Ptr("string"),
		OrderByAsc: to.Ptr(false),
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type DatastoresClientCreateOrUpdateOptions

type DatastoresClientCreateOrUpdateOptions struct {
	// Flag to skip validation.
	SkipValidation *bool
}

DatastoresClientCreateOrUpdateOptions contains the optional parameters for the DatastoresClient.CreateOrUpdate method.

type DatastoresClientCreateOrUpdateResponse

type DatastoresClientCreateOrUpdateResponse struct {
	Datastore
}

DatastoresClientCreateOrUpdateResponse contains the response from method DatastoresClient.CreateOrUpdate.

type DatastoresClientDeleteOptions

type DatastoresClientDeleteOptions struct {
}

DatastoresClientDeleteOptions contains the optional parameters for the DatastoresClient.Delete method.

type DatastoresClientDeleteResponse

type DatastoresClientDeleteResponse struct {
}

DatastoresClientDeleteResponse contains the response from method DatastoresClient.Delete.

type DatastoresClientGetOptions

type DatastoresClientGetOptions struct {
}

DatastoresClientGetOptions contains the optional parameters for the DatastoresClient.Get method.

type DatastoresClientGetResponse

type DatastoresClientGetResponse struct {
	Datastore
}

DatastoresClientGetResponse contains the response from method DatastoresClient.Get.

type DatastoresClientListOptions

type DatastoresClientListOptions struct {
	// Maximum number of results to return.
	Count *int32
	// Filter down to the workspace default datastore.
	IsDefault *bool
	// Names of datastores to return.
	Names []string
	// Order by property (createdtime | modifiedtime | name).
	OrderBy *string
	// Order by property in ascending order.
	OrderByAsc *bool
	// Text to search for in the datastore names.
	SearchText *string
	// Continuation token for pagination.
	Skip *string
}

DatastoresClientListOptions contains the optional parameters for the DatastoresClient.List method.

type DatastoresClientListResponse

type DatastoresClientListResponse struct {
	DatastoreResourceArmPaginatedResult
}

DatastoresClientListResponse contains the response from method DatastoresClient.List.

type DatastoresClientListSecretsOptions

type DatastoresClientListSecretsOptions struct {
}

DatastoresClientListSecretsOptions contains the optional parameters for the DatastoresClient.ListSecrets method.

type DatastoresClientListSecretsResponse

type DatastoresClientListSecretsResponse struct {
	DatastoreSecretsClassification
}

DatastoresClientListSecretsResponse contains the response from method DatastoresClient.ListSecrets.

func (*DatastoresClientListSecretsResponse) UnmarshalJSON

func (d *DatastoresClientListSecretsResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DatastoresClientListSecretsResponse.

type DefaultScaleSettings

type DefaultScaleSettings struct {
	// REQUIRED; [Required] Type of deployment scaling algorithm
	ScaleType *ScaleType `json:"scaleType,omitempty"`
}

func (*DefaultScaleSettings) GetOnlineScaleSettings

func (d *DefaultScaleSettings) GetOnlineScaleSettings() *OnlineScaleSettings

GetOnlineScaleSettings implements the OnlineScaleSettingsClassification interface for type DefaultScaleSettings.

func (DefaultScaleSettings) MarshalJSON

func (d DefaultScaleSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultScaleSettings.

func (*DefaultScaleSettings) UnmarshalJSON

func (d *DefaultScaleSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultScaleSettings.

type DeploymentLogs

type DeploymentLogs struct {
	// The retrieved online deployment logs.
	Content *string `json:"content,omitempty"`
}

type DeploymentLogsRequest

type DeploymentLogsRequest struct {
	// The type of container to retrieve logs from.
	ContainerType *ContainerType `json:"containerType,omitempty"`

	// The maximum number of lines to tail.
	Tail *int32 `json:"tail,omitempty"`
}

type DeploymentProvisioningState

type DeploymentProvisioningState string

DeploymentProvisioningState - Possible values for DeploymentProvisioningState.

const (
	DeploymentProvisioningStateCanceled  DeploymentProvisioningState = "Canceled"
	DeploymentProvisioningStateCreating  DeploymentProvisioningState = "Creating"
	DeploymentProvisioningStateDeleting  DeploymentProvisioningState = "Deleting"
	DeploymentProvisioningStateFailed    DeploymentProvisioningState = "Failed"
	DeploymentProvisioningStateScaling   DeploymentProvisioningState = "Scaling"
	DeploymentProvisioningStateSucceeded DeploymentProvisioningState = "Succeeded"
	DeploymentProvisioningStateUpdating  DeploymentProvisioningState = "Updating"
)

func PossibleDeploymentProvisioningStateValues

func PossibleDeploymentProvisioningStateValues() []DeploymentProvisioningState

PossibleDeploymentProvisioningStateValues returns the possible values for the DeploymentProvisioningState const type.

type DiagnoseRequestProperties

type DiagnoseRequestProperties struct {
	// Setting for diagnosing dependent application insights
	ApplicationInsights map[string]interface{} `json:"applicationInsights,omitempty"`

	// Setting for diagnosing dependent container registry
	ContainerRegistry map[string]interface{} `json:"containerRegistry,omitempty"`

	// Setting for diagnosing dns resolution
	DNSResolution map[string]interface{} `json:"dnsResolution,omitempty"`

	// Setting for diagnosing dependent key vault
	KeyVault map[string]interface{} `json:"keyVault,omitempty"`

	// Setting for diagnosing network security group
	Nsg map[string]interface{} `json:"nsg,omitempty"`

	// Setting for diagnosing unclassified category of problems
	Others map[string]interface{} `json:"others,omitempty"`

	// Setting for diagnosing resource lock
	ResourceLock map[string]interface{} `json:"resourceLock,omitempty"`

	// Setting for diagnosing dependent storage account
	StorageAccount map[string]interface{} `json:"storageAccount,omitempty"`

	// Setting for diagnosing user defined routing
	Udr map[string]interface{} `json:"udr,omitempty"`
}

func (DiagnoseRequestProperties) MarshalJSON

func (d DiagnoseRequestProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DiagnoseRequestProperties.

type DiagnoseResponseResult

type DiagnoseResponseResult struct {
	Value *DiagnoseResponseResultValue `json:"value,omitempty"`
}

type DiagnoseResponseResultValue

type DiagnoseResponseResultValue struct {
	ApplicationInsightsResults []*DiagnoseResult `json:"applicationInsightsResults,omitempty"`
	ContainerRegistryResults   []*DiagnoseResult `json:"containerRegistryResults,omitempty"`
	DNSResolutionResults       []*DiagnoseResult `json:"dnsResolutionResults,omitempty"`
	KeyVaultResults            []*DiagnoseResult `json:"keyVaultResults,omitempty"`
	NetworkSecurityRuleResults []*DiagnoseResult `json:"networkSecurityRuleResults,omitempty"`
	OtherResults               []*DiagnoseResult `json:"otherResults,omitempty"`
	ResourceLockResults        []*DiagnoseResult `json:"resourceLockResults,omitempty"`
	StorageAccountResults      []*DiagnoseResult `json:"storageAccountResults,omitempty"`
	UserDefinedRouteResults    []*DiagnoseResult `json:"userDefinedRouteResults,omitempty"`
}

type DiagnoseResult

type DiagnoseResult struct {
	// READ-ONLY; Code for workspace setup error
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Level of workspace setup error
	Level *DiagnoseResultLevel `json:"level,omitempty" azure:"ro"`

	// READ-ONLY; Message of workspace setup error
	Message *string `json:"message,omitempty" azure:"ro"`
}

DiagnoseResult - Result of Diagnose

type DiagnoseResultLevel

type DiagnoseResultLevel string

DiagnoseResultLevel - Level of workspace setup error

const (
	DiagnoseResultLevelError       DiagnoseResultLevel = "Error"
	DiagnoseResultLevelInformation DiagnoseResultLevel = "Information"
	DiagnoseResultLevelWarning     DiagnoseResultLevel = "Warning"
)

func PossibleDiagnoseResultLevelValues

func PossibleDiagnoseResultLevelValues() []DiagnoseResultLevel

PossibleDiagnoseResultLevelValues returns the possible values for the DiagnoseResultLevel const type.

type DiagnoseWorkspaceParameters

type DiagnoseWorkspaceParameters struct {
	// Value of Parameters
	Value *DiagnoseRequestProperties `json:"value,omitempty"`
}

DiagnoseWorkspaceParameters - Parameters to diagnose a workspace

type DistributionConfiguration

type DistributionConfiguration struct {
	// REQUIRED; [Required] Specifies the type of distribution framework.
	DistributionType *DistributionType `json:"distributionType,omitempty"`
}

DistributionConfiguration - Base definition for job distribution configuration.

func (*DistributionConfiguration) GetDistributionConfiguration

func (d *DistributionConfiguration) GetDistributionConfiguration() *DistributionConfiguration

GetDistributionConfiguration implements the DistributionConfigurationClassification interface for type DistributionConfiguration.

type DistributionConfigurationClassification

type DistributionConfigurationClassification interface {
	// GetDistributionConfiguration returns the DistributionConfiguration content of the underlying type.
	GetDistributionConfiguration() *DistributionConfiguration
}

DistributionConfigurationClassification provides polymorphic access to related types. Call the interface's GetDistributionConfiguration() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DistributionConfiguration, *Mpi, *PyTorch, *TensorFlow

type DistributionType

type DistributionType string

DistributionType - Enum to determine the job distribution type.

const (
	DistributionTypeMpi        DistributionType = "Mpi"
	DistributionTypePyTorch    DistributionType = "PyTorch"
	DistributionTypeTensorFlow DistributionType = "TensorFlow"
)

func PossibleDistributionTypeValues

func PossibleDistributionTypeValues() []DistributionType

PossibleDistributionTypeValues returns the possible values for the DistributionType const type.

type EarlyTerminationPolicy

type EarlyTerminationPolicy struct {
	// REQUIRED; [Required] Name of policy configuration
	PolicyType *EarlyTerminationPolicyType `json:"policyType,omitempty"`

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32 `json:"delayEvaluation,omitempty"`

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32 `json:"evaluationInterval,omitempty"`
}

EarlyTerminationPolicy - Early termination policies enable canceling poor-performing runs before they complete

func (*EarlyTerminationPolicy) GetEarlyTerminationPolicy

func (e *EarlyTerminationPolicy) GetEarlyTerminationPolicy() *EarlyTerminationPolicy

GetEarlyTerminationPolicy implements the EarlyTerminationPolicyClassification interface for type EarlyTerminationPolicy.

type EarlyTerminationPolicyClassification

type EarlyTerminationPolicyClassification interface {
	// GetEarlyTerminationPolicy returns the EarlyTerminationPolicy content of the underlying type.
	GetEarlyTerminationPolicy() *EarlyTerminationPolicy
}

EarlyTerminationPolicyClassification provides polymorphic access to related types. Call the interface's GetEarlyTerminationPolicy() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BanditPolicy, *EarlyTerminationPolicy, *MedianStoppingPolicy, *TruncationSelectionPolicy

type EarlyTerminationPolicyType

type EarlyTerminationPolicyType string
const (
	EarlyTerminationPolicyTypeBandit              EarlyTerminationPolicyType = "Bandit"
	EarlyTerminationPolicyTypeMedianStopping      EarlyTerminationPolicyType = "MedianStopping"
	EarlyTerminationPolicyTypeTruncationSelection EarlyTerminationPolicyType = "TruncationSelection"
)

func PossibleEarlyTerminationPolicyTypeValues

func PossibleEarlyTerminationPolicyTypeValues() []EarlyTerminationPolicyType

PossibleEarlyTerminationPolicyTypeValues returns the possible values for the EarlyTerminationPolicyType const type.

type EncryptionKeyVaultProperties

type EncryptionKeyVaultProperties struct {
	// REQUIRED; Key vault uri to access the encryption key.
	KeyIdentifier *string `json:"keyIdentifier,omitempty"`

	// REQUIRED; The ArmId of the keyVault where the customer owned encryption key is present.
	KeyVaultArmID *string `json:"keyVaultArmId,omitempty"`

	// For future use - The client id of the identity which will be used to access key vault.
	IdentityClientID *string `json:"identityClientId,omitempty"`
}

type EncryptionProperty

type EncryptionProperty struct {
	// REQUIRED; Customer Key vault properties.
	KeyVaultProperties *EncryptionKeyVaultProperties `json:"keyVaultProperties,omitempty"`

	// REQUIRED; Indicates whether or not the encryption is enabled for the workspace.
	Status *EncryptionStatus `json:"status,omitempty"`

	// The identity that will be used to access the key vault for encryption at rest.
	Identity *IdentityForCmk `json:"identity,omitempty"`
}

type EncryptionStatus

type EncryptionStatus string

EncryptionStatus - Indicates whether or not the encryption is enabled for the workspace.

const (
	EncryptionStatusDisabled EncryptionStatus = "Disabled"
	EncryptionStatusEnabled  EncryptionStatus = "Enabled"
)

func PossibleEncryptionStatusValues

func PossibleEncryptionStatusValues() []EncryptionStatus

PossibleEncryptionStatusValues returns the possible values for the EncryptionStatus const type.

type EndpointAuthKeys

type EndpointAuthKeys struct {
	// The primary key.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// The secondary key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

EndpointAuthKeys - Keys for endpoint authentication.

type EndpointAuthMode

type EndpointAuthMode string

EndpointAuthMode - Enum to determine endpoint authentication mode.

const (
	EndpointAuthModeAADToken EndpointAuthMode = "AADToken"
	EndpointAuthModeAMLToken EndpointAuthMode = "AMLToken"
	EndpointAuthModeKey      EndpointAuthMode = "Key"
)

func PossibleEndpointAuthModeValues

func PossibleEndpointAuthModeValues() []EndpointAuthMode

PossibleEndpointAuthModeValues returns the possible values for the EndpointAuthMode const type.

type EndpointAuthToken

type EndpointAuthToken struct {
	// Access token for endpoint authentication.
	AccessToken *string `json:"accessToken,omitempty"`

	// Access token expiry time (UTC).
	ExpiryTimeUTC *int64 `json:"expiryTimeUtc,omitempty"`

	// Refresh access token after time (UTC).
	RefreshAfterTimeUTC *int64 `json:"refreshAfterTimeUtc,omitempty"`

	// Access token type.
	TokenType *string `json:"tokenType,omitempty"`
}

EndpointAuthToken - Service Token

type EndpointComputeType

type EndpointComputeType string

EndpointComputeType - Enum to determine endpoint compute type.

const (
	EndpointComputeTypeAzureMLCompute EndpointComputeType = "AzureMLCompute"
	EndpointComputeTypeKubernetes     EndpointComputeType = "Kubernetes"
	EndpointComputeTypeManaged        EndpointComputeType = "Managed"
)

func PossibleEndpointComputeTypeValues

func PossibleEndpointComputeTypeValues() []EndpointComputeType

PossibleEndpointComputeTypeValues returns the possible values for the EndpointComputeType const type.

type EndpointDeploymentPropertiesBase

type EndpointDeploymentPropertiesBase struct {
	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration `json:"codeConfiguration,omitempty"`

	// Description of the endpoint deployment.
	Description *string `json:"description,omitempty"`

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string `json:"environmentId,omitempty"`

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`
}

EndpointDeploymentPropertiesBase - Base definition for endpoint deployment.

func (EndpointDeploymentPropertiesBase) MarshalJSON

func (e EndpointDeploymentPropertiesBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointDeploymentPropertiesBase.

type EndpointPropertiesBase

type EndpointPropertiesBase struct {
	// REQUIRED; [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication.
	// 'Key' doesn't expire but 'AMLToken' does.
	AuthMode *EndpointAuthMode `json:"authMode,omitempty"`

	// Description of the inference endpoint.
	Description *string `json:"description,omitempty"`

	// EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be
	// retrieved using the ListKeys API.
	Keys *EndpointAuthKeys `json:"keys,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`

	// READ-ONLY; Endpoint URI.
	ScoringURI *string `json:"scoringUri,omitempty" azure:"ro"`

	// READ-ONLY; Endpoint Swagger URI.
	SwaggerURI *string `json:"swaggerUri,omitempty" azure:"ro"`
}

EndpointPropertiesBase - Inference Endpoint base definition

func (EndpointPropertiesBase) MarshalJSON

func (e EndpointPropertiesBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointPropertiesBase.

type EndpointProvisioningState

type EndpointProvisioningState string

EndpointProvisioningState - State of endpoint provisioning.

const (
	EndpointProvisioningStateCanceled  EndpointProvisioningState = "Canceled"
	EndpointProvisioningStateCreating  EndpointProvisioningState = "Creating"
	EndpointProvisioningStateDeleting  EndpointProvisioningState = "Deleting"
	EndpointProvisioningStateFailed    EndpointProvisioningState = "Failed"
	EndpointProvisioningStateSucceeded EndpointProvisioningState = "Succeeded"
	EndpointProvisioningStateUpdating  EndpointProvisioningState = "Updating"
)

func PossibleEndpointProvisioningStateValues

func PossibleEndpointProvisioningStateValues() []EndpointProvisioningState

PossibleEndpointProvisioningStateValues returns the possible values for the EndpointProvisioningState const type.

type EnvironmentContainer

type EnvironmentContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *EnvironmentContainerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

EnvironmentContainer - Azure Resource Manager resource envelope.

type EnvironmentContainerProperties

type EnvironmentContainerProperties struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string `json:"latestVersion,omitempty" azure:"ro"`

	// READ-ONLY; The next auto incremental version
	NextVersion *string `json:"nextVersion,omitempty" azure:"ro"`
}

EnvironmentContainerProperties - Container for environment specification versions.

func (EnvironmentContainerProperties) MarshalJSON

func (e EnvironmentContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentContainerProperties.

type EnvironmentContainerResourceArmPaginatedResult

type EnvironmentContainerResourceArmPaginatedResult struct {
	// The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type EnvironmentContainer.
	Value []*EnvironmentContainer `json:"value,omitempty"`
}

EnvironmentContainerResourceArmPaginatedResult - A paginated list of EnvironmentContainer entities.

type EnvironmentContainersClient

type EnvironmentContainersClient struct {
	// contains filtered or unexported fields
}

EnvironmentContainersClient contains the methods for the EnvironmentContainers group. Don't use this type directly, use NewEnvironmentContainersClient() instead.

func NewEnvironmentContainersClient

func NewEnvironmentContainersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EnvironmentContainersClient, error)

NewEnvironmentContainersClient creates a new instance of EnvironmentContainersClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*EnvironmentContainersClient) CreateOrUpdate

CreateOrUpdate - Create or update container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. body - Container entity to create or update. options - EnvironmentContainersClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentContainersClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentContainer/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"testrg123",
	"testworkspace",
	"testEnvironment",
	armmachinelearning.EnvironmentContainer{
		Properties: &armmachinelearning.EnvironmentContainerProperties{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"additionalProp1": to.Ptr("string"),
				"additionalProp2": to.Ptr("string"),
				"additionalProp3": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"additionalProp1": to.Ptr("string"),
				"additionalProp2": to.Ptr("string"),
				"additionalProp3": to.Ptr("string"),
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*EnvironmentContainersClient) Delete

Delete - Delete container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - EnvironmentContainersClientDeleteOptions contains the optional parameters for the EnvironmentContainersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentContainer/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"testrg123",
	"testworkspace",
	"testContainer",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*EnvironmentContainersClient) Get

Get - Get container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - EnvironmentContainersClientGetOptions contains the optional parameters for the EnvironmentContainersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentContainer/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"testrg123",
	"testworkspace",
	"testEnvironment",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*EnvironmentContainersClient) NewListPager

NewListPager - List environment containers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - EnvironmentContainersClientListOptions contains the optional parameters for the EnvironmentContainersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentContainer/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg123",
	"testworkspace",
	&armmachinelearning.EnvironmentContainersClientListOptions{Skip: nil,
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type EnvironmentContainersClientCreateOrUpdateOptions

type EnvironmentContainersClientCreateOrUpdateOptions struct {
}

EnvironmentContainersClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentContainersClient.CreateOrUpdate method.

type EnvironmentContainersClientCreateOrUpdateResponse

type EnvironmentContainersClientCreateOrUpdateResponse struct {
	EnvironmentContainer
}

EnvironmentContainersClientCreateOrUpdateResponse contains the response from method EnvironmentContainersClient.CreateOrUpdate.

type EnvironmentContainersClientDeleteOptions

type EnvironmentContainersClientDeleteOptions struct {
}

EnvironmentContainersClientDeleteOptions contains the optional parameters for the EnvironmentContainersClient.Delete method.

type EnvironmentContainersClientDeleteResponse

type EnvironmentContainersClientDeleteResponse struct {
}

EnvironmentContainersClientDeleteResponse contains the response from method EnvironmentContainersClient.Delete.

type EnvironmentContainersClientGetOptions

type EnvironmentContainersClientGetOptions struct {
}

EnvironmentContainersClientGetOptions contains the optional parameters for the EnvironmentContainersClient.Get method.

type EnvironmentContainersClientGetResponse

type EnvironmentContainersClientGetResponse struct {
	EnvironmentContainer
}

EnvironmentContainersClientGetResponse contains the response from method EnvironmentContainersClient.Get.

type EnvironmentContainersClientListOptions

type EnvironmentContainersClientListOptions struct {
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Continuation token for pagination.
	Skip *string
}

EnvironmentContainersClientListOptions contains the optional parameters for the EnvironmentContainersClient.List method.

type EnvironmentContainersClientListResponse

type EnvironmentContainersClientListResponse struct {
	EnvironmentContainerResourceArmPaginatedResult
}

EnvironmentContainersClientListResponse contains the response from method EnvironmentContainersClient.List.

type EnvironmentType

type EnvironmentType string

EnvironmentType - Environment type is either user created or curated by Azure ML service

const (
	EnvironmentTypeCurated     EnvironmentType = "Curated"
	EnvironmentTypeUserCreated EnvironmentType = "UserCreated"
)

func PossibleEnvironmentTypeValues

func PossibleEnvironmentTypeValues() []EnvironmentType

PossibleEnvironmentTypeValues returns the possible values for the EnvironmentType const type.

type EnvironmentVersion

type EnvironmentVersion struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *EnvironmentVersionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

EnvironmentVersion - Azure Resource Manager resource envelope.

type EnvironmentVersionProperties

type EnvironmentVersionProperties struct {
	// Configuration settings for Docker build context.
	Build *BuildContext `json:"build,omitempty"`

	// Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.
	CondaFile *string `json:"condaFile,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Name of the image that will be used for the environment.
	Image *string `json:"image,omitempty"`

	// Defines configuration specific to inference.
	InferenceConfig *InferenceContainerProperties `json:"inferenceConfig,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The OS type of the environment.
	OSType *OperatingSystemType `json:"osType,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Environment type is either user managed or curated by the Azure ML service
	EnvironmentType *EnvironmentType `json:"environmentType,omitempty" azure:"ro"`
}

EnvironmentVersionProperties - Environment version details.

func (EnvironmentVersionProperties) MarshalJSON

func (e EnvironmentVersionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentVersionProperties.

type EnvironmentVersionResourceArmPaginatedResult

type EnvironmentVersionResourceArmPaginatedResult struct {
	// The link to the next page of EnvironmentVersion objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type EnvironmentVersion.
	Value []*EnvironmentVersion `json:"value,omitempty"`
}

EnvironmentVersionResourceArmPaginatedResult - A paginated list of EnvironmentVersion entities.

type EnvironmentVersionsClient

type EnvironmentVersionsClient struct {
	// contains filtered or unexported fields
}

EnvironmentVersionsClient contains the methods for the EnvironmentVersions group. Don't use this type directly, use NewEnvironmentVersionsClient() instead.

func NewEnvironmentVersionsClient

func NewEnvironmentVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EnvironmentVersionsClient, error)

NewEnvironmentVersionsClient creates a new instance of EnvironmentVersionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*EnvironmentVersionsClient) CreateOrUpdate

CreateOrUpdate - Creates or updates an EnvironmentVersion. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Name of EnvironmentVersion. This is case-sensitive. version - Version of EnvironmentVersion. body - Definition of EnvironmentVersion. options - EnvironmentVersionsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentVersionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentVersion/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	armmachinelearning.EnvironmentVersion{
		Properties: &armmachinelearning.EnvironmentVersionProperties{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
			IsAnonymous: to.Ptr(false),
			Build: &armmachinelearning.BuildContext{
				ContextURI:     to.Ptr("https://storage-account.blob.core.windows.net/azureml/DockerBuildContext/95ddede6b9b8c4e90472db3acd0a8d28/"),
				DockerfilePath: to.Ptr("prod/Dockerfile"),
			},
			CondaFile: to.Ptr("string"),
			Image:     to.Ptr("docker.io/tensorflow/serving:latest"),
			InferenceConfig: &armmachinelearning.InferenceContainerProperties{
				LivenessRoute: &armmachinelearning.Route{
					Path: to.Ptr("string"),
					Port: to.Ptr[int32](1),
				},
				ReadinessRoute: &armmachinelearning.Route{
					Path: to.Ptr("string"),
					Port: to.Ptr[int32](1),
				},
				ScoringRoute: &armmachinelearning.Route{
					Path: to.Ptr("string"),
					Port: to.Ptr[int32](1),
				},
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*EnvironmentVersionsClient) Delete

func (client *EnvironmentVersionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *EnvironmentVersionsClientDeleteOptions) (EnvironmentVersionsClientDeleteResponse, error)

Delete - Delete version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. options - EnvironmentVersionsClientDeleteOptions contains the optional parameters for the EnvironmentVersionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentVersion/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*EnvironmentVersionsClient) Get

func (client *EnvironmentVersionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *EnvironmentVersionsClientGetOptions) (EnvironmentVersionsClientGetResponse, error)

Get - Get version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. options - EnvironmentVersionsClientGetOptions contains the optional parameters for the EnvironmentVersionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentVersion/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*EnvironmentVersionsClient) NewListPager

func (client *EnvironmentVersionsClient) NewListPager(resourceGroupName string, workspaceName string, name string, options *EnvironmentVersionsClientListOptions) *runtime.Pager[EnvironmentVersionsClientListResponse]

NewListPager - List versions. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - EnvironmentVersionsClientListOptions contains the optional parameters for the EnvironmentVersionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/EnvironmentVersion/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewEnvironmentVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	"string",
	&armmachinelearning.EnvironmentVersionsClientListOptions{OrderBy: to.Ptr("string"),
		Top:          to.Ptr[int32](1),
		Skip:         nil,
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type EnvironmentVersionsClientCreateOrUpdateOptions

type EnvironmentVersionsClientCreateOrUpdateOptions struct {
}

EnvironmentVersionsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentVersionsClient.CreateOrUpdate method.

type EnvironmentVersionsClientCreateOrUpdateResponse

type EnvironmentVersionsClientCreateOrUpdateResponse struct {
	EnvironmentVersion
}

EnvironmentVersionsClientCreateOrUpdateResponse contains the response from method EnvironmentVersionsClient.CreateOrUpdate.

type EnvironmentVersionsClientDeleteOptions

type EnvironmentVersionsClientDeleteOptions struct {
}

EnvironmentVersionsClientDeleteOptions contains the optional parameters for the EnvironmentVersionsClient.Delete method.

type EnvironmentVersionsClientDeleteResponse

type EnvironmentVersionsClientDeleteResponse struct {
}

EnvironmentVersionsClientDeleteResponse contains the response from method EnvironmentVersionsClient.Delete.

type EnvironmentVersionsClientGetOptions

type EnvironmentVersionsClientGetOptions struct {
}

EnvironmentVersionsClientGetOptions contains the optional parameters for the EnvironmentVersionsClient.Get method.

type EnvironmentVersionsClientGetResponse

type EnvironmentVersionsClientGetResponse struct {
	EnvironmentVersion
}

EnvironmentVersionsClientGetResponse contains the response from method EnvironmentVersionsClient.Get.

type EnvironmentVersionsClientListOptions

type EnvironmentVersionsClientListOptions struct {
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Ordering of list.
	OrderBy *string
	// Continuation token for pagination.
	Skip *string
	// Maximum number of records to return.
	Top *int32
}

EnvironmentVersionsClientListOptions contains the optional parameters for the EnvironmentVersionsClient.List method.

type EnvironmentVersionsClientListResponse

type EnvironmentVersionsClientListResponse struct {
	EnvironmentVersionResourceArmPaginatedResult
}

EnvironmentVersionsClientListResponse contains the response from method EnvironmentVersionsClient.List.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDetail

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

type ErrorResponse

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type EstimatedVMPrice

type EstimatedVMPrice struct {
	// REQUIRED; Operating system type used by the VM.
	OSType *VMPriceOSType `json:"osType,omitempty"`

	// REQUIRED; The price charged for using the VM.
	RetailPrice *float64 `json:"retailPrice,omitempty"`

	// REQUIRED; The type of the VM.
	VMTier *VMTier `json:"vmTier,omitempty"`
}

EstimatedVMPrice - The estimated price info for using a VM of a particular OS type, tier, etc.

type EstimatedVMPrices

type EstimatedVMPrices struct {
	// REQUIRED; Three lettered code specifying the currency of the VM price. Example: USD
	BillingCurrency *BillingCurrency `json:"billingCurrency,omitempty"`

	// REQUIRED; The unit of time measurement for the specified VM price. Example: OneHour
	UnitOfMeasure *UnitOfMeasure `json:"unitOfMeasure,omitempty"`

	// REQUIRED; The list of estimated prices for using a VM of a particular OS type, tier, etc.
	Values []*EstimatedVMPrice `json:"values,omitempty"`
}

EstimatedVMPrices - The estimated price info for using a VM.

type ExternalFQDNResponse

type ExternalFQDNResponse struct {
	Value []*FQDNEndpoints `json:"value,omitempty"`
}

type FQDNEndpoint

type FQDNEndpoint struct {
	DomainName      *string               `json:"domainName,omitempty"`
	EndpointDetails []*FQDNEndpointDetail `json:"endpointDetails,omitempty"`
}

type FQDNEndpointDetail

type FQDNEndpointDetail struct {
	Port *int32 `json:"port,omitempty"`
}

type FQDNEndpoints

type FQDNEndpoints struct {
	Properties *FQDNEndpointsProperties `json:"properties,omitempty"`
}

type FQDNEndpointsProperties

type FQDNEndpointsProperties struct {
	Category  *string         `json:"category,omitempty"`
	Endpoints []*FQDNEndpoint `json:"endpoints,omitempty"`
}

type FlavorData

type FlavorData struct {
	// Model flavor-specific data.
	Data map[string]*string `json:"data,omitempty"`
}

func (FlavorData) MarshalJSON

func (f FlavorData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlavorData.

type Goal

type Goal string

Goal - Defines supported metric goals for hyperparameter tuning

const (
	GoalMaximize Goal = "Maximize"
	GoalMinimize Goal = "Minimize"
)

func PossibleGoalValues

func PossibleGoalValues() []Goal

PossibleGoalValues returns the possible values for the Goal const type.

type GridSamplingAlgorithm

type GridSamplingAlgorithm struct {
	// REQUIRED; [Required] The algorithm used for generating hyperparameter values, along with configuration properties
	SamplingAlgorithmType *SamplingAlgorithmType `json:"samplingAlgorithmType,omitempty"`
}

GridSamplingAlgorithm - Defines a Sampling Algorithm that exhaustively generates every value combination in the space

func (*GridSamplingAlgorithm) GetSamplingAlgorithm

func (g *GridSamplingAlgorithm) GetSamplingAlgorithm() *SamplingAlgorithm

GetSamplingAlgorithm implements the SamplingAlgorithmClassification interface for type GridSamplingAlgorithm.

func (GridSamplingAlgorithm) MarshalJSON

func (g GridSamplingAlgorithm) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GridSamplingAlgorithm.

func (*GridSamplingAlgorithm) UnmarshalJSON

func (g *GridSamplingAlgorithm) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GridSamplingAlgorithm.

type HDInsight

type HDInsight struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// HDInsight compute properties
	Properties *HDInsightProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

HDInsight - A HDInsight compute.

func (*HDInsight) GetCompute

func (h *HDInsight) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type HDInsight.

func (HDInsight) MarshalJSON

func (h HDInsight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HDInsight.

func (*HDInsight) UnmarshalJSON

func (h *HDInsight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HDInsight.

type HDInsightProperties

type HDInsightProperties struct {
	// Public IP address of the master node of the cluster.
	Address *string `json:"address,omitempty"`

	// Admin credentials for master node of the cluster
	AdministratorAccount *VirtualMachineSSHCredentials `json:"administratorAccount,omitempty"`

	// Port open for ssh connections on the master node of the cluster.
	SSHPort *int32 `json:"sshPort,omitempty"`
}

HDInsightProperties - HDInsight compute properties

type HDInsightSchema

type HDInsightSchema struct {
	// HDInsight compute properties
	Properties *HDInsightProperties `json:"properties,omitempty"`
}

type IDAssetReference

type IDAssetReference struct {
	// REQUIRED; [Required] ARM resource ID of the asset.
	AssetID *string `json:"assetId,omitempty"`

	// REQUIRED; [Required] Specifies the type of asset reference.
	ReferenceType *ReferenceType `json:"referenceType,omitempty"`
}

IDAssetReference - Reference to an asset via its ARM resource ID.

func (*IDAssetReference) GetAssetReferenceBase

func (i *IDAssetReference) GetAssetReferenceBase() *AssetReferenceBase

GetAssetReferenceBase implements the AssetReferenceBaseClassification interface for type IDAssetReference.

func (IDAssetReference) MarshalJSON

func (i IDAssetReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IDAssetReference.

func (*IDAssetReference) UnmarshalJSON

func (i *IDAssetReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IDAssetReference.

type IdentityConfiguration

type IdentityConfiguration struct {
	// REQUIRED; [Required] Specifies the type of identity framework.
	IdentityType *IdentityConfigurationType `json:"identityType,omitempty"`
}

IdentityConfiguration - Base definition for identity configuration.

func (*IdentityConfiguration) GetIdentityConfiguration

func (i *IdentityConfiguration) GetIdentityConfiguration() *IdentityConfiguration

GetIdentityConfiguration implements the IdentityConfigurationClassification interface for type IdentityConfiguration.

type IdentityConfigurationClassification

type IdentityConfigurationClassification interface {
	// GetIdentityConfiguration returns the IdentityConfiguration content of the underlying type.
	GetIdentityConfiguration() *IdentityConfiguration
}

IdentityConfigurationClassification provides polymorphic access to related types. Call the interface's GetIdentityConfiguration() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AmlToken, *IdentityConfiguration, *ManagedIdentity, *UserIdentity

type IdentityConfigurationType

type IdentityConfigurationType string

IdentityConfigurationType - Enum to determine identity framework.

const (
	IdentityConfigurationTypeAMLToken     IdentityConfigurationType = "AMLToken"
	IdentityConfigurationTypeManaged      IdentityConfigurationType = "Managed"
	IdentityConfigurationTypeUserIdentity IdentityConfigurationType = "UserIdentity"
)

func PossibleIdentityConfigurationTypeValues

func PossibleIdentityConfigurationTypeValues() []IdentityConfigurationType

PossibleIdentityConfigurationTypeValues returns the possible values for the IdentityConfigurationType const type.

type IdentityForCmk

type IdentityForCmk struct {
	// The ArmId of the user assigned identity that will be used to access the customer managed key vault
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

IdentityForCmk - Identity that will be used to access key vault for encryption at rest

type InferenceContainerProperties

type InferenceContainerProperties struct {
	// The route to check the liveness of the inference server container.
	LivenessRoute *Route `json:"livenessRoute,omitempty"`

	// The route to check the readiness of the inference server container.
	ReadinessRoute *Route `json:"readinessRoute,omitempty"`

	// The port to send the scoring requests to, within the inference server container.
	ScoringRoute *Route `json:"scoringRoute,omitempty"`
}

type InputDeliveryMode

type InputDeliveryMode string

InputDeliveryMode - Enum to determine the input data delivery mode.

const (
	InputDeliveryModeDirect         InputDeliveryMode = "Direct"
	InputDeliveryModeDownload       InputDeliveryMode = "Download"
	InputDeliveryModeEvalDownload   InputDeliveryMode = "EvalDownload"
	InputDeliveryModeEvalMount      InputDeliveryMode = "EvalMount"
	InputDeliveryModeReadOnlyMount  InputDeliveryMode = "ReadOnlyMount"
	InputDeliveryModeReadWriteMount InputDeliveryMode = "ReadWriteMount"
)

func PossibleInputDeliveryModeValues

func PossibleInputDeliveryModeValues() []InputDeliveryMode

PossibleInputDeliveryModeValues returns the possible values for the InputDeliveryMode const type.

type InstanceTypeSchema

type InstanceTypeSchema struct {
	// Node Selector
	NodeSelector map[string]*string `json:"nodeSelector,omitempty"`

	// Resource requests/limits for this instance type
	Resources *InstanceTypeSchemaResources `json:"resources,omitempty"`
}

InstanceTypeSchema - Instance type schema.

func (InstanceTypeSchema) MarshalJSON

func (i InstanceTypeSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InstanceTypeSchema.

type InstanceTypeSchemaResources

type InstanceTypeSchemaResources struct {
	// Resource limits for this instance type
	Limits map[string]*string `json:"limits,omitempty"`

	// Resource requests for this instance type
	Requests map[string]*string `json:"requests,omitempty"`
}

InstanceTypeSchemaResources - Resource requests/limits for this instance type

func (InstanceTypeSchemaResources) MarshalJSON

func (i InstanceTypeSchemaResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InstanceTypeSchemaResources.

type JobBase

type JobBase struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties JobBasePropertiesClassification `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

JobBase - Azure Resource Manager resource envelope.

func (JobBase) MarshalJSON

func (j JobBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobBase.

func (*JobBase) UnmarshalJSON

func (j *JobBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobBase.

type JobBaseProperties

type JobBaseProperties struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobType *JobType `json:"jobType,omitempty"`

	// ARM resource ID of the compute resource.
	ComputeID *string `json:"computeId,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Display name of job.
	DisplayName *string `json:"displayName,omitempty"`

	// The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
	ExperimentName *string `json:"experimentName,omitempty"`

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification `json:"identity,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
	Services map[string]*JobService `json:"services,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Status of the job.
	Status *JobStatus `json:"status,omitempty" azure:"ro"`
}

JobBaseProperties - Base definition for a job.

func (*JobBaseProperties) GetJobBaseProperties

func (j *JobBaseProperties) GetJobBaseProperties() *JobBaseProperties

GetJobBaseProperties implements the JobBasePropertiesClassification interface for type JobBaseProperties.

func (JobBaseProperties) MarshalJSON

func (j JobBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobBaseProperties.

func (*JobBaseProperties) UnmarshalJSON

func (j *JobBaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobBaseProperties.

type JobBasePropertiesClassification

type JobBasePropertiesClassification interface {
	// GetJobBaseProperties returns the JobBaseProperties content of the underlying type.
	GetJobBaseProperties() *JobBaseProperties
}

JobBasePropertiesClassification provides polymorphic access to related types. Call the interface's GetJobBaseProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CommandJob, *JobBaseProperties, *PipelineJob, *SweepJob

type JobBaseResourceArmPaginatedResult

type JobBaseResourceArmPaginatedResult struct {
	// The link to the next page of JobBase objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type JobBase.
	Value []*JobBase `json:"value,omitempty"`
}

JobBaseResourceArmPaginatedResult - A paginated list of JobBase entities.

type JobInput

type JobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`
}

JobInput - Command job definition.

func (*JobInput) GetJobInput

func (j *JobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type JobInput.

type JobInputClassification

type JobInputClassification interface {
	// GetJobInput returns the JobInput content of the underlying type.
	GetJobInput() *JobInput
}

JobInputClassification provides polymorphic access to related types. Call the interface's GetJobInput() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CustomModelJobInput, *JobInput, *LiteralJobInput, *MLFlowModelJobInput, *MLTableJobInput, *TritonModelJobInput, *URIFileJobInput, - *URIFolderJobInput

type JobInputType

type JobInputType string

JobInputType - Enum to determine the Job Input Type.

const (
	JobInputTypeCustomModel JobInputType = "custom_model"
	JobInputTypeLiteral     JobInputType = "literal"
	JobInputTypeMlflowModel JobInputType = "mlflow_model"
	JobInputTypeMltable     JobInputType = "mltable"
	JobInputTypeTritonModel JobInputType = "triton_model"
	JobInputTypeURIFile     JobInputType = "uri_file"
	JobInputTypeURIFolder   JobInputType = "uri_folder"
)

func PossibleJobInputTypeValues

func PossibleJobInputTypeValues() []JobInputType

PossibleJobInputTypeValues returns the possible values for the JobInputType const type.

type JobLimits

type JobLimits struct {
	// REQUIRED; [Required] JobLimit type.
	JobLimitsType *JobLimitsType `json:"jobLimitsType,omitempty"`

	// The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as
	// low as Seconds.
	Timeout *string `json:"timeout,omitempty"`
}

func (*JobLimits) GetJobLimits

func (j *JobLimits) GetJobLimits() *JobLimits

GetJobLimits implements the JobLimitsClassification interface for type JobLimits.

type JobLimitsClassification

type JobLimitsClassification interface {
	// GetJobLimits returns the JobLimits content of the underlying type.
	GetJobLimits() *JobLimits
}

JobLimitsClassification provides polymorphic access to related types. Call the interface's GetJobLimits() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CommandJobLimits, *JobLimits, *SweepJobLimits

type JobLimitsType

type JobLimitsType string
const (
	JobLimitsTypeCommand JobLimitsType = "Command"
	JobLimitsTypeSweep   JobLimitsType = "Sweep"
)

func PossibleJobLimitsTypeValues

func PossibleJobLimitsTypeValues() []JobLimitsType

PossibleJobLimitsTypeValues returns the possible values for the JobLimitsType const type.

type JobOutput

type JobOutput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobOutputType *JobOutputType `json:"jobOutputType,omitempty"`

	// Description for the output.
	Description *string `json:"description,omitempty"`
}

JobOutput - Job output definition container information on where to find job output/logs.

func (*JobOutput) GetJobOutput

func (j *JobOutput) GetJobOutput() *JobOutput

GetJobOutput implements the JobOutputClassification interface for type JobOutput.

type JobOutputClassification

type JobOutputClassification interface {
	// GetJobOutput returns the JobOutput content of the underlying type.
	GetJobOutput() *JobOutput
}

JobOutputClassification provides polymorphic access to related types. Call the interface's GetJobOutput() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CustomModelJobOutput, *JobOutput, *MLFlowModelJobOutput, *MLTableJobOutput, *TritonModelJobOutput, *URIFileJobOutput, - *URIFolderJobOutput

type JobOutputType

type JobOutputType string

JobOutputType - Enum to determine the Job Output Type.

const (
	JobOutputTypeCustomModel JobOutputType = "custom_model"
	JobOutputTypeMlflowModel JobOutputType = "mlflow_model"
	JobOutputTypeMltable     JobOutputType = "mltable"
	JobOutputTypeTritonModel JobOutputType = "triton_model"
	JobOutputTypeURIFile     JobOutputType = "uri_file"
	JobOutputTypeURIFolder   JobOutputType = "uri_folder"
)

func PossibleJobOutputTypeValues

func PossibleJobOutputTypeValues() []JobOutputType

PossibleJobOutputTypeValues returns the possible values for the JobOutputType const type.

type JobService

type JobService struct {
	// Url for endpoint.
	Endpoint *string `json:"endpoint,omitempty"`

	// Endpoint type.
	JobServiceType *string `json:"jobServiceType,omitempty"`

	// Port for endpoint.
	Port *int32 `json:"port,omitempty"`

	// Additional properties to set on the endpoint.
	Properties map[string]*string `json:"properties,omitempty"`

	// READ-ONLY; Any error in the service.
	ErrorMessage *string `json:"errorMessage,omitempty" azure:"ro"`

	// READ-ONLY; Status of endpoint.
	Status *string `json:"status,omitempty" azure:"ro"`
}

JobService - Job endpoint definition

func (JobService) MarshalJSON

func (j JobService) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobService.

type JobStatus

type JobStatus string

JobStatus - The status of a job.

const (
	// JobStatusCancelRequested - Cancellation has been requested for the job.
	JobStatusCancelRequested JobStatus = "CancelRequested"
	// JobStatusCanceled - Following cancellation request, the job is now successfully canceled.
	JobStatusCanceled JobStatus = "Canceled"
	// JobStatusCompleted - Job completed successfully. This reflects that both the job itself and output collection states completed
	// successfully
	JobStatusCompleted JobStatus = "Completed"
	// JobStatusFailed - Job failed.
	JobStatusFailed JobStatus = "Failed"
	// JobStatusFinalizing - Job is completed in the target. It is in output collection state now.
	JobStatusFinalizing JobStatus = "Finalizing"
	// JobStatusNotResponding - When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run
	// goes to NotResponding state.
	// NotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of
	// the previous states.
	JobStatusNotResponding JobStatus = "NotResponding"
	// JobStatusNotStarted - Run hasn't started yet.
	JobStatusNotStarted JobStatus = "NotStarted"
	// JobStatusPaused - The job is paused by users. Some adjustment to labeling jobs can be made only in paused state.
	JobStatusPaused JobStatus = "Paused"
	// JobStatusPreparing - The run environment is being prepared.
	JobStatusPreparing JobStatus = "Preparing"
	// JobStatusProvisioning - (Not used currently) It will be used if ES is creating the compute target.
	JobStatusProvisioning JobStatus = "Provisioning"
	// JobStatusQueued - The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting
	// for all required nodes to be ready.
	JobStatusQueued JobStatus = "Queued"
	// JobStatusRunning - The job started to run in the compute target.
	JobStatusRunning JobStatus = "Running"
	// JobStatusStarting - Run has started. The user has a run ID.
	JobStatusStarting JobStatus = "Starting"
	// JobStatusUnknown - Default job status if not mapped to all other statuses
	JobStatusUnknown JobStatus = "Unknown"
)

func PossibleJobStatusValues

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns the possible values for the JobStatus const type.

type JobType

type JobType string

JobType - Enum to determine the type of job.

const (
	JobTypeCommand  JobType = "Command"
	JobTypePipeline JobType = "Pipeline"
	JobTypeSweep    JobType = "Sweep"
)

func PossibleJobTypeValues

func PossibleJobTypeValues() []JobType

PossibleJobTypeValues returns the possible values for the JobType const type.

type JobsClient

type JobsClient struct {
	// contains filtered or unexported fields
}

JobsClient contains the methods for the Jobs group. Don't use this type directly, use NewJobsClient() instead.

func NewJobsClient

func NewJobsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*JobsClient, error)

NewJobsClient creates a new instance of JobsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*JobsClient) BeginCancel

func (client *JobsClient) BeginCancel(ctx context.Context, resourceGroupName string, workspaceName string, id string, options *JobsClientBeginCancelOptions) (*runtime.Poller[JobsClientCancelResponse], error)

BeginCancel - Cancels a Job (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. id - The name and identifier for the Job. This is case-sensitive. options - JobsClientBeginCancelOptions contains the optional parameters for the JobsClient.BeginCancel method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Job/cancel.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewJobsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCancel(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*JobsClient) BeginDelete

func (client *JobsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, id string, options *JobsClientBeginDeleteOptions) (*runtime.Poller[JobsClientDeleteResponse], error)

BeginDelete - Deletes a Job (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. id - The name and identifier for the Job. This is case-sensitive. options - JobsClientBeginDeleteOptions contains the optional parameters for the JobsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Job/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewJobsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*JobsClient) CreateOrUpdate

func (client *JobsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, id string, body JobBase, options *JobsClientCreateOrUpdateOptions) (JobsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates and executes a Job. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. id - The name and identifier for the Job. This is case-sensitive. body - Job definition object. options - JobsClientCreateOrUpdateOptions contains the optional parameters for the JobsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Job/CommandJob/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewJobsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	armmachinelearning.JobBase{
		Properties: &armmachinelearning.CommandJob{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
			ComputeID:      to.Ptr("string"),
			DisplayName:    to.Ptr("string"),
			ExperimentName: to.Ptr("string"),
			Identity: &armmachinelearning.AmlToken{
				IdentityType: to.Ptr(armmachinelearning.IdentityConfigurationTypeAMLToken),
			},
			JobType: to.Ptr(armmachinelearning.JobTypeCommand),
			Services: map[string]*armmachinelearning.JobService{
				"string": {
					Endpoint:       to.Ptr("string"),
					JobServiceType: to.Ptr("string"),
					Port:           to.Ptr[int32](1),
					Properties: map[string]*string{
						"string": to.Ptr("string"),
					},
				},
			},
			CodeID:  to.Ptr("string"),
			Command: to.Ptr("string"),
			Distribution: &armmachinelearning.TensorFlow{
				DistributionType:     to.Ptr(armmachinelearning.DistributionTypeTensorFlow),
				ParameterServerCount: to.Ptr[int32](1),
				WorkerCount:          to.Ptr[int32](1),
			},
			EnvironmentID: to.Ptr("string"),
			EnvironmentVariables: map[string]*string{
				"string": to.Ptr("string"),
			},
			Inputs: map[string]armmachinelearning.JobInputClassification{
				"string": &armmachinelearning.LiteralJobInput{
					Description:  to.Ptr("string"),
					JobInputType: to.Ptr(armmachinelearning.JobInputTypeLiteral),
					Value:        to.Ptr("string"),
				},
			},
			Limits: &armmachinelearning.CommandJobLimits{
				JobLimitsType: to.Ptr(armmachinelearning.JobLimitsTypeCommand),
				Timeout:       to.Ptr("PT5M"),
			},
			Outputs: map[string]armmachinelearning.JobOutputClassification{
				"string": &armmachinelearning.URIFileJobOutput{
					Mode:          to.Ptr(armmachinelearning.OutputDeliveryModeReadWriteMount),
					URI:           to.Ptr("string"),
					Description:   to.Ptr("string"),
					JobOutputType: to.Ptr(armmachinelearning.JobOutputTypeURIFile),
				},
			},
			Resources: &armmachinelearning.ResourceConfiguration{
				InstanceCount: to.Ptr[int32](1),
				InstanceType:  to.Ptr("string"),
				Properties: map[string]interface{}{
					"string": map[string]interface{}{
						"e6b6493e-7d5e-4db3-be1e-306ec641327e": nil,
					},
				},
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*JobsClient) Get

func (client *JobsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, id string, options *JobsClientGetOptions) (JobsClientGetResponse, error)

Get - Gets a Job by name/id. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. id - The name and identifier for the Job. This is case-sensitive. options - JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Job/CommandJob/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewJobsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*JobsClient) NewListPager

func (client *JobsClient) NewListPager(resourceGroupName string, workspaceName string, options *JobsClientListOptions) *runtime.Pager[JobsClientListResponse]

NewListPager - Lists Jobs in the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - JobsClientListOptions contains the optional parameters for the JobsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Job/CommandJob/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewJobsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	&armmachinelearning.JobsClientListOptions{Skip: nil,
		JobType:      to.Ptr("string"),
		Tag:          to.Ptr("string"),
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type JobsClientBeginCancelOptions

type JobsClientBeginCancelOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

JobsClientBeginCancelOptions contains the optional parameters for the JobsClient.BeginCancel method.

type JobsClientBeginDeleteOptions

type JobsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

JobsClientBeginDeleteOptions contains the optional parameters for the JobsClient.BeginDelete method.

type JobsClientCancelResponse

type JobsClientCancelResponse struct {
}

JobsClientCancelResponse contains the response from method JobsClient.Cancel.

type JobsClientCreateOrUpdateOptions

type JobsClientCreateOrUpdateOptions struct {
}

JobsClientCreateOrUpdateOptions contains the optional parameters for the JobsClient.CreateOrUpdate method.

type JobsClientCreateOrUpdateResponse

type JobsClientCreateOrUpdateResponse struct {
	JobBase
}

JobsClientCreateOrUpdateResponse contains the response from method JobsClient.CreateOrUpdate.

type JobsClientDeleteResponse

type JobsClientDeleteResponse struct {
}

JobsClientDeleteResponse contains the response from method JobsClient.Delete.

type JobsClientGetOptions

type JobsClientGetOptions struct {
}

JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetResponse

type JobsClientGetResponse struct {
	JobBase
}

JobsClientGetResponse contains the response from method JobsClient.Get.

type JobsClientListOptions

type JobsClientListOptions struct {
	// Type of job to be returned.
	JobType *string
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Continuation token for pagination.
	Skip *string
	// Jobs returned will have this tag key.
	Tag *string
}

JobsClientListOptions contains the optional parameters for the JobsClient.List method.

type JobsClientListResponse

type JobsClientListResponse struct {
	JobBaseResourceArmPaginatedResult
}

JobsClientListResponse contains the response from method JobsClient.List.

type KeyType

type KeyType string
const (
	KeyTypePrimary   KeyType = "Primary"
	KeyTypeSecondary KeyType = "Secondary"
)

func PossibleKeyTypeValues

func PossibleKeyTypeValues() []KeyType

PossibleKeyTypeValues returns the possible values for the KeyType const type.

type Kubernetes

type Kubernetes struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// Properties of Kubernetes
	Properties *KubernetesProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

Kubernetes - A Machine Learning compute based on Kubernetes Compute.

func (*Kubernetes) GetCompute

func (k *Kubernetes) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type Kubernetes.

func (Kubernetes) MarshalJSON

func (k Kubernetes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Kubernetes.

func (*Kubernetes) UnmarshalJSON

func (k *Kubernetes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Kubernetes.

type KubernetesOnlineDeployment

type KubernetesOnlineDeployment struct {
	// REQUIRED; [Required] The compute type of the endpoint.
	EndpointComputeType *EndpointComputeType `json:"endpointComputeType,omitempty"`

	// If true, enables Application Insights logging.
	AppInsightsEnabled *bool `json:"appInsightsEnabled,omitempty"`

	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration `json:"codeConfiguration,omitempty"`

	// The resource requirements for the container (cpu and memory).
	ContainerResourceRequirements *ContainerResourceRequirements `json:"containerResourceRequirements,omitempty"`

	// Description of the endpoint deployment.
	Description *string `json:"description,omitempty"`

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string `json:"environmentId,omitempty"`

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// Compute instance type.
	InstanceType *string `json:"instanceType,omitempty"`

	// Liveness probe monitors the health of the container regularly.
	LivenessProbe *ProbeSettings `json:"livenessProbe,omitempty"`

	// The URI path to the model.
	Model *string `json:"model,omitempty"`

	// The path to mount the model in custom container.
	ModelMountPath *string `json:"modelMountPath,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`

	// Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness
	// probe.
	ReadinessProbe *ProbeSettings `json:"readinessProbe,omitempty"`

	// Request settings for the deployment.
	RequestSettings *OnlineRequestSettings `json:"requestSettings,omitempty"`

	// Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment
	// and to DefaultScaleSettings for ManagedOnlineDeployment.
	ScaleSettings OnlineScaleSettingsClassification `json:"scaleSettings,omitempty"`

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

KubernetesOnlineDeployment - Properties specific to a KubernetesOnlineDeployment.

func (*KubernetesOnlineDeployment) GetOnlineDeploymentProperties

func (k *KubernetesOnlineDeployment) GetOnlineDeploymentProperties() *OnlineDeploymentProperties

GetOnlineDeploymentProperties implements the OnlineDeploymentPropertiesClassification interface for type KubernetesOnlineDeployment.

func (KubernetesOnlineDeployment) MarshalJSON

func (k KubernetesOnlineDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesOnlineDeployment.

func (*KubernetesOnlineDeployment) UnmarshalJSON

func (k *KubernetesOnlineDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesOnlineDeployment.

type KubernetesProperties

type KubernetesProperties struct {
	// Default instance type
	DefaultInstanceType *string `json:"defaultInstanceType,omitempty"`

	// Extension instance release train.
	ExtensionInstanceReleaseTrain *string `json:"extensionInstanceReleaseTrain,omitempty"`

	// Extension principal-id.
	ExtensionPrincipalID *string `json:"extensionPrincipalId,omitempty"`

	// Instance Type Schema
	InstanceTypes map[string]*InstanceTypeSchema `json:"instanceTypes,omitempty"`

	// Compute namespace
	Namespace *string `json:"namespace,omitempty"`

	// Relay connection string.
	RelayConnectionString *string `json:"relayConnectionString,omitempty"`

	// ServiceBus connection string.
	ServiceBusConnectionString *string `json:"serviceBusConnectionString,omitempty"`

	// VC name.
	VcName *string `json:"vcName,omitempty"`
}

KubernetesProperties - Kubernetes properties

func (KubernetesProperties) MarshalJSON

func (k KubernetesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesProperties.

type KubernetesSchema

type KubernetesSchema struct {
	// Properties of Kubernetes
	Properties *KubernetesProperties `json:"properties,omitempty"`
}

KubernetesSchema - Kubernetes Compute Schema

type ListAmlUserFeatureResult

type ListAmlUserFeatureResult struct {
	// READ-ONLY; The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next
	// page of AML user features information.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of AML user facing features.
	Value []*AmlUserFeature `json:"value,omitempty" azure:"ro"`
}

ListAmlUserFeatureResult - The List Aml user feature operation response.

type ListNotebookKeysResult

type ListNotebookKeysResult struct {
	// READ-ONLY
	PrimaryAccessKey *string `json:"primaryAccessKey,omitempty" azure:"ro"`

	// READ-ONLY
	SecondaryAccessKey *string `json:"secondaryAccessKey,omitempty" azure:"ro"`
}

type ListStorageAccountKeysResult

type ListStorageAccountKeysResult struct {
	// READ-ONLY
	UserStorageKey *string `json:"userStorageKey,omitempty" azure:"ro"`
}

type ListUsagesResult

type ListUsagesResult struct {
	// READ-ONLY; The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next
	// page of AML resource usage information.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of AML resource usages.
	Value []*Usage `json:"value,omitempty" azure:"ro"`
}

ListUsagesResult - The List Usages operation response.

type ListViewType

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

func PossibleListViewTypeValues

func PossibleListViewTypeValues() []ListViewType

PossibleListViewTypeValues returns the possible values for the ListViewType const type.

type ListWorkspaceKeysResult

type ListWorkspaceKeysResult struct {
	// READ-ONLY
	AppInsightsInstrumentationKey *string `json:"appInsightsInstrumentationKey,omitempty" azure:"ro"`

	// READ-ONLY
	ContainerRegistryCredentials *RegistryListCredentialsResult `json:"containerRegistryCredentials,omitempty" azure:"ro"`

	// READ-ONLY
	NotebookAccessKeys *ListNotebookKeysResult `json:"notebookAccessKeys,omitempty" azure:"ro"`

	// READ-ONLY
	UserStorageKey *string `json:"userStorageKey,omitempty" azure:"ro"`

	// READ-ONLY
	UserStorageResourceID *string `json:"userStorageResourceId,omitempty" azure:"ro"`
}

type ListWorkspaceQuotas

type ListWorkspaceQuotas struct {
	// READ-ONLY; The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch
	// the next page of Workspace Quota information.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of Workspace Quotas by VM Family
	Value []*ResourceQuota `json:"value,omitempty" azure:"ro"`
}

ListWorkspaceQuotas - The List WorkspaceQuotasByVMFamily operation response.

type LiteralJobInput

type LiteralJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// REQUIRED; [Required] Literal value for the input.
	Value *string `json:"value,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`
}

LiteralJobInput - Literal input type.

func (*LiteralJobInput) GetJobInput

func (l *LiteralJobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type LiteralJobInput.

func (LiteralJobInput) MarshalJSON

func (l LiteralJobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LiteralJobInput.

func (*LiteralJobInput) UnmarshalJSON

func (l *LiteralJobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LiteralJobInput.

type LoadBalancerType

type LoadBalancerType string

LoadBalancerType - Load Balancer Type

const (
	LoadBalancerTypeInternalLoadBalancer LoadBalancerType = "InternalLoadBalancer"
	LoadBalancerTypePublicIP             LoadBalancerType = "PublicIp"
)

func PossibleLoadBalancerTypeValues

func PossibleLoadBalancerTypeValues() []LoadBalancerType

PossibleLoadBalancerTypeValues returns the possible values for the LoadBalancerType const type.

type MLFlowModelJobInput

type MLFlowModelJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// REQUIRED; [Required] Input Asset URI.
	URI *string `json:"uri,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode `json:"mode,omitempty"`
}

func (*MLFlowModelJobInput) GetJobInput

func (m *MLFlowModelJobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type MLFlowModelJobInput.

func (MLFlowModelJobInput) MarshalJSON

func (m MLFlowModelJobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MLFlowModelJobInput.

func (*MLFlowModelJobInput) UnmarshalJSON

func (m *MLFlowModelJobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MLFlowModelJobInput.

type MLFlowModelJobOutput

type MLFlowModelJobOutput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobOutputType *JobOutputType `json:"jobOutputType,omitempty"`

	// Description for the output.
	Description *string `json:"description,omitempty"`

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode `json:"mode,omitempty"`

	// Output Asset URI.
	URI *string `json:"uri,omitempty"`
}

func (*MLFlowModelJobOutput) GetJobOutput

func (m *MLFlowModelJobOutput) GetJobOutput() *JobOutput

GetJobOutput implements the JobOutputClassification interface for type MLFlowModelJobOutput.

func (MLFlowModelJobOutput) MarshalJSON

func (m MLFlowModelJobOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MLFlowModelJobOutput.

func (*MLFlowModelJobOutput) UnmarshalJSON

func (m *MLFlowModelJobOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MLFlowModelJobOutput.

type MLTableData

type MLTableData struct {
	// REQUIRED; [Required] Specifies the type of data.
	DataType *DataType `json:"dataType,omitempty"`

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20220501.Assets.DataVersionBase.DataType
	DataURI *string `json:"dataUri,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Uris referenced in the MLTable definition (required for lineage)
	ReferencedUris []*string `json:"referencedUris,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

MLTableData - MLTable data definition

func (*MLTableData) GetDataVersionBaseProperties

func (m *MLTableData) GetDataVersionBaseProperties() *DataVersionBaseProperties

GetDataVersionBaseProperties implements the DataVersionBasePropertiesClassification interface for type MLTableData.

func (MLTableData) MarshalJSON

func (m MLTableData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MLTableData.

func (*MLTableData) UnmarshalJSON

func (m *MLTableData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MLTableData.

type MLTableJobInput

type MLTableJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// REQUIRED; [Required] Input Asset URI.
	URI *string `json:"uri,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode `json:"mode,omitempty"`
}

func (*MLTableJobInput) GetJobInput

func (m *MLTableJobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type MLTableJobInput.

func (MLTableJobInput) MarshalJSON

func (m MLTableJobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MLTableJobInput.

func (*MLTableJobInput) UnmarshalJSON

func (m *MLTableJobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MLTableJobInput.

type MLTableJobOutput

type MLTableJobOutput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobOutputType *JobOutputType `json:"jobOutputType,omitempty"`

	// Description for the output.
	Description *string `json:"description,omitempty"`

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode `json:"mode,omitempty"`

	// Output Asset URI.
	URI *string `json:"uri,omitempty"`
}

func (*MLTableJobOutput) GetJobOutput

func (m *MLTableJobOutput) GetJobOutput() *JobOutput

GetJobOutput implements the JobOutputClassification interface for type MLTableJobOutput.

func (MLTableJobOutput) MarshalJSON

func (m MLTableJobOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MLTableJobOutput.

func (*MLTableJobOutput) UnmarshalJSON

func (m *MLTableJobOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MLTableJobOutput.

type ManagedIdentity

type ManagedIdentity struct {
	// REQUIRED; [Required] Specifies the type of identity framework.
	IdentityType *IdentityConfigurationType `json:"identityType,omitempty"`

	// Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.
	ClientID *string `json:"clientId,omitempty"`

	// Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.
	ObjectID *string `json:"objectId,omitempty"`

	// Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.
	ResourceID *string `json:"resourceId,omitempty"`
}

ManagedIdentity - Managed identity configuration.

func (*ManagedIdentity) GetIdentityConfiguration

func (m *ManagedIdentity) GetIdentityConfiguration() *IdentityConfiguration

GetIdentityConfiguration implements the IdentityConfigurationClassification interface for type ManagedIdentity.

func (ManagedIdentity) MarshalJSON

func (m ManagedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedIdentity.

func (*ManagedIdentity) UnmarshalJSON

func (m *ManagedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentity.

type ManagedIdentityAuthTypeWorkspaceConnectionProperties

type ManagedIdentityAuthTypeWorkspaceConnectionProperties struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType `json:"authType,omitempty"`

	// Category of the connection
	Category    *ConnectionCategory                 `json:"category,omitempty"`
	Credentials *WorkspaceConnectionManagedIdentity `json:"credentials,omitempty"`
	Target      *string                             `json:"target,omitempty"`

	// Value details of the workspace connection.
	Value *string `json:"value,omitempty"`

	// format for the workspace connection value
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

func (*ManagedIdentityAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2

GetWorkspaceConnectionPropertiesV2 implements the WorkspaceConnectionPropertiesV2Classification interface for type ManagedIdentityAuthTypeWorkspaceConnectionProperties.

func (ManagedIdentityAuthTypeWorkspaceConnectionProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ManagedIdentityAuthTypeWorkspaceConnectionProperties.

func (*ManagedIdentityAuthTypeWorkspaceConnectionProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedIdentityAuthTypeWorkspaceConnectionProperties.

type ManagedOnlineDeployment

type ManagedOnlineDeployment struct {
	// REQUIRED; [Required] The compute type of the endpoint.
	EndpointComputeType *EndpointComputeType `json:"endpointComputeType,omitempty"`

	// If true, enables Application Insights logging.
	AppInsightsEnabled *bool `json:"appInsightsEnabled,omitempty"`

	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration `json:"codeConfiguration,omitempty"`

	// Description of the endpoint deployment.
	Description *string `json:"description,omitempty"`

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string `json:"environmentId,omitempty"`

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// Compute instance type.
	InstanceType *string `json:"instanceType,omitempty"`

	// Liveness probe monitors the health of the container regularly.
	LivenessProbe *ProbeSettings `json:"livenessProbe,omitempty"`

	// The URI path to the model.
	Model *string `json:"model,omitempty"`

	// The path to mount the model in custom container.
	ModelMountPath *string `json:"modelMountPath,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`

	// Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness
	// probe.
	ReadinessProbe *ProbeSettings `json:"readinessProbe,omitempty"`

	// Request settings for the deployment.
	RequestSettings *OnlineRequestSettings `json:"requestSettings,omitempty"`

	// Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment
	// and to DefaultScaleSettings for ManagedOnlineDeployment.
	ScaleSettings OnlineScaleSettingsClassification `json:"scaleSettings,omitempty"`

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ManagedOnlineDeployment - Properties specific to a ManagedOnlineDeployment.

func (*ManagedOnlineDeployment) GetOnlineDeploymentProperties

func (m *ManagedOnlineDeployment) GetOnlineDeploymentProperties() *OnlineDeploymentProperties

GetOnlineDeploymentProperties implements the OnlineDeploymentPropertiesClassification interface for type ManagedOnlineDeployment.

func (ManagedOnlineDeployment) MarshalJSON

func (m ManagedOnlineDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedOnlineDeployment.

func (*ManagedOnlineDeployment) UnmarshalJSON

func (m *ManagedOnlineDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedOnlineDeployment.

type ManagedServiceIdentity

type ManagedServiceIdentity struct {
	// REQUIRED; Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
	Type *ManagedServiceIdentityType `json:"type,omitempty"`

	// The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM
	// resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
	// The dictionary values can be empty objects ({}) in
	// requests.
	UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

ManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities)

func (ManagedServiceIdentity) MarshalJSON

func (m ManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedServiceIdentity.

type ManagedServiceIdentityType

type ManagedServiceIdentityType string

ManagedServiceIdentityType - Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

const (
	ManagedServiceIdentityTypeNone                       ManagedServiceIdentityType = "None"
	ManagedServiceIdentityTypeSystemAssigned             ManagedServiceIdentityType = "SystemAssigned"
	ManagedServiceIdentityTypeSystemAssignedUserAssigned ManagedServiceIdentityType = "SystemAssigned,UserAssigned"
	ManagedServiceIdentityTypeUserAssigned               ManagedServiceIdentityType = "UserAssigned"
)

func PossibleManagedServiceIdentityTypeValues

func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType

PossibleManagedServiceIdentityTypeValues returns the possible values for the ManagedServiceIdentityType const type.

type MedianStoppingPolicy

type MedianStoppingPolicy struct {
	// REQUIRED; [Required] Name of policy configuration
	PolicyType *EarlyTerminationPolicyType `json:"policyType,omitempty"`

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32 `json:"delayEvaluation,omitempty"`

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32 `json:"evaluationInterval,omitempty"`
}

MedianStoppingPolicy - Defines an early termination policy based on running averages of the primary metric of all runs

func (*MedianStoppingPolicy) GetEarlyTerminationPolicy

func (m *MedianStoppingPolicy) GetEarlyTerminationPolicy() *EarlyTerminationPolicy

GetEarlyTerminationPolicy implements the EarlyTerminationPolicyClassification interface for type MedianStoppingPolicy.

func (MedianStoppingPolicy) MarshalJSON

func (m MedianStoppingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MedianStoppingPolicy.

func (*MedianStoppingPolicy) UnmarshalJSON

func (m *MedianStoppingPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MedianStoppingPolicy.

type ModelContainer

type ModelContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *ModelContainerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ModelContainer - Azure Resource Manager resource envelope.

type ModelContainerProperties

type ModelContainerProperties struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string `json:"latestVersion,omitempty" azure:"ro"`

	// READ-ONLY; The next auto incremental version
	NextVersion *string `json:"nextVersion,omitempty" azure:"ro"`
}

func (ModelContainerProperties) MarshalJSON

func (m ModelContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelContainerProperties.

type ModelContainerResourceArmPaginatedResult

type ModelContainerResourceArmPaginatedResult struct {
	// The link to the next page of ModelContainer objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type ModelContainer.
	Value []*ModelContainer `json:"value,omitempty"`
}

ModelContainerResourceArmPaginatedResult - A paginated list of ModelContainer entities.

type ModelContainersClient

type ModelContainersClient struct {
	// contains filtered or unexported fields
}

ModelContainersClient contains the methods for the ModelContainers group. Don't use this type directly, use NewModelContainersClient() instead.

func NewModelContainersClient

func NewModelContainersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ModelContainersClient, error)

NewModelContainersClient creates a new instance of ModelContainersClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ModelContainersClient) CreateOrUpdate

func (client *ModelContainersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, body ModelContainer, options *ModelContainersClientCreateOrUpdateOptions) (ModelContainersClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. body - Container entity to create or update. options - ModelContainersClientCreateOrUpdateOptions contains the optional parameters for the ModelContainersClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelContainer/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"testrg123",
	"workspace123",
	"testContainer",
	armmachinelearning.ModelContainer{
		Properties: &armmachinelearning.ModelContainerProperties{
			Description: to.Ptr("Model container description"),
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ModelContainersClient) Delete

func (client *ModelContainersClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *ModelContainersClientDeleteOptions) (ModelContainersClientDeleteResponse, error)

Delete - Delete container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - ModelContainersClientDeleteOptions contains the optional parameters for the ModelContainersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelContainer/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"testrg123",
	"workspace123",
	"testContainer",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*ModelContainersClient) Get

func (client *ModelContainersClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *ModelContainersClientGetOptions) (ModelContainersClientGetResponse, error)

Get - Get container. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. options - ModelContainersClientGetOptions contains the optional parameters for the ModelContainersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelContainer/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"testrg123",
	"workspace123",
	"testContainer",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ModelContainersClient) NewListPager

func (client *ModelContainersClient) NewListPager(resourceGroupName string, workspaceName string, options *ModelContainersClientListOptions) *runtime.Pager[ModelContainersClientListResponse]

NewListPager - List model containers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - ModelContainersClientListOptions contains the optional parameters for the ModelContainersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelContainer/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelContainersClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg123",
	"workspace123",
	&armmachinelearning.ModelContainersClientListOptions{Skip: nil,
		Count:        nil,
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ModelContainersClientCreateOrUpdateOptions

type ModelContainersClientCreateOrUpdateOptions struct {
}

ModelContainersClientCreateOrUpdateOptions contains the optional parameters for the ModelContainersClient.CreateOrUpdate method.

type ModelContainersClientCreateOrUpdateResponse

type ModelContainersClientCreateOrUpdateResponse struct {
	ModelContainer
}

ModelContainersClientCreateOrUpdateResponse contains the response from method ModelContainersClient.CreateOrUpdate.

type ModelContainersClientDeleteOptions

type ModelContainersClientDeleteOptions struct {
}

ModelContainersClientDeleteOptions contains the optional parameters for the ModelContainersClient.Delete method.

type ModelContainersClientDeleteResponse

type ModelContainersClientDeleteResponse struct {
}

ModelContainersClientDeleteResponse contains the response from method ModelContainersClient.Delete.

type ModelContainersClientGetOptions

type ModelContainersClientGetOptions struct {
}

ModelContainersClientGetOptions contains the optional parameters for the ModelContainersClient.Get method.

type ModelContainersClientGetResponse

type ModelContainersClientGetResponse struct {
	ModelContainer
}

ModelContainersClientGetResponse contains the response from method ModelContainersClient.Get.

type ModelContainersClientListOptions

type ModelContainersClientListOptions struct {
	// Maximum number of results to return.
	Count *int32
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Continuation token for pagination.
	Skip *string
}

ModelContainersClientListOptions contains the optional parameters for the ModelContainersClient.List method.

type ModelContainersClientListResponse

type ModelContainersClientListResponse struct {
	ModelContainerResourceArmPaginatedResult
}

ModelContainersClientListResponse contains the response from method ModelContainersClient.List.

type ModelVersion

type ModelVersion struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *ModelVersionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ModelVersion - Azure Resource Manager resource envelope.

type ModelVersionProperties

type ModelVersionProperties struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Mapping of model flavors to their properties.
	Flavors map[string]*FlavorData `json:"flavors,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// Name of the training job which produced this model
	JobName *string `json:"jobName,omitempty"`

	// The storage format for this entity. Used for NCD.
	ModelType *string `json:"modelType,omitempty"`

	// The URI path to the model contents.
	ModelURI *string `json:"modelUri,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

ModelVersionProperties - Model asset version details.

func (ModelVersionProperties) MarshalJSON

func (m ModelVersionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelVersionProperties.

type ModelVersionResourceArmPaginatedResult

type ModelVersionResourceArmPaginatedResult struct {
	// The link to the next page of ModelVersion objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type ModelVersion.
	Value []*ModelVersion `json:"value,omitempty"`
}

ModelVersionResourceArmPaginatedResult - A paginated list of ModelVersion entities.

type ModelVersionsClient

type ModelVersionsClient struct {
	// contains filtered or unexported fields
}

ModelVersionsClient contains the methods for the ModelVersions group. Don't use this type directly, use NewModelVersionsClient() instead.

func NewModelVersionsClient

func NewModelVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ModelVersionsClient, error)

NewModelVersionsClient creates a new instance of ModelVersionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ModelVersionsClient) CreateOrUpdate

func (client *ModelVersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, body ModelVersion, options *ModelVersionsClientCreateOrUpdateOptions) (ModelVersionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. body - Version entity to create or update. options - ModelVersionsClientCreateOrUpdateOptions contains the optional parameters for the ModelVersionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelVersion/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	armmachinelearning.ModelVersion{
		Properties: &armmachinelearning.ModelVersionProperties{
			Description: to.Ptr("string"),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Tags: map[string]*string{
				"string": to.Ptr("string"),
			},
			IsAnonymous: to.Ptr(false),
			Flavors: map[string]*armmachinelearning.FlavorData{
				"string": {
					Data: map[string]*string{
						"string": to.Ptr("string"),
					},
				},
			},
			ModelType: to.Ptr("CustomModel"),
			ModelURI:  to.Ptr("string"),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ModelVersionsClient) Delete

func (client *ModelVersionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *ModelVersionsClientDeleteOptions) (ModelVersionsClientDeleteResponse, error)

Delete - Delete version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. options - ModelVersionsClientDeleteOptions contains the optional parameters for the ModelVersionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelVersion/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*ModelVersionsClient) Get

func (client *ModelVersionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, version string, options *ModelVersionsClientGetOptions) (ModelVersionsClientGetResponse, error)

Get - Get version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Container name. This is case-sensitive. version - Version identifier. This is case-sensitive. options - ModelVersionsClientGetOptions contains the optional parameters for the ModelVersionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelVersion/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"string",
	"string",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ModelVersionsClient) NewListPager

func (client *ModelVersionsClient) NewListPager(resourceGroupName string, workspaceName string, name string, options *ModelVersionsClientListOptions) *runtime.Pager[ModelVersionsClientListResponse]

NewListPager - List model versions. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. name - Model name. This is case-sensitive. options - ModelVersionsClientListOptions contains the optional parameters for the ModelVersionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ModelVersion/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewModelVersionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	"string",
	&armmachinelearning.ModelVersionsClientListOptions{Skip: nil,
		OrderBy:      to.Ptr("string"),
		Top:          to.Ptr[int32](1),
		Version:      to.Ptr("string"),
		Description:  to.Ptr("string"),
		Offset:       to.Ptr[int32](1),
		Tags:         to.Ptr("string"),
		Properties:   to.Ptr("string"),
		Feed:         nil,
		ListViewType: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ModelVersionsClientCreateOrUpdateOptions

type ModelVersionsClientCreateOrUpdateOptions struct {
}

ModelVersionsClientCreateOrUpdateOptions contains the optional parameters for the ModelVersionsClient.CreateOrUpdate method.

type ModelVersionsClientCreateOrUpdateResponse

type ModelVersionsClientCreateOrUpdateResponse struct {
	ModelVersion
}

ModelVersionsClientCreateOrUpdateResponse contains the response from method ModelVersionsClient.CreateOrUpdate.

type ModelVersionsClientDeleteOptions

type ModelVersionsClientDeleteOptions struct {
}

ModelVersionsClientDeleteOptions contains the optional parameters for the ModelVersionsClient.Delete method.

type ModelVersionsClientDeleteResponse

type ModelVersionsClientDeleteResponse struct {
}

ModelVersionsClientDeleteResponse contains the response from method ModelVersionsClient.Delete.

type ModelVersionsClientGetOptions

type ModelVersionsClientGetOptions struct {
}

ModelVersionsClientGetOptions contains the optional parameters for the ModelVersionsClient.Get method.

type ModelVersionsClientGetResponse

type ModelVersionsClientGetResponse struct {
	ModelVersion
}

ModelVersionsClientGetResponse contains the response from method ModelVersionsClient.Get.

type ModelVersionsClientListOptions

type ModelVersionsClientListOptions struct {
	// Model description.
	Description *string
	// Name of the feed.
	Feed *string
	// View type for including/excluding (for example) archived entities.
	ListViewType *ListViewType
	// Number of initial results to skip.
	Offset *int32
	// Ordering of list.
	OrderBy *string
	// Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2
	Properties *string
	// Continuation token for pagination.
	Skip *string
	// Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2
	Tags *string
	// Maximum number of records to return.
	Top *int32
	// Model version.
	Version *string
}

ModelVersionsClientListOptions contains the optional parameters for the ModelVersionsClient.List method.

type ModelVersionsClientListResponse

type ModelVersionsClientListResponse struct {
	ModelVersionResourceArmPaginatedResult
}

ModelVersionsClientListResponse contains the response from method ModelVersionsClient.List.

type MountAction

type MountAction string

MountAction - Mount Action.

const (
	MountActionMount   MountAction = "Mount"
	MountActionUnmount MountAction = "Unmount"
)

func PossibleMountActionValues

func PossibleMountActionValues() []MountAction

PossibleMountActionValues returns the possible values for the MountAction const type.

type MountState

type MountState string

MountState - Mount state.

const (
	MountStateMountFailed      MountState = "MountFailed"
	MountStateMountRequested   MountState = "MountRequested"
	MountStateMounted          MountState = "Mounted"
	MountStateUnmountFailed    MountState = "UnmountFailed"
	MountStateUnmountRequested MountState = "UnmountRequested"
	MountStateUnmounted        MountState = "Unmounted"
)

func PossibleMountStateValues

func PossibleMountStateValues() []MountState

PossibleMountStateValues returns the possible values for the MountState const type.

type Mpi

type Mpi struct {
	// REQUIRED; [Required] Specifies the type of distribution framework.
	DistributionType *DistributionType `json:"distributionType,omitempty"`

	// Number of processes per MPI node.
	ProcessCountPerInstance *int32 `json:"processCountPerInstance,omitempty"`
}

Mpi - MPI distribution configuration.

func (*Mpi) GetDistributionConfiguration

func (m *Mpi) GetDistributionConfiguration() *DistributionConfiguration

GetDistributionConfiguration implements the DistributionConfigurationClassification interface for type Mpi.

func (Mpi) MarshalJSON

func (m Mpi) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Mpi.

func (*Mpi) UnmarshalJSON

func (m *Mpi) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Mpi.

type Network

type Network string

Network - network of this container.

const (
	NetworkBridge Network = "Bridge"
	NetworkHost   Network = "Host"
)

func PossibleNetworkValues

func PossibleNetworkValues() []Network

PossibleNetworkValues returns the possible values for the Network const type.

type NodeState

type NodeState string

NodeState - State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.

const (
	NodeStateIdle      NodeState = "idle"
	NodeStateLeaving   NodeState = "leaving"
	NodeStatePreempted NodeState = "preempted"
	NodeStatePreparing NodeState = "preparing"
	NodeStateRunning   NodeState = "running"
	NodeStateUnusable  NodeState = "unusable"
)

func PossibleNodeStateValues

func PossibleNodeStateValues() []NodeState

PossibleNodeStateValues returns the possible values for the NodeState const type.

type NodeStateCounts

type NodeStateCounts struct {
	// READ-ONLY; Number of compute nodes in idle state.
	IdleNodeCount *int32 `json:"idleNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are leaving the amlCompute.
	LeavingNodeCount *int32 `json:"leavingNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are in preempted state.
	PreemptedNodeCount *int32 `json:"preemptedNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are being prepared.
	PreparingNodeCount *int32 `json:"preparingNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are running jobs.
	RunningNodeCount *int32 `json:"runningNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are in unusable state.
	UnusableNodeCount *int32 `json:"unusableNodeCount,omitempty" azure:"ro"`
}

NodeStateCounts - Counts of various compute node states on the amlCompute.

type NoneAuthTypeWorkspaceConnectionProperties

type NoneAuthTypeWorkspaceConnectionProperties struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType `json:"authType,omitempty"`

	// Category of the connection
	Category *ConnectionCategory `json:"category,omitempty"`
	Target   *string             `json:"target,omitempty"`

	// Value details of the workspace connection.
	Value *string `json:"value,omitempty"`

	// format for the workspace connection value
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

func (*NoneAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2

func (n *NoneAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2() *WorkspaceConnectionPropertiesV2

GetWorkspaceConnectionPropertiesV2 implements the WorkspaceConnectionPropertiesV2Classification interface for type NoneAuthTypeWorkspaceConnectionProperties.

func (NoneAuthTypeWorkspaceConnectionProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NoneAuthTypeWorkspaceConnectionProperties.

func (*NoneAuthTypeWorkspaceConnectionProperties) UnmarshalJSON

func (n *NoneAuthTypeWorkspaceConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NoneAuthTypeWorkspaceConnectionProperties.

type NoneDatastoreCredentials

type NoneDatastoreCredentials struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType `json:"credentialsType,omitempty"`
}

NoneDatastoreCredentials - Empty/none datastore credentials.

func (*NoneDatastoreCredentials) GetDatastoreCredentials

func (n *NoneDatastoreCredentials) GetDatastoreCredentials() *DatastoreCredentials

GetDatastoreCredentials implements the DatastoreCredentialsClassification interface for type NoneDatastoreCredentials.

func (NoneDatastoreCredentials) MarshalJSON

func (n NoneDatastoreCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NoneDatastoreCredentials.

func (*NoneDatastoreCredentials) UnmarshalJSON

func (n *NoneDatastoreCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NoneDatastoreCredentials.

type NotebookAccessTokenResult

type NotebookAccessTokenResult struct {
	// READ-ONLY
	AccessToken *string `json:"accessToken,omitempty" azure:"ro"`

	// READ-ONLY
	ExpiresIn *int32 `json:"expiresIn,omitempty" azure:"ro"`

	// READ-ONLY
	HostName *string `json:"hostName,omitempty" azure:"ro"`

	// READ-ONLY
	NotebookResourceID *string `json:"notebookResourceId,omitempty" azure:"ro"`

	// READ-ONLY
	PublicDNS *string `json:"publicDns,omitempty" azure:"ro"`

	// READ-ONLY
	RefreshToken *string `json:"refreshToken,omitempty" azure:"ro"`

	// READ-ONLY
	Scope *string `json:"scope,omitempty" azure:"ro"`

	// READ-ONLY
	TokenType *string `json:"tokenType,omitempty" azure:"ro"`
}

type NotebookPreparationError

type NotebookPreparationError struct {
	ErrorMessage *string `json:"errorMessage,omitempty"`
	StatusCode   *int32  `json:"statusCode,omitempty"`
}

type NotebookResourceInfo

type NotebookResourceInfo struct {
	Fqdn *string `json:"fqdn,omitempty"`

	// The error that occurs when preparing notebook.
	NotebookPreparationError *NotebookPreparationError `json:"notebookPreparationError,omitempty"`

	// the data plane resourceId that used to initialize notebook component
	ResourceID *string `json:"resourceId,omitempty"`
}

type Objective

type Objective struct {
	// REQUIRED; [Required] Defines supported metric goals for hyperparameter tuning
	Goal *Goal `json:"goal,omitempty"`

	// REQUIRED; [Required] Name of the metric to optimize.
	PrimaryMetric *string `json:"primaryMetric,omitempty"`
}

Objective - Optimization objective.

type OnlineDeployment

type OnlineDeployment struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties OnlineDeploymentPropertiesClassification `json:"properties,omitempty"`

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string `json:"kind,omitempty"`

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

func (OnlineDeployment) MarshalJSON

func (o OnlineDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineDeployment.

func (*OnlineDeployment) UnmarshalJSON

func (o *OnlineDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OnlineDeployment.

type OnlineDeploymentProperties

type OnlineDeploymentProperties struct {
	// REQUIRED; [Required] The compute type of the endpoint.
	EndpointComputeType *EndpointComputeType `json:"endpointComputeType,omitempty"`

	// If true, enables Application Insights logging.
	AppInsightsEnabled *bool `json:"appInsightsEnabled,omitempty"`

	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration `json:"codeConfiguration,omitempty"`

	// Description of the endpoint deployment.
	Description *string `json:"description,omitempty"`

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string `json:"environmentId,omitempty"`

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// Compute instance type.
	InstanceType *string `json:"instanceType,omitempty"`

	// Liveness probe monitors the health of the container regularly.
	LivenessProbe *ProbeSettings `json:"livenessProbe,omitempty"`

	// The URI path to the model.
	Model *string `json:"model,omitempty"`

	// The path to mount the model in custom container.
	ModelMountPath *string `json:"modelMountPath,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`

	// Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness
	// probe.
	ReadinessProbe *ProbeSettings `json:"readinessProbe,omitempty"`

	// Request settings for the deployment.
	RequestSettings *OnlineRequestSettings `json:"requestSettings,omitempty"`

	// Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment
	// and to DefaultScaleSettings for ManagedOnlineDeployment.
	ScaleSettings OnlineScaleSettingsClassification `json:"scaleSettings,omitempty"`

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

func (*OnlineDeploymentProperties) GetOnlineDeploymentProperties

func (o *OnlineDeploymentProperties) GetOnlineDeploymentProperties() *OnlineDeploymentProperties

GetOnlineDeploymentProperties implements the OnlineDeploymentPropertiesClassification interface for type OnlineDeploymentProperties.

func (OnlineDeploymentProperties) MarshalJSON

func (o OnlineDeploymentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineDeploymentProperties.

func (*OnlineDeploymentProperties) UnmarshalJSON

func (o *OnlineDeploymentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OnlineDeploymentProperties.

type OnlineDeploymentPropertiesClassification

type OnlineDeploymentPropertiesClassification interface {
	// GetOnlineDeploymentProperties returns the OnlineDeploymentProperties content of the underlying type.
	GetOnlineDeploymentProperties() *OnlineDeploymentProperties
}

OnlineDeploymentPropertiesClassification provides polymorphic access to related types. Call the interface's GetOnlineDeploymentProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *KubernetesOnlineDeployment, *ManagedOnlineDeployment, *OnlineDeploymentProperties

type OnlineDeploymentTrackedResourceArmPaginatedResult

type OnlineDeploymentTrackedResourceArmPaginatedResult struct {
	// The link to the next page of OnlineDeployment objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type OnlineDeployment.
	Value []*OnlineDeployment `json:"value,omitempty"`
}

OnlineDeploymentTrackedResourceArmPaginatedResult - A paginated list of OnlineDeployment entities.

type OnlineDeploymentsClient

type OnlineDeploymentsClient struct {
	// contains filtered or unexported fields
}

OnlineDeploymentsClient contains the methods for the OnlineDeployments group. Don't use this type directly, use NewOnlineDeploymentsClient() instead.

func NewOnlineDeploymentsClient

func NewOnlineDeploymentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OnlineDeploymentsClient, error)

NewOnlineDeploymentsClient creates a new instance of OnlineDeploymentsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OnlineDeploymentsClient) BeginCreateOrUpdate

func (client *OnlineDeploymentsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, body OnlineDeployment, options *OnlineDeploymentsClientBeginCreateOrUpdateOptions) (*runtime.Poller[OnlineDeploymentsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update Inference Endpoint Deployment (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name. deploymentName - Inference Endpoint Deployment name. body - Inference Endpoint entity to apply during operation. options - OnlineDeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the OnlineDeploymentsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineDeployment/KubernetesOnlineDeployment/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	"testDeploymentName",
	armmachinelearning.OnlineDeployment{
		Location: to.Ptr("string"),
		Tags:     map[string]*string{},
		Identity: &armmachinelearning.ManagedServiceIdentity{
			Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
			UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
				"string": {},
			},
		},
		Kind: to.Ptr("string"),
		Properties: &armmachinelearning.KubernetesOnlineDeployment{
			Description: to.Ptr("string"),
			CodeConfiguration: &armmachinelearning.CodeConfiguration{
				CodeID:        to.Ptr("string"),
				ScoringScript: to.Ptr("string"),
			},
			EnvironmentID: to.Ptr("string"),
			EnvironmentVariables: map[string]*string{
				"string": to.Ptr("string"),
			},
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			AppInsightsEnabled:  to.Ptr(false),
			EndpointComputeType: to.Ptr(armmachinelearning.EndpointComputeTypeKubernetes),
			InstanceType:        to.Ptr("string"),
			LivenessProbe: &armmachinelearning.ProbeSettings{
				FailureThreshold: to.Ptr[int32](1),
				InitialDelay:     to.Ptr("PT5M"),
				Period:           to.Ptr("PT5M"),
				SuccessThreshold: to.Ptr[int32](1),
				Timeout:          to.Ptr("PT5M"),
			},
			Model:          to.Ptr("string"),
			ModelMountPath: to.Ptr("string"),
			RequestSettings: &armmachinelearning.OnlineRequestSettings{
				MaxConcurrentRequestsPerInstance: to.Ptr[int32](1),
				MaxQueueWait:                     to.Ptr("PT5M"),
				RequestTimeout:                   to.Ptr("PT5M"),
			},
			ScaleSettings: &armmachinelearning.DefaultScaleSettings{
				ScaleType: to.Ptr(armmachinelearning.ScaleTypeDefault),
			},
			ContainerResourceRequirements: &armmachinelearning.ContainerResourceRequirements{
				ContainerResourceLimits: &armmachinelearning.ContainerResourceSettings{
					CPU:    to.Ptr("\"1\""),
					Gpu:    to.Ptr("\"1\""),
					Memory: to.Ptr("\"2Gi\""),
				},
				ContainerResourceRequests: &armmachinelearning.ContainerResourceSettings{
					CPU:    to.Ptr("\"1\""),
					Gpu:    to.Ptr("\"1\""),
					Memory: to.Ptr("\"2Gi\""),
				},
			},
		},
		SKU: &armmachinelearning.SKU{
			Name:     to.Ptr("string"),
			Capacity: to.Ptr[int32](1),
			Family:   to.Ptr("string"),
			Size:     to.Ptr("string"),
			Tier:     to.Ptr(armmachinelearning.SKUTierFree),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineDeploymentsClient) BeginDelete

func (client *OnlineDeploymentsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, options *OnlineDeploymentsClientBeginDeleteOptions) (*runtime.Poller[OnlineDeploymentsClientDeleteResponse], error)

BeginDelete - Delete Inference Endpoint Deployment (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name. deploymentName - Inference Endpoint Deployment name. options - OnlineDeploymentsClientBeginDeleteOptions contains the optional parameters for the OnlineDeploymentsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineDeployment/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx,
	"testrg123",
	"workspace123",
	"testEndpoint",
	"testDeployment",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*OnlineDeploymentsClient) BeginUpdate

func (client *OnlineDeploymentsClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, body PartialMinimalTrackedResourceWithSKU, options *OnlineDeploymentsClientBeginUpdateOptions) (*runtime.Poller[OnlineDeploymentsClientUpdateResponse], error)

BeginUpdate - Update Online Deployment (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. deploymentName - Inference Endpoint Deployment name. body - Online Endpoint entity to apply during operation. options - OnlineDeploymentsClientBeginUpdateOptions contains the optional parameters for the OnlineDeploymentsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineDeployment/KubernetesOnlineDeployment/update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	"testDeploymentName",
	armmachinelearning.PartialMinimalTrackedResourceWithSKU{
		Tags: map[string]*string{},
		SKU: &armmachinelearning.PartialSKU{
			Name:     to.Ptr("string"),
			Capacity: to.Ptr[int32](1),
			Family:   to.Ptr("string"),
			Size:     to.Ptr("string"),
			Tier:     to.Ptr(armmachinelearning.SKUTierFree),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineDeploymentsClient) Get

func (client *OnlineDeploymentsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, options *OnlineDeploymentsClientGetOptions) (OnlineDeploymentsClientGetResponse, error)

Get - Get Inference Deployment Deployment. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name. deploymentName - Inference Endpoint Deployment name. options - OnlineDeploymentsClientGetOptions contains the optional parameters for the OnlineDeploymentsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineDeployment/KubernetesOnlineDeployment/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	"testDeploymentName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineDeploymentsClient) GetLogs

func (client *OnlineDeploymentsClient) GetLogs(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, deploymentName string, body DeploymentLogsRequest, options *OnlineDeploymentsClientGetLogsOptions) (OnlineDeploymentsClientGetLogsResponse, error)

GetLogs - Polls an Endpoint operation. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name. deploymentName - The name and identifier for the endpoint. body - The request containing parameters for retrieving logs. options - OnlineDeploymentsClientGetLogsOptions contains the optional parameters for the OnlineDeploymentsClient.GetLogs method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineDeployment/getLogs.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetLogs(ctx,
	"testrg123",
	"workspace123",
	"testEndpoint",
	"testDeployment",
	armmachinelearning.DeploymentLogsRequest{
		ContainerType: to.Ptr(armmachinelearning.ContainerTypeStorageInitializer),
		Tail:          to.Ptr[int32](0),
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineDeploymentsClient) NewListPager

func (client *OnlineDeploymentsClient) NewListPager(resourceGroupName string, workspaceName string, endpointName string, options *OnlineDeploymentsClientListOptions) *runtime.Pager[OnlineDeploymentsClientListResponse]

NewListPager - List Inference Endpoint Deployments. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name. options - OnlineDeploymentsClientListOptions contains the optional parameters for the OnlineDeploymentsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineDeployment/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineDeploymentsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	"testEndpointName",
	&armmachinelearning.OnlineDeploymentsClientListOptions{OrderBy: to.Ptr("string"),
		Top:  to.Ptr[int32](1),
		Skip: nil,
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*OnlineDeploymentsClient) NewListSKUsPager

func (client *OnlineDeploymentsClient) NewListSKUsPager(resourceGroupName string, workspaceName string, endpointName string, deploymentName string, options *OnlineDeploymentsClientListSKUsOptions) *runtime.Pager[OnlineDeploymentsClientListSKUsResponse]

NewListSKUsPager - List Inference Endpoint Deployment Skus. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Inference endpoint name. deploymentName - Inference Endpoint Deployment name. options - OnlineDeploymentsClientListSKUsOptions contains the optional parameters for the OnlineDeploymentsClient.ListSKUs method.

type OnlineDeploymentsClientBeginCreateOrUpdateOptions

type OnlineDeploymentsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OnlineDeploymentsClientBeginCreateOrUpdateOptions contains the optional parameters for the OnlineDeploymentsClient.BeginCreateOrUpdate method.

type OnlineDeploymentsClientBeginDeleteOptions

type OnlineDeploymentsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OnlineDeploymentsClientBeginDeleteOptions contains the optional parameters for the OnlineDeploymentsClient.BeginDelete method.

type OnlineDeploymentsClientBeginUpdateOptions

type OnlineDeploymentsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OnlineDeploymentsClientBeginUpdateOptions contains the optional parameters for the OnlineDeploymentsClient.BeginUpdate method.

type OnlineDeploymentsClientCreateOrUpdateResponse

type OnlineDeploymentsClientCreateOrUpdateResponse struct {
	OnlineDeployment
}

OnlineDeploymentsClientCreateOrUpdateResponse contains the response from method OnlineDeploymentsClient.CreateOrUpdate.

type OnlineDeploymentsClientDeleteResponse

type OnlineDeploymentsClientDeleteResponse struct {
}

OnlineDeploymentsClientDeleteResponse contains the response from method OnlineDeploymentsClient.Delete.

type OnlineDeploymentsClientGetLogsOptions

type OnlineDeploymentsClientGetLogsOptions struct {
}

OnlineDeploymentsClientGetLogsOptions contains the optional parameters for the OnlineDeploymentsClient.GetLogs method.

type OnlineDeploymentsClientGetLogsResponse

type OnlineDeploymentsClientGetLogsResponse struct {
	DeploymentLogs
}

OnlineDeploymentsClientGetLogsResponse contains the response from method OnlineDeploymentsClient.GetLogs.

type OnlineDeploymentsClientGetOptions

type OnlineDeploymentsClientGetOptions struct {
}

OnlineDeploymentsClientGetOptions contains the optional parameters for the OnlineDeploymentsClient.Get method.

type OnlineDeploymentsClientGetResponse

type OnlineDeploymentsClientGetResponse struct {
	OnlineDeployment
}

OnlineDeploymentsClientGetResponse contains the response from method OnlineDeploymentsClient.Get.

type OnlineDeploymentsClientListOptions

type OnlineDeploymentsClientListOptions struct {
	// Ordering of list.
	OrderBy *string
	// Continuation token for pagination.
	Skip *string
	// Top of list.
	Top *int32
}

OnlineDeploymentsClientListOptions contains the optional parameters for the OnlineDeploymentsClient.List method.

type OnlineDeploymentsClientListResponse

type OnlineDeploymentsClientListResponse struct {
	OnlineDeploymentTrackedResourceArmPaginatedResult
}

OnlineDeploymentsClientListResponse contains the response from method OnlineDeploymentsClient.List.

type OnlineDeploymentsClientListSKUsOptions

type OnlineDeploymentsClientListSKUsOptions struct {
	// Number of Skus to be retrieved in a page of results.
	Count *int32
	// Continuation token for pagination.
	Skip *string
}

OnlineDeploymentsClientListSKUsOptions contains the optional parameters for the OnlineDeploymentsClient.ListSKUs method.

type OnlineDeploymentsClientListSKUsResponse

type OnlineDeploymentsClientListSKUsResponse struct {
	SKUResourceArmPaginatedResult
}

OnlineDeploymentsClientListSKUsResponse contains the response from method OnlineDeploymentsClient.ListSKUs.

type OnlineDeploymentsClientUpdateResponse

type OnlineDeploymentsClientUpdateResponse struct {
	OnlineDeployment
}

OnlineDeploymentsClientUpdateResponse contains the response from method OnlineDeploymentsClient.Update.

type OnlineEndpoint

type OnlineEndpoint struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *OnlineEndpointProperties `json:"properties,omitempty"`

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string `json:"kind,omitempty"`

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

func (OnlineEndpoint) MarshalJSON

func (o OnlineEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineEndpoint.

type OnlineEndpointProperties

type OnlineEndpointProperties struct {
	// REQUIRED; [Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication.
	// 'Key' doesn't expire but 'AMLToken' does.
	AuthMode *EndpointAuthMode `json:"authMode,omitempty"`

	// ARM resource ID of the compute if it exists. optional
	Compute *string `json:"compute,omitempty"`

	// Description of the inference endpoint.
	Description *string `json:"description,omitempty"`

	// EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be
	// retrieved using the ListKeys API.
	Keys *EndpointAuthKeys `json:"keys,omitempty"`

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string `json:"properties,omitempty"`

	// Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.
	Traffic map[string]*int32 `json:"traffic,omitempty"`

	// READ-ONLY; Provisioning state for the endpoint.
	ProvisioningState *EndpointProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Endpoint URI.
	ScoringURI *string `json:"scoringUri,omitempty" azure:"ro"`

	// READ-ONLY; Endpoint Swagger URI.
	SwaggerURI *string `json:"swaggerUri,omitempty" azure:"ro"`
}

OnlineEndpointProperties - Online endpoint configuration

func (OnlineEndpointProperties) MarshalJSON

func (o OnlineEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineEndpointProperties.

type OnlineEndpointTrackedResourceArmPaginatedResult

type OnlineEndpointTrackedResourceArmPaginatedResult struct {
	// The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type OnlineEndpoint.
	Value []*OnlineEndpoint `json:"value,omitempty"`
}

OnlineEndpointTrackedResourceArmPaginatedResult - A paginated list of OnlineEndpoint entities.

type OnlineEndpointsClient

type OnlineEndpointsClient struct {
	// contains filtered or unexported fields
}

OnlineEndpointsClient contains the methods for the OnlineEndpoints group. Don't use this type directly, use NewOnlineEndpointsClient() instead.

func NewOnlineEndpointsClient

func NewOnlineEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OnlineEndpointsClient, error)

NewOnlineEndpointsClient creates a new instance of OnlineEndpointsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OnlineEndpointsClient) BeginCreateOrUpdate

func (client *OnlineEndpointsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, body OnlineEndpoint, options *OnlineEndpointsClientBeginCreateOrUpdateOptions) (*runtime.Poller[OnlineEndpointsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update Online Endpoint (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. body - Online Endpoint entity to apply during operation. options - OnlineEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the OnlineEndpointsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	armmachinelearning.OnlineEndpoint{
		Location: to.Ptr("string"),
		Tags:     map[string]*string{},
		Identity: &armmachinelearning.ManagedServiceIdentity{
			Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
			UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
				"string": {},
			},
		},
		Kind: to.Ptr("string"),
		Properties: &armmachinelearning.OnlineEndpointProperties{
			Description: to.Ptr("string"),
			AuthMode:    to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
			Properties: map[string]*string{
				"string": to.Ptr("string"),
			},
			Compute: to.Ptr("string"),
			Traffic: map[string]*int32{
				"string": to.Ptr[int32](1),
			},
		},
		SKU: &armmachinelearning.SKU{
			Name:     to.Ptr("string"),
			Capacity: to.Ptr[int32](1),
			Family:   to.Ptr("string"),
			Size:     to.Ptr("string"),
			Tier:     to.Ptr(armmachinelearning.SKUTierFree),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineEndpointsClient) BeginDelete

func (client *OnlineEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, options *OnlineEndpointsClientBeginDeleteOptions) (*runtime.Poller[OnlineEndpointsClientDeleteResponse], error)

BeginDelete - Delete Online Endpoint (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. options - OnlineEndpointsClientBeginDeleteOptions contains the optional parameters for the OnlineEndpointsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*OnlineEndpointsClient) BeginRegenerateKeys

BeginRegenerateKeys - Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. body - RegenerateKeys request . options - OnlineEndpointsClientBeginRegenerateKeysOptions contains the optional parameters for the OnlineEndpointsClient.BeginRegenerateKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/regenerateKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginRegenerateKeys(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	armmachinelearning.RegenerateEndpointKeysRequest{
		KeyType:  to.Ptr(armmachinelearning.KeyTypePrimary),
		KeyValue: to.Ptr("string"),
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*OnlineEndpointsClient) BeginUpdate

BeginUpdate - Update Online Endpoint (asynchronous). If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. body - Online Endpoint entity to apply during operation. options - OnlineEndpointsClientBeginUpdateOptions contains the optional parameters for the OnlineEndpointsClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	armmachinelearning.PartialMinimalTrackedResourceWithIdentity{
		Tags: map[string]*string{},
		Identity: &armmachinelearning.PartialManagedServiceIdentity{
			Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
			UserAssignedIdentities: map[string]interface{}{
				"string": map[string]interface{}{},
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineEndpointsClient) Get

func (client *OnlineEndpointsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, options *OnlineEndpointsClientGetOptions) (OnlineEndpointsClientGetResponse, error)

Get - Get Online Endpoint. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. options - OnlineEndpointsClientGetOptions contains the optional parameters for the OnlineEndpointsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineEndpointsClient) GetToken

func (client *OnlineEndpointsClient) GetToken(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, options *OnlineEndpointsClientGetTokenOptions) (OnlineEndpointsClientGetTokenResponse, error)

GetToken - Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. options - OnlineEndpointsClientGetTokenOptions contains the optional parameters for the OnlineEndpointsClient.GetToken method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/getToken.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetToken(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineEndpointsClient) ListKeys

func (client *OnlineEndpointsClient) ListKeys(ctx context.Context, resourceGroupName string, workspaceName string, endpointName string, options *OnlineEndpointsClientListKeysOptions) (OnlineEndpointsClientListKeysResponse, error)

ListKeys - List EndpointAuthKeys for an Endpoint using Key-based authentication. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. endpointName - Online Endpoint name. options - OnlineEndpointsClientListKeysOptions contains the optional parameters for the OnlineEndpointsClient.ListKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/listKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListKeys(ctx,
	"test-rg",
	"my-aml-workspace",
	"testEndpointName",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*OnlineEndpointsClient) NewListPager

func (client *OnlineEndpointsClient) NewListPager(resourceGroupName string, workspaceName string, options *OnlineEndpointsClientListOptions) *runtime.Pager[OnlineEndpointsClientListResponse]

NewListPager - List Online Endpoints. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - OnlineEndpointsClientListOptions contains the optional parameters for the OnlineEndpointsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/OnlineEndpoint/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOnlineEndpointsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("test-rg",
	"my-aml-workspace",
	&armmachinelearning.OnlineEndpointsClientListOptions{Name: to.Ptr("string"),
		Count:       to.Ptr[int32](1),
		ComputeType: to.Ptr(armmachinelearning.EndpointComputeTypeManaged),
		Skip:        nil,
		Tags:        to.Ptr("string"),
		Properties:  to.Ptr("string"),
		OrderBy:     to.Ptr(armmachinelearning.OrderStringCreatedAtDesc),
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type OnlineEndpointsClientBeginCreateOrUpdateOptions

type OnlineEndpointsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OnlineEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the OnlineEndpointsClient.BeginCreateOrUpdate method.

type OnlineEndpointsClientBeginDeleteOptions

type OnlineEndpointsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OnlineEndpointsClientBeginDeleteOptions contains the optional parameters for the OnlineEndpointsClient.BeginDelete method.

type OnlineEndpointsClientBeginRegenerateKeysOptions

type OnlineEndpointsClientBeginRegenerateKeysOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OnlineEndpointsClientBeginRegenerateKeysOptions contains the optional parameters for the OnlineEndpointsClient.BeginRegenerateKeys method.

type OnlineEndpointsClientBeginUpdateOptions

type OnlineEndpointsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OnlineEndpointsClientBeginUpdateOptions contains the optional parameters for the OnlineEndpointsClient.BeginUpdate method.

type OnlineEndpointsClientCreateOrUpdateResponse

type OnlineEndpointsClientCreateOrUpdateResponse struct {
	OnlineEndpoint
}

OnlineEndpointsClientCreateOrUpdateResponse contains the response from method OnlineEndpointsClient.CreateOrUpdate.

type OnlineEndpointsClientDeleteResponse

type OnlineEndpointsClientDeleteResponse struct {
}

OnlineEndpointsClientDeleteResponse contains the response from method OnlineEndpointsClient.Delete.

type OnlineEndpointsClientGetOptions

type OnlineEndpointsClientGetOptions struct {
}

OnlineEndpointsClientGetOptions contains the optional parameters for the OnlineEndpointsClient.Get method.

type OnlineEndpointsClientGetResponse

type OnlineEndpointsClientGetResponse struct {
	OnlineEndpoint
}

OnlineEndpointsClientGetResponse contains the response from method OnlineEndpointsClient.Get.

type OnlineEndpointsClientGetTokenOptions

type OnlineEndpointsClientGetTokenOptions struct {
}

OnlineEndpointsClientGetTokenOptions contains the optional parameters for the OnlineEndpointsClient.GetToken method.

type OnlineEndpointsClientGetTokenResponse

type OnlineEndpointsClientGetTokenResponse struct {
	EndpointAuthToken
}

OnlineEndpointsClientGetTokenResponse contains the response from method OnlineEndpointsClient.GetToken.

type OnlineEndpointsClientListKeysOptions

type OnlineEndpointsClientListKeysOptions struct {
}

OnlineEndpointsClientListKeysOptions contains the optional parameters for the OnlineEndpointsClient.ListKeys method.

type OnlineEndpointsClientListKeysResponse

type OnlineEndpointsClientListKeysResponse struct {
	EndpointAuthKeys
}

OnlineEndpointsClientListKeysResponse contains the response from method OnlineEndpointsClient.ListKeys.

type OnlineEndpointsClientListOptions

type OnlineEndpointsClientListOptions struct {
	// EndpointComputeType to be filtered by.
	ComputeType *EndpointComputeType
	// Number of endpoints to be retrieved in a page of results.
	Count *int32
	// Name of the endpoint.
	Name *string
	// The option to order the response.
	OrderBy *OrderString
	// A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties
	// key=value Example: propKey1,propKey2,propKey3=value3 .
	Properties *string
	// Continuation token for pagination.
	Skip *string
	// A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example:
	// tagKey1,tagKey2,tagKey3=value3 .
	Tags *string
}

OnlineEndpointsClientListOptions contains the optional parameters for the OnlineEndpointsClient.List method.

type OnlineEndpointsClientListResponse

type OnlineEndpointsClientListResponse struct {
	OnlineEndpointTrackedResourceArmPaginatedResult
}

OnlineEndpointsClientListResponse contains the response from method OnlineEndpointsClient.List.

type OnlineEndpointsClientRegenerateKeysResponse

type OnlineEndpointsClientRegenerateKeysResponse struct {
}

OnlineEndpointsClientRegenerateKeysResponse contains the response from method OnlineEndpointsClient.RegenerateKeys.

type OnlineEndpointsClientUpdateResponse

type OnlineEndpointsClientUpdateResponse struct {
	OnlineEndpoint
}

OnlineEndpointsClientUpdateResponse contains the response from method OnlineEndpointsClient.Update.

type OnlineRequestSettings

type OnlineRequestSettings struct {
	// The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.
	MaxConcurrentRequestsPerInstance *int32 `json:"maxConcurrentRequestsPerInstance,omitempty"`

	// The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms.
	MaxQueueWait *string `json:"maxQueueWait,omitempty"`

	// The scoring timeout in ISO 8601 format. Defaults to 5000ms.
	RequestTimeout *string `json:"requestTimeout,omitempty"`
}

OnlineRequestSettings - Online deployment scoring requests configuration.

type OnlineScaleSettings

type OnlineScaleSettings struct {
	// REQUIRED; [Required] Type of deployment scaling algorithm
	ScaleType *ScaleType `json:"scaleType,omitempty"`
}

OnlineScaleSettings - Online deployment scaling configuration.

func (*OnlineScaleSettings) GetOnlineScaleSettings

func (o *OnlineScaleSettings) GetOnlineScaleSettings() *OnlineScaleSettings

GetOnlineScaleSettings implements the OnlineScaleSettingsClassification interface for type OnlineScaleSettings.

type OnlineScaleSettingsClassification

type OnlineScaleSettingsClassification interface {
	// GetOnlineScaleSettings returns the OnlineScaleSettings content of the underlying type.
	GetOnlineScaleSettings() *OnlineScaleSettings
}

OnlineScaleSettingsClassification provides polymorphic access to related types. Call the interface's GetOnlineScaleSettings() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DefaultScaleSettings, *OnlineScaleSettings, *TargetUtilizationScaleSettings

type OperatingSystemType

type OperatingSystemType string

OperatingSystemType - The type of operating system.

const (
	OperatingSystemTypeLinux   OperatingSystemType = "Linux"
	OperatingSystemTypeWindows OperatingSystemType = "Windows"
)

func PossibleOperatingSystemTypeValues

func PossibleOperatingSystemTypeValues() []OperatingSystemType

PossibleOperatingSystemTypeValues returns the possible values for the OperatingSystemType const type.

type OperationName

type OperationName string

OperationName - Name of the last operation.

const (
	OperationNameCreate  OperationName = "Create"
	OperationNameDelete  OperationName = "Delete"
	OperationNameReimage OperationName = "Reimage"
	OperationNameRestart OperationName = "Restart"
	OperationNameStart   OperationName = "Start"
	OperationNameStop    OperationName = "Stop"
)

func PossibleOperationNameValues

func PossibleOperationNameValues() []OperationName

PossibleOperationNameValues returns the possible values for the OperationName const type.

type OperationStatus

type OperationStatus string

OperationStatus - Operation status.

const (
	OperationStatusCreateFailed  OperationStatus = "CreateFailed"
	OperationStatusDeleteFailed  OperationStatus = "DeleteFailed"
	OperationStatusInProgress    OperationStatus = "InProgress"
	OperationStatusReimageFailed OperationStatus = "ReimageFailed"
	OperationStatusRestartFailed OperationStatus = "RestartFailed"
	OperationStatusStartFailed   OperationStatus = "StartFailed"
	OperationStatusStopFailed    OperationStatus = "StopFailed"
	OperationStatusSucceeded     OperationStatus = "Succeeded"
)

func PossibleOperationStatusValues

func PossibleOperationStatusValues() []OperationStatus

PossibleOperationStatusValues returns the possible values for the OperationStatus const type.

type OperationTrigger

type OperationTrigger string

OperationTrigger - Trigger of operation.

const (
	OperationTriggerIdleShutdown OperationTrigger = "IdleShutdown"
	OperationTriggerSchedule     OperationTrigger = "Schedule"
	OperationTriggerUser         OperationTrigger = "User"
)

func PossibleOperationTriggerValues

func PossibleOperationTriggerValues() []OperationTrigger

PossibleOperationTriggerValues returns the possible values for the OperationTrigger const type.

type OperationsClient

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager

NewListPager - Lists all of the available Azure Machine Learning Workspaces REST API operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/operationsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewOperationsClient(cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	AmlOperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OrderString

type OrderString string
const (
	OrderStringCreatedAtAsc  OrderString = "CreatedAtAsc"
	OrderStringCreatedAtDesc OrderString = "CreatedAtDesc"
	OrderStringUpdatedAtAsc  OrderString = "UpdatedAtAsc"
	OrderStringUpdatedAtDesc OrderString = "UpdatedAtDesc"
)

func PossibleOrderStringValues

func PossibleOrderStringValues() []OrderString

PossibleOrderStringValues returns the possible values for the OrderString const type.

type OsType

type OsType string

OsType - Compute OS Type

const (
	OsTypeLinux   OsType = "Linux"
	OsTypeWindows OsType = "Windows"
)

func PossibleOsTypeValues

func PossibleOsTypeValues() []OsType

PossibleOsTypeValues returns the possible values for the OsType const type.

type OutputDeliveryMode

type OutputDeliveryMode string

OutputDeliveryMode - Output data delivery mode enums.

const (
	OutputDeliveryModeReadWriteMount OutputDeliveryMode = "ReadWriteMount"
	OutputDeliveryModeUpload         OutputDeliveryMode = "Upload"
)

func PossibleOutputDeliveryModeValues

func PossibleOutputDeliveryModeValues() []OutputDeliveryMode

PossibleOutputDeliveryModeValues returns the possible values for the OutputDeliveryMode const type.

type OutputPathAssetReference

type OutputPathAssetReference struct {
	// REQUIRED; [Required] Specifies the type of asset reference.
	ReferenceType *ReferenceType `json:"referenceType,omitempty"`

	// ARM resource ID of the job.
	JobID *string `json:"jobId,omitempty"`

	// The path of the file/directory in the job output.
	Path *string `json:"path,omitempty"`
}

OutputPathAssetReference - Reference to an asset via its path in a job output.

func (*OutputPathAssetReference) GetAssetReferenceBase

func (o *OutputPathAssetReference) GetAssetReferenceBase() *AssetReferenceBase

GetAssetReferenceBase implements the AssetReferenceBaseClassification interface for type OutputPathAssetReference.

func (OutputPathAssetReference) MarshalJSON

func (o OutputPathAssetReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutputPathAssetReference.

func (*OutputPathAssetReference) UnmarshalJSON

func (o *OutputPathAssetReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutputPathAssetReference.

type PATAuthTypeWorkspaceConnectionProperties

type PATAuthTypeWorkspaceConnectionProperties struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType `json:"authType,omitempty"`

	// Category of the connection
	Category    *ConnectionCategory                     `json:"category,omitempty"`
	Credentials *WorkspaceConnectionPersonalAccessToken `json:"credentials,omitempty"`
	Target      *string                                 `json:"target,omitempty"`

	// Value details of the workspace connection.
	Value *string `json:"value,omitempty"`

	// format for the workspace connection value
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

func (*PATAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2

func (p *PATAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2() *WorkspaceConnectionPropertiesV2

GetWorkspaceConnectionPropertiesV2 implements the WorkspaceConnectionPropertiesV2Classification interface for type PATAuthTypeWorkspaceConnectionProperties.

func (PATAuthTypeWorkspaceConnectionProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PATAuthTypeWorkspaceConnectionProperties.

func (*PATAuthTypeWorkspaceConnectionProperties) UnmarshalJSON

func (p *PATAuthTypeWorkspaceConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PATAuthTypeWorkspaceConnectionProperties.

type PaginatedComputeResourcesList

type PaginatedComputeResourcesList struct {
	// A continuation link (absolute URI) to the next page of results in the list.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of Machine Learning compute objects wrapped in ARM resource envelope.
	Value []*ComputeResource `json:"value,omitempty"`
}

PaginatedComputeResourcesList - Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.

type PartialBatchDeployment

type PartialBatchDeployment struct {
	// Description of the endpoint deployment.
	Description *string `json:"description,omitempty"`
}

PartialBatchDeployment - Mutable batch inference settings per deployment.

type PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties

type PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties struct {
	// Additional attributes of the entity.
	Properties *PartialBatchDeployment `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties - Strictly used in update requests.

func (PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties.

type PartialManagedServiceIdentity

type PartialManagedServiceIdentity struct {
	// Managed service identity (system assigned and/or user assigned identities)
	Type *ManagedServiceIdentityType `json:"type,omitempty"`

	// The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM
	// resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
	// The dictionary values can be empty objects ({}) in
	// requests.
	UserAssignedIdentities map[string]interface{} `json:"userAssignedIdentities,omitempty"`
}

PartialManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities)

func (PartialManagedServiceIdentity) MarshalJSON

func (p PartialManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartialManagedServiceIdentity.

type PartialMinimalTrackedResource

type PartialMinimalTrackedResource struct {
	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

PartialMinimalTrackedResource - Strictly used in update requests.

func (PartialMinimalTrackedResource) MarshalJSON

func (p PartialMinimalTrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartialMinimalTrackedResource.

type PartialMinimalTrackedResourceWithIdentity

type PartialMinimalTrackedResourceWithIdentity struct {
	// Managed service identity (system assigned and/or user assigned identities)
	Identity *PartialManagedServiceIdentity `json:"identity,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

PartialMinimalTrackedResourceWithIdentity - Strictly used in update requests.

func (PartialMinimalTrackedResourceWithIdentity) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PartialMinimalTrackedResourceWithIdentity.

type PartialMinimalTrackedResourceWithSKU

type PartialMinimalTrackedResourceWithSKU struct {
	// Sku details required for ARM contract for Autoscaling.
	SKU *PartialSKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

PartialMinimalTrackedResourceWithSKU - Strictly used in update requests.

func (PartialMinimalTrackedResourceWithSKU) MarshalJSON

func (p PartialMinimalTrackedResourceWithSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartialMinimalTrackedResourceWithSKU.

type PartialSKU

type PartialSKU struct {
	// If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the
	// resource this may be omitted.
	Capacity *int32 `json:"capacity,omitempty"`

	// If the service has different generations of hardware, for the same SKU, then that can be captured here.
	Family *string `json:"family,omitempty"`

	// The name of the SKU. Ex - P3. It is typically a letter+number code.
	Name *string `json:"name,omitempty"`

	// The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
	Size *string `json:"size,omitempty"`

	// This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required
	// on a PUT.
	Tier *SKUTier `json:"tier,omitempty"`
}

PartialSKU - Common SKU definition.

type Password

type Password struct {
	// READ-ONLY
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY
	Value *string `json:"value,omitempty" azure:"ro"`
}

type PersonalComputeInstanceSettings

type PersonalComputeInstanceSettings struct {
	// A user explicitly assigned to a personal compute instance.
	AssignedUser *AssignedUser `json:"assignedUser,omitempty"`
}

PersonalComputeInstanceSettings - Settings for a personal compute instance.

type PipelineJob

type PipelineJob struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobType *JobType `json:"jobType,omitempty"`

	// ARM resource ID of the compute resource.
	ComputeID *string `json:"computeId,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Display name of job.
	DisplayName *string `json:"displayName,omitempty"`

	// The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
	ExperimentName *string `json:"experimentName,omitempty"`

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification `json:"identity,omitempty"`

	// Inputs for the pipeline job.
	Inputs map[string]JobInputClassification `json:"inputs,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// Jobs construct the Pipeline Job.
	Jobs map[string]interface{} `json:"jobs,omitempty"`

	// Outputs for the pipeline job
	Outputs map[string]JobOutputClassification `json:"outputs,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
	Services map[string]*JobService `json:"services,omitempty"`

	// Pipeline settings, for things like ContinueRunOnStepFailure etc.
	Settings interface{} `json:"settings,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Status of the job.
	Status *JobStatus `json:"status,omitempty" azure:"ro"`
}

PipelineJob - Pipeline Job definition: defines generic to MFE attributes.

func (*PipelineJob) GetJobBaseProperties

func (p *PipelineJob) GetJobBaseProperties() *JobBaseProperties

GetJobBaseProperties implements the JobBasePropertiesClassification interface for type PipelineJob.

func (PipelineJob) MarshalJSON

func (p PipelineJob) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PipelineJob.

func (*PipelineJob) UnmarshalJSON

func (p *PipelineJob) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PipelineJob.

type PrivateEndpoint

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The ARM identifier for Subnet resource that private endpoint links to
	SubnetArmID *string `json:"subnetArmId,omitempty" azure:"ro"`
}

PrivateEndpoint - The Private Endpoint resource.

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// The sku of the workspace.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - The Private Endpoint Connection resource.

func (PrivateEndpointConnection) MarshalJSON

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - List of private endpoint connection associated with the specified workspace

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state.

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient

type PrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) CreateOrUpdate

func (client *PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, properties PrivateEndpointConnection, options *PrivateEndpointConnectionsClientCreateOrUpdateOptions) (PrivateEndpointConnectionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Update the state of specified private endpoint connection associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. privateEndpointConnectionName - The name of the private endpoint connection associated with the workspace properties - The private endpoint connection properties. options - PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/PrivateEndpointConnection/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx,
	"rg-1234",
	"testworkspace",
	"{privateEndpointConnectionName}",
	armmachinelearning.PrivateEndpointConnection{
		Properties: &armmachinelearning.PrivateEndpointConnectionProperties{
			PrivateLinkServiceConnectionState: &armmachinelearning.PrivateLinkServiceConnectionState{
				Description: to.Ptr("Auto-Approved"),
				Status:      to.Ptr(armmachinelearning.PrivateEndpointServiceConnectionStatusApproved),
			},
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateEndpointConnectionsClient) Delete

func (client *PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientDeleteOptions) (PrivateEndpointConnectionsClientDeleteResponse, error)

Delete - Deletes the specified private endpoint connection associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. privateEndpointConnectionName - The name of the private endpoint connection associated with the workspace options - PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/PrivateEndpointConnection/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"rg-1234",
	"testworkspace",
	"{privateEndpointConnectionName}",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*PrivateEndpointConnectionsClient) Get

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. privateEndpointConnectionName - The name of the private endpoint connection associated with the workspace options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/PrivateEndpointConnection/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"rg-1234",
	"testworkspace",
	"{privateEndpointConnectionName}",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateEndpointConnectionsClient) NewListPager

NewListPager - List all the private endpoint connections associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/PrivateEndpointConnection/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg-1234",
	"testworkspace",
	nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type PrivateEndpointConnectionsClientCreateOrUpdateOptions

type PrivateEndpointConnectionsClientCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteOptions

type PrivateEndpointConnectionsClientDeleteOptions struct {
}

PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

type PrivateEndpointConnectionsClientDeleteResponse

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

type PrivateEndpointConnectionsClientListResponse

type PrivateEndpointConnectionsClientListResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.List.

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status.

const (
	PrivateEndpointServiceConnectionStatusApproved     PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusDisconnected PrivateEndpointServiceConnectionStatus = "Disconnected"
	PrivateEndpointServiceConnectionStatusPending      PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected     PrivateEndpointServiceConnectionStatus = "Rejected"
	PrivateEndpointServiceConnectionStatusTimeout      PrivateEndpointServiceConnectionStatus = "Timeout"
)

func PossiblePrivateEndpointServiceConnectionStatusValues

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource

type PrivateLinkResource struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// The sku of the workspace.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON

func (p PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

type PrivateLinkResourceProperties

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) List

List - Gets the private link resources that need to be created for a workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/PrivateLinkResource/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewPrivateLinkResourcesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx,
	"rg-1234",
	"testworkspace",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type PrivateLinkResourcesClientListOptions

type PrivateLinkResourcesClientListOptions struct {
}

PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

type PrivateLinkResourcesClientListResponse

type PrivateLinkResourcesClientListResponse struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListResponse contains the response from method PrivateLinkResourcesClient.List.

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type ProbeSettings

type ProbeSettings struct {
	// The number of failures to allow before returning an unhealthy status.
	FailureThreshold *int32 `json:"failureThreshold,omitempty"`

	// The delay before the first probe in ISO 8601 format.
	InitialDelay *string `json:"initialDelay,omitempty"`

	// The length of time between probes in ISO 8601 format.
	Period *string `json:"period,omitempty"`

	// The number of successful probes before returning a healthy status.
	SuccessThreshold *int32 `json:"successThreshold,omitempty"`

	// The probe timeout in ISO 8601 format.
	Timeout *string `json:"timeout,omitempty"`
}

ProbeSettings - Deployment container liveness/readiness probe configuration.

type ProvisioningState

type ProvisioningState string

ProvisioningState - The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.

const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUnknown   ProvisioningState = "Unknown"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProvisioningStatus

type ProvisioningStatus string

ProvisioningStatus - The current deployment state of schedule.

const (
	ProvisioningStatusCompleted    ProvisioningStatus = "Completed"
	ProvisioningStatusFailed       ProvisioningStatus = "Failed"
	ProvisioningStatusProvisioning ProvisioningStatus = "Provisioning"
)

func PossibleProvisioningStatusValues

func PossibleProvisioningStatusValues() []ProvisioningStatus

PossibleProvisioningStatusValues returns the possible values for the ProvisioningStatus const type.

type PublicNetworkAccess

type PublicNetworkAccess string

PublicNetworkAccess - Whether requests from Public Network are allowed.

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

type PyTorch

type PyTorch struct {
	// REQUIRED; [Required] Specifies the type of distribution framework.
	DistributionType *DistributionType `json:"distributionType,omitempty"`

	// Number of processes per node.
	ProcessCountPerInstance *int32 `json:"processCountPerInstance,omitempty"`
}

PyTorch distribution configuration.

func (*PyTorch) GetDistributionConfiguration

func (p *PyTorch) GetDistributionConfiguration() *DistributionConfiguration

GetDistributionConfiguration implements the DistributionConfigurationClassification interface for type PyTorch.

func (PyTorch) MarshalJSON

func (p PyTorch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PyTorch.

func (*PyTorch) UnmarshalJSON

func (p *PyTorch) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PyTorch.

type QuotaBaseProperties

type QuotaBaseProperties struct {
	// Specifies the resource ID.
	ID *string `json:"id,omitempty"`

	// The maximum permitted quota of the resource.
	Limit *int64 `json:"limit,omitempty"`

	// Specifies the resource type.
	Type *string `json:"type,omitempty"`

	// An enum describing the unit of quota measurement.
	Unit *QuotaUnit `json:"unit,omitempty"`
}

QuotaBaseProperties - The properties for Quota update or retrieval.

type QuotaUnit

type QuotaUnit string

QuotaUnit - An enum describing the unit of quota measurement.

const (
	QuotaUnitCount QuotaUnit = "Count"
)

func PossibleQuotaUnitValues

func PossibleQuotaUnitValues() []QuotaUnit

PossibleQuotaUnitValues returns the possible values for the QuotaUnit const type.

type QuotaUpdateParameters

type QuotaUpdateParameters struct {
	// Region of workspace quota to be updated.
	Location *string `json:"location,omitempty"`

	// The list for update quota.
	Value []*QuotaBaseProperties `json:"value,omitempty"`
}

QuotaUpdateParameters - Quota update parameters.

func (QuotaUpdateParameters) MarshalJSON

func (q QuotaUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaUpdateParameters.

type QuotasClient

type QuotasClient struct {
	// contains filtered or unexported fields
}

QuotasClient contains the methods for the Quotas group. Don't use this type directly, use NewQuotasClient() instead.

func NewQuotasClient

func NewQuotasClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*QuotasClient, error)

NewQuotasClient creates a new instance of QuotasClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*QuotasClient) NewListPager

func (client *QuotasClient) NewListPager(location string, options *QuotasClientListOptions) *runtime.Pager[QuotasClientListResponse]

NewListPager - Gets the currently assigned Workspace Quotas based on VMFamily. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location for which resource usage is queried. options - QuotasClientListOptions contains the optional parameters for the QuotasClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Quota/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewQuotasClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("eastus",
	nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*QuotasClient) Update

Update - Update quota for each VM family in workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location for update quota is queried. parameters - Quota update parameters. options - QuotasClientUpdateOptions contains the optional parameters for the QuotasClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Quota/update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewQuotasClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Update(ctx,
	"eastus",
	armmachinelearning.QuotaUpdateParameters{
		Value: []*armmachinelearning.QuotaBaseProperties{
			{
				Type:  to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
				ID:    to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
				Limit: to.Ptr[int64](100),
				Unit:  to.Ptr(armmachinelearning.QuotaUnitCount),
			},
			{
				Type:  to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
				ID:    to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
				Limit: to.Ptr[int64](200),
				Unit:  to.Ptr(armmachinelearning.QuotaUnitCount),
			}},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type QuotasClientListOptions

type QuotasClientListOptions struct {
}

QuotasClientListOptions contains the optional parameters for the QuotasClient.List method.

type QuotasClientListResponse

type QuotasClientListResponse struct {
	ListWorkspaceQuotas
}

QuotasClientListResponse contains the response from method QuotasClient.List.

type QuotasClientUpdateOptions

type QuotasClientUpdateOptions struct {
}

QuotasClientUpdateOptions contains the optional parameters for the QuotasClient.Update method.

type QuotasClientUpdateResponse

type QuotasClientUpdateResponse struct {
	UpdateWorkspaceQuotasResult
}

QuotasClientUpdateResponse contains the response from method QuotasClient.Update.

type RandomSamplingAlgorithm

type RandomSamplingAlgorithm struct {
	// REQUIRED; [Required] The algorithm used for generating hyperparameter values, along with configuration properties
	SamplingAlgorithmType *SamplingAlgorithmType `json:"samplingAlgorithmType,omitempty"`

	// The specific type of random algorithm
	Rule *RandomSamplingAlgorithmRule `json:"rule,omitempty"`

	// An optional integer to use as the seed for random number generation
	Seed *int32 `json:"seed,omitempty"`
}

RandomSamplingAlgorithm - Defines a Sampling Algorithm that generates values randomly

func (*RandomSamplingAlgorithm) GetSamplingAlgorithm

func (r *RandomSamplingAlgorithm) GetSamplingAlgorithm() *SamplingAlgorithm

GetSamplingAlgorithm implements the SamplingAlgorithmClassification interface for type RandomSamplingAlgorithm.

func (RandomSamplingAlgorithm) MarshalJSON

func (r RandomSamplingAlgorithm) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RandomSamplingAlgorithm.

func (*RandomSamplingAlgorithm) UnmarshalJSON

func (r *RandomSamplingAlgorithm) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RandomSamplingAlgorithm.

type RandomSamplingAlgorithmRule

type RandomSamplingAlgorithmRule string

RandomSamplingAlgorithmRule - The specific type of random algorithm

const (
	RandomSamplingAlgorithmRuleRandom RandomSamplingAlgorithmRule = "Random"
	RandomSamplingAlgorithmRuleSobol  RandomSamplingAlgorithmRule = "Sobol"
)

func PossibleRandomSamplingAlgorithmRuleValues

func PossibleRandomSamplingAlgorithmRuleValues() []RandomSamplingAlgorithmRule

PossibleRandomSamplingAlgorithmRuleValues returns the possible values for the RandomSamplingAlgorithmRule const type.

type ReferenceType

type ReferenceType string

ReferenceType - Enum to determine which reference method to use for an asset.

const (
	ReferenceTypeDataPath   ReferenceType = "DataPath"
	ReferenceTypeID         ReferenceType = "Id"
	ReferenceTypeOutputPath ReferenceType = "OutputPath"
)

func PossibleReferenceTypeValues

func PossibleReferenceTypeValues() []ReferenceType

PossibleReferenceTypeValues returns the possible values for the ReferenceType const type.

type RegenerateEndpointKeysRequest

type RegenerateEndpointKeysRequest struct {
	// REQUIRED; [Required] Specification for which type of key to generate. Primary or Secondary.
	KeyType *KeyType `json:"keyType,omitempty"`

	// The value the key is set to.
	KeyValue *string `json:"keyValue,omitempty"`
}

type RegistryListCredentialsResult

type RegistryListCredentialsResult struct {
	Passwords []*Password `json:"passwords,omitempty"`

	// READ-ONLY
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY
	Username *string `json:"username,omitempty" azure:"ro"`
}

type RemoteLoginPortPublicAccess

type RemoteLoginPortPublicAccess string

RemoteLoginPortPublicAccess - State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.

const (
	RemoteLoginPortPublicAccessDisabled     RemoteLoginPortPublicAccess = "Disabled"
	RemoteLoginPortPublicAccessEnabled      RemoteLoginPortPublicAccess = "Enabled"
	RemoteLoginPortPublicAccessNotSpecified RemoteLoginPortPublicAccess = "NotSpecified"
)

func PossibleRemoteLoginPortPublicAccessValues

func PossibleRemoteLoginPortPublicAccessValues() []RemoteLoginPortPublicAccess

PossibleRemoteLoginPortPublicAccessValues returns the possible values for the RemoteLoginPortPublicAccess const type.

type Resource

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type ResourceBase

type ResourceBase struct {
	// The asset description text.
	Description *string `json:"description,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

func (ResourceBase) MarshalJSON

func (r ResourceBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceBase.

type ResourceConfiguration

type ResourceConfiguration struct {
	// Optional number of instances or nodes used by the compute target.
	InstanceCount *int32 `json:"instanceCount,omitempty"`

	// Optional type of VM used as supported by the compute target.
	InstanceType *string `json:"instanceType,omitempty"`

	// Additional properties bag.
	Properties map[string]interface{} `json:"properties,omitempty"`
}

func (ResourceConfiguration) MarshalJSON

func (r ResourceConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceConfiguration.

type ResourceID

type ResourceID struct {
	// REQUIRED; The ID of the resource
	ID *string `json:"id,omitempty"`
}

ResourceID - Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

type ResourceName

type ResourceName struct {
	// READ-ONLY; The localized name of the resource.
	LocalizedValue *string `json:"localizedValue,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Value *string `json:"value,omitempty" azure:"ro"`
}

ResourceName - The Resource Name.

type ResourceQuota

type ResourceQuota struct {
	// READ-ONLY; Region of the AML workspace in the id.
	AmlWorkspaceLocation *string `json:"amlWorkspaceLocation,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The maximum permitted quota of the resource.
	Limit *int64 `json:"limit,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *ResourceName `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the resource type.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; An enum describing the unit of quota measurement.
	Unit *QuotaUnit `json:"unit,omitempty" azure:"ro"`
}

ResourceQuota - The quota assigned to a resource.

type Route

type Route struct {
	// REQUIRED; [Required] The path for the route.
	Path *string `json:"path,omitempty"`

	// REQUIRED; [Required] The port for the route.
	Port *int32 `json:"port,omitempty"`
}

type SASAuthTypeWorkspaceConnectionProperties

type SASAuthTypeWorkspaceConnectionProperties struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType `json:"authType,omitempty"`

	// Category of the connection
	Category    *ConnectionCategory                       `json:"category,omitempty"`
	Credentials *WorkspaceConnectionSharedAccessSignature `json:"credentials,omitempty"`
	Target      *string                                   `json:"target,omitempty"`

	// Value details of the workspace connection.
	Value *string `json:"value,omitempty"`

	// format for the workspace connection value
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

func (*SASAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2

func (s *SASAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2() *WorkspaceConnectionPropertiesV2

GetWorkspaceConnectionPropertiesV2 implements the WorkspaceConnectionPropertiesV2Classification interface for type SASAuthTypeWorkspaceConnectionProperties.

func (SASAuthTypeWorkspaceConnectionProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type SASAuthTypeWorkspaceConnectionProperties.

func (*SASAuthTypeWorkspaceConnectionProperties) UnmarshalJSON

func (s *SASAuthTypeWorkspaceConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SASAuthTypeWorkspaceConnectionProperties.

type SKU

type SKU struct {
	// REQUIRED; The name of the SKU. Ex - P3. It is typically a letter+number code
	Name *string `json:"name,omitempty"`

	// If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the
	// resource this may be omitted.
	Capacity *int32 `json:"capacity,omitempty"`

	// If the service has different generations of hardware, for the same SKU, then that can be captured here.
	Family *string `json:"family,omitempty"`

	// The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
	Size *string `json:"size,omitempty"`

	// This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required
	// on a PUT.
	Tier *SKUTier `json:"tier,omitempty"`
}

SKU - The resource model definition representing SKU

type SKUCapacity

type SKUCapacity struct {
	// Gets or sets the default capacity.
	Default *int32 `json:"default,omitempty"`

	// Gets or sets the maximum.
	Maximum *int32 `json:"maximum,omitempty"`

	// Gets or sets the minimum.
	Minimum *int32 `json:"minimum,omitempty"`

	// Gets or sets the type of the scale.
	ScaleType *SKUScaleType `json:"scaleType,omitempty"`
}

SKUCapacity - SKU capacity information

type SKUResource

type SKUResource struct {
	// Gets or sets the Sku Capacity.
	Capacity *SKUCapacity `json:"capacity,omitempty"`

	// Gets or sets the Sku.
	SKU *SKUSetting `json:"sku,omitempty"`

	// READ-ONLY; The resource type name.
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`
}

SKUResource - Fulfills ARM Contract requirement to list all available SKUS for a resource.

type SKUResourceArmPaginatedResult

type SKUResourceArmPaginatedResult struct {
	// The link to the next page of SkuResource objects. If null, there are no additional pages.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of objects of type SkuResource.
	Value []*SKUResource `json:"value,omitempty"`
}

SKUResourceArmPaginatedResult - A paginated list of SkuResource entities.

type SKUScaleType

type SKUScaleType string

SKUScaleType - Node scaling setting for the compute sku.

const (
	// SKUScaleTypeAutomatic - Automatically scales node count.
	SKUScaleTypeAutomatic SKUScaleType = "Automatic"
	// SKUScaleTypeManual - Node count scaled upon user request.
	SKUScaleTypeManual SKUScaleType = "Manual"
	// SKUScaleTypeNone - Fixed set of nodes.
	SKUScaleTypeNone SKUScaleType = "None"
)

func PossibleSKUScaleTypeValues

func PossibleSKUScaleTypeValues() []SKUScaleType

PossibleSKUScaleTypeValues returns the possible values for the SKUScaleType const type.

type SKUSetting

type SKUSetting struct {
	// REQUIRED; [Required] The name of the SKU. Ex - P3. It is typically a letter+number code.
	Name *string `json:"name,omitempty"`

	// This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required
	// on a PUT.
	Tier *SKUTier `json:"tier,omitempty"`
}

SKUSetting - SkuSetting fulfills the need for stripped down SKU info in ARM contract.

type SKUTier

type SKUTier string

SKUTier - This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

const (
	SKUTierFree     SKUTier = "Free"
	SKUTierBasic    SKUTier = "Basic"
	SKUTierStandard SKUTier = "Standard"
	SKUTierPremium  SKUTier = "Premium"
)

func PossibleSKUTierValues

func PossibleSKUTierValues() []SKUTier

PossibleSKUTierValues returns the possible values for the SKUTier const type.

type SSHPublicAccess

type SSHPublicAccess string

SSHPublicAccess - State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.

const (
	SSHPublicAccessDisabled SSHPublicAccess = "Disabled"
	SSHPublicAccessEnabled  SSHPublicAccess = "Enabled"
)

func PossibleSSHPublicAccessValues

func PossibleSSHPublicAccessValues() []SSHPublicAccess

PossibleSSHPublicAccessValues returns the possible values for the SSHPublicAccess const type.

type SSLConfigStatus

type SSLConfigStatus string

SSLConfigStatus - Enable or disable ssl for scoring

const (
	SSLConfigStatusAuto     SSLConfigStatus = "Auto"
	SSLConfigStatusDisabled SSLConfigStatus = "Disabled"
	SSLConfigStatusEnabled  SSLConfigStatus = "Enabled"
)

func PossibleSSLConfigStatusValues

func PossibleSSLConfigStatusValues() []SSLConfigStatus

PossibleSSLConfigStatusValues returns the possible values for the SSLConfigStatus const type.

type SSLConfiguration

type SSLConfiguration struct {
	// Cert data
	Cert *string `json:"cert,omitempty"`

	// CNAME of the cert
	Cname *string `json:"cname,omitempty"`

	// Key data
	Key *string `json:"key,omitempty"`

	// Leaf domain label of public endpoint
	LeafDomainLabel *string `json:"leafDomainLabel,omitempty"`

	// Indicates whether to overwrite existing domain label.
	OverwriteExistingDomain *bool `json:"overwriteExistingDomain,omitempty"`

	// Enable or disable ssl for scoring
	Status *SSLConfigStatus `json:"status,omitempty"`
}

SSLConfiguration - The ssl configuration for scoring

type SamplingAlgorithm

type SamplingAlgorithm struct {
	// REQUIRED; [Required] The algorithm used for generating hyperparameter values, along with configuration properties
	SamplingAlgorithmType *SamplingAlgorithmType `json:"samplingAlgorithmType,omitempty"`
}

SamplingAlgorithm - The Sampling Algorithm used to generate hyperparameter values, along with properties to configure the algorithm

func (*SamplingAlgorithm) GetSamplingAlgorithm

func (s *SamplingAlgorithm) GetSamplingAlgorithm() *SamplingAlgorithm

GetSamplingAlgorithm implements the SamplingAlgorithmClassification interface for type SamplingAlgorithm.

type SamplingAlgorithmClassification

type SamplingAlgorithmClassification interface {
	// GetSamplingAlgorithm returns the SamplingAlgorithm content of the underlying type.
	GetSamplingAlgorithm() *SamplingAlgorithm
}

SamplingAlgorithmClassification provides polymorphic access to related types. Call the interface's GetSamplingAlgorithm() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BayesianSamplingAlgorithm, *GridSamplingAlgorithm, *RandomSamplingAlgorithm, *SamplingAlgorithm

type SamplingAlgorithmType

type SamplingAlgorithmType string
const (
	SamplingAlgorithmTypeBayesian SamplingAlgorithmType = "Bayesian"
	SamplingAlgorithmTypeGrid     SamplingAlgorithmType = "Grid"
	SamplingAlgorithmTypeRandom   SamplingAlgorithmType = "Random"
)

func PossibleSamplingAlgorithmTypeValues

func PossibleSamplingAlgorithmTypeValues() []SamplingAlgorithmType

PossibleSamplingAlgorithmTypeValues returns the possible values for the SamplingAlgorithmType const type.

type SasDatastoreCredentials

type SasDatastoreCredentials struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType `json:"credentialsType,omitempty"`

	// REQUIRED; [Required] Storage container secrets.
	Secrets *SasDatastoreSecrets `json:"secrets,omitempty"`
}

SasDatastoreCredentials - SAS datastore credentials configuration.

func (*SasDatastoreCredentials) GetDatastoreCredentials

func (s *SasDatastoreCredentials) GetDatastoreCredentials() *DatastoreCredentials

GetDatastoreCredentials implements the DatastoreCredentialsClassification interface for type SasDatastoreCredentials.

func (SasDatastoreCredentials) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SasDatastoreCredentials.

func (*SasDatastoreCredentials) UnmarshalJSON

func (s *SasDatastoreCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SasDatastoreCredentials.

type SasDatastoreSecrets

type SasDatastoreSecrets struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	SecretsType *SecretsType `json:"secretsType,omitempty"`

	// Storage container SAS token.
	SasToken *string `json:"sasToken,omitempty"`
}

SasDatastoreSecrets - Datastore SAS secrets.

func (*SasDatastoreSecrets) GetDatastoreSecrets

func (s *SasDatastoreSecrets) GetDatastoreSecrets() *DatastoreSecrets

GetDatastoreSecrets implements the DatastoreSecretsClassification interface for type SasDatastoreSecrets.

func (SasDatastoreSecrets) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SasDatastoreSecrets.

func (*SasDatastoreSecrets) UnmarshalJSON

func (s *SasDatastoreSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SasDatastoreSecrets.

type ScaleSettings

type ScaleSettings struct {
	// REQUIRED; Max number of nodes to use
	MaxNodeCount *int32 `json:"maxNodeCount,omitempty"`

	// Min number of nodes to use
	MinNodeCount *int32 `json:"minNodeCount,omitempty"`

	// Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.
	NodeIdleTimeBeforeScaleDown *string `json:"nodeIdleTimeBeforeScaleDown,omitempty"`
}

ScaleSettings - scale settings for AML Compute

type ScaleSettingsInformation

type ScaleSettingsInformation struct {
	// scale settings for AML Compute
	ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
}

ScaleSettingsInformation - Desired scale settings for the amlCompute.

type ScaleType

type ScaleType string
const (
	ScaleTypeDefault           ScaleType = "Default"
	ScaleTypeTargetUtilization ScaleType = "TargetUtilization"
)

func PossibleScaleTypeValues

func PossibleScaleTypeValues() []ScaleType

PossibleScaleTypeValues returns the possible values for the ScaleType const type.

type ScheduleBase

type ScheduleBase struct {
	ID                 *string                    `json:"id,omitempty"`
	ProvisioningStatus *ScheduleProvisioningState `json:"provisioningStatus,omitempty"`
	Status             *ScheduleStatus            `json:"status,omitempty"`
}

type ScheduleProvisioningState

type ScheduleProvisioningState string
const (
	ScheduleProvisioningStateCompleted    ScheduleProvisioningState = "Completed"
	ScheduleProvisioningStateFailed       ScheduleProvisioningState = "Failed"
	ScheduleProvisioningStateProvisioning ScheduleProvisioningState = "Provisioning"
)

func PossibleScheduleProvisioningStateValues

func PossibleScheduleProvisioningStateValues() []ScheduleProvisioningState

PossibleScheduleProvisioningStateValues returns the possible values for the ScheduleProvisioningState const type.

type ScheduleStatus

type ScheduleStatus string
const (
	ScheduleStatusDisabled ScheduleStatus = "Disabled"
	ScheduleStatusEnabled  ScheduleStatus = "Enabled"
)

func PossibleScheduleStatusValues

func PossibleScheduleStatusValues() []ScheduleStatus

PossibleScheduleStatusValues returns the possible values for the ScheduleStatus const type.

type ScriptReference

type ScriptReference struct {
	// Optional command line arguments passed to the script to run.
	ScriptArguments *string `json:"scriptArguments,omitempty"`

	// The location of scripts in the mounted volume.
	ScriptData *string `json:"scriptData,omitempty"`

	// The storage source of the script: inline, workspace.
	ScriptSource *string `json:"scriptSource,omitempty"`

	// Optional time period passed to timeout command.
	Timeout *string `json:"timeout,omitempty"`
}

ScriptReference - Script reference

type ScriptsToExecute

type ScriptsToExecute struct {
	// Script that's run only once during provision of the compute.
	CreationScript *ScriptReference `json:"creationScript,omitempty"`

	// Script that's run every time the machine starts.
	StartupScript *ScriptReference `json:"startupScript,omitempty"`
}

ScriptsToExecute - Customized setup scripts

type SecretsType

type SecretsType string

SecretsType - Enum to determine the datastore secrets type.

const (
	SecretsTypeAccountKey       SecretsType = "AccountKey"
	SecretsTypeCertificate      SecretsType = "Certificate"
	SecretsTypeSas              SecretsType = "Sas"
	SecretsTypeServicePrincipal SecretsType = "ServicePrincipal"
)

func PossibleSecretsTypeValues

func PossibleSecretsTypeValues() []SecretsType

PossibleSecretsTypeValues returns the possible values for the SecretsType const type.

type ServiceDataAccessAuthIdentity

type ServiceDataAccessAuthIdentity string
const (
	// ServiceDataAccessAuthIdentityNone - Do not use any identity for service data access.
	ServiceDataAccessAuthIdentityNone ServiceDataAccessAuthIdentity = "None"
	// ServiceDataAccessAuthIdentityWorkspaceSystemAssignedIdentity - Use the system assigned managed identity of the Workspace
	// to authenticate service data access.
	ServiceDataAccessAuthIdentityWorkspaceSystemAssignedIdentity ServiceDataAccessAuthIdentity = "WorkspaceSystemAssignedIdentity"
	// ServiceDataAccessAuthIdentityWorkspaceUserAssignedIdentity - Use the user assigned managed identity of the Workspace to
	// authenticate service data access.
	ServiceDataAccessAuthIdentityWorkspaceUserAssignedIdentity ServiceDataAccessAuthIdentity = "WorkspaceUserAssignedIdentity"
)

func PossibleServiceDataAccessAuthIdentityValues

func PossibleServiceDataAccessAuthIdentityValues() []ServiceDataAccessAuthIdentity

PossibleServiceDataAccessAuthIdentityValues returns the possible values for the ServiceDataAccessAuthIdentity const type.

type ServiceManagedResourcesSettings

type ServiceManagedResourcesSettings struct {
	// The settings for the service managed cosmosdb account.
	CosmosDb *CosmosDbSettings `json:"cosmosDb,omitempty"`
}

type ServicePrincipalDatastoreCredentials

type ServicePrincipalDatastoreCredentials struct {
	// REQUIRED; [Required] Service principal client ID.
	ClientID *string `json:"clientId,omitempty"`

	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType `json:"credentialsType,omitempty"`

	// REQUIRED; [Required] Service principal secrets.
	Secrets *ServicePrincipalDatastoreSecrets `json:"secrets,omitempty"`

	// REQUIRED; [Required] ID of the tenant to which the service principal belongs.
	TenantID *string `json:"tenantId,omitempty"`

	// Authority URL used for authentication.
	AuthorityURL *string `json:"authorityUrl,omitempty"`

	// Resource the service principal has access to.
	ResourceURL *string `json:"resourceUrl,omitempty"`
}

ServicePrincipalDatastoreCredentials - Service Principal datastore credentials configuration.

func (*ServicePrincipalDatastoreCredentials) GetDatastoreCredentials

func (s *ServicePrincipalDatastoreCredentials) GetDatastoreCredentials() *DatastoreCredentials

GetDatastoreCredentials implements the DatastoreCredentialsClassification interface for type ServicePrincipalDatastoreCredentials.

func (ServicePrincipalDatastoreCredentials) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ServicePrincipalDatastoreCredentials.

func (*ServicePrincipalDatastoreCredentials) UnmarshalJSON

func (s *ServicePrincipalDatastoreCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServicePrincipalDatastoreCredentials.

type ServicePrincipalDatastoreSecrets

type ServicePrincipalDatastoreSecrets struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	SecretsType *SecretsType `json:"secretsType,omitempty"`

	// Service principal secret.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

ServicePrincipalDatastoreSecrets - Datastore Service Principal secrets.

func (*ServicePrincipalDatastoreSecrets) GetDatastoreSecrets

func (s *ServicePrincipalDatastoreSecrets) GetDatastoreSecrets() *DatastoreSecrets

GetDatastoreSecrets implements the DatastoreSecretsClassification interface for type ServicePrincipalDatastoreSecrets.

func (ServicePrincipalDatastoreSecrets) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ServicePrincipalDatastoreSecrets.

func (*ServicePrincipalDatastoreSecrets) UnmarshalJSON

func (s *ServicePrincipalDatastoreSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServicePrincipalDatastoreSecrets.

type SetupScripts

type SetupScripts struct {
	// Customized setup scripts
	Scripts *ScriptsToExecute `json:"scripts,omitempty"`
}

SetupScripts - Details of customized scripts to execute for setting up the cluster.

type SharedPrivateLinkResource

type SharedPrivateLinkResource struct {
	// Unique name of the private link.
	Name *string `json:"name,omitempty"`

	// Resource properties.
	Properties *SharedPrivateLinkResourceProperty `json:"properties,omitempty"`
}

type SharedPrivateLinkResourceProperty

type SharedPrivateLinkResourceProperty struct {
	// The private link resource group id.
	GroupID *string `json:"groupId,omitempty"`

	// The resource id that private link links to.
	PrivateLinkResourceID *string `json:"privateLinkResourceId,omitempty"`

	// Request message.
	RequestMessage *string `json:"requestMessage,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

SharedPrivateLinkResourceProperty - Properties of a shared private link resource.

type SourceType

type SourceType string

SourceType - Data source type.

const (
	SourceTypeDataset   SourceType = "Dataset"
	SourceTypeDatastore SourceType = "Datastore"
	SourceTypeURI       SourceType = "URI"
)

func PossibleSourceTypeValues

func PossibleSourceTypeValues() []SourceType

PossibleSourceTypeValues returns the possible values for the SourceType const type.

type Status

type Status string

Status - Status of update workspace quota.

const (
	StatusFailure                              Status = "Failure"
	StatusInvalidQuotaBelowClusterMinimum      Status = "InvalidQuotaBelowClusterMinimum"
	StatusInvalidQuotaExceedsSubscriptionLimit Status = "InvalidQuotaExceedsSubscriptionLimit"
	StatusInvalidVMFamilyName                  Status = "InvalidVMFamilyName"
	StatusOperationNotEnabledForRegion         Status = "OperationNotEnabledForRegion"
	StatusOperationNotSupportedForSKU          Status = "OperationNotSupportedForSku"
	StatusSuccess                              Status = "Success"
	StatusUndefined                            Status = "Undefined"
)

func PossibleStatusValues

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type StorageAccountType

type StorageAccountType string

StorageAccountType - type of this storage account.

const (
	StorageAccountTypePremiumLRS  StorageAccountType = "Premium_LRS"
	StorageAccountTypeStandardLRS StorageAccountType = "Standard_LRS"
)

func PossibleStorageAccountTypeValues

func PossibleStorageAccountTypeValues() []StorageAccountType

PossibleStorageAccountTypeValues returns the possible values for the StorageAccountType const type.

type SweepJob

type SweepJob struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobType *JobType `json:"jobType,omitempty"`

	// REQUIRED; [Required] Optimization objective.
	Objective *Objective `json:"objective,omitempty"`

	// REQUIRED; [Required] The hyperparameter sampling algorithm
	SamplingAlgorithm SamplingAlgorithmClassification `json:"samplingAlgorithm,omitempty"`

	// REQUIRED; [Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the
	// parameter
	SearchSpace interface{} `json:"searchSpace,omitempty"`

	// REQUIRED; [Required] Trial component definition.
	Trial *TrialComponent `json:"trial,omitempty"`

	// ARM resource ID of the compute resource.
	ComputeID *string `json:"computeId,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// Display name of job.
	DisplayName *string `json:"displayName,omitempty"`

	// Early termination policies enable canceling poor-performing runs before they complete
	EarlyTermination EarlyTerminationPolicyClassification `json:"earlyTermination,omitempty"`

	// The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
	ExperimentName *string `json:"experimentName,omitempty"`

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification `json:"identity,omitempty"`

	// Mapping of input data bindings used in the job.
	Inputs map[string]JobInputClassification `json:"inputs,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// Sweep Job limit.
	Limits *SweepJobLimits `json:"limits,omitempty"`

	// Mapping of output data bindings used in the job.
	Outputs map[string]JobOutputClassification `json:"outputs,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
	Services map[string]*JobService `json:"services,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Status of the job.
	Status *JobStatus `json:"status,omitempty" azure:"ro"`
}

SweepJob - Sweep job definition.

func (*SweepJob) GetJobBaseProperties

func (s *SweepJob) GetJobBaseProperties() *JobBaseProperties

GetJobBaseProperties implements the JobBasePropertiesClassification interface for type SweepJob.

func (SweepJob) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SweepJob.

func (*SweepJob) UnmarshalJSON

func (s *SweepJob) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SweepJob.

type SweepJobLimits

type SweepJobLimits struct {
	// REQUIRED; [Required] JobLimit type.
	JobLimitsType *JobLimitsType `json:"jobLimitsType,omitempty"`

	// Sweep Job max concurrent trials.
	MaxConcurrentTrials *int32 `json:"maxConcurrentTrials,omitempty"`

	// Sweep Job max total trials.
	MaxTotalTrials *int32 `json:"maxTotalTrials,omitempty"`

	// The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as
	// low as Seconds.
	Timeout *string `json:"timeout,omitempty"`

	// Sweep Job Trial timeout value.
	TrialTimeout *string `json:"trialTimeout,omitempty"`
}

SweepJobLimits - Sweep Job limit class.

func (*SweepJobLimits) GetJobLimits

func (s *SweepJobLimits) GetJobLimits() *JobLimits

GetJobLimits implements the JobLimitsClassification interface for type SweepJobLimits.

func (SweepJobLimits) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SweepJobLimits.

func (*SweepJobLimits) UnmarshalJSON

func (s *SweepJobLimits) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SweepJobLimits.

type SynapseSpark

type SynapseSpark struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool                   `json:"disableLocalAuth,omitempty"`
	Properties       *SynapseSparkProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SynapseSpark - A SynapseSpark compute.

func (*SynapseSpark) GetCompute

func (s *SynapseSpark) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type SynapseSpark.

func (SynapseSpark) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SynapseSpark.

func (*SynapseSpark) UnmarshalJSON

func (s *SynapseSpark) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SynapseSpark.

type SynapseSparkProperties

type SynapseSparkProperties struct {
	// Auto pause properties.
	AutoPauseProperties *AutoPauseProperties `json:"autoPauseProperties,omitempty"`

	// Auto scale properties.
	AutoScaleProperties *AutoScaleProperties `json:"autoScaleProperties,omitempty"`

	// The number of compute nodes currently assigned to the compute.
	NodeCount *int32 `json:"nodeCount,omitempty"`

	// Node size.
	NodeSize *string `json:"nodeSize,omitempty"`

	// Node size family.
	NodeSizeFamily *string `json:"nodeSizeFamily,omitempty"`

	// Pool name.
	PoolName *string `json:"poolName,omitempty"`

	// Name of the resource group in which workspace is located.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// Spark version.
	SparkVersion *string `json:"sparkVersion,omitempty"`

	// Azure subscription identifier.
	SubscriptionID *string `json:"subscriptionId,omitempty"`

	// Name of Azure Machine Learning workspace.
	WorkspaceName *string `json:"workspaceName,omitempty"`
}

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type SystemService

type SystemService struct {
	// READ-ONLY; Public IP address
	PublicIPAddress *string `json:"publicIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; The type of this system service.
	SystemServiceType *string `json:"systemServiceType,omitempty" azure:"ro"`

	// READ-ONLY; The version for this type.
	Version *string `json:"version,omitempty" azure:"ro"`
}

SystemService - A system service running on a compute.

type TargetUtilizationScaleSettings

type TargetUtilizationScaleSettings struct {
	// REQUIRED; [Required] Type of deployment scaling algorithm
	ScaleType *ScaleType `json:"scaleType,omitempty"`

	// The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.
	MaxInstances *int32 `json:"maxInstances,omitempty"`

	// The minimum number of instances to always be present.
	MinInstances *int32 `json:"minInstances,omitempty"`

	// The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.
	PollingInterval *string `json:"pollingInterval,omitempty"`

	// Target CPU usage for the autoscaler.
	TargetUtilizationPercentage *int32 `json:"targetUtilizationPercentage,omitempty"`
}

func (*TargetUtilizationScaleSettings) GetOnlineScaleSettings

func (t *TargetUtilizationScaleSettings) GetOnlineScaleSettings() *OnlineScaleSettings

GetOnlineScaleSettings implements the OnlineScaleSettingsClassification interface for type TargetUtilizationScaleSettings.

func (TargetUtilizationScaleSettings) MarshalJSON

func (t TargetUtilizationScaleSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TargetUtilizationScaleSettings.

func (*TargetUtilizationScaleSettings) UnmarshalJSON

func (t *TargetUtilizationScaleSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TargetUtilizationScaleSettings.

type TensorFlow

type TensorFlow struct {
	// REQUIRED; [Required] Specifies the type of distribution framework.
	DistributionType *DistributionType `json:"distributionType,omitempty"`

	// Number of parameter server tasks.
	ParameterServerCount *int32 `json:"parameterServerCount,omitempty"`

	// Number of workers. If not specified, will default to the instance count.
	WorkerCount *int32 `json:"workerCount,omitempty"`
}

TensorFlow distribution configuration.

func (*TensorFlow) GetDistributionConfiguration

func (t *TensorFlow) GetDistributionConfiguration() *DistributionConfiguration

GetDistributionConfiguration implements the DistributionConfigurationClassification interface for type TensorFlow.

func (TensorFlow) MarshalJSON

func (t TensorFlow) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TensorFlow.

func (*TensorFlow) UnmarshalJSON

func (t *TensorFlow) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TensorFlow.

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type TrialComponent

type TrialComponent struct {
	// REQUIRED; [Required] The command to execute on startup of the job. eg. "python train.py"
	Command *string `json:"command,omitempty"`

	// REQUIRED; [Required] The ARM resource ID of the Environment specification for the job.
	EnvironmentID *string `json:"environmentId,omitempty"`

	// ARM resource ID of the code asset.
	CodeID *string `json:"codeId,omitempty"`

	// Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.
	Distribution DistributionConfigurationClassification `json:"distribution,omitempty"`

	// Environment variables included in the job.
	EnvironmentVariables map[string]*string `json:"environmentVariables,omitempty"`

	// Compute Resource configuration for the job.
	Resources *ResourceConfiguration `json:"resources,omitempty"`
}

TrialComponent - Trial component definition.

func (TrialComponent) MarshalJSON

func (t TrialComponent) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrialComponent.

func (*TrialComponent) UnmarshalJSON

func (t *TrialComponent) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrialComponent.

type TritonModelJobInput

type TritonModelJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// REQUIRED; [Required] Input Asset URI.
	URI *string `json:"uri,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode `json:"mode,omitempty"`
}

func (*TritonModelJobInput) GetJobInput

func (t *TritonModelJobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type TritonModelJobInput.

func (TritonModelJobInput) MarshalJSON

func (t TritonModelJobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TritonModelJobInput.

func (*TritonModelJobInput) UnmarshalJSON

func (t *TritonModelJobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TritonModelJobInput.

type TritonModelJobOutput

type TritonModelJobOutput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobOutputType *JobOutputType `json:"jobOutputType,omitempty"`

	// Description for the output.
	Description *string `json:"description,omitempty"`

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode `json:"mode,omitempty"`

	// Output Asset URI.
	URI *string `json:"uri,omitempty"`
}

func (*TritonModelJobOutput) GetJobOutput

func (t *TritonModelJobOutput) GetJobOutput() *JobOutput

GetJobOutput implements the JobOutputClassification interface for type TritonModelJobOutput.

func (TritonModelJobOutput) MarshalJSON

func (t TritonModelJobOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TritonModelJobOutput.

func (*TritonModelJobOutput) UnmarshalJSON

func (t *TritonModelJobOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TritonModelJobOutput.

type TruncationSelectionPolicy

type TruncationSelectionPolicy struct {
	// REQUIRED; [Required] Name of policy configuration
	PolicyType *EarlyTerminationPolicyType `json:"policyType,omitempty"`

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32 `json:"delayEvaluation,omitempty"`

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32 `json:"evaluationInterval,omitempty"`

	// The percentage of runs to cancel at each evaluation interval.
	TruncationPercentage *int32 `json:"truncationPercentage,omitempty"`
}

TruncationSelectionPolicy - Defines an early termination policy that cancels a given percentage of runs at each evaluation interval.

func (*TruncationSelectionPolicy) GetEarlyTerminationPolicy

func (t *TruncationSelectionPolicy) GetEarlyTerminationPolicy() *EarlyTerminationPolicy

GetEarlyTerminationPolicy implements the EarlyTerminationPolicyClassification interface for type TruncationSelectionPolicy.

func (TruncationSelectionPolicy) MarshalJSON

func (t TruncationSelectionPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TruncationSelectionPolicy.

func (*TruncationSelectionPolicy) UnmarshalJSON

func (t *TruncationSelectionPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TruncationSelectionPolicy.

type URIFileDataVersion

type URIFileDataVersion struct {
	// REQUIRED; [Required] Specifies the type of data.
	DataType *DataType `json:"dataType,omitempty"`

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20220501.Assets.DataVersionBase.DataType
	DataURI *string `json:"dataUri,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

URIFileDataVersion - uri-file data version entity

func (*URIFileDataVersion) GetDataVersionBaseProperties

func (u *URIFileDataVersion) GetDataVersionBaseProperties() *DataVersionBaseProperties

GetDataVersionBaseProperties implements the DataVersionBasePropertiesClassification interface for type URIFileDataVersion.

func (URIFileDataVersion) MarshalJSON

func (u URIFileDataVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type URIFileDataVersion.

func (*URIFileDataVersion) UnmarshalJSON

func (u *URIFileDataVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type URIFileDataVersion.

type URIFileJobInput

type URIFileJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// REQUIRED; [Required] Input Asset URI.
	URI *string `json:"uri,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode `json:"mode,omitempty"`
}

func (*URIFileJobInput) GetJobInput

func (u *URIFileJobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type URIFileJobInput.

func (URIFileJobInput) MarshalJSON

func (u URIFileJobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type URIFileJobInput.

func (*URIFileJobInput) UnmarshalJSON

func (u *URIFileJobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type URIFileJobInput.

type URIFileJobOutput

type URIFileJobOutput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobOutputType *JobOutputType `json:"jobOutputType,omitempty"`

	// Description for the output.
	Description *string `json:"description,omitempty"`

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode `json:"mode,omitempty"`

	// Output Asset URI.
	URI *string `json:"uri,omitempty"`
}

func (*URIFileJobOutput) GetJobOutput

func (u *URIFileJobOutput) GetJobOutput() *JobOutput

GetJobOutput implements the JobOutputClassification interface for type URIFileJobOutput.

func (URIFileJobOutput) MarshalJSON

func (u URIFileJobOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type URIFileJobOutput.

func (*URIFileJobOutput) UnmarshalJSON

func (u *URIFileJobOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type URIFileJobOutput.

type URIFolderDataVersion

type URIFolderDataVersion struct {
	// REQUIRED; [Required] Specifies the type of data.
	DataType *DataType `json:"dataType,omitempty"`

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20220501.Assets.DataVersionBase.DataType
	DataURI *string `json:"dataUri,omitempty"`

	// The asset description text.
	Description *string `json:"description,omitempty"`

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool `json:"isAnonymous,omitempty"`

	// Is the asset archived?
	IsArchived *bool `json:"isArchived,omitempty"`

	// The asset property dictionary.
	Properties map[string]*string `json:"properties,omitempty"`

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string `json:"tags,omitempty"`
}

URIFolderDataVersion - uri-folder data version entity

func (*URIFolderDataVersion) GetDataVersionBaseProperties

func (u *URIFolderDataVersion) GetDataVersionBaseProperties() *DataVersionBaseProperties

GetDataVersionBaseProperties implements the DataVersionBasePropertiesClassification interface for type URIFolderDataVersion.

func (URIFolderDataVersion) MarshalJSON

func (u URIFolderDataVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type URIFolderDataVersion.

func (*URIFolderDataVersion) UnmarshalJSON

func (u *URIFolderDataVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type URIFolderDataVersion.

type URIFolderJobInput

type URIFolderJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType `json:"jobInputType,omitempty"`

	// REQUIRED; [Required] Input Asset URI.
	URI *string `json:"uri,omitempty"`

	// Description for the input.
	Description *string `json:"description,omitempty"`

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode `json:"mode,omitempty"`
}

func (*URIFolderJobInput) GetJobInput

func (u *URIFolderJobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type URIFolderJobInput.

func (URIFolderJobInput) MarshalJSON

func (u URIFolderJobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type URIFolderJobInput.

func (*URIFolderJobInput) UnmarshalJSON

func (u *URIFolderJobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type URIFolderJobInput.

type URIFolderJobOutput

type URIFolderJobOutput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobOutputType *JobOutputType `json:"jobOutputType,omitempty"`

	// Description for the output.
	Description *string `json:"description,omitempty"`

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode `json:"mode,omitempty"`

	// Output Asset URI.
	URI *string `json:"uri,omitempty"`
}

func (*URIFolderJobOutput) GetJobOutput

func (u *URIFolderJobOutput) GetJobOutput() *JobOutput

GetJobOutput implements the JobOutputClassification interface for type URIFolderJobOutput.

func (URIFolderJobOutput) MarshalJSON

func (u URIFolderJobOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type URIFolderJobOutput.

func (*URIFolderJobOutput) UnmarshalJSON

func (u *URIFolderJobOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type URIFolderJobOutput.

type UnderlyingResourceAction

type UnderlyingResourceAction string
const (
	UnderlyingResourceActionDelete UnderlyingResourceAction = "Delete"
	UnderlyingResourceActionDetach UnderlyingResourceAction = "Detach"
)

func PossibleUnderlyingResourceActionValues

func PossibleUnderlyingResourceActionValues() []UnderlyingResourceAction

PossibleUnderlyingResourceActionValues returns the possible values for the UnderlyingResourceAction const type.

type UnitOfMeasure

type UnitOfMeasure string

UnitOfMeasure - The unit of time measurement for the specified VM price. Example: OneHour

const (
	UnitOfMeasureOneHour UnitOfMeasure = "OneHour"
)

func PossibleUnitOfMeasureValues

func PossibleUnitOfMeasureValues() []UnitOfMeasure

PossibleUnitOfMeasureValues returns the possible values for the UnitOfMeasure const type.

type UpdateWorkspaceQuotas

type UpdateWorkspaceQuotas struct {
	// The maximum permitted quota of the resource.
	Limit *int64 `json:"limit,omitempty"`

	// Status of update workspace quota.
	Status *Status `json:"status,omitempty"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the resource type.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; An enum describing the unit of quota measurement.
	Unit *QuotaUnit `json:"unit,omitempty" azure:"ro"`
}

UpdateWorkspaceQuotas - The properties for update Quota response.

type UpdateWorkspaceQuotasResult

type UpdateWorkspaceQuotasResult struct {
	// READ-ONLY; The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next
	// page of Workspace Quota update result.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of workspace quota update result.
	Value []*UpdateWorkspaceQuotas `json:"value,omitempty" azure:"ro"`
}

UpdateWorkspaceQuotasResult - The result of update workspace quota.

type Usage

type Usage struct {
	// READ-ONLY; Region of the AML workspace in the id.
	AmlWorkspaceLocation *string `json:"amlWorkspaceLocation,omitempty" azure:"ro"`

	// READ-ONLY; The current usage of the resource.
	CurrentValue *int64 `json:"currentValue,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The maximum permitted usage of the resource.
	Limit *int64 `json:"limit,omitempty" azure:"ro"`

	// READ-ONLY; The name of the type of usage.
	Name *UsageName `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the resource type.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; An enum describing the unit of usage measurement.
	Unit *UsageUnit `json:"unit,omitempty" azure:"ro"`
}

Usage - Describes AML Resource Usage.

type UsageName

type UsageName struct {
	// READ-ONLY; The localized name of the resource.
	LocalizedValue *string `json:"localizedValue,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Value *string `json:"value,omitempty" azure:"ro"`
}

UsageName - The Usage Names.

type UsageUnit

type UsageUnit string

UsageUnit - An enum describing the unit of usage measurement.

const (
	UsageUnitCount UsageUnit = "Count"
)

func PossibleUsageUnitValues

func PossibleUsageUnitValues() []UsageUnit

PossibleUsageUnitValues returns the possible values for the UsageUnit const type.

type UsagesClient

type UsagesClient struct {
	// contains filtered or unexported fields
}

UsagesClient contains the methods for the Usages group. Don't use this type directly, use NewUsagesClient() instead.

func NewUsagesClient

func NewUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UsagesClient, error)

NewUsagesClient creates a new instance of UsagesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*UsagesClient) NewListPager

func (client *UsagesClient) NewListPager(location string, options *UsagesClientListOptions) *runtime.Pager[UsagesClientListResponse]

NewListPager - Gets the current usage information as well as limits for AML resources for given subscription and location. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location for which resource usage is queried. options - UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Usage/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewUsagesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("eastus",
	nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type UsagesClientListOptions

type UsagesClientListOptions struct {
}

UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

type UsagesClientListResponse

type UsagesClientListResponse struct {
	ListUsagesResult
}

UsagesClientListResponse contains the response from method UsagesClient.List.

type UserAccountCredentials

type UserAccountCredentials struct {
	// REQUIRED; Name of the administrator user account which can be used to SSH to nodes.
	AdminUserName *string `json:"adminUserName,omitempty"`

	// Password of the administrator user account.
	AdminUserPassword *string `json:"adminUserPassword,omitempty"`

	// SSH public key of the administrator user account.
	AdminUserSSHPublicKey *string `json:"adminUserSshPublicKey,omitempty"`
}

UserAccountCredentials - Settings for user account that gets created on each on the nodes of a compute.

type UserAssignedIdentity

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserAssignedIdentity - User assigned identity properties

type UserIdentity

type UserIdentity struct {
	// REQUIRED; [Required] Specifies the type of identity framework.
	IdentityType *IdentityConfigurationType `json:"identityType,omitempty"`
}

UserIdentity - User identity configuration.

func (*UserIdentity) GetIdentityConfiguration

func (u *UserIdentity) GetIdentityConfiguration() *IdentityConfiguration

GetIdentityConfiguration implements the IdentityConfigurationClassification interface for type UserIdentity.

func (UserIdentity) MarshalJSON

func (u UserIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserIdentity.

func (*UserIdentity) UnmarshalJSON

func (u *UserIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserIdentity.

type UsernamePasswordAuthTypeWorkspaceConnectionProperties

type UsernamePasswordAuthTypeWorkspaceConnectionProperties struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType `json:"authType,omitempty"`

	// Category of the connection
	Category    *ConnectionCategory                  `json:"category,omitempty"`
	Credentials *WorkspaceConnectionUsernamePassword `json:"credentials,omitempty"`
	Target      *string                              `json:"target,omitempty"`

	// Value details of the workspace connection.
	Value *string `json:"value,omitempty"`

	// format for the workspace connection value
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

func (*UsernamePasswordAuthTypeWorkspaceConnectionProperties) GetWorkspaceConnectionPropertiesV2

GetWorkspaceConnectionPropertiesV2 implements the WorkspaceConnectionPropertiesV2Classification interface for type UsernamePasswordAuthTypeWorkspaceConnectionProperties.

func (UsernamePasswordAuthTypeWorkspaceConnectionProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type UsernamePasswordAuthTypeWorkspaceConnectionProperties.

func (*UsernamePasswordAuthTypeWorkspaceConnectionProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type UsernamePasswordAuthTypeWorkspaceConnectionProperties.

type VMPriceOSType

type VMPriceOSType string

VMPriceOSType - Operating system type used by the VM.

const (
	VMPriceOSTypeLinux   VMPriceOSType = "Linux"
	VMPriceOSTypeWindows VMPriceOSType = "Windows"
)

func PossibleVMPriceOSTypeValues

func PossibleVMPriceOSTypeValues() []VMPriceOSType

PossibleVMPriceOSTypeValues returns the possible values for the VMPriceOSType const type.

type VMPriority

type VMPriority string

VMPriority - Virtual Machine priority

const (
	VMPriorityDedicated   VMPriority = "Dedicated"
	VMPriorityLowPriority VMPriority = "LowPriority"
)

func PossibleVMPriorityValues

func PossibleVMPriorityValues() []VMPriority

PossibleVMPriorityValues returns the possible values for the VMPriority const type.

type VMTier

type VMTier string

VMTier - The type of the VM.

const (
	VMTierLowPriority VMTier = "LowPriority"
	VMTierSpot        VMTier = "Spot"
	VMTierStandard    VMTier = "Standard"
)

func PossibleVMTierValues

func PossibleVMTierValues() []VMTier

PossibleVMTierValues returns the possible values for the VMTier const type.

type ValueFormat

type ValueFormat string

ValueFormat - format for the workspace connection value

const (
	ValueFormatJSON ValueFormat = "JSON"
)

func PossibleValueFormatValues

func PossibleValueFormatValues() []ValueFormat

PossibleValueFormatValues returns the possible values for the ValueFormat const type.

type VirtualMachine

type VirtualMachine struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// The description of the Machine Learning compute.
	Description *string `json:"description,omitempty"`

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool                           `json:"disableLocalAuth,omitempty"`
	Properties       *VirtualMachineSchemaProperties `json:"properties,omitempty"`

	// ARM resource id of the underlying compute
	ResourceID *string `json:"resourceId,omitempty"`

	// READ-ONLY; Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time `json:"createdOn,omitempty" azure:"ro"`

	// READ-ONLY; Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning
	// service provisioned it if false.
	IsAttachedCompute *bool `json:"isAttachedCompute,omitempty" azure:"ro"`

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time `json:"modifiedOn,omitempty" azure:"ro"`

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse `json:"provisioningErrors,omitempty" azure:"ro"`

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualMachine - A Machine Learning compute based on Azure Virtual Machines.

func (*VirtualMachine) GetCompute

func (v *VirtualMachine) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type VirtualMachine.

func (VirtualMachine) MarshalJSON

func (v VirtualMachine) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachine.

func (*VirtualMachine) UnmarshalJSON

func (v *VirtualMachine) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachine.

type VirtualMachineImage

type VirtualMachineImage struct {
	// REQUIRED; Virtual Machine image path
	ID *string `json:"id,omitempty"`
}

VirtualMachineImage - Virtual Machine image for Windows AML Compute

type VirtualMachineSSHCredentials

type VirtualMachineSSHCredentials struct {
	// Password of admin account
	Password *string `json:"password,omitempty"`

	// Private key data
	PrivateKeyData *string `json:"privateKeyData,omitempty"`

	// Public key data
	PublicKeyData *string `json:"publicKeyData,omitempty"`

	// Username of admin account
	Username *string `json:"username,omitempty"`
}

VirtualMachineSSHCredentials - Admin credentials for virtual machine

type VirtualMachineSchema

type VirtualMachineSchema struct {
	Properties *VirtualMachineSchemaProperties `json:"properties,omitempty"`
}

type VirtualMachineSchemaProperties

type VirtualMachineSchemaProperties struct {
	// Public IP address of the virtual machine.
	Address *string `json:"address,omitempty"`

	// Admin credentials for virtual machine
	AdministratorAccount *VirtualMachineSSHCredentials `json:"administratorAccount,omitempty"`

	// Indicates whether this compute will be used for running notebooks.
	IsNotebookInstanceCompute *bool `json:"isNotebookInstanceCompute,omitempty"`

	// Notebook server port open for ssh connections.
	NotebookServerPort *int32 `json:"notebookServerPort,omitempty"`

	// Port open for ssh connections.
	SSHPort *int32 `json:"sshPort,omitempty"`

	// Virtual Machine size
	VirtualMachineSize *string `json:"virtualMachineSize,omitempty"`
}

type VirtualMachineSecrets

type VirtualMachineSecrets struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType `json:"computeType,omitempty"`

	// Admin credentials for virtual machine.
	AdministratorAccount *VirtualMachineSSHCredentials `json:"administratorAccount,omitempty"`
}

VirtualMachineSecrets - Secrets related to a Machine Learning compute based on AKS.

func (*VirtualMachineSecrets) GetComputeSecrets

func (v *VirtualMachineSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type VirtualMachineSecrets.

func (*VirtualMachineSecrets) UnmarshalJSON

func (v *VirtualMachineSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSecrets.

type VirtualMachineSecretsSchema

type VirtualMachineSecretsSchema struct {
	// Admin credentials for virtual machine.
	AdministratorAccount *VirtualMachineSSHCredentials `json:"administratorAccount,omitempty"`
}

type VirtualMachineSize

type VirtualMachineSize struct {
	// The estimated price information for using a VM.
	EstimatedVMPrices *EstimatedVMPrices `json:"estimatedVMPrices,omitempty"`

	// Specifies the compute types supported by the virtual machine size.
	SupportedComputeTypes []*string `json:"supportedComputeTypes,omitempty"`

	// READ-ONLY; The family name of the virtual machine size.
	Family *string `json:"family,omitempty" azure:"ro"`

	// READ-ONLY; The number of gPUs supported by the virtual machine size.
	Gpus *int32 `json:"gpus,omitempty" azure:"ro"`

	// READ-ONLY; Specifies if the virtual machine size supports low priority VMs.
	LowPriorityCapable *bool `json:"lowPriorityCapable,omitempty" azure:"ro"`

	// READ-ONLY; The resource volume size, in MB, allowed by the virtual machine size.
	MaxResourceVolumeMB *int32 `json:"maxResourceVolumeMB,omitempty" azure:"ro"`

	// READ-ONLY; The amount of memory, in GB, supported by the virtual machine size.
	MemoryGB *float64 `json:"memoryGB,omitempty" azure:"ro"`

	// READ-ONLY; The name of the virtual machine size.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The OS VHD disk size, in MB, allowed by the virtual machine size.
	OSVhdSizeMB *int32 `json:"osVhdSizeMB,omitempty" azure:"ro"`

	// READ-ONLY; Specifies if the virtual machine size supports premium IO.
	PremiumIO *bool `json:"premiumIO,omitempty" azure:"ro"`

	// READ-ONLY; The number of vCPUs supported by the virtual machine size.
	VCPUs *int32 `json:"vCPUs,omitempty" azure:"ro"`
}

VirtualMachineSize - Describes the properties of a VM size.

type VirtualMachineSizeListResult

type VirtualMachineSizeListResult struct {
	// The list of virtual machine sizes supported by AmlCompute.
	Value []*VirtualMachineSize `json:"value,omitempty"`
}

VirtualMachineSizeListResult - The List Virtual Machine size operation response.

type VirtualMachineSizesClient

type VirtualMachineSizesClient struct {
	// contains filtered or unexported fields
}

VirtualMachineSizesClient contains the methods for the VirtualMachineSizes group. Don't use this type directly, use NewVirtualMachineSizesClient() instead.

func NewVirtualMachineSizesClient

func NewVirtualMachineSizesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VirtualMachineSizesClient, error)

NewVirtualMachineSizesClient creates a new instance of VirtualMachineSizesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualMachineSizesClient) List

List - Returns supported VM Sizes in a location If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The location upon which virtual-machine-sizes is queried. options - VirtualMachineSizesClientListOptions contains the optional parameters for the VirtualMachineSizesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/VirtualMachineSize/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewVirtualMachineSizesClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx,
	"eastus",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualMachineSizesClientListOptions

type VirtualMachineSizesClientListOptions struct {
}

VirtualMachineSizesClientListOptions contains the optional parameters for the VirtualMachineSizesClient.List method.

type VirtualMachineSizesClientListResponse

type VirtualMachineSizesClientListResponse struct {
	VirtualMachineSizeListResult
}

VirtualMachineSizesClientListResponse contains the response from method VirtualMachineSizesClient.List.

type Workspace

type Workspace struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Specifies the location of the resource.
	Location *string `json:"location,omitempty"`

	// The properties of the machine learning workspace.
	Properties *WorkspaceProperties `json:"properties,omitempty"`

	// The sku of the workspace.
	SKU *SKU `json:"sku,omitempty"`

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Workspace - An object that represents a machine learning workspace.

func (Workspace) MarshalJSON

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Workspace.

type WorkspaceConnectionManagedIdentity

type WorkspaceConnectionManagedIdentity struct {
	ClientID   *string `json:"clientId,omitempty"`
	ResourceID *string `json:"resourceId,omitempty"`
}

type WorkspaceConnectionPersonalAccessToken

type WorkspaceConnectionPersonalAccessToken struct {
	Pat *string `json:"pat,omitempty"`
}

type WorkspaceConnectionPropertiesV2

type WorkspaceConnectionPropertiesV2 struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType `json:"authType,omitempty"`

	// Category of the connection
	Category *ConnectionCategory `json:"category,omitempty"`
	Target   *string             `json:"target,omitempty"`

	// Value details of the workspace connection.
	Value *string `json:"value,omitempty"`

	// format for the workspace connection value
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

func (*WorkspaceConnectionPropertiesV2) GetWorkspaceConnectionPropertiesV2

func (w *WorkspaceConnectionPropertiesV2) GetWorkspaceConnectionPropertiesV2() *WorkspaceConnectionPropertiesV2

GetWorkspaceConnectionPropertiesV2 implements the WorkspaceConnectionPropertiesV2Classification interface for type WorkspaceConnectionPropertiesV2.

type WorkspaceConnectionPropertiesV2BasicResource

type WorkspaceConnectionPropertiesV2BasicResource struct {
	// REQUIRED
	Properties WorkspaceConnectionPropertiesV2Classification `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

func (WorkspaceConnectionPropertiesV2BasicResource) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type WorkspaceConnectionPropertiesV2BasicResource.

func (*WorkspaceConnectionPropertiesV2BasicResource) UnmarshalJSON

func (w *WorkspaceConnectionPropertiesV2BasicResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceConnectionPropertiesV2BasicResource.

type WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult

type WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult struct {
	Value []*WorkspaceConnectionPropertiesV2BasicResource `json:"value,omitempty"`

	// READ-ONLY
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

type WorkspaceConnectionPropertiesV2Classification

type WorkspaceConnectionPropertiesV2Classification interface {
	// GetWorkspaceConnectionPropertiesV2 returns the WorkspaceConnectionPropertiesV2 content of the underlying type.
	GetWorkspaceConnectionPropertiesV2() *WorkspaceConnectionPropertiesV2
}

WorkspaceConnectionPropertiesV2Classification provides polymorphic access to related types. Call the interface's GetWorkspaceConnectionPropertiesV2() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ManagedIdentityAuthTypeWorkspaceConnectionProperties, *NoneAuthTypeWorkspaceConnectionProperties, *PATAuthTypeWorkspaceConnectionProperties, - *SASAuthTypeWorkspaceConnectionProperties, *UsernamePasswordAuthTypeWorkspaceConnectionProperties, *WorkspaceConnectionPropertiesV2

type WorkspaceConnectionSharedAccessSignature

type WorkspaceConnectionSharedAccessSignature struct {
	Sas *string `json:"sas,omitempty"`
}

type WorkspaceConnectionUsernamePassword

type WorkspaceConnectionUsernamePassword struct {
	Password *string `json:"password,omitempty"`
	Username *string `json:"username,omitempty"`
}

type WorkspaceConnectionsClient

type WorkspaceConnectionsClient struct {
	// contains filtered or unexported fields
}

WorkspaceConnectionsClient contains the methods for the WorkspaceConnections group. Don't use this type directly, use NewWorkspaceConnectionsClient() instead.

func NewWorkspaceConnectionsClient

func NewWorkspaceConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceConnectionsClient, error)

NewWorkspaceConnectionsClient creates a new instance of WorkspaceConnectionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WorkspaceConnectionsClient) Create

Create - If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. connectionName - Friendly name of the workspace connection parameters - The object for creating or updating a new workspace connection options - WorkspaceConnectionsClientCreateOptions contains the optional parameters for the WorkspaceConnectionsClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/WorkspaceConnection/create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Create(ctx,
	"resourceGroup-1",
	"workspace-1",
	"connection-1",
	armmachinelearning.WorkspaceConnectionPropertiesV2BasicResource{
		Properties: &armmachinelearning.NoneAuthTypeWorkspaceConnectionProperties{
			AuthType: to.Ptr(armmachinelearning.ConnectionAuthTypeNone),
			Category: to.Ptr(armmachinelearning.ConnectionCategoryContainerRegistry),
			Target:   to.Ptr("www.facebook.com"),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspaceConnectionsClient) Delete

func (client *WorkspaceConnectionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, connectionName string, options *WorkspaceConnectionsClientDeleteOptions) (WorkspaceConnectionsClientDeleteResponse, error)

Delete - If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. connectionName - Friendly name of the workspace connection options - WorkspaceConnectionsClientDeleteOptions contains the optional parameters for the WorkspaceConnectionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/WorkspaceConnection/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx,
	"resourceGroup-1",
	"workspace-1",
	"connection-1",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*WorkspaceConnectionsClient) Get

func (client *WorkspaceConnectionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, connectionName string, options *WorkspaceConnectionsClientGetOptions) (WorkspaceConnectionsClientGetResponse, error)

Get - If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. connectionName - Friendly name of the workspace connection options - WorkspaceConnectionsClientGetOptions contains the optional parameters for the WorkspaceConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/WorkspaceConnection/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"resourceGroup-1",
	"workspace-1",
	"connection-1",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspaceConnectionsClient) NewListPager

NewListPager - If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspaceConnectionsClientListOptions contains the optional parameters for the WorkspaceConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/WorkspaceConnection/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("resourceGroup-1",
	"workspace-1",
	&armmachinelearning.WorkspaceConnectionsClientListOptions{Target: to.Ptr("www.facebook.com"),
		Category: to.Ptr("ContainerRegistry"),
	})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type WorkspaceConnectionsClientCreateOptions

type WorkspaceConnectionsClientCreateOptions struct {
}

WorkspaceConnectionsClientCreateOptions contains the optional parameters for the WorkspaceConnectionsClient.Create method.

type WorkspaceConnectionsClientCreateResponse

type WorkspaceConnectionsClientCreateResponse struct {
	WorkspaceConnectionPropertiesV2BasicResource
}

WorkspaceConnectionsClientCreateResponse contains the response from method WorkspaceConnectionsClient.Create.

type WorkspaceConnectionsClientDeleteOptions

type WorkspaceConnectionsClientDeleteOptions struct {
}

WorkspaceConnectionsClientDeleteOptions contains the optional parameters for the WorkspaceConnectionsClient.Delete method.

type WorkspaceConnectionsClientDeleteResponse

type WorkspaceConnectionsClientDeleteResponse struct {
}

WorkspaceConnectionsClientDeleteResponse contains the response from method WorkspaceConnectionsClient.Delete.

type WorkspaceConnectionsClientGetOptions

type WorkspaceConnectionsClientGetOptions struct {
}

WorkspaceConnectionsClientGetOptions contains the optional parameters for the WorkspaceConnectionsClient.Get method.

type WorkspaceConnectionsClientGetResponse

type WorkspaceConnectionsClientGetResponse struct {
	WorkspaceConnectionPropertiesV2BasicResource
}

WorkspaceConnectionsClientGetResponse contains the response from method WorkspaceConnectionsClient.Get.

type WorkspaceConnectionsClientListOptions

type WorkspaceConnectionsClientListOptions struct {
	// Category of the workspace connection.
	Category *string
	// Target of the workspace connection.
	Target *string
}

WorkspaceConnectionsClientListOptions contains the optional parameters for the WorkspaceConnectionsClient.List method.

type WorkspaceConnectionsClientListResponse

type WorkspaceConnectionsClientListResponse struct {
	WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult
}

WorkspaceConnectionsClientListResponse contains the response from method WorkspaceConnectionsClient.List.

type WorkspaceFeaturesClient

type WorkspaceFeaturesClient struct {
	// contains filtered or unexported fields
}

WorkspaceFeaturesClient contains the methods for the WorkspaceFeatures group. Don't use this type directly, use NewWorkspaceFeaturesClient() instead.

func NewWorkspaceFeaturesClient

func NewWorkspaceFeaturesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceFeaturesClient, error)

NewWorkspaceFeaturesClient creates a new instance of WorkspaceFeaturesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WorkspaceFeaturesClient) NewListPager

func (client *WorkspaceFeaturesClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceFeaturesClientListOptions) *runtime.Pager[WorkspaceFeaturesClientListResponse]

NewListPager - Lists all enabled features for a workspace If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspaceFeaturesClientListOptions contains the optional parameters for the WorkspaceFeaturesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/WorkspaceFeature/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspaceFeaturesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myResourceGroup",
	"testworkspace",
	nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type WorkspaceFeaturesClientListOptions

type WorkspaceFeaturesClientListOptions struct {
}

WorkspaceFeaturesClientListOptions contains the optional parameters for the WorkspaceFeaturesClient.List method.

type WorkspaceFeaturesClientListResponse

type WorkspaceFeaturesClientListResponse struct {
	ListAmlUserFeatureResult
}

WorkspaceFeaturesClientListResponse contains the response from method WorkspaceFeaturesClient.List.

type WorkspaceListResult

type WorkspaceListResult struct {
	// The URI that can be used to request the next list of machine learning workspaces.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request
	// the next list of machine learning workspaces.
	Value []*Workspace `json:"value,omitempty"`
}

WorkspaceListResult - The result of a request to list machine learning workspaces.

type WorkspaceProperties

type WorkspaceProperties struct {
	// The flag to indicate whether to allow public access when behind VNet.
	AllowPublicAccessWhenBehindVnet *bool `json:"allowPublicAccessWhenBehindVnet,omitempty"`

	// ARM id of the application insights associated with this workspace.
	ApplicationInsights *string `json:"applicationInsights,omitempty"`

	// ARM id of the container registry associated with this workspace.
	ContainerRegistry *string `json:"containerRegistry,omitempty"`

	// The description of this workspace.
	Description *string `json:"description,omitempty"`

	// Url for the discovery service to identify regional endpoints for machine learning experimentation services
	DiscoveryURL *string `json:"discoveryUrl,omitempty"`

	// The encryption settings of Azure ML workspace.
	Encryption *EncryptionProperty `json:"encryption,omitempty"`

	// The friendly name for this workspace. This name in mutable
	FriendlyName *string `json:"friendlyName,omitempty"`

	// The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
	HbiWorkspace *bool `json:"hbiWorkspace,omitempty"`

	// The compute name for image build
	ImageBuildCompute *string `json:"imageBuildCompute,omitempty"`

	// ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
	KeyVault *string `json:"keyVault,omitempty"`

	// The user assigned identity resource id that represents the workspace identity.
	PrimaryUserAssignedIdentity *string `json:"primaryUserAssignedIdentity,omitempty"`

	// Whether requests from Public Network are allowed.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// The service managed resource settings.
	ServiceManagedResourcesSettings *ServiceManagedResourcesSettings `json:"serviceManagedResourcesSettings,omitempty"`

	// The list of shared private link resources in this workspace.
	SharedPrivateLinkResources []*SharedPrivateLinkResource `json:"sharedPrivateLinkResources,omitempty"`

	// ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
	StorageAccount *string `json:"storageAccount,omitempty"`

	// Enabling v1legacymode may prevent you from using features provided by the v2 API.
	V1LegacyMode *bool `json:"v1LegacyMode,omitempty"`

	// READ-ONLY; The URI associated with this workspace that machine learning flow must point at to set up tracking.
	MlFlowTrackingURI *string `json:"mlFlowTrackingUri,omitempty" azure:"ro"`

	// READ-ONLY; The notebook info of Azure ML workspace.
	NotebookInfo *NotebookResourceInfo `json:"notebookInfo,omitempty" azure:"ro"`

	// READ-ONLY; The list of private endpoint connections in the workspace.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Count of private connections in the workspace
	PrivateLinkCount *int32 `json:"privateLinkCount,omitempty" azure:"ro"`

	// READ-ONLY; The current deployment state of workspace resource. The provisioningState is to indicate states for resource
	// provisioning.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The name of the managed resource group created by workspace RP in customer subscription if the workspace is
	// CMK workspace
	ServiceProvisionedResourceGroup *string `json:"serviceProvisionedResourceGroup,omitempty" azure:"ro"`

	// READ-ONLY; If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
	StorageHnsEnabled *bool `json:"storageHnsEnabled,omitempty" azure:"ro"`

	// READ-ONLY; The tenant id associated with this workspace.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`

	// READ-ONLY; The immutable id associated with this workspace.
	WorkspaceID *string `json:"workspaceId,omitempty" azure:"ro"`
}

WorkspaceProperties - The properties of a machine learning workspace.

func (WorkspaceProperties) MarshalJSON

func (w WorkspaceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceProperties.

type WorkspacePropertiesUpdateParameters

type WorkspacePropertiesUpdateParameters struct {
	// ARM id of the application insights associated with this workspace.
	ApplicationInsights *string `json:"applicationInsights,omitempty"`

	// ARM id of the container registry associated with this workspace.
	ContainerRegistry *string `json:"containerRegistry,omitempty"`

	// The description of this workspace.
	Description *string `json:"description,omitempty"`

	// The friendly name for this workspace.
	FriendlyName *string `json:"friendlyName,omitempty"`

	// The compute name for image build
	ImageBuildCompute *string `json:"imageBuildCompute,omitempty"`

	// The user assigned identity resource id that represents the workspace identity.
	PrimaryUserAssignedIdentity *string `json:"primaryUserAssignedIdentity,omitempty"`

	// Whether requests from Public Network are allowed.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// The service managed resource settings.
	ServiceManagedResourcesSettings *ServiceManagedResourcesSettings `json:"serviceManagedResourcesSettings,omitempty"`
}

WorkspacePropertiesUpdateParameters - The parameters for updating the properties of a machine learning workspace.

type WorkspaceUpdateParameters

type WorkspaceUpdateParameters struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// The properties that the machine learning workspace will be updated with.
	Properties *WorkspacePropertiesUpdateParameters `json:"properties,omitempty"`

	// The sku of the workspace.
	SKU *SKU `json:"sku,omitempty"`

	// The resource tags for the machine learning workspace.
	Tags map[string]*string `json:"tags,omitempty"`
}

WorkspaceUpdateParameters - The parameters for updating a machine learning workspace.

func (WorkspaceUpdateParameters) MarshalJSON

func (w WorkspaceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceUpdateParameters.

type WorkspacesClient

type WorkspacesClient struct {
	// contains filtered or unexported fields
}

WorkspacesClient contains the methods for the Workspaces group. Don't use this type directly, use NewWorkspacesClient() instead.

func NewWorkspacesClient

func NewWorkspacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspacesClient, error)

NewWorkspacesClient creates a new instance of WorkspacesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WorkspacesClient) BeginCreateOrUpdate

func (client *WorkspacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, parameters Workspace, options *WorkspacesClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspacesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a workspace with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. parameters - The parameters for creating or updating a machine learning workspace. options - WorkspacesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspacesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx,
	"workspace-1234",
	"testworkspace",
	armmachinelearning.Workspace{
		Identity: &armmachinelearning.ManagedServiceIdentity{
			Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
			UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
				"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": {},
			},
		},
		Location: to.Ptr("eastus2euap"),
		Properties: &armmachinelearning.WorkspaceProperties{
			Description:         to.Ptr("test description"),
			ApplicationInsights: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights"),
			ContainerRegistry:   to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry"),
			Encryption: &armmachinelearning.EncryptionProperty{
				Identity: &armmachinelearning.IdentityForCmk{
					UserAssignedIdentity: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai"),
				},
				KeyVaultProperties: &armmachinelearning.EncryptionKeyVaultProperties{
					IdentityClientID: to.Ptr(""),
					KeyIdentifier:    to.Ptr("https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb"),
					KeyVaultArmID:    to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv"),
				},
				Status: to.Ptr(armmachinelearning.EncryptionStatusEnabled),
			},
			FriendlyName: to.Ptr("HelloName"),
			HbiWorkspace: to.Ptr(false),
			KeyVault:     to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv"),
			SharedPrivateLinkResources: []*armmachinelearning.SharedPrivateLinkResource{
				{
					Name: to.Ptr("testdbresource"),
					Properties: &armmachinelearning.SharedPrivateLinkResourceProperty{
						GroupID:               to.Ptr("Sql"),
						PrivateLinkResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql"),
						RequestMessage:        to.Ptr("Please approve"),
						Status:                to.Ptr(armmachinelearning.PrivateEndpointServiceConnectionStatusApproved),
					},
				}},
			StorageAccount: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount"),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) BeginDelete

func (client *WorkspacesClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginDeleteOptions) (*runtime.Poller[WorkspacesClientDeleteResponse], error)

BeginDelete - Deletes a machine learning workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginDeleteOptions contains the optional parameters for the WorkspacesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx,
	"workspace-1234",
	"testworkspace",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*WorkspacesClient) BeginDiagnose

func (client *WorkspacesClient) BeginDiagnose(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginDiagnoseOptions) (*runtime.Poller[WorkspacesClientDiagnoseResponse], error)

BeginDiagnose - Diagnose workspace setup issue. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginDiagnoseOptions contains the optional parameters for the WorkspacesClient.BeginDiagnose method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/diagnose.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDiagnose(ctx,
	"workspace-1234",
	"testworkspace",
	&armmachinelearning.WorkspacesClientBeginDiagnoseOptions{Parameters: &armmachinelearning.DiagnoseWorkspaceParameters{
		Value: &armmachinelearning.DiagnoseRequestProperties{
			ApplicationInsights: map[string]interface{}{},
			ContainerRegistry:   map[string]interface{}{},
			DNSResolution:       map[string]interface{}{},
			KeyVault:            map[string]interface{}{},
			Nsg:                 map[string]interface{}{},
			Others:              map[string]interface{}{},
			ResourceLock:        map[string]interface{}{},
			StorageAccount:      map[string]interface{}{},
			Udr:                 map[string]interface{}{},
		},
	},
	})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) BeginPrepareNotebook

func (client *WorkspacesClient) BeginPrepareNotebook(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginPrepareNotebookOptions) (*runtime.Poller[WorkspacesClientPrepareNotebookResponse], error)

BeginPrepareNotebook - Prepare a notebook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginPrepareNotebookOptions contains the optional parameters for the WorkspacesClient.BeginPrepareNotebook method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Notebook/prepare.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginPrepareNotebook(ctx,
	"testrg123",
	"workspaces123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) BeginResyncKeys

func (client *WorkspacesClient) BeginResyncKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginResyncKeysOptions) (*runtime.Poller[WorkspacesClientResyncKeysResponse], error)

BeginResyncKeys - Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginResyncKeysOptions contains the optional parameters for the WorkspacesClient.BeginResyncKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/resyncKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginResyncKeys(ctx,
	"testrg123",
	"workspaces123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*WorkspacesClient) BeginUpdate

func (client *WorkspacesClient) BeginUpdate(ctx context.Context, resourceGroupName string, workspaceName string, parameters WorkspaceUpdateParameters, options *WorkspacesClientBeginUpdateOptions) (*runtime.Poller[WorkspacesClientUpdateResponse], error)

BeginUpdate - Updates a machine learning workspace with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. parameters - The parameters for updating a machine learning workspace. options - WorkspacesClientBeginUpdateOptions contains the optional parameters for the WorkspacesClient.BeginUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx,
	"workspace-1234",
	"testworkspace",
	armmachinelearning.WorkspaceUpdateParameters{
		Properties: &armmachinelearning.WorkspacePropertiesUpdateParameters{
			Description:         to.Ptr("new description"),
			FriendlyName:        to.Ptr("New friendly name"),
			PublicNetworkAccess: to.Ptr(armmachinelearning.PublicNetworkAccessDisabled),
		},
	},
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) Get

func (client *WorkspacesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientGetOptions) (WorkspacesClientGetResponse, error)

Get - Gets the properties of the specified machine learning workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientGetOptions contains the optional parameters for the WorkspacesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx,
	"workspace-1234",
	"testworkspace",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) ListKeys

func (client *WorkspacesClient) ListKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListKeysOptions) (WorkspacesClientListKeysResponse, error)

ListKeys - Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListKeysOptions contains the optional parameters for the WorkspacesClient.ListKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/listKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListKeys(ctx,
	"testrg123",
	"workspaces123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) ListNotebookAccessToken

func (client *WorkspacesClient) ListNotebookAccessToken(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListNotebookAccessTokenOptions) (WorkspacesClientListNotebookAccessTokenResponse, error)

ListNotebookAccessToken - return notebook access token and refresh token If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListNotebookAccessTokenOptions contains the optional parameters for the WorkspacesClient.ListNotebookAccessToken method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/listNotebookAccessToken.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListNotebookAccessToken(ctx,
	"workspace-1234",
	"testworkspace",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) ListNotebookKeys

func (client *WorkspacesClient) ListNotebookKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListNotebookKeysOptions) (WorkspacesClientListNotebookKeysResponse, error)

ListNotebookKeys - List keys of a notebook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListNotebookKeysOptions contains the optional parameters for the WorkspacesClient.ListNotebookKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Notebook/listKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListNotebookKeys(ctx,
	"testrg123",
	"workspaces123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) ListOutboundNetworkDependenciesEndpoints

func (client *WorkspacesClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions) (WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse, error)

ListOutboundNetworkDependenciesEndpoints - Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the WorkspacesClient.ListOutboundNetworkDependenciesEndpoints method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/ExternalFQDN/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListOutboundNetworkDependenciesEndpoints(ctx,
	"workspace-1234",
	"testworkspace",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) ListStorageAccountKeys

func (client *WorkspacesClient) ListStorageAccountKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListStorageAccountKeysOptions) (WorkspacesClientListStorageAccountKeysResponse, error)

ListStorageAccountKeys - List storage account keys of a workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListStorageAccountKeysOptions contains the optional parameters for the WorkspacesClient.ListStorageAccountKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/listStorageAccountKeys.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListStorageAccountKeys(ctx,
	"testrg123",
	"workspaces123",
	nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WorkspacesClient) NewListByResourceGroupPager

func (client *WorkspacesClient) NewListByResourceGroupPager(resourceGroupName string, options *WorkspacesClientListByResourceGroupOptions) *runtime.Pager[WorkspacesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Lists all the available machine learning workspaces under the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. The name is case insensitive. options - WorkspacesClientListByResourceGroupOptions contains the optional parameters for the WorkspacesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/listByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("workspace-1234",
	&armmachinelearning.WorkspacesClientListByResourceGroupOptions{Skip: nil})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*WorkspacesClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Lists all the available machine learning workspaces under the specified subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - WorkspacesClientListBySubscriptionOptions contains the optional parameters for the WorkspacesClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-05-01/examples/Workspace/listBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armmachinelearning.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListBySubscriptionPager(&armmachinelearning.WorkspacesClientListBySubscriptionOptions{Skip: nil})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type WorkspacesClientBeginCreateOrUpdateOptions

type WorkspacesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspacesClient.BeginCreateOrUpdate method.

type WorkspacesClientBeginDeleteOptions

type WorkspacesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginDeleteOptions contains the optional parameters for the WorkspacesClient.BeginDelete method.

type WorkspacesClientBeginDiagnoseOptions

type WorkspacesClientBeginDiagnoseOptions struct {
	// The parameter of diagnosing workspace health
	Parameters *DiagnoseWorkspaceParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginDiagnoseOptions contains the optional parameters for the WorkspacesClient.BeginDiagnose method.

type WorkspacesClientBeginPrepareNotebookOptions

type WorkspacesClientBeginPrepareNotebookOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginPrepareNotebookOptions contains the optional parameters for the WorkspacesClient.BeginPrepareNotebook method.

type WorkspacesClientBeginResyncKeysOptions

type WorkspacesClientBeginResyncKeysOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginResyncKeysOptions contains the optional parameters for the WorkspacesClient.BeginResyncKeys method.

type WorkspacesClientBeginUpdateOptions

type WorkspacesClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspacesClientBeginUpdateOptions contains the optional parameters for the WorkspacesClient.BeginUpdate method.

type WorkspacesClientCreateOrUpdateResponse

type WorkspacesClientCreateOrUpdateResponse struct {
	Workspace
}

WorkspacesClientCreateOrUpdateResponse contains the response from method WorkspacesClient.CreateOrUpdate.

type WorkspacesClientDeleteResponse

type WorkspacesClientDeleteResponse struct {
}

WorkspacesClientDeleteResponse contains the response from method WorkspacesClient.Delete.

type WorkspacesClientDiagnoseResponse

type WorkspacesClientDiagnoseResponse struct {
	DiagnoseResponseResult
}

WorkspacesClientDiagnoseResponse contains the response from method WorkspacesClient.Diagnose.

type WorkspacesClientGetOptions

type WorkspacesClientGetOptions struct {
}

WorkspacesClientGetOptions contains the optional parameters for the WorkspacesClient.Get method.

type WorkspacesClientGetResponse

type WorkspacesClientGetResponse struct {
	Workspace
}

WorkspacesClientGetResponse contains the response from method WorkspacesClient.Get.

type WorkspacesClientListByResourceGroupOptions

type WorkspacesClientListByResourceGroupOptions struct {
	// Continuation token for pagination.
	Skip *string
}

WorkspacesClientListByResourceGroupOptions contains the optional parameters for the WorkspacesClient.ListByResourceGroup method.

type WorkspacesClientListByResourceGroupResponse

type WorkspacesClientListByResourceGroupResponse struct {
	WorkspaceListResult
}

WorkspacesClientListByResourceGroupResponse contains the response from method WorkspacesClient.ListByResourceGroup.

type WorkspacesClientListBySubscriptionOptions

type WorkspacesClientListBySubscriptionOptions struct {
	// Continuation token for pagination.
	Skip *string
}

WorkspacesClientListBySubscriptionOptions contains the optional parameters for the WorkspacesClient.ListBySubscription method.

type WorkspacesClientListBySubscriptionResponse

type WorkspacesClientListBySubscriptionResponse struct {
	WorkspaceListResult
}

WorkspacesClientListBySubscriptionResponse contains the response from method WorkspacesClient.ListBySubscription.

type WorkspacesClientListKeysOptions

type WorkspacesClientListKeysOptions struct {
}

WorkspacesClientListKeysOptions contains the optional parameters for the WorkspacesClient.ListKeys method.

type WorkspacesClientListKeysResponse

type WorkspacesClientListKeysResponse struct {
	ListWorkspaceKeysResult
}

WorkspacesClientListKeysResponse contains the response from method WorkspacesClient.ListKeys.

type WorkspacesClientListNotebookAccessTokenOptions

type WorkspacesClientListNotebookAccessTokenOptions struct {
}

WorkspacesClientListNotebookAccessTokenOptions contains the optional parameters for the WorkspacesClient.ListNotebookAccessToken method.

type WorkspacesClientListNotebookAccessTokenResponse

type WorkspacesClientListNotebookAccessTokenResponse struct {
	NotebookAccessTokenResult
}

WorkspacesClientListNotebookAccessTokenResponse contains the response from method WorkspacesClient.ListNotebookAccessToken.

type WorkspacesClientListNotebookKeysOptions

type WorkspacesClientListNotebookKeysOptions struct {
}

WorkspacesClientListNotebookKeysOptions contains the optional parameters for the WorkspacesClient.ListNotebookKeys method.

type WorkspacesClientListNotebookKeysResponse

type WorkspacesClientListNotebookKeysResponse struct {
	ListNotebookKeysResult
}

WorkspacesClientListNotebookKeysResponse contains the response from method WorkspacesClient.ListNotebookKeys.

type WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions

type WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions struct {
}

WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the WorkspacesClient.ListOutboundNetworkDependenciesEndpoints method.

type WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse

type WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse struct {
	ExternalFQDNResponse
}

WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse contains the response from method WorkspacesClient.ListOutboundNetworkDependenciesEndpoints.

type WorkspacesClientListStorageAccountKeysOptions

type WorkspacesClientListStorageAccountKeysOptions struct {
}

WorkspacesClientListStorageAccountKeysOptions contains the optional parameters for the WorkspacesClient.ListStorageAccountKeys method.

type WorkspacesClientListStorageAccountKeysResponse

type WorkspacesClientListStorageAccountKeysResponse struct {
	ListStorageAccountKeysResult
}

WorkspacesClientListStorageAccountKeysResponse contains the response from method WorkspacesClient.ListStorageAccountKeys.

type WorkspacesClientPrepareNotebookResponse

type WorkspacesClientPrepareNotebookResponse struct {
	NotebookResourceInfo
}

WorkspacesClientPrepareNotebookResponse contains the response from method WorkspacesClient.PrepareNotebook.

type WorkspacesClientResyncKeysResponse

type WorkspacesClientResyncKeysResponse struct {
}

WorkspacesClientResyncKeysResponse contains the response from method WorkspacesClient.ResyncKeys.

type WorkspacesClientUpdateResponse

type WorkspacesClientUpdateResponse struct {
	Workspace
}

WorkspacesClientUpdateResponse contains the response from method WorkspacesClient.Update.

Jump to

Keyboard shortcuts

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