armmachinelearning

package module
v3.2.0 Latest Latest
Warning

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

Go to latest
Published: Nov 24, 2023 License: MIT Imports: 15 Imported by: 43

README

Azure Machine Learning Module for Go

PkgGoDev

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

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

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/v2

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.

Client Factory

Azure Machine Learning module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armmachinelearning.NewClientFactory(<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,
    },
}
clientFactory, err := armmachinelearning.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewUsagesClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Major Version Upgrade

Go uses semantic import versioning to ensure a good backward compatibility for modules. For Azure Go management SDK, we usually upgrade module version according to cooresponding service's API version. Regarding it could be a complicated experience for major version upgrade, we will try our best to keep the SDK API stable and release new version in backward compatible way. However, if any unavoidable breaking changes and a new major version releases for SDK modules, you could use these commands under your module folder to upgrade:

go install github.com/icholy/gomajor@latest
gomajor get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute@latest

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

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// AKS properties
	Properties *AKSSchemaProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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
}

func (AKSSchema) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AKSSchema.

func (*AKSSchema) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AKSSchema.

type AKSSchemaProperties

type AKSSchemaProperties struct {
	// Number of agents
	AgentCount *int32

	// Agent virtual machine size
	AgentVMSize *string

	// AKS networking configuration for vnet
	AksNetworkingConfiguration *AksNetworkingConfiguration

	// Cluster full qualified domain name
	ClusterFqdn *string

	// Intended usage of the cluster
	ClusterPurpose *ClusterPurpose

	// Load Balancer Subnet
	LoadBalancerSubnet *string

	// Load Balancer Type
	LoadBalancerType *LoadBalancerType

	// SSL configuration
	SSLConfiguration *SSLConfiguration

	// READ-ONLY; System services
	SystemServices []*SystemService
}

AKSSchemaProperties - AKS properties

func (AKSSchemaProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AKSSchemaProperties.

func (*AKSSchemaProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AKSSchemaProperties.

type AccountKeyDatastoreCredentials

type AccountKeyDatastoreCredentials struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType

	// REQUIRED; [Required] Storage account secrets.
	Secrets *AccountKeyDatastoreSecrets
}

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

	// Storage account key.
	Key *string
}

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

	// Content of kubeconfig file that can be used to connect to the Kubernetes cluster.
	AdminKubeConfig *string

	// Image registry pull secret.
	ImagePullSecretName *string

	// Content of kubeconfig file that can be used to connect to the Kubernetes cluster.
	UserKubeConfig *string
}

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

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

MarshalJSON implements the json.Marshaller 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

	// Image registry pull secret.
	ImagePullSecretName *string

	// Content of kubeconfig file that can be used to connect to the Kubernetes cluster.
	UserKubeConfig *string
}

AksComputeSecretsProperties - Properties of AksComputeSecrets

func (AksComputeSecretsProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AksComputeSecretsProperties.

func (*AksComputeSecretsProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AksComputeSecretsProperties.

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

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

	// A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
	ServiceCidr *string

	// Virtual network subnet resource ID the compute nodes belong to
	SubnetID *string
}

AksNetworkingConfiguration - Advance configuration for AKS networking

func (AksNetworkingConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AksNetworkingConfiguration.

func (*AksNetworkingConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AksNetworkingConfiguration.

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

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// Properties of AmlCompute
	Properties *AmlComputeProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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

	// READ-ONLY; State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.
	NodeState *NodeState

	// READ-ONLY; SSH port number of the node.
	Port *int32

	// READ-ONLY; Private IP address of the compute node.
	PrivateIPAddress *string

	// READ-ONLY; Public IP address of the compute node.
	PublicIPAddress *string

	// READ-ONLY; ID of the Experiment running on the node, if any else null.
	RunID *string
}

AmlComputeNodeInformation - Compute node information related to a AmlCompute.

func (AmlComputeNodeInformation) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlComputeNodeInformation.

func (*AmlComputeNodeInformation) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlComputeNodeInformation.

type AmlComputeNodesInformation

type AmlComputeNodesInformation struct {
	// READ-ONLY; The continuation token.
	NextLink *string

	// READ-ONLY; The collection of returned AmlCompute nodes details.
	Nodes []*AmlComputeNodeInformation
}

AmlComputeNodesInformation - Result of AmlCompute Nodes

func (AmlComputeNodesInformation) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlComputeNodesInformation.

func (*AmlComputeNodesInformation) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlComputeNodesInformation.

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

	// Network is isolated or not
	IsolatedNetwork *bool

	// Compute OS Type
	OSType *OsType

	// A property bag containing additional properties.
	PropertyBag any

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

	// Scale settings for AML Compute
	ScaleSettings *ScaleSettings

	// Virtual network subnet resource ID the compute nodes belong to.
	Subnet *ResourceID

	// Credentials for an administrator user account that will be created on each compute node.
	UserAccountCredentials *UserAccountCredentials

	// Virtual Machine priority
	VMPriority *VMPriority

	// Virtual Machine Size
	VMSize *string

	// Virtual Machine image for AML Compute - windows only
	VirtualMachineImage *VirtualMachineImage

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

	// READ-ONLY; The time at which the compute entered its current allocation state.
	AllocationStateTransitionTime *time.Time

	// READ-ONLY; The number of compute nodes currently assigned to the compute.
	CurrentNodeCount *int32

	// READ-ONLY; Collection of errors encountered by various compute nodes during node setup.
	Errors []*ErrorResponse

	// READ-ONLY; Counts of various node states on the compute.
	NodeStateCounts *NodeStateCounts

	// 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
}

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
}

AmlComputeSchema - Properties(top level) of AmlCompute

func (AmlComputeSchema) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlComputeSchema.

func (*AmlComputeSchema) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlComputeSchema.

type AmlOperation

type AmlOperation struct {
	// Display name of operation
	Display *AmlOperationDisplay

	// Indicates whether the operation applies to data-plane
	IsDataAction *bool

	// Operation name: {provider}/{resource}/{operation}
	Name *string
}

AmlOperation - Azure Machine Learning workspace REST API operation

func (AmlOperation) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlOperation.

func (*AmlOperation) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlOperation.

type AmlOperationDisplay

type AmlOperationDisplay struct {
	// The description for the operation.
	Description *string

	// The operation that users can perform.
	Operation *string

	// The resource provider name: Microsoft.MachineLearningExperimentation
	Provider *string

	// The resource on which the operation is performed.
	Resource *string
}

AmlOperationDisplay - Display name of operation

func (AmlOperationDisplay) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlOperationDisplay.

func (*AmlOperationDisplay) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlOperationDisplay.

type AmlOperationListResult

type AmlOperationListResult struct {
	// List of AML workspace operations supported by the AML workspace resource provider.
	Value []*AmlOperation
}

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

func (AmlOperationListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlOperationListResult.

func (*AmlOperationListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlOperationListResult.

type AmlToken

type AmlToken struct {
	// REQUIRED; [Required] Specifies the type of identity framework.
	IdentityType *IdentityConfigurationType
}

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

	// Specifies the feature name
	DisplayName *string

	// Specifies the feature ID
	ID *string
}

AmlUserFeature - Features enabled for a workspace

func (AmlUserFeature) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlUserFeature.

func (*AmlUserFeature) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlUserFeature.

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

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

func (AssetBase) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AssetBase.

func (*AssetBase) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AssetBase.

type AssetContainer

type AssetContainer struct {
	// The asset description text.
	Description *string

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string

	// READ-ONLY; The next auto incremental version
	NextVersion *string
}

func (AssetContainer) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AssetContainer.

func (*AssetContainer) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AssetContainer.

type AssetJobInput

type AssetJobInput struct {
	// REQUIRED; [Required] Input Asset URI.
	URI *string

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode
}

AssetJobInput - Asset input type.

func (AssetJobInput) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AssetJobInput.

func (*AssetJobInput) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AssetJobInput.

type AssetJobOutput

type AssetJobOutput struct {
	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode

	// Output Asset URI.
	URI *string
}

AssetJobOutput - Asset output type.

func (AssetJobOutput) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AssetJobOutput.

func (*AssetJobOutput) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AssetJobOutput.

type AssetReferenceBase

type AssetReferenceBase struct {
	// REQUIRED; [Required] Specifies the type of asset reference.
	ReferenceType *ReferenceType
}

AssetReferenceBase - Base definition for asset references.

func (*AssetReferenceBase) GetAssetReferenceBase

func (a *AssetReferenceBase) GetAssetReferenceBase() *AssetReferenceBase

GetAssetReferenceBase implements the AssetReferenceBaseClassification interface for type AssetReferenceBase.

func (AssetReferenceBase) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AssetReferenceBase.

func (*AssetReferenceBase) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// REQUIRED; User’s AAD Tenant Id.
	TenantID *string
}

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

func (AssignedUser) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AssignedUser.

func (*AssignedUser) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AssignedUser.

type AutoForecastHorizon

type AutoForecastHorizon struct {
	// REQUIRED; [Required] Set forecast horizon value selection mode.
	Mode *ForecastHorizonMode
}

AutoForecastHorizon - Forecast horizon determined automatically by system.

func (*AutoForecastHorizon) GetForecastHorizon

func (a *AutoForecastHorizon) GetForecastHorizon() *ForecastHorizon

GetForecastHorizon implements the ForecastHorizonClassification interface for type AutoForecastHorizon.

func (AutoForecastHorizon) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoForecastHorizon.

func (*AutoForecastHorizon) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoForecastHorizon.

type AutoMLJob

type AutoMLJob struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobType *JobType

	// REQUIRED; [Required] This represents scenario which can be one of Tables/NLP/Image
	TaskDetails AutoMLVerticalClassification

	// ARM resource ID of the component resource.
	ComponentID *string

	// ARM resource ID of the compute resource.
	ComputeID *string

	// The asset description text.
	Description *string

	// Display name of job.
	DisplayName *string

	// The ARM resource ID of the Environment specification for the job. This is optional value to provide, if not provided, AutoML
	// will default this to Production AutoML curated environment version when
	// running the job.
	EnvironmentID *string

	// Environment variables included in the job.
	EnvironmentVariables map[string]*string

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

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification

	// Is the asset archived?
	IsArchived *bool

	// Mapping of output data bindings used in the job.
	Outputs map[string]JobOutputClassification

	// The asset property dictionary.
	Properties map[string]*string

	// Compute Resource configuration for the job.
	Resources *JobResourceConfiguration

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

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Status of the job.
	Status *JobStatus
}

AutoMLJob class. Use this class for executing AutoML tasks like Classification/Regression etc. See TaskType enum for all the tasks supported.

func (*AutoMLJob) GetJobBaseProperties

func (a *AutoMLJob) GetJobBaseProperties() *JobBaseProperties

GetJobBaseProperties implements the JobBasePropertiesClassification interface for type AutoMLJob.

func (AutoMLJob) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoMLJob.

func (*AutoMLJob) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoMLJob.

type AutoMLVertical

type AutoMLVertical struct {
	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string
}

AutoMLVertical - AutoML vertical class. Base class for AutoML verticals - TableVertical/ImageVertical/NLPVertical

func (*AutoMLVertical) GetAutoMLVertical

func (a *AutoMLVertical) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type AutoMLVertical.

func (AutoMLVertical) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoMLVertical.

func (*AutoMLVertical) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoMLVertical.

type AutoMLVerticalClassification

type AutoMLVerticalClassification interface {
	// GetAutoMLVertical returns the AutoMLVertical content of the underlying type.
	GetAutoMLVertical() *AutoMLVertical
}

AutoMLVerticalClassification provides polymorphic access to related types. Call the interface's GetAutoMLVertical() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AutoMLVertical, *Classification, *Forecasting, *ImageClassification, *ImageClassificationMultilabel, *ImageInstanceSegmentation, - *ImageObjectDetection, *Regression, *TextClassification, *TextClassificationMultilabel, *TextNer

type AutoNCrossValidations

type AutoNCrossValidations struct {
	// REQUIRED; [Required] Mode for determining N-Cross validations.
	Mode *NCrossValidationsMode
}

AutoNCrossValidations - N-Cross validations determined automatically.

func (*AutoNCrossValidations) GetNCrossValidations

func (a *AutoNCrossValidations) GetNCrossValidations() *NCrossValidations

GetNCrossValidations implements the NCrossValidationsClassification interface for type AutoNCrossValidations.

func (AutoNCrossValidations) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoNCrossValidations.

func (*AutoNCrossValidations) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoNCrossValidations.

type AutoPauseProperties

type AutoPauseProperties struct {
	DelayInMinutes *int32
	Enabled        *bool
}

AutoPauseProperties - Auto pause properties

func (AutoPauseProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoPauseProperties.

func (*AutoPauseProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoPauseProperties.

type AutoRebuildSetting

type AutoRebuildSetting string

AutoRebuildSetting - AutoRebuild setting for the derived image

const (
	AutoRebuildSettingDisabled          AutoRebuildSetting = "Disabled"
	AutoRebuildSettingOnBaseImageUpdate AutoRebuildSetting = "OnBaseImageUpdate"
)

func PossibleAutoRebuildSettingValues

func PossibleAutoRebuildSettingValues() []AutoRebuildSetting

PossibleAutoRebuildSettingValues returns the possible values for the AutoRebuildSetting const type.

type AutoScaleProperties

type AutoScaleProperties struct {
	Enabled      *bool
	MaxNodeCount *int32
	MinNodeCount *int32
}

AutoScaleProperties - Auto scale properties

func (AutoScaleProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoScaleProperties.

func (*AutoScaleProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoScaleProperties.

type AutoSeasonality

type AutoSeasonality struct {
	// REQUIRED; [Required] Seasonality mode.
	Mode *SeasonalityMode
}

func (*AutoSeasonality) GetSeasonality

func (a *AutoSeasonality) GetSeasonality() *Seasonality

GetSeasonality implements the SeasonalityClassification interface for type AutoSeasonality.

func (AutoSeasonality) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoSeasonality.

func (*AutoSeasonality) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoSeasonality.

type AutoTargetLags

type AutoTargetLags struct {
	// REQUIRED; [Required] Set target lags mode - Auto/Custom
	Mode *TargetLagsMode
}

func (*AutoTargetLags) GetTargetLags

func (a *AutoTargetLags) GetTargetLags() *TargetLags

GetTargetLags implements the TargetLagsClassification interface for type AutoTargetLags.

func (AutoTargetLags) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoTargetLags.

func (*AutoTargetLags) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoTargetLags.

type AutoTargetRollingWindowSize

type AutoTargetRollingWindowSize struct {
	// REQUIRED; [Required] TargetRollingWindowSiz detection mode.
	Mode *TargetRollingWindowSizeMode
}

AutoTargetRollingWindowSize - Target lags rolling window determined automatically.

func (*AutoTargetRollingWindowSize) GetTargetRollingWindowSize

func (a *AutoTargetRollingWindowSize) GetTargetRollingWindowSize() *TargetRollingWindowSize

GetTargetRollingWindowSize implements the TargetRollingWindowSizeClassification interface for type AutoTargetRollingWindowSize.

func (AutoTargetRollingWindowSize) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoTargetRollingWindowSize.

func (*AutoTargetRollingWindowSize) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoTargetRollingWindowSize.

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

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType

	// Storage account name.
	AccountName *string

	// Storage account container name.
	ContainerName *string

	// The asset description text.
	Description *string

	// Azure cloud endpoint for the storage account.
	Endpoint *string

	// The asset property dictionary.
	Properties map[string]*string

	// Protocol used to communicate with the storage account.
	Protocol *string

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool
}

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

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType

	// REQUIRED; [Required] Azure Data Lake store name.
	StoreName *string

	// The asset description text.
	Description *string

	// The asset property dictionary.
	Properties map[string]*string

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool
}

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

	// REQUIRED; [Required] Account credentials.
	Credentials DatastoreCredentialsClassification

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType

	// REQUIRED; [Required] The name of the Data Lake Gen2 filesystem.
	Filesystem *string

	// The asset description text.
	Description *string

	// Azure cloud endpoint for the storage account.
	Endpoint *string

	// The asset property dictionary.
	Properties map[string]*string

	// Protocol used to communicate with the storage account.
	Protocol *string

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool
}

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

	// REQUIRED; [Required] Account credentials.
	Credentials DatastoreCredentialsClassification

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType

	// REQUIRED; [Required] The name of the Azure file share that the datastore points to.
	FileShareName *string

	// The asset description text.
	Description *string

	// Azure cloud endpoint for the storage account.
	Endpoint *string

	// The asset property dictionary.
	Properties map[string]*string

	// Protocol used to communicate with the storage account.
	Protocol *string

	// Indicates which identity to use to authenticate service data access to customer's storage.
	ServiceDataAccessAuthIdentity *ServiceDataAccessAuthIdentity

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool
}

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

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32

	// Absolute distance allowed from the best performing run.
	SlackAmount *float32

	// Ratio of the allowed distance from the best performing run.
	SlackFactor *float32
}

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

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *BatchDeploymentProperties

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (BatchDeployment) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BatchDeployment.

func (*BatchDeployment) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type BatchDeployment.

type BatchDeploymentProperties

type BatchDeploymentProperties struct {
	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration

	// Compute target for batch inference operation.
	Compute *string

	// Description of the endpoint deployment.
	Description *string

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string

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

	// Logging level for batch inference operation.
	LoggingLevel *BatchLoggingLevel

	// Indicates maximum number of parallelism per instance.
	MaxConcurrencyPerInstance *int32

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

	// Reference to the model asset for the endpoint deployment.
	Model AssetReferenceBaseClassification

	// Indicates how the output will be organized.
	OutputAction *BatchOutputAction

	// Customized output file name for append_row output action.
	OutputFileName *string

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string

	// Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
	Resources *DeploymentResourceConfiguration

	// Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.
	RetrySettings *BatchRetrySettings

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState
}

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

	// An array of objects of type BatchDeployment.
	Value []*BatchDeployment
}

BatchDeploymentTrackedResourceArmPaginatedResult - A paginated list of BatchDeployment entities.

func (BatchDeploymentTrackedResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type BatchDeploymentTrackedResourceArmPaginatedResult.

func (*BatchDeploymentTrackedResourceArmPaginatedResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type BatchDeploymentTrackedResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBatchDeploymentsClient().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.DeploymentResourceConfiguration{
			InstanceCount: to.Ptr[int32](1),
			InstanceType:  to.Ptr("string"),
			Properties: map[string]any{
				"string": map[string]any{
					"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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BatchDeployment = armmachinelearning.BatchDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		Resources: &armmachinelearning.DeploymentResourceConfiguration{
// 			InstanceCount: to.Ptr[int32](1),
// 			InstanceType: to.Ptr("string"),
// 			Properties: map[string]any{
// 				"string": map[string]any{
// 					"4939850d-8eae-4343-8566-0826259a2ad1": 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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBatchDeploymentsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBatchDeploymentsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BatchDeployment = armmachinelearning.BatchDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		Resources: &armmachinelearning.DeploymentResourceConfiguration{
// 			InstanceCount: to.Ptr[int32](1),
// 			InstanceType: to.Ptr("string"),
// 			Properties: map[string]any{
// 				"string": map[string]any{
// 					"1e5e1cf9-b0ea-4cf6-9764-e750bf85c10a": 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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBatchDeploymentsClient().Get(ctx, "test-rg", "my-aml-workspace", "testEndpointName", "testDeploymentName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BatchDeployment = armmachinelearning.BatchDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		Resources: &armmachinelearning.DeploymentResourceConfiguration{
// 			InstanceCount: to.Ptr[int32](1),
// 			InstanceType: to.Ptr("string"),
// 			Properties: map[string]any{
// 				"string": map[string]any{
// 					"843c2bb4-e5f1-4267-98c8-ba22a99dbb00": 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),
// 	},
// }
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.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBatchDeploymentsClient().NewListPager("test-rg", "my-aml-workspace", "testEndpointName", &armmachinelearning.BatchDeploymentsClientListOptions{OrderBy: to.Ptr("string"),
	Top:  to.Ptr[int32](1),
	Skip: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.BatchDeploymentTrackedResourceArmPaginatedResult = armmachinelearning.BatchDeploymentTrackedResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.BatchDeployment{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("string"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Identity: &armmachinelearning.ManagedServiceIdentity{
	// 				Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
	// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
	// 					"string": &armmachinelearning.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 						PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 					},
	// 				},
	// 			},
	// 			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"),
	// 				ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
	// 				Resources: &armmachinelearning.DeploymentResourceConfiguration{
	// 					InstanceCount: to.Ptr[int32](1),
	// 					InstanceType: to.Ptr("string"),
	// 					Properties: map[string]any{
	// 						"string": map[string]any{
	// 							"a3c13e2e-a213-4cac-9f5a-b49966906ad6": 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),
	// 			},
	// 	}},
	// }
}
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.BeginCreateOrUpdate.

type BatchDeploymentsClientDeleteResponse

type BatchDeploymentsClientDeleteResponse struct {
}

BatchDeploymentsClientDeleteResponse contains the response from method BatchDeploymentsClient.BeginDelete.

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.NewListPager method.

type BatchDeploymentsClientListResponse

type BatchDeploymentsClientListResponse struct {
	// A paginated list of BatchDeployment entities.
	BatchDeploymentTrackedResourceArmPaginatedResult
}

BatchDeploymentsClientListResponse contains the response from method BatchDeploymentsClient.NewListPager.

type BatchDeploymentsClientUpdateResponse

type BatchDeploymentsClientUpdateResponse struct {
	BatchDeployment
}

BatchDeploymentsClientUpdateResponse contains the response from method BatchDeploymentsClient.BeginUpdate.

type BatchEndpoint

type BatchEndpoint struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *BatchEndpointProperties

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (BatchEndpoint) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BatchEndpoint.

func (*BatchEndpoint) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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
}

BatchEndpointDefaults - Batch endpoint default values

func (BatchEndpointDefaults) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BatchEndpointDefaults.

func (*BatchEndpointDefaults) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type BatchEndpointDefaults.

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

	// Default values for Batch Endpoint
	Defaults *BatchEndpointDefaults

	// Description of the inference endpoint.
	Description *string

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

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string

	// READ-ONLY; Provisioning state for the endpoint.
	ProvisioningState *EndpointProvisioningState

	// READ-ONLY; Endpoint URI.
	ScoringURI *string

	// READ-ONLY; Endpoint Swagger URI.
	SwaggerURI *string
}

BatchEndpointProperties - Batch endpoint configuration.

func (BatchEndpointProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BatchEndpointProperties.

func (*BatchEndpointProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type BatchEndpoint.
	Value []*BatchEndpoint
}

BatchEndpointTrackedResourceArmPaginatedResult - A paginated list of BatchEndpoint entities.

func (BatchEndpointTrackedResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type BatchEndpointTrackedResourceArmPaginatedResult.

func (*BatchEndpointTrackedResourceArmPaginatedResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type BatchEndpointTrackedResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBatchEndpointsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BatchEndpoint = armmachinelearning.BatchEndpoint{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.BatchEndpointProperties{
// 		Description: to.Ptr("string"),
// 		AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		ScoringURI: to.Ptr("https://www.contoso.com/example"),
// 		SwaggerURI: to.Ptr("https://www.contoso.com/example"),
// 		Defaults: &armmachinelearning.BatchEndpointDefaults{
// 			DeploymentName: to.Ptr("string"),
// 		},
// 		ProvisioningState: to.Ptr(armmachinelearning.EndpointProvisioningStateSucceeded),
// 	},
// 	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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBatchEndpointsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewBatchEndpointsClient().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]any{
			"string": map[string]any{},
		},
	},
}, 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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BatchEndpoint = armmachinelearning.BatchEndpoint{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.BatchEndpointProperties{
// 		Description: to.Ptr("string"),
// 		AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		ScoringURI: to.Ptr("https://www.contoso.com/example"),
// 		SwaggerURI: to.Ptr("https://www.contoso.com/example"),
// 		Defaults: &armmachinelearning.BatchEndpointDefaults{
// 			DeploymentName: to.Ptr("string"),
// 		},
// 		ProvisioningState: to.Ptr(armmachinelearning.EndpointProvisioningStateSucceeded),
// 	},
// 	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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBatchEndpointsClient().Get(ctx, "test-rg", "my-aml-workspace", "testEndpointName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.BatchEndpoint = armmachinelearning.BatchEndpoint{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.BatchEndpointProperties{
// 		Description: to.Ptr("string"),
// 		AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		ScoringURI: to.Ptr("https://www.contoso.com/example"),
// 		SwaggerURI: to.Ptr("https://www.contoso.com/example"),
// 		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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewBatchEndpointsClient().ListKeys(ctx, "test-rg", "my-aml-workspace", "testEndpointName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EndpointAuthKeys = armmachinelearning.EndpointAuthKeys{
// 	PrimaryKey: to.Ptr("string"),
// 	SecondaryKey: to.Ptr("string"),
// }
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.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewBatchEndpointsClient().NewListPager("test-rg", "my-aml-workspace", &armmachinelearning.BatchEndpointsClientListOptions{Count: to.Ptr[int32](1),
	Skip: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.BatchEndpointTrackedResourceArmPaginatedResult = armmachinelearning.BatchEndpointTrackedResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.BatchEndpoint{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("string"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Identity: &armmachinelearning.ManagedServiceIdentity{
	// 				Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
	// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
	// 					"string": &armmachinelearning.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 						PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 					},
	// 				},
	// 			},
	// 			Kind: to.Ptr("string"),
	// 			Properties: &armmachinelearning.BatchEndpointProperties{
	// 				Description: to.Ptr("string"),
	// 				AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
	// 				Properties: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 				ScoringURI: to.Ptr("https://www.contoso.com/example"),
	// 				SwaggerURI: to.Ptr("https://www.contoso.com/example"),
	// 				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),
	// 			},
	// 	}},
	// }
}
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.BeginCreateOrUpdate.

type BatchEndpointsClientDeleteResponse

type BatchEndpointsClientDeleteResponse struct {
}

BatchEndpointsClientDeleteResponse contains the response from method BatchEndpointsClient.BeginDelete.

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 {
	// Keys for endpoint authentication.
	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.NewListPager method.

type BatchEndpointsClientListResponse

type BatchEndpointsClientListResponse struct {
	// A paginated list of BatchEndpoint entities.
	BatchEndpointTrackedResourceArmPaginatedResult
}

BatchEndpointsClientListResponse contains the response from method BatchEndpointsClient.NewListPager.

type BatchEndpointsClientUpdateResponse

type BatchEndpointsClientUpdateResponse struct {
	BatchEndpoint
}

BatchEndpointsClientUpdateResponse contains the response from method BatchEndpointsClient.BeginUpdate.

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

	// Invocation timeout for a mini-batch, in ISO 8601 format.
	Timeout *string
}

BatchRetrySettings - Retry settings for a batch inference operation.

func (BatchRetrySettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BatchRetrySettings.

func (*BatchRetrySettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type BatchRetrySettings.

type BayesianSamplingAlgorithm

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

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 BlockedTransformers

type BlockedTransformers string

BlockedTransformers - Enum for all classification models supported by AutoML.

const (
	// BlockedTransformersCatTargetEncoder - Target encoding for categorical data.
	BlockedTransformersCatTargetEncoder BlockedTransformers = "CatTargetEncoder"
	// BlockedTransformersCountVectorizer - Count Vectorizer converts a collection of text documents to a matrix of token counts.
	BlockedTransformersCountVectorizer BlockedTransformers = "CountVectorizer"
	// BlockedTransformersHashOneHotEncoder - Hashing One Hot Encoder can turn categorical variables into a limited number of
	// new features. This is often used for high-cardinality categorical features.
	BlockedTransformersHashOneHotEncoder BlockedTransformers = "HashOneHotEncoder"
	// BlockedTransformersLabelEncoder - Label encoder converts labels/categorical variables in a numerical form.
	BlockedTransformersLabelEncoder BlockedTransformers = "LabelEncoder"
	// BlockedTransformersNaiveBayes - Naive Bayes is a classified that is used for classification of discrete features that are
	// categorically distributed.
	BlockedTransformersNaiveBayes BlockedTransformers = "NaiveBayes"
	// BlockedTransformersOneHotEncoder - Ohe hot encoding creates a binary feature transformation.
	BlockedTransformersOneHotEncoder BlockedTransformers = "OneHotEncoder"
	// BlockedTransformersTextTargetEncoder - Target encoding for text data.
	BlockedTransformersTextTargetEncoder BlockedTransformers = "TextTargetEncoder"
	// BlockedTransformersTfIdf - Tf-Idf stands for, term-frequency times inverse document-frequency. This is a common term weighting
	// scheme for identifying information from documents.
	BlockedTransformersTfIdf BlockedTransformers = "TfIdf"
	// BlockedTransformersWoETargetEncoder - Weight of Evidence encoding is a technique used to encode categorical variables.
	// It uses the natural log of the P(1)/P(0) to create weights.
	BlockedTransformersWoETargetEncoder BlockedTransformers = "WoETargetEncoder"
	// BlockedTransformersWordEmbedding - Word embedding helps represents words or phrases as a vector, or a series of numbers.
	BlockedTransformersWordEmbedding BlockedTransformers = "WordEmbedding"
)

func PossibleBlockedTransformersValues

func PossibleBlockedTransformersValues() []BlockedTransformers

PossibleBlockedTransformersValues returns the possible values for the BlockedTransformers 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

	// Path to the Dockerfile in the build context.
	DockerfilePath *string
}

BuildContext - Configuration settings for Docker build context

func (BuildContext) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type BuildContext.

func (*BuildContext) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type BuildContext.

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

	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType

	// REQUIRED; [Required] Service principal secrets.
	Secrets *CertificateDatastoreSecrets

	// REQUIRED; [Required] ID of the tenant to which the service principal belongs.
	TenantID *string

	// REQUIRED; [Required] Thumbprint of the certificate used for authentication.
	Thumbprint *string

	// Authority URL used for authentication.
	AuthorityURL *string

	// Resource the service principal has access to.
	ResourceURL *string
}

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

	// Service principal certificate.
	Certificate *string
}

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 Classification

type Classification struct {
	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Columns to use for CVSplit data.
	CvSplitColumnNames []*string

	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *TableVerticalFeaturizationSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *TableVerticalLimitSettings

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Number of cross validation folds to be applied on training dataset when validation dataset is not provided.
	NCrossValidations NCrossValidationsClassification

	// Positive label for binary metrics calculation.
	PositiveLabel *string

	// Primary metric for the task.
	PrimaryMetric *ClassificationPrimaryMetrics

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Test data input.
	TestData *MLTableJobInput

	// The fraction of test dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied when
	// validation dataset is not provided.
	TestDataSize *float64

	// Inputs for training phase for an AutoML Job.
	TrainingSettings *ClassificationTrainingSettings

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64

	// The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to
	// be weighted up or down.
	WeightColumnName *string
}

Classification task in AutoML Table vertical.

func (*Classification) GetAutoMLVertical

func (c *Classification) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type Classification.

func (Classification) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Classification.

func (*Classification) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Classification.

type ClassificationModels

type ClassificationModels string

ClassificationModels - Enum for all classification models supported by AutoML.

const (
	// ClassificationModelsBernoulliNaiveBayes - Naive Bayes classifier for multivariate Bernoulli models.
	ClassificationModelsBernoulliNaiveBayes ClassificationModels = "BernoulliNaiveBayes"
	// ClassificationModelsDecisionTree - Decision Trees are a non-parametric supervised learning method used for both classification
	// and regression tasks.
	// The goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from
	// the data features.
	ClassificationModelsDecisionTree ClassificationModels = "DecisionTree"
	// ClassificationModelsExtremeRandomTrees - Extreme Trees is an ensemble machine learning algorithm that combines the predictions
	// from many decision trees. It is related to the widely used random forest algorithm.
	ClassificationModelsExtremeRandomTrees ClassificationModels = "ExtremeRandomTrees"
	// ClassificationModelsGradientBoosting - The technique of transiting week learners into a strong learner is called Boosting.
	// The gradient boosting algorithm process works on this theory of execution.
	ClassificationModelsGradientBoosting ClassificationModels = "GradientBoosting"
	// ClassificationModelsKNN - K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints
	// which further means that the new data point will be assigned a value based on how closely it matches the points in the
	// training set.
	ClassificationModelsKNN ClassificationModels = "KNN"
	// ClassificationModelsLightGBM - LightGBM is a gradient boosting framework that uses tree based learning algorithms.
	ClassificationModelsLightGBM ClassificationModels = "LightGBM"
	// ClassificationModelsLinearSVM - A support vector machine (SVM) is a supervised machine learning model that uses classification
	// algorithms for two-group classification problems.
	// After giving an SVM model sets of labeled training data for each category, they're able to categorize new text.
	// Linear SVM performs best when input data is linear, i.e., data can be easily classified by drawing the straight line between
	// classified values on a plotted graph.
	ClassificationModelsLinearSVM ClassificationModels = "LinearSVM"
	// ClassificationModelsLogisticRegression - Logistic regression is a fundamental classification technique.
	// It belongs to the group of linear classifiers and is somewhat similar to polynomial and linear regression.
	// Logistic regression is fast and relatively uncomplicated, and it's convenient for you to interpret the results.
	// Although it's essentially a method for binary classification, it can also be applied to multiclass problems.
	ClassificationModelsLogisticRegression ClassificationModels = "LogisticRegression"
	// ClassificationModelsMultinomialNaiveBayes - The multinomial Naive Bayes classifier is suitable for classification with
	// discrete features (e.g., word counts for text classification).
	// The multinomial distribution normally requires integer feature counts. However, in practice, fractional counts such as
	// tf-idf may also work.
	ClassificationModelsMultinomialNaiveBayes ClassificationModels = "MultinomialNaiveBayes"
	// ClassificationModelsRandomForest - Random forest is a supervised learning algorithm.
	// The "forest" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.
	// The general idea of the bagging method is that a combination of learning models increases the overall result.
	ClassificationModelsRandomForest ClassificationModels = "RandomForest"
	// ClassificationModelsSGD - SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning
	// applications
	// to find the model parameters that correspond to the best fit between predicted and actual outputs.
	ClassificationModelsSGD ClassificationModels = "SGD"
	// ClassificationModelsSVM - A support vector machine (SVM) is a supervised machine learning model that uses classification
	// algorithms for two-group classification problems.
	// After giving an SVM model sets of labeled training data for each category, they're able to categorize new text.
	ClassificationModelsSVM ClassificationModels = "SVM"
	// ClassificationModelsXGBoostClassifier - XGBoost: Extreme Gradient Boosting Algorithm. This algorithm is used for structured
	// data where target column values can be divided into distinct class values.
	ClassificationModelsXGBoostClassifier ClassificationModels = "XGBoostClassifier"
)

func PossibleClassificationModelsValues

func PossibleClassificationModelsValues() []ClassificationModels

PossibleClassificationModelsValues returns the possible values for the ClassificationModels const type.

type ClassificationMultilabelPrimaryMetrics

type ClassificationMultilabelPrimaryMetrics string

ClassificationMultilabelPrimaryMetrics - Primary metrics for classification multilabel tasks.

const (
	// ClassificationMultilabelPrimaryMetricsAUCWeighted - AUC is the Area under the curve.
	// This metric represents arithmetic mean of the score for each class,
	// weighted by the number of true instances in each class.
	ClassificationMultilabelPrimaryMetricsAUCWeighted ClassificationMultilabelPrimaryMetrics = "AUCWeighted"
	// ClassificationMultilabelPrimaryMetricsAccuracy - Accuracy is the ratio of predictions that exactly match the true class
	// labels.
	ClassificationMultilabelPrimaryMetricsAccuracy ClassificationMultilabelPrimaryMetrics = "Accuracy"
	// ClassificationMultilabelPrimaryMetricsAveragePrecisionScoreWeighted - The arithmetic mean of the average precision score
	// for each class, weighted by
	// the number of true instances in each class.
	ClassificationMultilabelPrimaryMetricsAveragePrecisionScoreWeighted ClassificationMultilabelPrimaryMetrics = "AveragePrecisionScoreWeighted"
	// ClassificationMultilabelPrimaryMetricsIOU - Intersection Over Union. Intersection of predictions divided by union of predictions.
	ClassificationMultilabelPrimaryMetricsIOU ClassificationMultilabelPrimaryMetrics = "IOU"
	// ClassificationMultilabelPrimaryMetricsNormMacroRecall - Normalized macro recall is recall macro-averaged and normalized,
	// so that random
	// performance has a score of 0, and perfect performance has a score of 1.
	ClassificationMultilabelPrimaryMetricsNormMacroRecall ClassificationMultilabelPrimaryMetrics = "NormMacroRecall"
	// ClassificationMultilabelPrimaryMetricsPrecisionScoreWeighted - The arithmetic mean of precision for each class, weighted
	// by number of true instances in each class.
	ClassificationMultilabelPrimaryMetricsPrecisionScoreWeighted ClassificationMultilabelPrimaryMetrics = "PrecisionScoreWeighted"
)

func PossibleClassificationMultilabelPrimaryMetricsValues

func PossibleClassificationMultilabelPrimaryMetricsValues() []ClassificationMultilabelPrimaryMetrics

PossibleClassificationMultilabelPrimaryMetricsValues returns the possible values for the ClassificationMultilabelPrimaryMetrics const type.

type ClassificationPrimaryMetrics

type ClassificationPrimaryMetrics string

ClassificationPrimaryMetrics - Primary metrics for classification tasks.

const (
	// ClassificationPrimaryMetricsAUCWeighted - AUC is the Area under the curve.
	// This metric represents arithmetic mean of the score for each class,
	// weighted by the number of true instances in each class.
	ClassificationPrimaryMetricsAUCWeighted ClassificationPrimaryMetrics = "AUCWeighted"
	// ClassificationPrimaryMetricsAccuracy - Accuracy is the ratio of predictions that exactly match the true class labels.
	ClassificationPrimaryMetricsAccuracy ClassificationPrimaryMetrics = "Accuracy"
	// ClassificationPrimaryMetricsAveragePrecisionScoreWeighted - The arithmetic mean of the average precision score for each
	// class, weighted by
	// the number of true instances in each class.
	ClassificationPrimaryMetricsAveragePrecisionScoreWeighted ClassificationPrimaryMetrics = "AveragePrecisionScoreWeighted"
	// ClassificationPrimaryMetricsNormMacroRecall - Normalized macro recall is recall macro-averaged and normalized, so that
	// random
	// performance has a score of 0, and perfect performance has a score of 1.
	ClassificationPrimaryMetricsNormMacroRecall ClassificationPrimaryMetrics = "NormMacroRecall"
	// ClassificationPrimaryMetricsPrecisionScoreWeighted - The arithmetic mean of precision for each class, weighted by number
	// of true instances in each class.
	ClassificationPrimaryMetricsPrecisionScoreWeighted ClassificationPrimaryMetrics = "PrecisionScoreWeighted"
)

func PossibleClassificationPrimaryMetricsValues

func PossibleClassificationPrimaryMetricsValues() []ClassificationPrimaryMetrics

PossibleClassificationPrimaryMetricsValues returns the possible values for the ClassificationPrimaryMetrics const type.

type ClassificationTrainingSettings

type ClassificationTrainingSettings struct {
	// Allowed models for classification task.
	AllowedTrainingAlgorithms []*ClassificationModels

	// Blocked models for classification task.
	BlockedTrainingAlgorithms []*ClassificationModels

	// Enable recommendation of DNN models.
	EnableDnnTraining *bool

	// Flag to turn on explainability on best model.
	EnableModelExplainability *bool

	// Flag for enabling onnx compatible models.
	EnableOnnxCompatibleModels *bool

	// Enable stack ensemble run.
	EnableStackEnsemble *bool

	// Enable voting ensemble run.
	EnableVoteEnsemble *bool

	// During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.
	// Configure this parameter with a higher value than 300 secs, if more time
	// is needed.
	EnsembleModelDownloadTimeout *string

	// Stack ensemble settings for stack ensemble run.
	StackEnsembleSettings *StackEnsembleSettings
}

ClassificationTrainingSettings - Classification Training related configuration.

func (ClassificationTrainingSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ClassificationTrainingSettings.

func (*ClassificationTrainingSettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClassificationTrainingSettings.

type ClientFactory added in v3.1.0

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v3.1.0

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • 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 (*ClientFactory) NewBatchDeploymentsClient added in v3.1.0

func (c *ClientFactory) NewBatchDeploymentsClient() *BatchDeploymentsClient

NewBatchDeploymentsClient creates a new instance of BatchDeploymentsClient.

func (*ClientFactory) NewBatchEndpointsClient added in v3.1.0

func (c *ClientFactory) NewBatchEndpointsClient() *BatchEndpointsClient

NewBatchEndpointsClient creates a new instance of BatchEndpointsClient.

func (*ClientFactory) NewCodeContainersClient added in v3.1.0

func (c *ClientFactory) NewCodeContainersClient() *CodeContainersClient

NewCodeContainersClient creates a new instance of CodeContainersClient.

func (*ClientFactory) NewCodeVersionsClient added in v3.1.0

func (c *ClientFactory) NewCodeVersionsClient() *CodeVersionsClient

NewCodeVersionsClient creates a new instance of CodeVersionsClient.

func (*ClientFactory) NewComponentContainersClient added in v3.1.0

func (c *ClientFactory) NewComponentContainersClient() *ComponentContainersClient

NewComponentContainersClient creates a new instance of ComponentContainersClient.

func (*ClientFactory) NewComponentVersionsClient added in v3.1.0

func (c *ClientFactory) NewComponentVersionsClient() *ComponentVersionsClient

NewComponentVersionsClient creates a new instance of ComponentVersionsClient.

func (*ClientFactory) NewComputeClient added in v3.1.0

func (c *ClientFactory) NewComputeClient() *ComputeClient

NewComputeClient creates a new instance of ComputeClient.

func (*ClientFactory) NewDataContainersClient added in v3.1.0

func (c *ClientFactory) NewDataContainersClient() *DataContainersClient

NewDataContainersClient creates a new instance of DataContainersClient.

func (*ClientFactory) NewDataVersionsClient added in v3.1.0

func (c *ClientFactory) NewDataVersionsClient() *DataVersionsClient

NewDataVersionsClient creates a new instance of DataVersionsClient.

func (*ClientFactory) NewDatastoresClient added in v3.1.0

func (c *ClientFactory) NewDatastoresClient() *DatastoresClient

NewDatastoresClient creates a new instance of DatastoresClient.

func (*ClientFactory) NewEnvironmentContainersClient added in v3.1.0

func (c *ClientFactory) NewEnvironmentContainersClient() *EnvironmentContainersClient

NewEnvironmentContainersClient creates a new instance of EnvironmentContainersClient.

func (*ClientFactory) NewEnvironmentVersionsClient added in v3.1.0

func (c *ClientFactory) NewEnvironmentVersionsClient() *EnvironmentVersionsClient

NewEnvironmentVersionsClient creates a new instance of EnvironmentVersionsClient.

func (*ClientFactory) NewJobsClient added in v3.1.0

func (c *ClientFactory) NewJobsClient() *JobsClient

NewJobsClient creates a new instance of JobsClient.

func (*ClientFactory) NewModelContainersClient added in v3.1.0

func (c *ClientFactory) NewModelContainersClient() *ModelContainersClient

NewModelContainersClient creates a new instance of ModelContainersClient.

func (*ClientFactory) NewModelVersionsClient added in v3.1.0

func (c *ClientFactory) NewModelVersionsClient() *ModelVersionsClient

NewModelVersionsClient creates a new instance of ModelVersionsClient.

func (*ClientFactory) NewOnlineDeploymentsClient added in v3.1.0

func (c *ClientFactory) NewOnlineDeploymentsClient() *OnlineDeploymentsClient

NewOnlineDeploymentsClient creates a new instance of OnlineDeploymentsClient.

func (*ClientFactory) NewOnlineEndpointsClient added in v3.1.0

func (c *ClientFactory) NewOnlineEndpointsClient() *OnlineEndpointsClient

NewOnlineEndpointsClient creates a new instance of OnlineEndpointsClient.

func (*ClientFactory) NewOperationsClient added in v3.1.0

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient added in v3.1.0

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

func (*ClientFactory) NewPrivateLinkResourcesClient added in v3.1.0

func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.

func (*ClientFactory) NewQuotasClient added in v3.1.0

func (c *ClientFactory) NewQuotasClient() *QuotasClient

NewQuotasClient creates a new instance of QuotasClient.

func (*ClientFactory) NewSchedulesClient added in v3.1.0

func (c *ClientFactory) NewSchedulesClient() *SchedulesClient

NewSchedulesClient creates a new instance of SchedulesClient.

func (*ClientFactory) NewUsagesClient added in v3.1.0

func (c *ClientFactory) NewUsagesClient() *UsagesClient

NewUsagesClient creates a new instance of UsagesClient.

func (*ClientFactory) NewVirtualMachineSizesClient added in v3.1.0

func (c *ClientFactory) NewVirtualMachineSizesClient() *VirtualMachineSizesClient

NewVirtualMachineSizesClient creates a new instance of VirtualMachineSizesClient.

func (*ClientFactory) NewWorkspaceConnectionsClient added in v3.1.0

func (c *ClientFactory) NewWorkspaceConnectionsClient() *WorkspaceConnectionsClient

NewWorkspaceConnectionsClient creates a new instance of WorkspaceConnectionsClient.

func (*ClientFactory) NewWorkspaceFeaturesClient added in v3.1.0

func (c *ClientFactory) NewWorkspaceFeaturesClient() *WorkspaceFeaturesClient

NewWorkspaceFeaturesClient creates a new instance of WorkspaceFeaturesClient.

func (*ClientFactory) NewWorkspacesClient added in v3.1.0

func (c *ClientFactory) NewWorkspacesClient() *WorkspacesClient

NewWorkspacesClient creates a new instance of WorkspacesClient.

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
}

ClusterUpdateParameters - AmlCompute update parameters.

func (ClusterUpdateParameters) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ClusterUpdateParameters.

func (*ClusterUpdateParameters) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterUpdateParameters.

type ClusterUpdateProperties

type ClusterUpdateProperties struct {
	// Properties of ClusterUpdate
	Properties *ScaleSettingsInformation
}

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

func (ClusterUpdateProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ClusterUpdateProperties.

func (*ClusterUpdateProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ClusterUpdateProperties.

type CodeConfiguration

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

	// ARM resource ID of the code asset.
	CodeID *string
}

CodeConfiguration - Configuration for a scoring code asset.

func (CodeConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CodeConfiguration.

func (*CodeConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CodeConfiguration.

type CodeContainer

type CodeContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *CodeContainerProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

CodeContainer - Azure Resource Manager resource envelope.

func (CodeContainer) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CodeContainer.

func (*CodeContainer) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CodeContainer.

type CodeContainerProperties

type CodeContainerProperties struct {
	// The asset description text.
	Description *string

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string

	// READ-ONLY; The next auto incremental version
	NextVersion *string
}

CodeContainerProperties - Container for code asset versions.

func (CodeContainerProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CodeContainerProperties.

func (*CodeContainerProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type CodeContainer.
	Value []*CodeContainer
}

CodeContainerResourceArmPaginatedResult - A paginated list of CodeContainer entities.

func (CodeContainerResourceArmPaginatedResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CodeContainerResourceArmPaginatedResult.

func (*CodeContainerResourceArmPaginatedResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CodeContainerResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCodeContainersClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.CodeContainer = armmachinelearning.CodeContainer{
// 	Name: to.Ptr("testContainer"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/codes"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("John Smith"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("John Smith"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.CodeContainerProperties{
// 		Description: to.Ptr("string"),
// 		Tags: map[string]*string{
// 			"property1": to.Ptr("string"),
// 			"property2": to.Ptr("string"),
// 		},
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewCodeContainersClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCodeContainersClient().Get(ctx, "testrg123", "testworkspace", "testContainer", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.CodeContainer = armmachinelearning.CodeContainer{
// 	Name: to.Ptr("testContainer"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/codes"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("John Smith"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("John Smith"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.CodeContainerProperties{
// 		Description: to.Ptr("string"),
// 		Tags: map[string]*string{
// 			"property1": to.Ptr("string"),
// 			"property2": to.Ptr("string"),
// 		},
// 	},
// }
Output:

func (*CodeContainersClient) NewListPager

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

NewListPager - List containers.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCodeContainersClient().NewListPager("testrg123", "testworkspace", &armmachinelearning.CodeContainersClientListOptions{Skip: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.CodeContainerResourceArmPaginatedResult = armmachinelearning.CodeContainerResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.CodeContainer{
	// 		{
	// 			Name: to.Ptr("testContainer"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/codes"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("John Smith"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("John Smith"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.CodeContainerProperties{
	// 				Description: to.Ptr("string"),
	// 				Tags: map[string]*string{
	// 					"property1": to.Ptr("string"),
	// 					"property2": to.Ptr("string"),
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("testContainer2"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/codes"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/codes/testContainer2"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("John Smith"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-08-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("John Smith"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.CodeContainerProperties{
	// 				Description: to.Ptr("string"),
	// 				Tags: map[string]*string{
	// 					"property1": to.Ptr("string"),
	// 					"property2": to.Ptr("string"),
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type CodeContainersClientCreateOrUpdateOptions

type CodeContainersClientCreateOrUpdateOptions struct {
}

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

type CodeContainersClientCreateOrUpdateResponse

type CodeContainersClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type CodeContainersClientListResponse

type CodeContainersClientListResponse struct {
	// A paginated list of CodeContainer entities.
	CodeContainerResourceArmPaginatedResult
}

CodeContainersClientListResponse contains the response from method CodeContainersClient.NewListPager.

type CodeVersion

type CodeVersion struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *CodeVersionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

CodeVersion - Azure Resource Manager resource envelope.

func (CodeVersion) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CodeVersion.

func (*CodeVersion) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CodeVersion.

type CodeVersionProperties

type CodeVersionProperties struct {
	// Uri where code is located
	CodeURI *string

	// The asset description text.
	Description *string

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

CodeVersionProperties - Code asset version details.

func (CodeVersionProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CodeVersionProperties.

func (*CodeVersionProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type CodeVersion.
	Value []*CodeVersion
}

CodeVersionResourceArmPaginatedResult - A paginated list of CodeVersion entities.

func (CodeVersionResourceArmPaginatedResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CodeVersionResourceArmPaginatedResult.

func (*CodeVersionResourceArmPaginatedResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CodeVersionResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCodeVersionsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.CodeVersion = armmachinelearning.CodeVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewCodeVersionsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCodeVersionsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.CodeVersion = armmachinelearning.CodeVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 	},
// }
Output:

func (*CodeVersionsClient) NewListPager

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

NewListPager - List versions.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCodeVersionsClient().NewListPager("test-rg", "my-aml-workspace", "string", &armmachinelearning.CodeVersionsClientListOptions{OrderBy: to.Ptr("string"),
	Top:  to.Ptr[int32](1),
	Skip: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.CodeVersionResourceArmPaginatedResult = armmachinelearning.CodeVersionResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.CodeVersion{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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"),
	// 			},
	// 	}},
	// }
}
Output:

type CodeVersionsClientCreateOrUpdateOptions

type CodeVersionsClientCreateOrUpdateOptions struct {
}

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

type CodeVersionsClientCreateOrUpdateResponse

type CodeVersionsClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type CodeVersionsClientListResponse

type CodeVersionsClientListResponse struct {
	// A paginated list of CodeVersion entities.
	CodeVersionResourceArmPaginatedResult
}

CodeVersionsClientListResponse contains the response from method CodeVersionsClient.NewListPager.

type ColumnTransformer

type ColumnTransformer struct {
	// Fields to apply transformer logic on.
	Fields []*string

	// Different properties to be passed to transformer. Input expected is dictionary of key,value pairs in JSON format.
	Parameters any
}

ColumnTransformer - Column transformer parameters.

func (ColumnTransformer) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ColumnTransformer.

func (*ColumnTransformer) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ColumnTransformer.

type CommandJob

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

	// REQUIRED; [Required] The ARM resource ID of the Environment specification for the job.
	EnvironmentID *string

	// REQUIRED; [Required] Specifies the type of job.
	JobType *JobType

	// ARM resource ID of the code asset.
	CodeID *string

	// ARM resource ID of the component resource.
	ComponentID *string

	// ARM resource ID of the compute resource.
	ComputeID *string

	// The asset description text.
	Description *string

	// Display name of job.
	DisplayName *string

	// Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.
	Distribution DistributionConfigurationClassification

	// Environment variables included in the job.
	EnvironmentVariables map[string]*string

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

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification

	// Mapping of input data bindings used in the job.
	Inputs map[string]JobInputClassification

	// Is the asset archived?
	IsArchived *bool

	// Command Job limit.
	Limits *CommandJobLimits

	// Mapping of output data bindings used in the job.
	Outputs map[string]JobOutputClassification

	// The asset property dictionary.
	Properties map[string]*string

	// Compute Resource configuration for the job.
	Resources *JobResourceConfiguration

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

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Input parameters.
	Parameters any

	// READ-ONLY; Status of the job.
	Status *JobStatus
}

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

	// 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
}

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ComponentContainer - Azure Resource Manager resource envelope.

func (ComponentContainer) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComponentContainer.

func (*ComponentContainer) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentContainer.

type ComponentContainerProperties

type ComponentContainerProperties struct {
	// The asset description text.
	Description *string

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string

	// READ-ONLY; The next auto incremental version
	NextVersion *string
}

ComponentContainerProperties - Component container definition.

func (ComponentContainerProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComponentContainerProperties.

func (*ComponentContainerProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type ComponentContainer.
	Value []*ComponentContainer
}

ComponentContainerResourceArmPaginatedResult - A paginated list of ComponentContainer entities.

func (ComponentContainerResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ComponentContainerResourceArmPaginatedResult.

func (*ComponentContainerResourceArmPaginatedResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentContainerResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComponentContainersClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComponentContainer = armmachinelearning.ComponentContainer{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.ComponentContainerProperties{
// 		Description: to.Ptr("string"),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Tags: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 	},
// }
Output:

func (*ComponentContainersClient) Delete

Delete - Delete container. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewComponentContainersClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComponentContainersClient().Get(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComponentContainer = armmachinelearning.ComponentContainer{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.ComponentContainerProperties{
// 		Description: to.Ptr("string"),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Tags: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 	},
// }
Output:

func (*ComponentContainersClient) NewListPager

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

NewListPager - List component containers.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewComponentContainersClient().NewListPager("test-rg", "my-aml-workspace", &armmachinelearning.ComponentContainersClientListOptions{Skip: nil,
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ComponentContainerResourceArmPaginatedResult = armmachinelearning.ComponentContainerResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.ComponentContainer{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.ComponentContainerProperties{
	// 				Description: to.Ptr("string"),
	// 				Properties: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 				Tags: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type ComponentContainersClientCreateOrUpdateOptions

type ComponentContainersClientCreateOrUpdateOptions struct {
}

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

type ComponentContainersClientCreateOrUpdateResponse

type ComponentContainersClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type ComponentContainersClientListResponse

type ComponentContainersClientListResponse struct {
	// A paginated list of ComponentContainer entities.
	ComponentContainerResourceArmPaginatedResult
}

ComponentContainersClientListResponse contains the response from method ComponentContainersClient.NewListPager.

type ComponentVersion

type ComponentVersion struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *ComponentVersionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ComponentVersion - Azure Resource Manager resource envelope.

func (ComponentVersion) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComponentVersion.

func (*ComponentVersion) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentVersion.

type ComponentVersionProperties

type ComponentVersionProperties struct {
	// Defines Component definition details.
	ComponentSpec any

	// The asset description text.
	Description *string

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

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.

func (*ComponentVersionProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type ComponentVersion.
	Value []*ComponentVersion
}

ComponentVersionResourceArmPaginatedResult - A paginated list of ComponentVersion entities.

func (ComponentVersionResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ComponentVersionResourceArmPaginatedResult.

func (*ComponentVersionResourceArmPaginatedResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentVersionResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComponentVersionsClient().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]any{
			"8ced901b-d826-477d-bfef-329da9672513": nil,
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComponentVersion = armmachinelearning.ComponentVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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]any{
// 			"2de2e74e-457d-4447-a581-933abc2b9d96": nil,
// 		},
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewComponentVersionsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComponentVersionsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComponentVersion = armmachinelearning.ComponentVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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]any{
// 			"1a7c40b5-2029-4f5f-a8d6-fd0822038773": nil,
// 		},
// 	},
// }
Output:

func (*ComponentVersionsClient) NewListPager

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

NewListPager - List component versions.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewComponentVersionsClient().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() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ComponentVersionResourceArmPaginatedResult = armmachinelearning.ComponentVersionResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.ComponentVersion{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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]any{
	// 					"50acbce5-cccc-475a-8ac6-c4da402afbd8": nil,
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type ComponentVersionsClientCreateOrUpdateOptions

type ComponentVersionsClientCreateOrUpdateOptions struct {
}

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

type ComponentVersionsClientCreateOrUpdateResponse

type ComponentVersionsClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type ComponentVersionsClientListResponse

type ComponentVersionsClientListResponse struct {
	// A paginated list of ComponentVersion entities.
	ComponentVersionResourceArmPaginatedResult
}

ComponentVersionsClientListResponse contains the response from method ComponentVersionsClient.NewListPager.

type Compute

type Compute struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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-10-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 (AttachAKubernetesCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.Kubernetes{
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeKubernetes),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 		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"),
// 			ExtensionInstanceReleaseTrain: to.Ptr("stable"),
// 			InstanceTypes: map[string]*armmachinelearning.InstanceTypeSchema{
// 				"defaultInstanceType": &armmachinelearning.InstanceTypeSchema{
// 					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"),
// 		},
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (CreateAAmlCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/BasicAmlCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.AmlCompute{
		Properties: &armmachinelearning.AmlComputeProperties{
			EnableNodePublicIP:          to.Ptr(true),
			IsolatedNetwork:             to.Ptr(false),
			OSType:                      to.Ptr(armmachinelearning.OsTypeWindows),
			RemoteLoginPortPublicAccess: to.Ptr(armmachinelearning.RemoteLoginPortPublicAccessNotSpecified),
			ScaleSettings: &armmachinelearning.ScaleSettings{
				MaxNodeCount:                to.Ptr[int32](1),
				MinNodeCount:                to.Ptr[int32](0),
				NodeIdleTimeBeforeScaleDown: to.Ptr("PT5M"),
			},
			VirtualMachineImage: &armmachinelearning.VirtualMachineImage{
				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myImageGallery/images/myImageDefinition/versions/0.0.1"),
			},
			VMPriority: to.Ptr(armmachinelearning.VMPriorityDedicated),
			VMSize:     to.Ptr("STANDARD_NC6"),
		},
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAmlCompute),
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.AmlCompute{
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAmlCompute),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (CreateADataFactoryCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.DataFactory{
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeDataFactory),
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.DataFactory{
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeDataFactory),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (CreateAnAksCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/BasicAKSCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.AKS{
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.AKS{
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (CreateAnComputeInstanceCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/ComputeInstance.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.ComputeInstance{
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeComputeInstance),
		Properties: &armmachinelearning.ComputeInstanceProperties{
			ApplicationSharingPolicy:         to.Ptr(armmachinelearning.ApplicationSharingPolicyPersonal),
			ComputeInstanceAuthorizationType: to.Ptr(armmachinelearning.ComputeInstanceAuthorizationTypePersonal),
			PersonalComputeInstanceSettings: &armmachinelearning.PersonalComputeInstanceSettings{
				AssignedUser: &armmachinelearning.AssignedUser{
					ObjectID: to.Ptr("00000000-0000-0000-0000-000000000000"),
					TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
				},
			},
			SSHSettings: &armmachinelearning.ComputeInstanceSSHSettings{
				SSHPublicAccess: to.Ptr(armmachinelearning.SSHPublicAccessDisabled),
			},
			Subnet: &armmachinelearning.ResourceID{
				ID: to.Ptr("test-subnet-resource-id"),
			},
			VMSize: to.Ptr("STANDARD_NC6"),
		},
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.ComputeInstance{
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeComputeInstance),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (CreateAnComputeInstanceComputeWithMinimalInputs)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.ComputeInstance{
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeComputeInstance),
		Properties: &armmachinelearning.ComputeInstanceProperties{
			VMSize: to.Ptr("STANDARD_NC6"),
		},
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.ComputeInstance{
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeComputeInstance),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (CreateAnComputeInstanceComputeWithSchedules)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/ComputeInstanceWithSchedules.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.ComputeInstance{
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeComputeInstance),
		Properties: &armmachinelearning.ComputeInstanceProperties{
			ApplicationSharingPolicy:         to.Ptr(armmachinelearning.ApplicationSharingPolicyPersonal),
			ComputeInstanceAuthorizationType: to.Ptr(armmachinelearning.ComputeInstanceAuthorizationTypePersonal),
			PersonalComputeInstanceSettings: &armmachinelearning.PersonalComputeInstanceSettings{
				AssignedUser: &armmachinelearning.AssignedUser{
					ObjectID: to.Ptr("00000000-0000-0000-0000-000000000000"),
					TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
				},
			},
			Schedules: &armmachinelearning.ComputeSchedules{
				ComputeStartStop: []*armmachinelearning.ComputeStartStopSchedule{
					{
						Action: to.Ptr(armmachinelearning.ComputePowerActionStop),
						Cron: &armmachinelearning.CronTrigger{
							StartTime:  to.Ptr("2021-04-23T01:30:00"),
							TimeZone:   to.Ptr("Pacific Standard Time"),
							Expression: to.Ptr("0 18 * * *"),
						},
						Status:      to.Ptr(armmachinelearning.ScheduleStatusEnabled),
						TriggerType: to.Ptr(armmachinelearning.TriggerTypeCron),
					}},
			},
			SSHSettings: &armmachinelearning.ComputeInstanceSSHSettings{
				SSHPublicAccess: to.Ptr(armmachinelearning.SSHPublicAccessDisabled),
			},
			VMSize: to.Ptr("STANDARD_NC6"),
		},
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.ComputeInstance{
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeComputeInstance),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (UpdateAAmlCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/AmlCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.AmlCompute{
		Properties: &armmachinelearning.AmlComputeProperties{
			ScaleSettings: &armmachinelearning.ScaleSettings{
				MaxNodeCount:                to.Ptr[int32](4),
				MinNodeCount:                to.Ptr[int32](4),
				NodeIdleTimeBeforeScaleDown: to.Ptr("PT5M"),
			},
		},
		Description: to.Ptr("some compute"),
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAmlCompute),
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.AmlCompute{
// 		Properties: &armmachinelearning.AmlComputeProperties{
// 			AllocationState: to.Ptr(armmachinelearning.AllocationStateResizing),
// 			AllocationStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-27T22:28:08.998Z"); return t}()),
// 			CurrentNodeCount: to.Ptr[int32](0),
// 			EnableNodePublicIP: to.Ptr(true),
// 			IsolatedNetwork: to.Ptr(false),
// 			NodeStateCounts: &armmachinelearning.NodeStateCounts{
// 				IdleNodeCount: to.Ptr[int32](0),
// 				LeavingNodeCount: to.Ptr[int32](0),
// 				PreemptedNodeCount: to.Ptr[int32](0),
// 				PreparingNodeCount: to.Ptr[int32](0),
// 				RunningNodeCount: to.Ptr[int32](0),
// 				UnusableNodeCount: to.Ptr[int32](0),
// 			},
// 			OSType: to.Ptr(armmachinelearning.OsTypeWindows),
// 			RemoteLoginPortPublicAccess: to.Ptr(armmachinelearning.RemoteLoginPortPublicAccessEnabled),
// 			ScaleSettings: &armmachinelearning.ScaleSettings{
// 				MaxNodeCount: to.Ptr[int32](1),
// 				MinNodeCount: to.Ptr[int32](0),
// 				NodeIdleTimeBeforeScaleDown: to.Ptr("PT5M"),
// 			},
// 			Subnet: &armmachinelearning.ResourceID{
// 				ID: to.Ptr("test-subnet-resource-id"),
// 			},
// 			TargetNodeCount: to.Ptr[int32](1),
// 			VMPriority: to.Ptr(armmachinelearning.VMPriorityDedicated),
// 			VMSize: to.Ptr("STANDARD_NC6"),
// 		},
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAmlCompute),
// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ModifiedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus2"),
// }
Output:

Example (UpdateAnAksCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/createOrUpdate/AKSCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().BeginCreateOrUpdate(ctx, "testrg123", "workspaces123", "compute123", armmachinelearning.ComputeResource{
	Properties: &armmachinelearning.AKS{
		Properties: &armmachinelearning.AKSSchemaProperties{
			AgentCount: to.Ptr[int32](4),
		},
		Description: to.Ptr("some compute"),
		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
		ResourceID:  to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2"),
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.AKS{
// 		Properties: &armmachinelearning.AKSSchemaProperties{
// 			AgentCount: to.Ptr[int32](4),
// 		},
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 		ResourceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2"),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewComputeClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.AmlCompute{
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAmlCompute),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus2"),
// }
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-10-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 (GetAAksCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComputeClient().Get(ctx, "testrg123", "workspaces123", "compute123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.AKS{
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ModifiedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 		ResourceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2"),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (GetAAmlCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/get/AmlCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComputeClient().Get(ctx, "testrg123", "workspaces123", "compute123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.AmlCompute{
// 		Properties: &armmachinelearning.AmlComputeProperties{
// 			AllocationState: to.Ptr(armmachinelearning.AllocationStateResizing),
// 			AllocationStateTransitionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-27T22:28:08.998Z"); return t}()),
// 			CurrentNodeCount: to.Ptr[int32](0),
// 			EnableNodePublicIP: to.Ptr(true),
// 			IsolatedNetwork: to.Ptr(false),
// 			NodeStateCounts: &armmachinelearning.NodeStateCounts{
// 				IdleNodeCount: to.Ptr[int32](0),
// 				LeavingNodeCount: to.Ptr[int32](0),
// 				PreemptedNodeCount: to.Ptr[int32](0),
// 				PreparingNodeCount: to.Ptr[int32](0),
// 				RunningNodeCount: to.Ptr[int32](0),
// 				UnusableNodeCount: to.Ptr[int32](0),
// 			},
// 			OSType: to.Ptr(armmachinelearning.OsTypeWindows),
// 			RemoteLoginPortPublicAccess: to.Ptr(armmachinelearning.RemoteLoginPortPublicAccessEnabled),
// 			ScaleSettings: &armmachinelearning.ScaleSettings{
// 				MaxNodeCount: to.Ptr[int32](1),
// 				MinNodeCount: to.Ptr[int32](0),
// 				NodeIdleTimeBeforeScaleDown: to.Ptr("PT5M"),
// 			},
// 			Subnet: &armmachinelearning.ResourceID{
// 				ID: to.Ptr("test-subnet-resource-id"),
// 			},
// 			TargetNodeCount: to.Ptr[int32](1),
// 			VMPriority: to.Ptr(armmachinelearning.VMPriorityDedicated),
// 			VMSize: to.Ptr("STANDARD_NC6"),
// 		},
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAmlCompute),
// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ModifiedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus2"),
// }
Output:

Example (GetAKubernetesCompute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/get/KubernetesCompute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComputeClient().Get(ctx, "testrg123", "workspaces123", "compute123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.Kubernetes{
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeKubernetes),
// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		IsAttachedCompute: to.Ptr(true),
// 		ModifiedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 		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"),
// 			ExtensionInstanceReleaseTrain: to.Ptr("stable"),
// 			InstanceTypes: map[string]*armmachinelearning.InstanceTypeSchema{
// 				"defaultInstanceType": &armmachinelearning.InstanceTypeSchema{
// 					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"),
// 		},
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus"),
// }
Output:

Example (GetAnComputeInstance)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Compute/get/ComputeInstance.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComputeClient().Get(ctx, "testrg123", "workspaces123", "compute123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ComputeResource = armmachinelearning.ComputeResource{
// 	Properties: &armmachinelearning.ComputeInstance{
// 		Description: to.Ptr("some compute"),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeComputeInstance),
// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ModifiedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
// 		ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
// 		Properties: &armmachinelearning.ComputeInstanceProperties{
// 			ApplicationSharingPolicy: to.Ptr(armmachinelearning.ApplicationSharingPolicyShared),
// 			Applications: []*armmachinelearning.ComputeInstanceApplication{
// 				{
// 					DisplayName: to.Ptr("Jupyter"),
// 					EndpointURI: to.Ptr("https://compute123.eastus2.azureml.net/jupyter"),
// 			}},
// 			ComputeInstanceAuthorizationType: to.Ptr(armmachinelearning.ComputeInstanceAuthorizationTypePersonal),
// 			ConnectivityEndpoints: &armmachinelearning.ComputeInstanceConnectivityEndpoints{
// 				PrivateIPAddress: to.Ptr("10.0.0.1"),
// 				PublicIPAddress: to.Ptr("10.0.0.1"),
// 			},
// 			CreatedBy: &armmachinelearning.ComputeInstanceCreatedBy{
// 				UserID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				UserName: to.Ptr("foobar@microsoft.com"),
// 				UserOrgID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 			PersonalComputeInstanceSettings: &armmachinelearning.PersonalComputeInstanceSettings{
// 				AssignedUser: &armmachinelearning.AssignedUser{
// 					ObjectID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 					TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				},
// 			},
// 			SSHSettings: &armmachinelearning.ComputeInstanceSSHSettings{
// 				AdminUserName: to.Ptr("azureuser"),
// 				SSHPort: to.Ptr[int32](22),
// 				SSHPublicAccess: to.Ptr(armmachinelearning.SSHPublicAccessEnabled),
// 			},
// 			State: to.Ptr(armmachinelearning.ComputeInstanceStateRunning),
// 			Subnet: &armmachinelearning.ResourceID{
// 				ID: to.Ptr("test-subnet-resource-id"),
// 			},
// 			VMSize: to.Ptr("STANDARD_NC6"),
// 		},
// 	},
// 	Name: to.Ptr("compute123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
// 	Location: to.Ptr("eastus2"),
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComputeClient().ListKeys(ctx, "testrg123", "workspaces123", "compute123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armmachinelearning.ComputeClientListKeysResponse{
// 	                            ComputeSecretsClassification: &armmachinelearning.AksComputeSecrets{
// 		AdminKubeConfig: to.Ptr("admin kube config..."),
// 		ImagePullSecretName: to.Ptr("the image pull secret name"),
// 		UserKubeConfig: to.Ptr("user kube config..."),
// 		ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
// 	},
// 	                        }
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.

Generated from API version 2022-10-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.NewListNodesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewComputeClient().NewListNodesPager("testrg123", "workspaces123", "compute123", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Nodes {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AmlComputeNodesInformation = armmachinelearning.AmlComputeNodesInformation{
	// 	Nodes: []*armmachinelearning.AmlComputeNodeInformation{
	// 		{
	// 			NodeID: to.Ptr("tvm-3601533753_1-20170719t162906z"),
	// 			NodeState: to.Ptr(armmachinelearning.NodeStateRunning),
	// 			Port: to.Ptr[int32](50000),
	// 			PrivateIPAddress: to.Ptr("13.84.190.124"),
	// 			PublicIPAddress: to.Ptr("13.84.190.134"),
	// 			RunID: to.Ptr("2f378a44-38f2-443a-9f0d-9909d0b47890"),
	// 		},
	// 		{
	// 			NodeID: to.Ptr("tvm-3601533753_2-20170719t162906z"),
	// 			NodeState: to.Ptr(armmachinelearning.NodeStateIdle),
	// 			Port: to.Ptr[int32](50001),
	// 			PrivateIPAddress: to.Ptr("13.84.190.124"),
	// 			PublicIPAddress: to.Ptr("13.84.190.134"),
	// 	}},
	// }
}
Output:

func (*ComputeClient) NewListPager

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

NewListPager - Gets computes in specified workspace.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewComputeClient().NewListPager("testrg123", "workspaces123", &armmachinelearning.ComputeClientListOptions{Skip: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PaginatedComputeResourcesList = armmachinelearning.PaginatedComputeResourcesList{
	// 	Value: []*armmachinelearning.ComputeResource{
	// 		{
	// 			Properties: &armmachinelearning.AKS{
	// 				Description: to.Ptr("some compute"),
	// 				ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
	// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
	// 				ModifiedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
	// 				ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
	// 				ResourceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2"),
	// 			},
	// 			Name: to.Ptr("compute123"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123"),
	// 			Location: to.Ptr("eastus"),
	// 		},
	// 		{
	// 			Properties: &armmachinelearning.AKS{
	// 				Description: to.Ptr("some compute"),
	// 				ComputeType: to.Ptr(armmachinelearning.ComputeTypeAKS),
	// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
	// 				ModifiedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T22:00:00.000Z"); return t}()),
	// 				ProvisioningState: to.Ptr(armmachinelearning.ProvisioningStateSucceeded),
	// 				ResourceID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2"),
	// 			},
	// 			Name: to.Ptr("compute1234"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes"),
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234"),
	// 			Location: to.Ptr("eastus"),
	// 	}},
	// }
}
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 {
	// Machine Learning compute object wrapped into ARM resource envelope.
	ComputeResource
}

ComputeClientCreateOrUpdateResponse contains the response from method ComputeClient.BeginCreateOrUpdate.

type ComputeClientDeleteResponse

type ComputeClientDeleteResponse struct {
}

ComputeClientDeleteResponse contains the response from method ComputeClient.BeginDelete.

type ComputeClientGetOptions

type ComputeClientGetOptions struct {
}

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

type ComputeClientGetResponse

type ComputeClientGetResponse struct {
	// Machine Learning compute object wrapped into ARM resource envelope.
	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 {
	// Secrets related to a Machine Learning compute. Might differ for every type of compute.
	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.NewListNodesPager method.

type ComputeClientListNodesResponse

type ComputeClientListNodesResponse struct {
	// Result of AmlCompute Nodes
	AmlComputeNodesInformation
}

ComputeClientListNodesResponse contains the response from method ComputeClient.NewListNodesPager.

type ComputeClientListOptions

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

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

type ComputeClientListResponse

type ComputeClientListResponse struct {
	// Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.
	PaginatedComputeResourcesList
}

ComputeClientListResponse contains the response from method ComputeClient.NewListPager.

type ComputeClientRestartResponse

type ComputeClientRestartResponse struct {
}

ComputeClientRestartResponse contains the response from method ComputeClient.BeginRestart.

type ComputeClientStartResponse

type ComputeClientStartResponse struct {
}

ComputeClientStartResponse contains the response from method ComputeClient.BeginStart.

type ComputeClientStopResponse

type ComputeClientStopResponse struct {
}

ComputeClientStopResponse contains the response from method ComputeClient.BeginStop.

type ComputeClientUpdateResponse

type ComputeClientUpdateResponse struct {
	// Machine Learning compute object wrapped into ARM resource envelope.
	ComputeResource
}

ComputeClientUpdateResponse contains the response from method ComputeClient.BeginUpdate.

type ComputeInstance

type ComputeInstance struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// Properties of ComputeInstance
	Properties *ComputeInstanceProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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

	// Application' endpoint URI.
	EndpointURI *string
}

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

func (ComputeInstanceApplication) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceApplication.

func (*ComputeInstanceApplication) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceApplication.

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

	// READ-ONLY; Public IP Address of this ComputeInstance.
	PublicIPAddress *string
}

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

func (ComputeInstanceConnectivityEndpoints) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceConnectivityEndpoints.

func (*ComputeInstanceConnectivityEndpoints) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceConnectivityEndpoints.

type ComputeInstanceContainer

type ComputeInstanceContainer struct {
	// Auto save settings.
	Autosave *Autosave

	// Environment information of this container.
	Environment *ComputeInstanceEnvironmentInfo

	// Information of GPU.
	Gpu *string

	// Name of the ComputeInstance container.
	Name *string

	// network of this container.
	Network *Network

	// READ-ONLY; services of this containers.
	Services []any
}

ComputeInstanceContainer - Defines an Aml Instance container.

func (ComputeInstanceContainer) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceContainer.

func (*ComputeInstanceContainer) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceContainer.

type ComputeInstanceCreatedBy

type ComputeInstanceCreatedBy struct {
	// READ-ONLY; Uniquely identifies the user within his/her organization.
	UserID *string

	// READ-ONLY; Name of the user.
	UserName *string

	// READ-ONLY; Uniquely identifies user' Azure Active Directory organization.
	UserOrgID *string
}

ComputeInstanceCreatedBy - Describes information on user who created this ComputeInstance.

func (ComputeInstanceCreatedBy) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceCreatedBy.

func (*ComputeInstanceCreatedBy) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceCreatedBy.

type ComputeInstanceDataDisk

type ComputeInstanceDataDisk struct {
	// Caching type of Data Disk.
	Caching *Caching

	// The initial disk size in gigabytes.
	DiskSizeGB *int32

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

	// type of this storage account.
	StorageAccountType *StorageAccountType
}

ComputeInstanceDataDisk - Defines an Aml Instance DataDisk.

func (ComputeInstanceDataDisk) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceDataDisk.

func (*ComputeInstanceDataDisk) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceDataDisk.

type ComputeInstanceDataMount

type ComputeInstanceDataMount struct {
	// who this data mount created by.
	CreatedBy *string

	// Error of this data mount.
	Error *string

	// Mount Action.
	MountAction *MountAction

	// name of the ComputeInstance data mount.
	MountName *string

	// Path of this data mount.
	MountPath *string

	// Mount state.
	MountState *MountState

	// The time when the disk mounted.
	MountedOn *time.Time

	// Source of the ComputeInstance data mount.
	Source *string

	// Data source type.
	SourceType *SourceType
}

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

	// version of environment.
	Version *string
}

ComputeInstanceEnvironmentInfo - Environment information

func (ComputeInstanceEnvironmentInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceEnvironmentInfo.

func (*ComputeInstanceEnvironmentInfo) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceEnvironmentInfo.

type ComputeInstanceLastOperation

type ComputeInstanceLastOperation struct {
	// Name of the last operation.
	OperationName *OperationName

	// Operation status.
	OperationStatus *OperationStatus

	// Time of the last operation.
	OperationTime *time.Time

	// Trigger of operation.
	OperationTrigger *OperationTrigger
}

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

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

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

	// Settings for a personal compute instance.
	PersonalComputeInstanceSettings *PersonalComputeInstanceSettings

	// Specifies policy and settings for SSH access.
	SSHSettings *ComputeInstanceSSHSettings

	// Details of customized scripts to execute for setting up the cluster.
	SetupScripts *SetupScripts

	// Virtual network subnet resource ID the compute nodes belong to.
	Subnet *ResourceID

	// Virtual Machine Size
	VMSize *string

	// READ-ONLY; Describes available applications and their endpoints on this ComputeInstance.
	Applications []*ComputeInstanceApplication

	// READ-ONLY; Describes all connectivity endpoints available for this ComputeInstance.
	ConnectivityEndpoints *ComputeInstanceConnectivityEndpoints

	// READ-ONLY; Describes informations of containers on this ComputeInstance.
	Containers []*ComputeInstanceContainer

	// READ-ONLY; Describes information on user who created this ComputeInstance.
	CreatedBy *ComputeInstanceCreatedBy

	// READ-ONLY; Describes informations of dataDisks on this ComputeInstance.
	DataDisks []*ComputeInstanceDataDisk

	// READ-ONLY; Describes informations of dataMounts on this ComputeInstance.
	DataMounts []*ComputeInstanceDataMount

	// READ-ONLY; Collection of errors encountered on this ComputeInstance.
	Errors []*ErrorResponse

	// READ-ONLY; The last operation on ComputeInstance.
	LastOperation *ComputeInstanceLastOperation

	// READ-ONLY; The list of schedules to be applied on the computes.
	Schedules *ComputeSchedules

	// READ-ONLY; The current state of this ComputeInstance.
	State *ComputeInstanceState

	// READ-ONLY; ComputeInstance version.
	Versions *ComputeInstanceVersion
}

ComputeInstanceProperties - Compute Instance properties

func (ComputeInstanceProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceProperties.

func (*ComputeInstanceProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

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

	// READ-ONLY; Describes the admin user name.
	AdminUserName *string

	// READ-ONLY; Describes the port for connecting through SSH.
	SSHPort *int32
}

ComputeInstanceSSHSettings - Specifies policy and settings for SSH access.

func (ComputeInstanceSSHSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceSSHSettings.

func (*ComputeInstanceSSHSettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceSSHSettings.

type ComputeInstanceSchema

type ComputeInstanceSchema struct {
	// Properties of ComputeInstance
	Properties *ComputeInstanceProperties
}

ComputeInstanceSchema - Properties(top level) of ComputeInstance

func (ComputeInstanceSchema) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceSchema.

func (*ComputeInstanceSchema) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceSchema.

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
}

ComputeInstanceVersion - Version of computeInstance.

func (ComputeInstanceVersion) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceVersion.

func (*ComputeInstanceVersion) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceVersion.

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

	// Specifies the location of the resource.
	Location *string

	// Compute properties
	Properties ComputeClassification

	// The sku of the workspace.
	SKU *SKU

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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
}

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
}

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.

func (*ComputeSchedules) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeSchedules.

type ComputeSecrets

type ComputeSecrets struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType
}

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.

func (ComputeSecrets) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeSecrets.

func (*ComputeSecrets) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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 {
	// [Required] The compute power action.
	Action *ComputePowerAction

	// Required if triggerType is Cron.
	Cron *CronTrigger

	// Required if triggerType is Recurrence.
	Recurrence *RecurrenceTrigger

	// [Deprecated] Not used any more.
	Schedule *ScheduleBase

	// Is the schedule enabled or disabled?
	Status *ScheduleStatus

	// [Required] The schedule trigger type.
	TriggerType *TriggerType

	// READ-ONLY; A system assigned id for the schedule.
	ID *string

	// READ-ONLY; The current deployment state of schedule.
	ProvisioningStatus *ProvisioningStatus
}

ComputeStartStopSchedule - Compute start stop schedule properties

func (ComputeStartStopSchedule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeStartStopSchedule.

func (*ComputeStartStopSchedule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeStartStopSchedule.

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

	// Container resource request info:
	ContainerResourceRequests *ContainerResourceSettings
}

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

func (ContainerResourceRequirements) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ContainerResourceRequirements.

func (*ContainerResourceRequirements) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerResourceRequirements.

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

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

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

func (ContainerResourceSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ContainerResourceSettings.

func (*ContainerResourceSettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerResourceSettings.

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
}

func (CosmosDbSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CosmosDbSettings.

func (*CosmosDbSettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CosmosDbSettings.

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 CronTrigger

type CronTrigger struct {
	// REQUIRED; [Required] Specifies cron expression of schedule. The expression should follow NCronTab format.
	Expression *string

	// REQUIRED; [Required]
	TriggerType *TriggerType

	// Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented
	// format would be "2022-06-01T00:00:01" If not present, the schedule will
	// run indefinitely
	EndTime *string

	// Specifies start time of schedule in ISO 8601 format, but without a UTC offset.
	StartTime *string

	// Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer:
	// https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11
	TimeZone *string
}

func (*CronTrigger) GetTriggerBase

func (c *CronTrigger) GetTriggerBase() *TriggerBase

GetTriggerBase implements the TriggerBaseClassification interface for type CronTrigger.

func (CronTrigger) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CronTrigger.

func (*CronTrigger) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CronTrigger.

type CustomForecastHorizon

type CustomForecastHorizon struct {
	// REQUIRED; [Required] Set forecast horizon value selection mode.
	Mode *ForecastHorizonMode

	// REQUIRED; [Required] Forecast horizon value.
	Value *int32
}

CustomForecastHorizon - The desired maximum forecast horizon in units of time-series frequency.

func (*CustomForecastHorizon) GetForecastHorizon

func (c *CustomForecastHorizon) GetForecastHorizon() *ForecastHorizon

GetForecastHorizon implements the ForecastHorizonClassification interface for type CustomForecastHorizon.

func (CustomForecastHorizon) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CustomForecastHorizon.

func (*CustomForecastHorizon) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomForecastHorizon.

type CustomModelJobInput

type CustomModelJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType

	// REQUIRED; [Required] Input Asset URI.
	URI *string

	// Description for the input.
	Description *string

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode
}

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

	// Description for the output.
	Description *string

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode

	// Output Asset URI.
	URI *string
}

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 CustomNCrossValidations

type CustomNCrossValidations struct {
	// REQUIRED; [Required] Mode for determining N-Cross validations.
	Mode *NCrossValidationsMode

	// REQUIRED; [Required] N-Cross validations value.
	Value *int32
}

CustomNCrossValidations - N-Cross validations are specified by user.

func (*CustomNCrossValidations) GetNCrossValidations

func (c *CustomNCrossValidations) GetNCrossValidations() *NCrossValidations

GetNCrossValidations implements the NCrossValidationsClassification interface for type CustomNCrossValidations.

func (CustomNCrossValidations) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CustomNCrossValidations.

func (*CustomNCrossValidations) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomNCrossValidations.

type CustomSeasonality

type CustomSeasonality struct {
	// REQUIRED; [Required] Seasonality mode.
	Mode *SeasonalityMode

	// REQUIRED; [Required] Seasonality value.
	Value *int32
}

func (*CustomSeasonality) GetSeasonality

func (c *CustomSeasonality) GetSeasonality() *Seasonality

GetSeasonality implements the SeasonalityClassification interface for type CustomSeasonality.

func (CustomSeasonality) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CustomSeasonality.

func (*CustomSeasonality) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomSeasonality.

type CustomTargetLags

type CustomTargetLags struct {
	// REQUIRED; [Required] Set target lags mode - Auto/Custom
	Mode *TargetLagsMode

	// REQUIRED; [Required] Set target lags values.
	Values []*int32
}

func (*CustomTargetLags) GetTargetLags

func (c *CustomTargetLags) GetTargetLags() *TargetLags

GetTargetLags implements the TargetLagsClassification interface for type CustomTargetLags.

func (CustomTargetLags) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CustomTargetLags.

func (*CustomTargetLags) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomTargetLags.

type CustomTargetRollingWindowSize

type CustomTargetRollingWindowSize struct {
	// REQUIRED; [Required] TargetRollingWindowSiz detection mode.
	Mode *TargetRollingWindowSizeMode

	// REQUIRED; [Required] TargetRollingWindowSize value.
	Value *int32
}

func (*CustomTargetRollingWindowSize) GetTargetRollingWindowSize

func (c *CustomTargetRollingWindowSize) GetTargetRollingWindowSize() *TargetRollingWindowSize

GetTargetRollingWindowSize implements the TargetRollingWindowSizeClassification interface for type CustomTargetRollingWindowSize.

func (CustomTargetRollingWindowSize) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CustomTargetRollingWindowSize.

func (*CustomTargetRollingWindowSize) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomTargetRollingWindowSize.

type DataContainer

type DataContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *DataContainerProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

DataContainer - Azure Resource Manager resource envelope.

func (DataContainer) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DataContainer.

func (*DataContainer) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataContainer.

type DataContainerProperties

type DataContainerProperties struct {
	// REQUIRED; [Required] Specifies the type of data.
	DataType *DataType

	// The asset description text.
	Description *string

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string

	// READ-ONLY; The next auto incremental version
	NextVersion *string
}

DataContainerProperties - Container for data asset versions.

func (DataContainerProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DataContainerProperties.

func (*DataContainerProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type DataContainer.
	Value []*DataContainer
}

DataContainerResourceArmPaginatedResult - A paginated list of DataContainer entities.

func (DataContainerResourceArmPaginatedResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DataContainerResourceArmPaginatedResult.

func (*DataContainerResourceArmPaginatedResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataContainerResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataContainersClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DataContainer = armmachinelearning.DataContainer{
// 	Name: to.Ptr("datacontainer123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/data"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("John Smith"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("John Smith"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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")),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewDataContainersClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataContainersClient().Get(ctx, "testrg123", "workspace123", "datacontainer123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DataContainer = armmachinelearning.DataContainer{
// 	Name: to.Ptr("datacontainer123"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/data"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("John Smith"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("John Smith"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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")),
// 	},
// }
Output:

func (*DataContainersClient) NewListPager

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

NewListPager - List data containers.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDataContainersClient().NewListPager("testrg123", "workspace123", &armmachinelearning.DataContainersClientListOptions{Skip: nil,
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DataContainerResourceArmPaginatedResult = armmachinelearning.DataContainerResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.DataContainer{
	// 		{
	// 			Name: to.Ptr("datastore123"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/data"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer123"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("John Smith"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("John Smith"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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")),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("datastore124"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/data"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/data/datacontainer124"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("John Smith"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("John Smith"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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")),
	// 			},
	// 	}},
	// }
}
Output:

type DataContainersClientCreateOrUpdateOptions

type DataContainersClientCreateOrUpdateOptions struct {
}

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

type DataContainersClientCreateOrUpdateResponse

type DataContainersClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type DataContainersClientListResponse

type DataContainersClientListResponse struct {
	// A paginated list of DataContainer entities.
	DataContainerResourceArmPaginatedResult
}

DataContainersClientListResponse contains the response from method DataContainersClient.NewListPager.

type DataFactory

type DataFactory struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool
	Properties       *DataLakeAnalyticsSchemaProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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
}

func (DataLakeAnalyticsSchema) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DataLakeAnalyticsSchema.

func (*DataLakeAnalyticsSchema) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataLakeAnalyticsSchema.

type DataLakeAnalyticsSchemaProperties

type DataLakeAnalyticsSchemaProperties struct {
	// DataLake Store Account Name
	DataLakeStoreAccountName *string
}

func (DataLakeAnalyticsSchemaProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DataLakeAnalyticsSchemaProperties.

func (*DataLakeAnalyticsSchemaProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataLakeAnalyticsSchemaProperties.

type DataPathAssetReference

type DataPathAssetReference struct {
	// REQUIRED; [Required] Specifies the type of asset reference.
	ReferenceType *ReferenceType

	// ARM resource ID of the datastore where the asset is located.
	DatastoreID *string

	// The path of the file/directory in the datastore.
	Path *string
}

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20221001.Assets.DataVersionBase.DataType
	DataURI *string

	// The asset description text.
	Description *string

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

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.

func (*DataVersionBaseProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type DataVersionBase.
	Value []*DataVersionBase
}

DataVersionBaseResourceArmPaginatedResult - A paginated list of DataVersionBase entities.

func (DataVersionBaseResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type DataVersionBaseResourceArmPaginatedResult.

func (*DataVersionBaseResourceArmPaginatedResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataVersionBaseResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataVersionsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DataVersionBase = armmachinelearning.DataVersionBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewDataVersionsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDataVersionsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DataVersionBase = armmachinelearning.DataVersionBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 	},
// }
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

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDataVersionsClient().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() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DataVersionBaseResourceArmPaginatedResult = armmachinelearning.DataVersionBaseResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.DataVersionBase{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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"),
	// 			},
	// 	}},
	// }
}
Output:

type DataVersionsClientCreateOrUpdateOptions

type DataVersionsClientCreateOrUpdateOptions struct {
}

DataVersionsClientCreateOrUpdateOptions contains the optional parameters for the DataVersionsClient.CreateOrUpdate method.

type DataVersionsClientCreateOrUpdateResponse

type DataVersionsClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type DataVersionsClientListResponse

type DataVersionsClientListResponse struct {
	// A paginated list of DataVersionBase entities.
	DataVersionBaseResourceArmPaginatedResult
}

DataVersionsClientListResponse contains the response from method DataVersionsClient.NewListPager.

type Databricks

type Databricks struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// Properties of Databricks
	Properties *DatabricksProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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

	// access token for databricks account.
	DatabricksAccessToken *string
}

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

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

MarshalJSON implements the json.Marshaller 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
}

DatabricksComputeSecretsProperties - Properties of Databricks Compute Secrets

func (DatabricksComputeSecretsProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DatabricksComputeSecretsProperties.

func (*DatabricksComputeSecretsProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabricksComputeSecretsProperties.

type DatabricksProperties

type DatabricksProperties struct {
	// Databricks access token
	DatabricksAccessToken *string

	// Workspace Url
	WorkspaceURL *string
}

DatabricksProperties - Properties of Databricks

func (DatabricksProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DatabricksProperties.

func (*DatabricksProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabricksProperties.

type DatabricksSchema

type DatabricksSchema struct {
	// Properties of Databricks
	Properties *DatabricksProperties
}

func (DatabricksSchema) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DatabricksSchema.

func (*DatabricksSchema) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabricksSchema.

type Datastore

type Datastore struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties DatastorePropertiesClassification

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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
}

DatastoreCredentials - Base definition for datastore credentials.

func (*DatastoreCredentials) GetDatastoreCredentials

func (d *DatastoreCredentials) GetDatastoreCredentials() *DatastoreCredentials

GetDatastoreCredentials implements the DatastoreCredentialsClassification interface for type DatastoreCredentials.

func (DatastoreCredentials) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DatastoreCredentials.

func (*DatastoreCredentials) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// REQUIRED; [Required] Storage type backing the datastore.
	DatastoreType *DatastoreType

	// The asset description text.
	Description *string

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Readonly property to indicate if datastore is the workspace default datastore
	IsDefault *bool
}

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

	// An array of objects of type Datastore.
	Value []*Datastore
}

DatastoreResourceArmPaginatedResult - A paginated list of Datastore entities.

func (DatastoreResourceArmPaginatedResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DatastoreResourceArmPaginatedResult.

func (*DatastoreResourceArmPaginatedResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatastoreResourceArmPaginatedResult.

type DatastoreSecrets

type DatastoreSecrets struct {
	// REQUIRED; [Required] Credential type used to authentication with storage.
	SecretsType *SecretsType
}

DatastoreSecrets - Base definition for datastore secrets.

func (*DatastoreSecrets) GetDatastoreSecrets

func (d *DatastoreSecrets) GetDatastoreSecrets() *DatastoreSecrets

GetDatastoreSecrets implements the DatastoreSecretsClassification interface for type DatastoreSecrets.

func (DatastoreSecrets) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DatastoreSecrets.

func (*DatastoreSecrets) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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-10-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 (CreateOrUpdateDatastoreAzureBlobWAccountKey)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Datastore/AzureBlobWAccountKey/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatastoresClient().CreateOrUpdate(ctx, "test-rg", "my-aml-workspace", "string", armmachinelearning.Datastore{
	Properties: &armmachinelearning.AzureBlobDatastore{
		Description: to.Ptr("string"),
		Tags: map[string]*string{
			"string": to.Ptr("string"),
		},
		Credentials: &armmachinelearning.AccountKeyDatastoreCredentials{
			CredentialsType: to.Ptr(armmachinelearning.CredentialsTypeAccountKey),
			Secrets: &armmachinelearning.AccountKeyDatastoreSecrets{
				SecretsType: to.Ptr(armmachinelearning.SecretsTypeAccountKey),
				Key:         to.Ptr("string"),
			},
		},
		DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureBlob),
		AccountName:   to.Ptr("string"),
		ContainerName: to.Ptr("string"),
		Endpoint:      to.Ptr("core.windows.net"),
		Protocol:      to.Ptr("https"),
	},
}, &armmachinelearning.DatastoresClientCreateOrUpdateOptions{SkipValidation: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Datastore = armmachinelearning.Datastore{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.AzureBlobDatastore{
// 		Description: to.Ptr("string"),
// 		Tags: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Credentials: &armmachinelearning.AccountKeyDatastoreCredentials{
// 			CredentialsType: to.Ptr(armmachinelearning.CredentialsTypeAccountKey),
// 		},
// 		DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureBlob),
// 		IsDefault: to.Ptr(false),
// 		AccountName: to.Ptr("string"),
// 		ContainerName: to.Ptr("string"),
// 		Endpoint: to.Ptr("core.windows.net"),
// 		Protocol: to.Ptr("https"),
// 	},
// }
Output:

Example (CreateOrUpdateDatastoreAzureDataLakeGen1WServicePrincipal)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatastoresClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Datastore = armmachinelearning.Datastore{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 			TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		},
// 		DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureDataLakeGen1),
// 		StoreName: to.Ptr("string"),
// 	},
// }
Output:

Example (CreateOrUpdateDatastoreAzureDataLakeGen2WServicePrincipal)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Datastore/AzureDataLakeGen2WServicePrincipal/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatastoresClient().CreateOrUpdate(ctx, "test-rg", "my-aml-workspace", "string", armmachinelearning.Datastore{
	Properties: &armmachinelearning.AzureDataLakeGen2Datastore{
		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.DatastoreTypeAzureDataLakeGen2),
		AccountName:   to.Ptr("string"),
		Endpoint:      to.Ptr("string"),
		Filesystem:    to.Ptr("string"),
		Protocol:      to.Ptr("string"),
	},
}, &armmachinelearning.DatastoresClientCreateOrUpdateOptions{SkipValidation: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Datastore = armmachinelearning.Datastore{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.AzureDataLakeGen2Datastore{
// 		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"),
// 			TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		},
// 		DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureDataLakeGen2),
// 		AccountName: to.Ptr("string"),
// 		Endpoint: to.Ptr("string"),
// 		Filesystem: to.Ptr("string"),
// 		Protocol: to.Ptr("string"),
// 	},
// }
Output:

Example (CreateOrUpdateDatastoreAzureFileStoreWAccountKey)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Datastore/AzureFileWAccountKey/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatastoresClient().CreateOrUpdate(ctx, "test-rg", "my-aml-workspace", "string", armmachinelearning.Datastore{
	Properties: &armmachinelearning.AzureFileDatastore{
		Description: to.Ptr("string"),
		Tags: map[string]*string{
			"string": to.Ptr("string"),
		},
		Credentials: &armmachinelearning.AccountKeyDatastoreCredentials{
			CredentialsType: to.Ptr(armmachinelearning.CredentialsTypeAccountKey),
			Secrets: &armmachinelearning.AccountKeyDatastoreSecrets{
				SecretsType: to.Ptr(armmachinelearning.SecretsTypeAccountKey),
				Key:         to.Ptr("string"),
			},
		},
		DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureFile),
		AccountName:   to.Ptr("string"),
		Endpoint:      to.Ptr("string"),
		FileShareName: to.Ptr("string"),
		Protocol:      to.Ptr("string"),
	},
}, &armmachinelearning.DatastoresClientCreateOrUpdateOptions{SkipValidation: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Datastore = armmachinelearning.Datastore{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.AzureFileDatastore{
// 		Description: to.Ptr("string"),
// 		Tags: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Credentials: &armmachinelearning.AccountKeyDatastoreCredentials{
// 			CredentialsType: to.Ptr(armmachinelearning.CredentialsTypeAccountKey),
// 		},
// 		DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureFile),
// 		AccountName: to.Ptr("string"),
// 		Endpoint: to.Ptr("string"),
// 		FileShareName: to.Ptr("string"),
// 		Protocol: to.Ptr("string"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewDatastoresClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatastoresClient().Get(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Datastore = armmachinelearning.Datastore{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.AzureBlobDatastore{
// 		Description: to.Ptr("string"),
// 		Tags: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Credentials: &armmachinelearning.AccountKeyDatastoreCredentials{
// 			CredentialsType: to.Ptr(armmachinelearning.CredentialsTypeAccountKey),
// 		},
// 		DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureBlob),
// 		IsDefault: to.Ptr(false),
// 		AccountName: to.Ptr("string"),
// 		ContainerName: to.Ptr("string"),
// 		Endpoint: to.Ptr("core.windows.net"),
// 		Protocol: to.Ptr("https"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDatastoresClient().ListSecrets(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armmachinelearning.DatastoresClientListSecretsResponse{
// 	                            DatastoreSecretsClassification: &armmachinelearning.AccountKeyDatastoreSecrets{
// 		SecretsType: to.Ptr(armmachinelearning.SecretsTypeAccountKey),
// 		Key: to.Ptr("string"),
// 	},
// 	                        }
Output:

func (*DatastoresClient) NewListPager

func (client *DatastoresClient) NewListPager(resourceGroupName string, workspaceName string, options *DatastoresClientListOptions) *runtime.Pager[DatastoresClientListResponse]

NewListPager - List datastores.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDatastoresClient().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() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.DatastoreResourceArmPaginatedResult = armmachinelearning.DatastoreResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.Datastore{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.AzureBlobDatastore{
	// 				Description: to.Ptr("string"),
	// 				Tags: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 				Credentials: &armmachinelearning.AccountKeyDatastoreCredentials{
	// 					CredentialsType: to.Ptr(armmachinelearning.CredentialsTypeAccountKey),
	// 				},
	// 				DatastoreType: to.Ptr(armmachinelearning.DatastoreTypeAzureBlob),
	// 				IsDefault: to.Ptr(false),
	// 				AccountName: to.Ptr("string"),
	// 				ContainerName: to.Ptr("string"),
	// 				Endpoint: to.Ptr("core.windows.net"),
	// 				Protocol: to.Ptr("https"),
	// 			},
	// 	}},
	// }
}
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 {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type DatastoresClientListResponse

type DatastoresClientListResponse struct {
	// A paginated list of Datastore entities.
	DatastoreResourceArmPaginatedResult
}

DatastoresClientListResponse contains the response from method DatastoresClient.NewListPager.

type DatastoresClientListSecretsOptions

type DatastoresClientListSecretsOptions struct {
}

DatastoresClientListSecretsOptions contains the optional parameters for the DatastoresClient.ListSecrets method.

type DatastoresClientListSecretsResponse

type DatastoresClientListSecretsResponse struct {
	// Base definition for datastore secrets.
	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
}

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
}

func (DeploymentLogs) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DeploymentLogs.

func (*DeploymentLogs) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentLogs.

type DeploymentLogsRequest

type DeploymentLogsRequest struct {
	// The type of container to retrieve logs from.
	ContainerType *ContainerType

	// The maximum number of lines to tail.
	Tail *int32
}

func (DeploymentLogsRequest) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DeploymentLogsRequest.

func (*DeploymentLogsRequest) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentLogsRequest.

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 DeploymentResourceConfiguration

type DeploymentResourceConfiguration struct {
	// Optional number of instances or nodes used by the compute target.
	InstanceCount *int32

	// Optional type of VM used as supported by the compute target.
	InstanceType *string

	// Additional properties bag.
	Properties map[string]any
}

func (DeploymentResourceConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DeploymentResourceConfiguration.

func (*DeploymentResourceConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentResourceConfiguration.

type DiagnoseRequestProperties

type DiagnoseRequestProperties struct {
	// Setting for diagnosing dependent application insights
	ApplicationInsights map[string]any

	// Setting for diagnosing dependent container registry
	ContainerRegistry map[string]any

	// Setting for diagnosing dns resolution
	DNSResolution map[string]any

	// Setting for diagnosing dependent key vault
	KeyVault map[string]any

	// Setting for diagnosing network security group
	Nsg map[string]any

	// Setting for diagnosing unclassified category of problems
	Others map[string]any

	// Setting for diagnosing resource lock
	ResourceLock map[string]any

	// Setting for diagnosing dependent storage account
	StorageAccount map[string]any

	// Setting for diagnosing user defined routing
	Udr map[string]any
}

func (DiagnoseRequestProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiagnoseRequestProperties.

func (*DiagnoseRequestProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnoseRequestProperties.

type DiagnoseResponseResult

type DiagnoseResponseResult struct {
	Value *DiagnoseResponseResultValue
}

func (DiagnoseResponseResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiagnoseResponseResult.

func (*DiagnoseResponseResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnoseResponseResult.

type DiagnoseResponseResultValue

type DiagnoseResponseResultValue struct {
	ApplicationInsightsResults []*DiagnoseResult
	ContainerRegistryResults   []*DiagnoseResult
	DNSResolutionResults       []*DiagnoseResult
	KeyVaultResults            []*DiagnoseResult
	NetworkSecurityRuleResults []*DiagnoseResult
	OtherResults               []*DiagnoseResult
	ResourceLockResults        []*DiagnoseResult
	StorageAccountResults      []*DiagnoseResult
	UserDefinedRouteResults    []*DiagnoseResult
}

func (DiagnoseResponseResultValue) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiagnoseResponseResultValue.

func (*DiagnoseResponseResultValue) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnoseResponseResultValue.

type DiagnoseResult

type DiagnoseResult struct {
	// READ-ONLY; Code for workspace setup error
	Code *string

	// READ-ONLY; Level of workspace setup error
	Level *DiagnoseResultLevel

	// READ-ONLY; Message of workspace setup error
	Message *string
}

DiagnoseResult - Result of Diagnose

func (DiagnoseResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiagnoseResult.

func (*DiagnoseResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnoseResult.

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
}

DiagnoseWorkspaceParameters - Parameters to diagnose a workspace

func (DiagnoseWorkspaceParameters) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiagnoseWorkspaceParameters.

func (*DiagnoseWorkspaceParameters) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type DiagnoseWorkspaceParameters.

type DistributionConfiguration

type DistributionConfiguration struct {
	// REQUIRED; [Required] Specifies the type of distribution framework.
	DistributionType *DistributionType
}

DistributionConfiguration - Base definition for job distribution configuration.

func (*DistributionConfiguration) GetDistributionConfiguration

func (d *DistributionConfiguration) GetDistributionConfiguration() *DistributionConfiguration

GetDistributionConfiguration implements the DistributionConfigurationClassification interface for type DistributionConfiguration.

func (DistributionConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DistributionConfiguration.

func (*DistributionConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32
}

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.

func (EarlyTerminationPolicy) MarshalJSON

func (e EarlyTerminationPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EarlyTerminationPolicy.

func (*EarlyTerminationPolicy) UnmarshalJSON

func (e *EarlyTerminationPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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 EgressPublicNetworkAccessType

type EgressPublicNetworkAccessType string

EgressPublicNetworkAccessType - Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment.

const (
	EgressPublicNetworkAccessTypeDisabled EgressPublicNetworkAccessType = "Disabled"
	EgressPublicNetworkAccessTypeEnabled  EgressPublicNetworkAccessType = "Enabled"
)

func PossibleEgressPublicNetworkAccessTypeValues

func PossibleEgressPublicNetworkAccessTypeValues() []EgressPublicNetworkAccessType

PossibleEgressPublicNetworkAccessTypeValues returns the possible values for the EgressPublicNetworkAccessType const type.

type EncryptionKeyVaultProperties

type EncryptionKeyVaultProperties struct {
	// REQUIRED; Key vault uri to access the encryption key.
	KeyIdentifier *string

	// REQUIRED; The ArmId of the keyVault where the customer owned encryption key is present.
	KeyVaultArmID *string

	// For future use - The client id of the identity which will be used to access key vault.
	IdentityClientID *string
}

func (EncryptionKeyVaultProperties) MarshalJSON

func (e EncryptionKeyVaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncryptionKeyVaultProperties.

func (*EncryptionKeyVaultProperties) UnmarshalJSON

func (e *EncryptionKeyVaultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionKeyVaultProperties.

type EncryptionProperty

type EncryptionProperty struct {
	// REQUIRED; Customer Key vault properties.
	KeyVaultProperties *EncryptionKeyVaultProperties

	// REQUIRED; Indicates whether or not the encryption is enabled for the workspace.
	Status *EncryptionStatus

	// The identity that will be used to access the key vault for encryption at rest.
	Identity *IdentityForCmk
}

func (EncryptionProperty) MarshalJSON

func (e EncryptionProperty) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EncryptionProperty.

func (*EncryptionProperty) UnmarshalJSON

func (e *EncryptionProperty) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EncryptionProperty.

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

	// The secondary key.
	SecondaryKey *string
}

EndpointAuthKeys - Keys for endpoint authentication.

func (EndpointAuthKeys) MarshalJSON

func (e EndpointAuthKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointAuthKeys.

func (*EndpointAuthKeys) UnmarshalJSON

func (e *EndpointAuthKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointAuthKeys.

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

	// Access token expiry time (UTC).
	ExpiryTimeUTC *int64

	// Refresh access token after time (UTC).
	RefreshAfterTimeUTC *int64

	// Access token type.
	TokenType *string
}

EndpointAuthToken - Service Token

func (EndpointAuthToken) MarshalJSON

func (e EndpointAuthToken) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointAuthToken.

func (*EndpointAuthToken) UnmarshalJSON

func (e *EndpointAuthToken) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointAuthToken.

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

	// Description of the endpoint deployment.
	Description *string

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string
}

EndpointDeploymentPropertiesBase - Base definition for endpoint deployment.

func (EndpointDeploymentPropertiesBase) MarshalJSON

func (e EndpointDeploymentPropertiesBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointDeploymentPropertiesBase.

func (*EndpointDeploymentPropertiesBase) UnmarshalJSON

func (e *EndpointDeploymentPropertiesBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// Description of the inference endpoint.
	Description *string

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

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string

	// READ-ONLY; Endpoint URI.
	ScoringURI *string

	// READ-ONLY; Endpoint Swagger URI.
	SwaggerURI *string
}

EndpointPropertiesBase - Inference Endpoint base definition

func (EndpointPropertiesBase) MarshalJSON

func (e EndpointPropertiesBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointPropertiesBase.

func (*EndpointPropertiesBase) UnmarshalJSON

func (e *EndpointPropertiesBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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 EndpointScheduleAction

type EndpointScheduleAction struct {
	// REQUIRED; [Required] Specifies the action type of the schedule
	ActionType *ScheduleActionType

	// REQUIRED; [Required] Defines Schedule action definition details.
	EndpointInvocationDefinition any
}

func (*EndpointScheduleAction) GetScheduleActionBase

func (e *EndpointScheduleAction) GetScheduleActionBase() *ScheduleActionBase

GetScheduleActionBase implements the ScheduleActionBaseClassification interface for type EndpointScheduleAction.

func (EndpointScheduleAction) MarshalJSON

func (e EndpointScheduleAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointScheduleAction.

func (*EndpointScheduleAction) UnmarshalJSON

func (e *EndpointScheduleAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointScheduleAction.

type EnvironmentContainer

type EnvironmentContainer struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *EnvironmentContainerProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

EnvironmentContainer - Azure Resource Manager resource envelope.

func (EnvironmentContainer) MarshalJSON

func (e EnvironmentContainer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentContainer.

func (*EnvironmentContainer) UnmarshalJSON

func (e *EnvironmentContainer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentContainer.

type EnvironmentContainerProperties

type EnvironmentContainerProperties struct {
	// The asset description text.
	Description *string

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string

	// READ-ONLY; The next auto incremental version
	NextVersion *string
}

EnvironmentContainerProperties - Container for environment specification versions.

func (EnvironmentContainerProperties) MarshalJSON

func (e EnvironmentContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentContainerProperties.

func (*EnvironmentContainerProperties) UnmarshalJSON

func (e *EnvironmentContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type EnvironmentContainer.
	Value []*EnvironmentContainer
}

EnvironmentContainerResourceArmPaginatedResult - A paginated list of EnvironmentContainer entities.

func (EnvironmentContainerResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type EnvironmentContainerResourceArmPaginatedResult.

func (*EnvironmentContainerResourceArmPaginatedResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentContainerResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEnvironmentContainersClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EnvironmentContainer = armmachinelearning.EnvironmentContainer{
// 	Name: to.Ptr("testEnvironment"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/environments"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-04T03:39:11.300Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-04T03:39:11.300Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 		},
// 	},
// }
Output:

func (*EnvironmentContainersClient) Delete

Delete - Delete container. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewEnvironmentContainersClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEnvironmentContainersClient().Get(ctx, "testrg123", "testworkspace", "testEnvironment", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EnvironmentContainer = armmachinelearning.EnvironmentContainer{
// 	Name: to.Ptr("testEnvironment"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/environments"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("John Smith"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("John Smith"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.EnvironmentContainerProperties{
// 		Description: to.Ptr("string"),
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("value1"),
// 			"tag2": to.Ptr("value2"),
// 		},
// 	},
// }
Output:

func (*EnvironmentContainersClient) NewListPager

NewListPager - List environment containers.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEnvironmentContainersClient().NewListPager("testrg123", "testworkspace", &armmachinelearning.EnvironmentContainersClientListOptions{Skip: nil,
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EnvironmentContainerResourceArmPaginatedResult = armmachinelearning.EnvironmentContainerResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.EnvironmentContainer{
	// 		{
	// 			Name: to.Ptr("testEnvironment"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/environments"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("John Smith"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("John Smith"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.EnvironmentContainerProperties{
	// 				Description: to.Ptr("string"),
	// 				Tags: map[string]*string{
	// 					"tag1": to.Ptr("value1"),
	// 					"tag2": to.Ptr("value2"),
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type EnvironmentContainersClientCreateOrUpdateOptions

type EnvironmentContainersClientCreateOrUpdateOptions struct {
}

EnvironmentContainersClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentContainersClient.CreateOrUpdate method.

type EnvironmentContainersClientCreateOrUpdateResponse

type EnvironmentContainersClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type EnvironmentContainersClientListResponse

type EnvironmentContainersClientListResponse struct {
	// A paginated list of EnvironmentContainer entities.
	EnvironmentContainerResourceArmPaginatedResult
}

EnvironmentContainersClientListResponse contains the response from method EnvironmentContainersClient.NewListPager.

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

EnvironmentVersion - Azure Resource Manager resource envelope.

func (EnvironmentVersion) MarshalJSON

func (e EnvironmentVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentVersion.

func (*EnvironmentVersion) UnmarshalJSON

func (e *EnvironmentVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVersion.

type EnvironmentVersionProperties

type EnvironmentVersionProperties struct {
	// Defines if image needs to be rebuilt based on base image changes.
	AutoRebuild *AutoRebuildSetting

	// Configuration settings for Docker build context.
	Build *BuildContext

	// Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages.
	CondaFile *string

	// The asset description text.
	Description *string

	// Name of the image that will be used for the environment.
	Image *string

	// Defines configuration specific to inference.
	InferenceConfig *InferenceContainerProperties

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The OS type of the environment.
	OSType *OperatingSystemType

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Environment type is either user managed or curated by the Azure ML service
	EnvironmentType *EnvironmentType
}

EnvironmentVersionProperties - Environment version details.

func (EnvironmentVersionProperties) MarshalJSON

func (e EnvironmentVersionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentVersionProperties.

func (*EnvironmentVersionProperties) UnmarshalJSON

func (e *EnvironmentVersionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type EnvironmentVersion.
	Value []*EnvironmentVersion
}

EnvironmentVersionResourceArmPaginatedResult - A paginated list of EnvironmentVersion entities.

func (EnvironmentVersionResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type EnvironmentVersionResourceArmPaginatedResult.

func (*EnvironmentVersionResourceArmPaginatedResult) UnmarshalJSON

func (e *EnvironmentVersionResourceArmPaginatedResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVersionResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEnvironmentVersionsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EnvironmentVersion = armmachinelearning.EnvironmentVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 		EnvironmentType: to.Ptr(armmachinelearning.EnvironmentTypeCurated),
// 		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),
// 			},
// 		},
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewEnvironmentVersionsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewEnvironmentVersionsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EnvironmentVersion = armmachinelearning.EnvironmentVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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"),
// 		EnvironmentType: to.Ptr(armmachinelearning.EnvironmentTypeCurated),
// 		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),
// 			},
// 		},
// 	},
// }
Output:

func (*EnvironmentVersionsClient) NewListPager

func (client *EnvironmentVersionsClient) NewListPager(resourceGroupName string, workspaceName string, name string, options *EnvironmentVersionsClientListOptions) *runtime.Pager[EnvironmentVersionsClientListResponse]

NewListPager - List versions.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewEnvironmentVersionsClient().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() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.EnvironmentVersionResourceArmPaginatedResult = armmachinelearning.EnvironmentVersionResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.EnvironmentVersion{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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"),
	// 				EnvironmentType: to.Ptr(armmachinelearning.EnvironmentTypeCurated),
	// 				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),
	// 					},
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type EnvironmentVersionsClientCreateOrUpdateOptions

type EnvironmentVersionsClientCreateOrUpdateOptions struct {
}

EnvironmentVersionsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentVersionsClient.CreateOrUpdate method.

type EnvironmentVersionsClientCreateOrUpdateResponse

type EnvironmentVersionsClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type EnvironmentVersionsClientListResponse

type EnvironmentVersionsClientListResponse struct {
	// A paginated list of EnvironmentVersion entities.
	EnvironmentVersionResourceArmPaginatedResult
}

EnvironmentVersionsClientListResponse contains the response from method EnvironmentVersionsClient.NewListPager.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON

func (e ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

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

func (ErrorResponse) MarshalJSON

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type EstimatedVMPrice

type EstimatedVMPrice struct {
	// REQUIRED; Operating system type used by the VM.
	OSType *VMPriceOSType

	// REQUIRED; The price charged for using the VM.
	RetailPrice *float64

	// REQUIRED; The type of the VM.
	VMTier *VMTier
}

EstimatedVMPrice - The estimated price info for using a VM of a particular OS type, tier, etc.

func (EstimatedVMPrice) MarshalJSON

func (e EstimatedVMPrice) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EstimatedVMPrice.

func (*EstimatedVMPrice) UnmarshalJSON

func (e *EstimatedVMPrice) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EstimatedVMPrice.

type EstimatedVMPrices

type EstimatedVMPrices struct {
	// REQUIRED; Three lettered code specifying the currency of the VM price. Example: USD
	BillingCurrency *BillingCurrency

	// REQUIRED; The unit of time measurement for the specified VM price. Example: OneHour
	UnitOfMeasure *UnitOfMeasure

	// REQUIRED; The list of estimated prices for using a VM of a particular OS type, tier, etc.
	Values []*EstimatedVMPrice
}

EstimatedVMPrices - The estimated price info for using a VM.

func (EstimatedVMPrices) MarshalJSON

func (e EstimatedVMPrices) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EstimatedVMPrices.

func (*EstimatedVMPrices) UnmarshalJSON

func (e *EstimatedVMPrices) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EstimatedVMPrices.

type ExternalFQDNResponse

type ExternalFQDNResponse struct {
	Value []*FQDNEndpoints
}

func (ExternalFQDNResponse) MarshalJSON

func (e ExternalFQDNResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExternalFQDNResponse.

func (*ExternalFQDNResponse) UnmarshalJSON

func (e *ExternalFQDNResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExternalFQDNResponse.

type FQDNEndpoint

type FQDNEndpoint struct {
	DomainName      *string
	EndpointDetails []*FQDNEndpointDetail
}

func (FQDNEndpoint) MarshalJSON

func (f FQDNEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FQDNEndpoint.

func (*FQDNEndpoint) UnmarshalJSON

func (f *FQDNEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FQDNEndpoint.

type FQDNEndpointDetail

type FQDNEndpointDetail struct {
	Port *int32
}

func (FQDNEndpointDetail) MarshalJSON

func (f FQDNEndpointDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FQDNEndpointDetail.

func (*FQDNEndpointDetail) UnmarshalJSON

func (f *FQDNEndpointDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FQDNEndpointDetail.

type FQDNEndpoints

type FQDNEndpoints struct {
	Properties *FQDNEndpointsProperties
}

func (FQDNEndpoints) MarshalJSON

func (f FQDNEndpoints) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FQDNEndpoints.

func (*FQDNEndpoints) UnmarshalJSON

func (f *FQDNEndpoints) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FQDNEndpoints.

type FQDNEndpointsProperties

type FQDNEndpointsProperties struct {
	Category  *string
	Endpoints []*FQDNEndpoint
}

func (FQDNEndpointsProperties) MarshalJSON

func (f FQDNEndpointsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FQDNEndpointsProperties.

func (*FQDNEndpointsProperties) UnmarshalJSON

func (f *FQDNEndpointsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FQDNEndpointsProperties.

type FeatureLags

type FeatureLags string

FeatureLags - Flag for generating lags for the numeric features.

const (
	// FeatureLagsAuto - System auto-generates feature lags.
	FeatureLagsAuto FeatureLags = "Auto"
	// FeatureLagsNone - No feature lags generated.
	FeatureLagsNone FeatureLags = "None"
)

func PossibleFeatureLagsValues

func PossibleFeatureLagsValues() []FeatureLags

PossibleFeatureLagsValues returns the possible values for the FeatureLags const type.

type FeaturizationMode

type FeaturizationMode string

FeaturizationMode - Featurization mode - determines data featurization mode.

const (
	// FeaturizationModeAuto - Auto mode, system performs featurization without any custom featurization inputs.
	FeaturizationModeAuto FeaturizationMode = "Auto"
	// FeaturizationModeCustom - Custom featurization.
	FeaturizationModeCustom FeaturizationMode = "Custom"
	// FeaturizationModeOff - Featurization off. 'Forecasting' task cannot use this value.
	FeaturizationModeOff FeaturizationMode = "Off"
)

func PossibleFeaturizationModeValues

func PossibleFeaturizationModeValues() []FeaturizationMode

PossibleFeaturizationModeValues returns the possible values for the FeaturizationMode const type.

type FeaturizationSettings

type FeaturizationSettings struct {
	// Dataset language, useful for the text data.
	DatasetLanguage *string
}

FeaturizationSettings - Featurization Configuration.

func (FeaturizationSettings) MarshalJSON

func (f FeaturizationSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FeaturizationSettings.

func (*FeaturizationSettings) UnmarshalJSON

func (f *FeaturizationSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeaturizationSettings.

type FlavorData

type FlavorData struct {
	// Model flavor-specific data.
	Data map[string]*string
}

func (FlavorData) MarshalJSON

func (f FlavorData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlavorData.

func (*FlavorData) UnmarshalJSON

func (f *FlavorData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FlavorData.

type ForecastHorizon

type ForecastHorizon struct {
	// REQUIRED; [Required] Set forecast horizon value selection mode.
	Mode *ForecastHorizonMode
}

ForecastHorizon - The desired maximum forecast horizon in units of time-series frequency.

func (*ForecastHorizon) GetForecastHorizon

func (f *ForecastHorizon) GetForecastHorizon() *ForecastHorizon

GetForecastHorizon implements the ForecastHorizonClassification interface for type ForecastHorizon.

func (ForecastHorizon) MarshalJSON

func (f ForecastHorizon) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForecastHorizon.

func (*ForecastHorizon) UnmarshalJSON

func (f *ForecastHorizon) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ForecastHorizon.

type ForecastHorizonClassification

type ForecastHorizonClassification interface {
	// GetForecastHorizon returns the ForecastHorizon content of the underlying type.
	GetForecastHorizon() *ForecastHorizon
}

ForecastHorizonClassification provides polymorphic access to related types. Call the interface's GetForecastHorizon() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AutoForecastHorizon, *CustomForecastHorizon, *ForecastHorizon

type ForecastHorizonMode

type ForecastHorizonMode string

ForecastHorizonMode - Enum to determine forecast horizon selection mode.

const (
	// ForecastHorizonModeAuto - Forecast horizon to be determined automatically.
	ForecastHorizonModeAuto ForecastHorizonMode = "Auto"
	// ForecastHorizonModeCustom - Use the custom forecast horizon.
	ForecastHorizonModeCustom ForecastHorizonMode = "Custom"
)

func PossibleForecastHorizonModeValues

func PossibleForecastHorizonModeValues() []ForecastHorizonMode

PossibleForecastHorizonModeValues returns the possible values for the ForecastHorizonMode const type.

type Forecasting

type Forecasting struct {
	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Columns to use for CVSplit data.
	CvSplitColumnNames []*string

	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *TableVerticalFeaturizationSettings

	// Forecasting task specific inputs.
	ForecastingSettings *ForecastingSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *TableVerticalLimitSettings

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Number of cross validation folds to be applied on training dataset when validation dataset is not provided.
	NCrossValidations NCrossValidationsClassification

	// Primary metric for forecasting task.
	PrimaryMetric *ForecastingPrimaryMetrics

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Test data input.
	TestData *MLTableJobInput

	// The fraction of test dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied when
	// validation dataset is not provided.
	TestDataSize *float64

	// Inputs for training phase for an AutoML Job.
	TrainingSettings *ForecastingTrainingSettings

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64

	// The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to
	// be weighted up or down.
	WeightColumnName *string
}

Forecasting task in AutoML Table vertical.

func (*Forecasting) GetAutoMLVertical

func (f *Forecasting) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type Forecasting.

func (Forecasting) MarshalJSON

func (f Forecasting) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Forecasting.

func (*Forecasting) UnmarshalJSON

func (f *Forecasting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Forecasting.

type ForecastingModels

type ForecastingModels string

ForecastingModels - Enum for all forecasting models supported by AutoML.

const (
	// ForecastingModelsArimax - An Autoregressive Integrated Moving Average with Explanatory Variable (ARIMAX) model can be viewed
	// as a multiple regression model with one or more autoregressive (AR) terms and/or one or more moving average (MA) terms.
	// This method is suitable for forecasting when data is stationary/non stationary, and multivariate with any type of data
	// pattern, i.e., level/trend /seasonality/cyclicity.
	ForecastingModelsArimax ForecastingModels = "Arimax"
	// ForecastingModelsAutoArima - Auto-Autoregressive Integrated Moving Average (ARIMA) model uses time-series data and statistical
	// analysis to interpret the data and make future predictions.
	// This model aims to explain data by using time series data on its past values and uses linear regression to make predictions.
	ForecastingModelsAutoArima ForecastingModels = "AutoArima"
	// ForecastingModelsAverage - The Average forecasting model makes predictions by carrying forward the average of the target
	// values for each time-series in the training data.
	ForecastingModelsAverage ForecastingModels = "Average"
	// ForecastingModelsDecisionTree - Decision Trees are a non-parametric supervised learning method used for both classification
	// and regression tasks.
	// The goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from
	// the data features.
	ForecastingModelsDecisionTree ForecastingModels = "DecisionTree"
	// ForecastingModelsElasticNet - Elastic net is a popular type of regularized linear regression that combines two popular
	// penalties, specifically the L1 and L2 penalty functions.
	ForecastingModelsElasticNet ForecastingModels = "ElasticNet"
	// ForecastingModelsExponentialSmoothing - Exponential smoothing is a time series forecasting method for univariate data that
	// can be extended to support data with a systematic trend or seasonal component.
	ForecastingModelsExponentialSmoothing ForecastingModels = "ExponentialSmoothing"
	// ForecastingModelsExtremeRandomTrees - Extreme Trees is an ensemble machine learning algorithm that combines the predictions
	// from many decision trees. It is related to the widely used random forest algorithm.
	ForecastingModelsExtremeRandomTrees ForecastingModels = "ExtremeRandomTrees"
	// ForecastingModelsGradientBoosting - The technique of transiting week learners into a strong learner is called Boosting.
	// The gradient boosting algorithm process works on this theory of execution.
	ForecastingModelsGradientBoosting ForecastingModels = "GradientBoosting"
	// ForecastingModelsKNN - K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints
	// which further means that the new data point will be assigned a value based on how closely it matches the points in the
	// training set.
	ForecastingModelsKNN ForecastingModels = "KNN"
	// ForecastingModelsLassoLars - Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with
	// an L1 prior as regularizer.
	ForecastingModelsLassoLars ForecastingModels = "LassoLars"
	// ForecastingModelsLightGBM - LightGBM is a gradient boosting framework that uses tree based learning algorithms.
	ForecastingModelsLightGBM ForecastingModels = "LightGBM"
	// ForecastingModelsNaive - The Naive forecasting model makes predictions by carrying forward the latest target value for
	// each time-series in the training data.
	ForecastingModelsNaive ForecastingModels = "Naive"
	// ForecastingModelsProphet - Prophet is a procedure for forecasting time series data based on an additive model where non-linear
	// trends are fit with yearly, weekly, and daily seasonality, plus holiday effects.
	// It works best with time series that have strong seasonal effects and several seasons of historical data. Prophet is robust
	// to missing data and shifts in the trend, and typically handles outliers well.
	ForecastingModelsProphet ForecastingModels = "Prophet"
	// ForecastingModelsRandomForest - Random forest is a supervised learning algorithm.
	// The "forest" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.
	// The general idea of the bagging method is that a combination of learning models increases the overall result.
	ForecastingModelsRandomForest ForecastingModels = "RandomForest"
	// ForecastingModelsSGD - SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications
	// to find the model parameters that correspond to the best fit between predicted and actual outputs.
	// It's an inexact but powerful technique.
	ForecastingModelsSGD ForecastingModels = "SGD"
	// ForecastingModelsSeasonalAverage - The Seasonal Average forecasting model makes predictions by carrying forward the average
	// value of the latest season of data for each time-series in the training data.
	ForecastingModelsSeasonalAverage ForecastingModels = "SeasonalAverage"
	// ForecastingModelsSeasonalNaive - The Seasonal Naive forecasting model makes predictions by carrying forward the latest
	// season of target values for each time-series in the training data.
	ForecastingModelsSeasonalNaive ForecastingModels = "SeasonalNaive"
	// ForecastingModelsTCNForecaster - TCNForecaster: Temporal Convolutional Networks Forecaster. //TODO: Ask forecasting team
	// for brief intro.
	ForecastingModelsTCNForecaster ForecastingModels = "TCNForecaster"
	// ForecastingModelsXGBoostRegressor - XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning
	// model using ensemble of base learners.
	ForecastingModelsXGBoostRegressor ForecastingModels = "XGBoostRegressor"
)

func PossibleForecastingModelsValues

func PossibleForecastingModelsValues() []ForecastingModels

PossibleForecastingModelsValues returns the possible values for the ForecastingModels const type.

type ForecastingPrimaryMetrics

type ForecastingPrimaryMetrics string

ForecastingPrimaryMetrics - Primary metrics for Forecasting task.

const (
	// ForecastingPrimaryMetricsNormalizedMeanAbsoluteError - The Normalized Mean Absolute Error (NMAE) is a validation metric
	// to compare the Mean Absolute Error (MAE) of (time) series with different scales.
	ForecastingPrimaryMetricsNormalizedMeanAbsoluteError ForecastingPrimaryMetrics = "NormalizedMeanAbsoluteError"
	// ForecastingPrimaryMetricsNormalizedRootMeanSquaredError - The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates
	// the comparison between models with different scales.
	ForecastingPrimaryMetricsNormalizedRootMeanSquaredError ForecastingPrimaryMetrics = "NormalizedRootMeanSquaredError"
	// ForecastingPrimaryMetricsR2Score - The R2 score is one of the performance evaluation measures for forecasting-based machine
	// learning models.
	ForecastingPrimaryMetricsR2Score ForecastingPrimaryMetrics = "R2Score"
	// ForecastingPrimaryMetricsSpearmanCorrelation - The Spearman's rank coefficient of correlation is a non-parametric measure
	// of rank correlation.
	ForecastingPrimaryMetricsSpearmanCorrelation ForecastingPrimaryMetrics = "SpearmanCorrelation"
)

func PossibleForecastingPrimaryMetricsValues

func PossibleForecastingPrimaryMetricsValues() []ForecastingPrimaryMetrics

PossibleForecastingPrimaryMetricsValues returns the possible values for the ForecastingPrimaryMetrics const type.

type ForecastingSettings

type ForecastingSettings struct {
	// Country or region for holidays for forecasting tasks. These should be ISO 3166 two-letter country/region codes, for example
	// 'US' or 'GB'.
	CountryOrRegionForHolidays *string

	// Number of periods between the origin time of one CV fold and the next fold. For example, if CVStepSize = 3 for daily data,
	// the origin time for each fold will be three days apart.
	CvStepSize *int32

	// Flag for generating lags for the numeric features with 'auto' or null.
	FeatureLags *FeatureLags

	// The desired maximum forecast horizon in units of time-series frequency.
	ForecastHorizon ForecastHorizonClassification

	// When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly,
	// etc. The forecast frequency is dataset frequency by default.
	Frequency *string

	// Set time series seasonality as an integer multiple of the series frequency. If seasonality is set to 'auto', it will be
	// inferred.
	Seasonality SeasonalityClassification

	// The parameter defining how if AutoML should handle short time series.
	ShortSeriesHandlingConfig *ShortSeriesHandlingConfiguration

	// The function to be used to aggregate the time series target column to conform to a user specified frequency. If the TargetAggregateFunction
	// is set i.e. not 'None', but the freq parameter is not set,
	// the error is raised. The possible target aggregation functions are: "sum", "max", "min" and "mean".
	TargetAggregateFunction *TargetAggregationFunction

	// The number of past periods to lag from the target column.
	TargetLags TargetLagsClassification

	// The number of past periods used to create a rolling window average of the target column.
	TargetRollingWindowSize TargetRollingWindowSizeClassification

	// The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data
	// used for building the time series and inferring its frequency.
	TimeColumnName *string

	// The names of columns used to group a timeseries. It can be used to create multiple series. If grain is not defined, the
	// data set is assumed to be one time-series. This parameter is used with task type
	// forecasting.
	TimeSeriesIDColumnNames []*string

	// Configure STL Decomposition of the time-series target column.
	UseStl *UseStl
}

ForecastingSettings - Forecasting specific parameters.

func (ForecastingSettings) MarshalJSON

func (f ForecastingSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForecastingSettings.

func (*ForecastingSettings) UnmarshalJSON

func (f *ForecastingSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ForecastingSettings.

type ForecastingTrainingSettings

type ForecastingTrainingSettings struct {
	// Allowed models for forecasting task.
	AllowedTrainingAlgorithms []*ForecastingModels

	// Blocked models for forecasting task.
	BlockedTrainingAlgorithms []*ForecastingModels

	// Enable recommendation of DNN models.
	EnableDnnTraining *bool

	// Flag to turn on explainability on best model.
	EnableModelExplainability *bool

	// Flag for enabling onnx compatible models.
	EnableOnnxCompatibleModels *bool

	// Enable stack ensemble run.
	EnableStackEnsemble *bool

	// Enable voting ensemble run.
	EnableVoteEnsemble *bool

	// During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.
	// Configure this parameter with a higher value than 300 secs, if more time
	// is needed.
	EnsembleModelDownloadTimeout *string

	// Stack ensemble settings for stack ensemble run.
	StackEnsembleSettings *StackEnsembleSettings
}

ForecastingTrainingSettings - Forecasting Training related configuration.

func (ForecastingTrainingSettings) MarshalJSON

func (f ForecastingTrainingSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ForecastingTrainingSettings.

func (*ForecastingTrainingSettings) UnmarshalJSON

func (f *ForecastingTrainingSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ForecastingTrainingSettings.

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
}

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

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// HDInsight compute properties
	Properties *HDInsightProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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

	// Admin credentials for master node of the cluster
	AdministratorAccount *VirtualMachineSSHCredentials

	// Port open for ssh connections on the master node of the cluster.
	SSHPort *int32
}

HDInsightProperties - HDInsight compute properties

func (HDInsightProperties) MarshalJSON

func (h HDInsightProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HDInsightProperties.

func (*HDInsightProperties) UnmarshalJSON

func (h *HDInsightProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HDInsightProperties.

type HDInsightSchema

type HDInsightSchema struct {
	// HDInsight compute properties
	Properties *HDInsightProperties
}

func (HDInsightSchema) MarshalJSON

func (h HDInsightSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HDInsightSchema.

func (*HDInsightSchema) UnmarshalJSON

func (h *HDInsightSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HDInsightSchema.

type IDAssetReference

type IDAssetReference struct {
	// REQUIRED; [Required] ARM resource ID of the asset.
	AssetID *string

	// REQUIRED; [Required] Specifies the type of asset reference.
	ReferenceType *ReferenceType
}

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
}

IdentityConfiguration - Base definition for identity configuration.

func (*IdentityConfiguration) GetIdentityConfiguration

func (i *IdentityConfiguration) GetIdentityConfiguration() *IdentityConfiguration

GetIdentityConfiguration implements the IdentityConfigurationClassification interface for type IdentityConfiguration.

func (IdentityConfiguration) MarshalJSON

func (i IdentityConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityConfiguration.

func (*IdentityConfiguration) UnmarshalJSON

func (i *IdentityConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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
}

IdentityForCmk - Identity that will be used to access key vault for encryption at rest

func (IdentityForCmk) MarshalJSON

func (i IdentityForCmk) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentityForCmk.

func (*IdentityForCmk) UnmarshalJSON

func (i *IdentityForCmk) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IdentityForCmk.

type ImageClassification

type ImageClassification struct {
	// REQUIRED; [Required] Limit settings for the AutoML job.
	LimitSettings *ImageLimitSettings

	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Settings used for training the model.
	ModelSettings *ImageModelSettingsClassification

	// Primary metric to optimize for this task.
	PrimaryMetric *ClassificationPrimaryMetrics

	// Search space for sampling different combinations of models and their hyperparameters.
	SearchSpace []*ImageModelDistributionSettingsClassification

	// Model sweeping and hyperparameter sweeping related settings.
	SweepSettings *ImageSweepSettings

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64
}

ImageClassification - Image Classification. Multi-class image classification is used when an image is classified with only a single label from a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'.

func (*ImageClassification) GetAutoMLVertical

func (i *ImageClassification) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type ImageClassification.

func (ImageClassification) MarshalJSON

func (i ImageClassification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageClassification.

func (*ImageClassification) UnmarshalJSON

func (i *ImageClassification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageClassification.

type ImageClassificationBase

type ImageClassificationBase struct {
	// REQUIRED; [Required] Limit settings for the AutoML job.
	LimitSettings *ImageLimitSettings

	// Settings used for training the model.
	ModelSettings *ImageModelSettingsClassification

	// Search space for sampling different combinations of models and their hyperparameters.
	SearchSpace []*ImageModelDistributionSettingsClassification

	// Model sweeping and hyperparameter sweeping related settings.
	SweepSettings *ImageSweepSettings

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64
}

func (ImageClassificationBase) MarshalJSON

func (i ImageClassificationBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageClassificationBase.

func (*ImageClassificationBase) UnmarshalJSON

func (i *ImageClassificationBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageClassificationBase.

type ImageClassificationMultilabel

type ImageClassificationMultilabel struct {
	// REQUIRED; [Required] Limit settings for the AutoML job.
	LimitSettings *ImageLimitSettings

	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Settings used for training the model.
	ModelSettings *ImageModelSettingsClassification

	// Primary metric to optimize for this task.
	PrimaryMetric *ClassificationMultilabelPrimaryMetrics

	// Search space for sampling different combinations of models and their hyperparameters.
	SearchSpace []*ImageModelDistributionSettingsClassification

	// Model sweeping and hyperparameter sweeping related settings.
	SweepSettings *ImageSweepSettings

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64
}

ImageClassificationMultilabel - Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels from a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'.

func (*ImageClassificationMultilabel) GetAutoMLVertical

func (i *ImageClassificationMultilabel) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type ImageClassificationMultilabel.

func (ImageClassificationMultilabel) MarshalJSON

func (i ImageClassificationMultilabel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageClassificationMultilabel.

func (*ImageClassificationMultilabel) UnmarshalJSON

func (i *ImageClassificationMultilabel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageClassificationMultilabel.

type ImageInstanceSegmentation

type ImageInstanceSegmentation struct {
	// REQUIRED; [Required] Limit settings for the AutoML job.
	LimitSettings *ImageLimitSettings

	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Settings used for training the model.
	ModelSettings *ImageModelSettingsObjectDetection

	// Primary metric to optimize for this task.
	PrimaryMetric *InstanceSegmentationPrimaryMetrics

	// Search space for sampling different combinations of models and their hyperparameters.
	SearchSpace []*ImageModelDistributionSettingsObjectDetection

	// Model sweeping and hyperparameter sweeping related settings.
	SweepSettings *ImageSweepSettings

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64
}

ImageInstanceSegmentation - Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level, drawing a polygon around each object in the image.

func (*ImageInstanceSegmentation) GetAutoMLVertical

func (i *ImageInstanceSegmentation) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type ImageInstanceSegmentation.

func (ImageInstanceSegmentation) MarshalJSON

func (i ImageInstanceSegmentation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageInstanceSegmentation.

func (*ImageInstanceSegmentation) UnmarshalJSON

func (i *ImageInstanceSegmentation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageInstanceSegmentation.

type ImageLimitSettings

type ImageLimitSettings struct {
	// Maximum number of concurrent AutoML iterations.
	MaxConcurrentTrials *int32

	// Maximum number of AutoML iterations.
	MaxTrials *int32

	// AutoML job timeout.
	Timeout *string
}

ImageLimitSettings - Limit settings for the AutoML job.

func (ImageLimitSettings) MarshalJSON

func (i ImageLimitSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageLimitSettings.

func (*ImageLimitSettings) UnmarshalJSON

func (i *ImageLimitSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageLimitSettings.

type ImageModelDistributionSettings

type ImageModelDistributionSettings struct {
	// Enable AMSGrad when optimizer is 'adam' or 'adamw'.
	AmsGradient *string

	// Settings for using Augmentations.
	Augmentations *string

	// Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta1 *string

	// Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta2 *string

	// Whether to use distributer training.
	Distributed *string

	// Enable early stopping logic during training.
	EarlyStopping *string

	// Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping.
	// Must be a positive integer.
	EarlyStoppingDelay *string

	// Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be
	// a positive integer.
	EarlyStoppingPatience *string

	// Enable normalization when exporting ONNX model.
	EnableOnnxNormalization *string

	// Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.
	EvaluationFrequency *string

	// Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights
	// while accumulating the gradients of those steps, and then using the
	// accumulated gradients to compute the weight updates. Must be a positive integer.
	GradientAccumulationStep *string

	// Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext'
	// means freezing layer0 and layer1. For a full list of models supported and details
	// on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	LayersToFreeze *string

	// Initial learning rate. Must be a float in the range [0, 1].
	LearningRate *string

	// Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.
	LearningRateScheduler *string

	// Name of the model to use for training. For more information on the available models please visit the official documentation:
	// https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	ModelName *string

	// Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].
	Momentum *string

	// Enable nesterov when optimizer is 'sgd'.
	Nesterov *string

	// Number of training epochs. Must be a positive integer.
	NumberOfEpochs *string

	// Number of data loader workers. Must be a non-negative integer.
	NumberOfWorkers *string

	// Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.
	Optimizer *string

	// Random seed to be used when using deterministic training.
	RandomSeed *string

	// Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].
	StepLRGamma *string

	// Value of step size when learning rate scheduler is 'step'. Must be a positive integer.
	StepLRStepSize *string

	// Training batch size. Must be a positive integer.
	TrainingBatchSize *string

	// Validation batch size. Must be a positive integer.
	ValidationBatchSize *string

	// Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].
	WarmupCosineLRCycles *string

	// Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.
	WarmupCosineLRWarmupEpochs *string

	// Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].
	WeightDecay *string
}

ImageModelDistributionSettings - Distribution expressions to sweep over values of model settings.Some examples are:ModelName = "choice('seresnext', 'resnest50')"; LearningRate = "uniform(0.001, 0.01)"; LayersToFreeze = "choice(0, 2)";All distributions can be specified as distribution_name(min, max) or choice(val1, val2, …, valn) where distribution name can be: uniform, quniform, loguniform, etc For more details on how to compose distribution expressions please check the documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters For more information on the available settings please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

func (ImageModelDistributionSettings) MarshalJSON

func (i ImageModelDistributionSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageModelDistributionSettings.

func (*ImageModelDistributionSettings) UnmarshalJSON

func (i *ImageModelDistributionSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageModelDistributionSettings.

type ImageModelDistributionSettingsClassification

type ImageModelDistributionSettingsClassification struct {
	// Enable AMSGrad when optimizer is 'adam' or 'adamw'.
	AmsGradient *string

	// Settings for using Augmentations.
	Augmentations *string

	// Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta1 *string

	// Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta2 *string

	// Whether to use distributer training.
	Distributed *string

	// Enable early stopping logic during training.
	EarlyStopping *string

	// Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping.
	// Must be a positive integer.
	EarlyStoppingDelay *string

	// Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be
	// a positive integer.
	EarlyStoppingPatience *string

	// Enable normalization when exporting ONNX model.
	EnableOnnxNormalization *string

	// Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.
	EvaluationFrequency *string

	// Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights
	// while accumulating the gradients of those steps, and then using the
	// accumulated gradients to compute the weight updates. Must be a positive integer.
	GradientAccumulationStep *string

	// Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext'
	// means freezing layer0 and layer1. For a full list of models supported and details
	// on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	LayersToFreeze *string

	// Initial learning rate. Must be a float in the range [0, 1].
	LearningRate *string

	// Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.
	LearningRateScheduler *string

	// Name of the model to use for training. For more information on the available models please visit the official documentation:
	// https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	ModelName *string

	// Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].
	Momentum *string

	// Enable nesterov when optimizer is 'sgd'.
	Nesterov *string

	// Number of training epochs. Must be a positive integer.
	NumberOfEpochs *string

	// Number of data loader workers. Must be a non-negative integer.
	NumberOfWorkers *string

	// Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.
	Optimizer *string

	// Random seed to be used when using deterministic training.
	RandomSeed *string

	// Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].
	StepLRGamma *string

	// Value of step size when learning rate scheduler is 'step'. Must be a positive integer.
	StepLRStepSize *string

	// Training batch size. Must be a positive integer.
	TrainingBatchSize *string

	// Image crop size that is input to the neural network for the training dataset. Must be a positive integer.
	TrainingCropSize *string

	// Validation batch size. Must be a positive integer.
	ValidationBatchSize *string

	// Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.
	ValidationCropSize *string

	// Image size to which to resize before cropping for validation dataset. Must be a positive integer.
	ValidationResizeSize *string

	// Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].
	WarmupCosineLRCycles *string

	// Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.
	WarmupCosineLRWarmupEpochs *string

	// Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].
	WeightDecay *string

	// Weighted loss. The accepted values are 0 for no weighted loss. 1 for weighted loss with sqrt.(classweights). 2 for weighted
	// loss with classweights. Must be 0 or 1 or 2.
	WeightedLoss *string
}

ImageModelDistributionSettingsClassification - Distribution expressions to sweep over values of model settings.Some examples are:ModelName = "choice('seresnext', 'resnest50')"; LearningRate = "uniform(0.001, 0.01)"; LayersToFreeze = "choice(0, 2)";For more details on how to compose distribution expressions please check the documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters For more information on the available settings please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

func (ImageModelDistributionSettingsClassification) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ImageModelDistributionSettingsClassification.

func (*ImageModelDistributionSettingsClassification) UnmarshalJSON

func (i *ImageModelDistributionSettingsClassification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageModelDistributionSettingsClassification.

type ImageModelDistributionSettingsObjectDetection

type ImageModelDistributionSettingsObjectDetection struct {
	// Enable AMSGrad when optimizer is 'adam' or 'adamw'.
	AmsGradient *string

	// Settings for using Augmentations.
	Augmentations *string

	// Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta1 *string

	// Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta2 *string

	// Maximum number of detections per image, for all classes. Must be a positive integer. Note: This settings is not supported
	// for the 'yolov5' algorithm.
	BoxDetectionsPerImage *string

	// During inference, only return proposals with a classification score greater than BoxScoreThreshold. Must be a float in
	// the range[0, 1].
	BoxScoreThreshold *string

	// Whether to use distributer training.
	Distributed *string

	// Enable early stopping logic during training.
	EarlyStopping *string

	// Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping.
	// Must be a positive integer.
	EarlyStoppingDelay *string

	// Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be
	// a positive integer.
	EarlyStoppingPatience *string

	// Enable normalization when exporting ONNX model.
	EnableOnnxNormalization *string

	// Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.
	EvaluationFrequency *string

	// Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights
	// while accumulating the gradients of those steps, and then using the
	// accumulated gradients to compute the weight updates. Must be a positive integer.
	GradientAccumulationStep *string

	// Image size for train and validation. Must be a positive integer. Note: The training run may get into CUDA OOM if the size
	// is too big. Note: This settings is only supported for the 'yolov5' algorithm.
	ImageSize *string

	// Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext'
	// means freezing layer0 and layer1. For a full list of models supported and details
	// on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	LayersToFreeze *string

	// Initial learning rate. Must be a float in the range [0, 1].
	LearningRate *string

	// Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.
	LearningRateScheduler *string

	// Maximum size of the image to be rescaled before feeding it to the backbone. Must be a positive integer. Note: training
	// run may get into CUDA OOM if the size is too big. Note: This settings is not
	// supported for the 'yolov5' algorithm.
	MaxSize *string

	// Minimum size of the image to be rescaled before feeding it to the backbone. Must be a positive integer. Note: training
	// run may get into CUDA OOM if the size is too big. Note: This settings is not
	// supported for the 'yolov5' algorithm.
	MinSize *string

	// Name of the model to use for training. For more information on the available models please visit the official documentation:
	// https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	ModelName *string

	// Model size. Must be 'small', 'medium', 'large', or 'xlarge'. Note: training run may get into CUDA OOM if the model size
	// is too big. Note: This settings is only supported for the 'yolov5' algorithm.
	ModelSize *string

	// Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].
	Momentum *string

	// Enable multi-scale image by varying image size by +/- 50%. Note: training run may get into CUDA OOM if no sufficient GPU
	// memory. Note: This settings is only supported for the 'yolov5' algorithm.
	MultiScale *string

	// Enable nesterov when optimizer is 'sgd'.
	Nesterov *string

	// IOU threshold used during inference in NMS post processing. Must be float in the range [0, 1].
	NmsIouThreshold *string

	// Number of training epochs. Must be a positive integer.
	NumberOfEpochs *string

	// Number of data loader workers. Must be a non-negative integer.
	NumberOfWorkers *string

	// Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'.
	Optimizer *string

	// Random seed to be used when using deterministic training.
	RandomSeed *string

	// Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].
	StepLRGamma *string

	// Value of step size when learning rate scheduler is 'step'. Must be a positive integer.
	StepLRStepSize *string

	// The grid size to use for tiling each image. Note: TileGridSize must not be None to enable small object detection logic.
	// A string containing two integers in mxn format. Note: This settings is not
	// supported for the 'yolov5' algorithm.
	TileGridSize *string

	// Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1). Note: This settings is not supported
	// for the 'yolov5' algorithm.
	TileOverlapRatio *string

	// The IOU threshold to use to perform NMS while merging predictions from tiles and image. Used in validation/ inference.
	// Must be float in the range [0, 1]. Note: This settings is not supported for the
	// 'yolov5' algorithm. NMS: Non-maximum suppression
	TilePredictionsNmsThreshold *string

	// Training batch size. Must be a positive integer.
	TrainingBatchSize *string

	// Validation batch size. Must be a positive integer.
	ValidationBatchSize *string

	// IOU threshold to use when computing validation metric. Must be float in the range [0, 1].
	ValidationIouThreshold *string

	// Metric computation method to use for validation metrics. Must be 'none', 'coco', 'voc', or 'coco_voc'.
	ValidationMetricType *string

	// Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].
	WarmupCosineLRCycles *string

	// Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.
	WarmupCosineLRWarmupEpochs *string

	// Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].
	WeightDecay *string
}

ImageModelDistributionSettingsObjectDetection - Distribution expressions to sweep over values of model settings.Some examples are:ModelName = "choice('seresnext', 'resnest50')"; LearningRate = "uniform(0.001, 0.01)"; LayersToFreeze = "choice(0, 2)";For more details on how to compose distribution expressions please check the documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters For more information on the available settings please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

func (ImageModelDistributionSettingsObjectDetection) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ImageModelDistributionSettingsObjectDetection.

func (*ImageModelDistributionSettingsObjectDetection) UnmarshalJSON

func (i *ImageModelDistributionSettingsObjectDetection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageModelDistributionSettingsObjectDetection.

type ImageModelSettings

type ImageModelSettings struct {
	// Settings for advanced scenarios.
	AdvancedSettings *string

	// Enable AMSGrad when optimizer is 'adam' or 'adamw'.
	AmsGradient *bool

	// Settings for using Augmentations.
	Augmentations *string

	// Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta1 *float32

	// Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta2 *float32

	// Frequency to store model checkpoints. Must be a positive integer.
	CheckpointFrequency *int32

	// The pretrained checkpoint model for incremental training.
	CheckpointModel *MLFlowModelJobInput

	// The id of a previous run that has a pretrained checkpoint for incremental training.
	CheckpointRunID *string

	// Whether to use distributed training.
	Distributed *bool

	// Enable early stopping logic during training.
	EarlyStopping *bool

	// Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping.
	// Must be a positive integer.
	EarlyStoppingDelay *int32

	// Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be
	// a positive integer.
	EarlyStoppingPatience *int32

	// Enable normalization when exporting ONNX model.
	EnableOnnxNormalization *bool

	// Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.
	EvaluationFrequency *int32

	// Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights
	// while accumulating the gradients of those steps, and then using the
	// accumulated gradients to compute the weight updates. Must be a positive integer.
	GradientAccumulationStep *int32

	// Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext'
	// means freezing layer0 and layer1. For a full list of models supported and details
	// on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	LayersToFreeze *int32

	// Initial learning rate. Must be a float in the range [0, 1].
	LearningRate *float32

	// Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.
	LearningRateScheduler *LearningRateScheduler

	// Name of the model to use for training. For more information on the available models please visit the official documentation:
	// https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	ModelName *string

	// Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].
	Momentum *float32

	// Enable nesterov when optimizer is 'sgd'.
	Nesterov *bool

	// Number of training epochs. Must be a positive integer.
	NumberOfEpochs *int32

	// Number of data loader workers. Must be a non-negative integer.
	NumberOfWorkers *int32

	// Type of optimizer.
	Optimizer *StochasticOptimizer

	// Random seed to be used when using deterministic training.
	RandomSeed *int32

	// Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].
	StepLRGamma *float32

	// Value of step size when learning rate scheduler is 'step'. Must be a positive integer.
	StepLRStepSize *int32

	// Training batch size. Must be a positive integer.
	TrainingBatchSize *int32

	// Validation batch size. Must be a positive integer.
	ValidationBatchSize *int32

	// Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].
	WarmupCosineLRCycles *float32

	// Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.
	WarmupCosineLRWarmupEpochs *int32

	// Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].
	WeightDecay *float32
}

ImageModelSettings - Settings used for training the model. For more information on the available settings please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

func (ImageModelSettings) MarshalJSON

func (i ImageModelSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageModelSettings.

func (*ImageModelSettings) UnmarshalJSON

func (i *ImageModelSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageModelSettings.

type ImageModelSettingsClassification

type ImageModelSettingsClassification struct {
	// Settings for advanced scenarios.
	AdvancedSettings *string

	// Enable AMSGrad when optimizer is 'adam' or 'adamw'.
	AmsGradient *bool

	// Settings for using Augmentations.
	Augmentations *string

	// Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta1 *float32

	// Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta2 *float32

	// Frequency to store model checkpoints. Must be a positive integer.
	CheckpointFrequency *int32

	// The pretrained checkpoint model for incremental training.
	CheckpointModel *MLFlowModelJobInput

	// The id of a previous run that has a pretrained checkpoint for incremental training.
	CheckpointRunID *string

	// Whether to use distributed training.
	Distributed *bool

	// Enable early stopping logic during training.
	EarlyStopping *bool

	// Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping.
	// Must be a positive integer.
	EarlyStoppingDelay *int32

	// Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be
	// a positive integer.
	EarlyStoppingPatience *int32

	// Enable normalization when exporting ONNX model.
	EnableOnnxNormalization *bool

	// Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.
	EvaluationFrequency *int32

	// Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights
	// while accumulating the gradients of those steps, and then using the
	// accumulated gradients to compute the weight updates. Must be a positive integer.
	GradientAccumulationStep *int32

	// Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext'
	// means freezing layer0 and layer1. For a full list of models supported and details
	// on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	LayersToFreeze *int32

	// Initial learning rate. Must be a float in the range [0, 1].
	LearningRate *float32

	// Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.
	LearningRateScheduler *LearningRateScheduler

	// Name of the model to use for training. For more information on the available models please visit the official documentation:
	// https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	ModelName *string

	// Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].
	Momentum *float32

	// Enable nesterov when optimizer is 'sgd'.
	Nesterov *bool

	// Number of training epochs. Must be a positive integer.
	NumberOfEpochs *int32

	// Number of data loader workers. Must be a non-negative integer.
	NumberOfWorkers *int32

	// Type of optimizer.
	Optimizer *StochasticOptimizer

	// Random seed to be used when using deterministic training.
	RandomSeed *int32

	// Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].
	StepLRGamma *float32

	// Value of step size when learning rate scheduler is 'step'. Must be a positive integer.
	StepLRStepSize *int32

	// Training batch size. Must be a positive integer.
	TrainingBatchSize *int32

	// Image crop size that is input to the neural network for the training dataset. Must be a positive integer.
	TrainingCropSize *int32

	// Validation batch size. Must be a positive integer.
	ValidationBatchSize *int32

	// Image crop size that is input to the neural network for the validation dataset. Must be a positive integer.
	ValidationCropSize *int32

	// Image size to which to resize before cropping for validation dataset. Must be a positive integer.
	ValidationResizeSize *int32

	// Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].
	WarmupCosineLRCycles *float32

	// Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.
	WarmupCosineLRWarmupEpochs *int32

	// Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].
	WeightDecay *float32

	// Weighted loss. The accepted values are 0 for no weighted loss. 1 for weighted loss with sqrt.(classweights). 2 for weighted
	// loss with classweights. Must be 0 or 1 or 2.
	WeightedLoss *int32
}

ImageModelSettingsClassification - Settings used for training the model. For more information on the available settings please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

func (ImageModelSettingsClassification) MarshalJSON

func (i ImageModelSettingsClassification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageModelSettingsClassification.

func (*ImageModelSettingsClassification) UnmarshalJSON

func (i *ImageModelSettingsClassification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageModelSettingsClassification.

type ImageModelSettingsObjectDetection

type ImageModelSettingsObjectDetection struct {
	// Settings for advanced scenarios.
	AdvancedSettings *string

	// Enable AMSGrad when optimizer is 'adam' or 'adamw'.
	AmsGradient *bool

	// Settings for using Augmentations.
	Augmentations *string

	// Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta1 *float32

	// Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1].
	Beta2 *float32

	// Maximum number of detections per image, for all classes. Must be a positive integer. Note: This settings is not supported
	// for the 'yolov5' algorithm.
	BoxDetectionsPerImage *int32

	// During inference, only return proposals with a classification score greater than BoxScoreThreshold. Must be a float in
	// the range[0, 1].
	BoxScoreThreshold *float32

	// Frequency to store model checkpoints. Must be a positive integer.
	CheckpointFrequency *int32

	// The pretrained checkpoint model for incremental training.
	CheckpointModel *MLFlowModelJobInput

	// The id of a previous run that has a pretrained checkpoint for incremental training.
	CheckpointRunID *string

	// Whether to use distributed training.
	Distributed *bool

	// Enable early stopping logic during training.
	EarlyStopping *bool

	// Minimum number of epochs or validation evaluations to wait before primary metric improvement is tracked for early stopping.
	// Must be a positive integer.
	EarlyStoppingDelay *int32

	// Minimum number of epochs or validation evaluations with no primary metric improvement before the run is stopped. Must be
	// a positive integer.
	EarlyStoppingPatience *int32

	// Enable normalization when exporting ONNX model.
	EnableOnnxNormalization *bool

	// Frequency to evaluate validation dataset to get metric scores. Must be a positive integer.
	EvaluationFrequency *int32

	// Gradient accumulation means running a configured number of "GradAccumulationStep" steps without updating the model weights
	// while accumulating the gradients of those steps, and then using the
	// accumulated gradients to compute the weight updates. Must be a positive integer.
	GradientAccumulationStep *int32

	// Image size for train and validation. Must be a positive integer. Note: The training run may get into CUDA OOM if the size
	// is too big. Note: This settings is only supported for the 'yolov5' algorithm.
	ImageSize *int32

	// Number of layers to freeze for the model. Must be a positive integer. For instance, passing 2 as value for 'seresnext'
	// means freezing layer0 and layer1. For a full list of models supported and details
	// on layer freeze, please see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	LayersToFreeze *int32

	// Initial learning rate. Must be a float in the range [0, 1].
	LearningRate *float32

	// Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'.
	LearningRateScheduler *LearningRateScheduler

	// Maximum size of the image to be rescaled before feeding it to the backbone. Must be a positive integer. Note: training
	// run may get into CUDA OOM if the size is too big. Note: This settings is not
	// supported for the 'yolov5' algorithm.
	MaxSize *int32

	// Minimum size of the image to be rescaled before feeding it to the backbone. Must be a positive integer. Note: training
	// run may get into CUDA OOM if the size is too big. Note: This settings is not
	// supported for the 'yolov5' algorithm.
	MinSize *int32

	// Name of the model to use for training. For more information on the available models please visit the official documentation:
	// https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.
	ModelName *string

	// Model size. Must be 'small', 'medium', 'large', or 'xlarge'. Note: training run may get into CUDA OOM if the model size
	// is too big. Note: This settings is only supported for the 'yolov5' algorithm.
	ModelSize *ModelSize

	// Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1].
	Momentum *float32

	// Enable multi-scale image by varying image size by +/- 50%. Note: training run may get into CUDA OOM if no sufficient GPU
	// memory. Note: This settings is only supported for the 'yolov5' algorithm.
	MultiScale *bool

	// Enable nesterov when optimizer is 'sgd'.
	Nesterov *bool

	// IOU threshold used during inference in NMS post processing. Must be a float in the range [0, 1].
	NmsIouThreshold *float32

	// Number of training epochs. Must be a positive integer.
	NumberOfEpochs *int32

	// Number of data loader workers. Must be a non-negative integer.
	NumberOfWorkers *int32

	// Type of optimizer.
	Optimizer *StochasticOptimizer

	// Random seed to be used when using deterministic training.
	RandomSeed *int32

	// Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1].
	StepLRGamma *float32

	// Value of step size when learning rate scheduler is 'step'. Must be a positive integer.
	StepLRStepSize *int32

	// The grid size to use for tiling each image. Note: TileGridSize must not be None to enable small object detection logic.
	// A string containing two integers in mxn format. Note: This settings is not
	// supported for the 'yolov5' algorithm.
	TileGridSize *string

	// Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1). Note: This settings is not supported
	// for the 'yolov5' algorithm.
	TileOverlapRatio *float32

	// The IOU threshold to use to perform NMS while merging predictions from tiles and image. Used in validation/ inference.
	// Must be float in the range [0, 1]. Note: This settings is not supported for the
	// 'yolov5' algorithm.
	TilePredictionsNmsThreshold *float32

	// Training batch size. Must be a positive integer.
	TrainingBatchSize *int32

	// Validation batch size. Must be a positive integer.
	ValidationBatchSize *int32

	// IOU threshold to use when computing validation metric. Must be float in the range [0, 1].
	ValidationIouThreshold *float32

	// Metric computation method to use for validation metrics.
	ValidationMetricType *ValidationMetricType

	// Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1].
	WarmupCosineLRCycles *float32

	// Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer.
	WarmupCosineLRWarmupEpochs *int32

	// Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1].
	WeightDecay *float32
}

ImageModelSettingsObjectDetection - Settings used for training the model. For more information on the available settings please visit the official documentation: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.

func (ImageModelSettingsObjectDetection) MarshalJSON

func (i ImageModelSettingsObjectDetection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageModelSettingsObjectDetection.

func (*ImageModelSettingsObjectDetection) UnmarshalJSON

func (i *ImageModelSettingsObjectDetection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageModelSettingsObjectDetection.

type ImageObjectDetection

type ImageObjectDetection struct {
	// REQUIRED; [Required] Limit settings for the AutoML job.
	LimitSettings *ImageLimitSettings

	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Settings used for training the model.
	ModelSettings *ImageModelSettingsObjectDetection

	// Primary metric to optimize for this task.
	PrimaryMetric *ObjectDetectionPrimaryMetrics

	// Search space for sampling different combinations of models and their hyperparameters.
	SearchSpace []*ImageModelDistributionSettingsObjectDetection

	// Model sweeping and hyperparameter sweeping related settings.
	SweepSettings *ImageSweepSettings

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64
}

ImageObjectDetection - Image Object Detection. Object detection is used to identify objects in an image and locate each object with a bounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.

func (*ImageObjectDetection) GetAutoMLVertical

func (i *ImageObjectDetection) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type ImageObjectDetection.

func (ImageObjectDetection) MarshalJSON

func (i ImageObjectDetection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageObjectDetection.

func (*ImageObjectDetection) UnmarshalJSON

func (i *ImageObjectDetection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageObjectDetection.

type ImageObjectDetectionBase

type ImageObjectDetectionBase struct {
	// REQUIRED; [Required] Limit settings for the AutoML job.
	LimitSettings *ImageLimitSettings

	// Settings used for training the model.
	ModelSettings *ImageModelSettingsObjectDetection

	// Search space for sampling different combinations of models and their hyperparameters.
	SearchSpace []*ImageModelDistributionSettingsObjectDetection

	// Model sweeping and hyperparameter sweeping related settings.
	SweepSettings *ImageSweepSettings

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64
}

func (ImageObjectDetectionBase) MarshalJSON

func (i ImageObjectDetectionBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageObjectDetectionBase.

func (*ImageObjectDetectionBase) UnmarshalJSON

func (i *ImageObjectDetectionBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageObjectDetectionBase.

type ImageSweepSettings

type ImageSweepSettings struct {
	// REQUIRED; [Required] Type of the hyperparameter sampling algorithms.
	SamplingAlgorithm *SamplingAlgorithmType

	// Type of early termination policy.
	EarlyTermination EarlyTerminationPolicyClassification
}

ImageSweepSettings - Model sweeping and hyperparameter sweeping related settings.

func (ImageSweepSettings) MarshalJSON

func (i ImageSweepSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageSweepSettings.

func (*ImageSweepSettings) UnmarshalJSON

func (i *ImageSweepSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageSweepSettings.

type ImageVertical

type ImageVertical struct {
	// REQUIRED; [Required] Limit settings for the AutoML job.
	LimitSettings *ImageLimitSettings

	// Model sweeping and hyperparameter sweeping related settings.
	SweepSettings *ImageSweepSettings

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64
}

ImageVertical - Abstract class for AutoML tasks that train image (computer vision) models - such as Image Classification / Image Classification Multilabel / Image Object Detection / Image Instance Segmentation.

func (ImageVertical) MarshalJSON

func (i ImageVertical) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageVertical.

func (*ImageVertical) UnmarshalJSON

func (i *ImageVertical) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageVertical.

type InferenceContainerProperties

type InferenceContainerProperties struct {
	// The route to check the liveness of the inference server container.
	LivenessRoute *Route

	// The route to check the readiness of the inference server container.
	ReadinessRoute *Route

	// The port to send the scoring requests to, within the inference server container.
	ScoringRoute *Route
}

func (InferenceContainerProperties) MarshalJSON

func (i InferenceContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InferenceContainerProperties.

func (*InferenceContainerProperties) UnmarshalJSON

func (i *InferenceContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InferenceContainerProperties.

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 InstanceSegmentationPrimaryMetrics

type InstanceSegmentationPrimaryMetrics string

InstanceSegmentationPrimaryMetrics - Primary metrics for InstanceSegmentation tasks.

const (
	// InstanceSegmentationPrimaryMetricsMeanAveragePrecision - Mean Average Precision (MAP) is the average of AP (Average Precision).
	// AP is calculated for each class and averaged to get the MAP.
	InstanceSegmentationPrimaryMetricsMeanAveragePrecision InstanceSegmentationPrimaryMetrics = "MeanAveragePrecision"
)

func PossibleInstanceSegmentationPrimaryMetricsValues

func PossibleInstanceSegmentationPrimaryMetricsValues() []InstanceSegmentationPrimaryMetrics

PossibleInstanceSegmentationPrimaryMetricsValues returns the possible values for the InstanceSegmentationPrimaryMetrics const type.

type InstanceTypeSchema

type InstanceTypeSchema struct {
	// Node Selector
	NodeSelector map[string]*string

	// Resource requests/limits for this instance type
	Resources *InstanceTypeSchemaResources
}

InstanceTypeSchema - Instance type schema.

func (InstanceTypeSchema) MarshalJSON

func (i InstanceTypeSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InstanceTypeSchema.

func (*InstanceTypeSchema) UnmarshalJSON

func (i *InstanceTypeSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InstanceTypeSchema.

type InstanceTypeSchemaResources

type InstanceTypeSchemaResources struct {
	// Resource limits for this instance type
	Limits map[string]*string

	// Resource requests for this instance type
	Requests map[string]*string
}

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.

func (*InstanceTypeSchemaResources) UnmarshalJSON

func (i *InstanceTypeSchemaResources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InstanceTypeSchemaResources.

type JobBase

type JobBase struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties JobBasePropertiesClassification

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

	// ARM resource ID of the component resource.
	ComponentID *string

	// ARM resource ID of the compute resource.
	ComputeID *string

	// The asset description text.
	Description *string

	// Display name of job.
	DisplayName *string

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

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

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

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Status of the job.
	Status *JobStatus
}

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: - *AutoMLJob, *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

	// An array of objects of type JobBase.
	Value []*JobBase
}

JobBaseResourceArmPaginatedResult - A paginated list of JobBase entities.

func (JobBaseResourceArmPaginatedResult) MarshalJSON

func (j JobBaseResourceArmPaginatedResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobBaseResourceArmPaginatedResult.

func (*JobBaseResourceArmPaginatedResult) UnmarshalJSON

func (j *JobBaseResourceArmPaginatedResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobBaseResourceArmPaginatedResult.

type JobInput

type JobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType

	// Description for the input.
	Description *string
}

JobInput - Command job definition.

func (*JobInput) GetJobInput

func (j *JobInput) GetJobInput() *JobInput

GetJobInput implements the JobInputClassification interface for type JobInput.

func (JobInput) MarshalJSON

func (j JobInput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobInput.

func (*JobInput) UnmarshalJSON

func (j *JobInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// 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
}

func (*JobLimits) GetJobLimits

func (j *JobLimits) GetJobLimits() *JobLimits

GetJobLimits implements the JobLimitsClassification interface for type JobLimits.

func (JobLimits) MarshalJSON

func (j JobLimits) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobLimits.

func (*JobLimits) UnmarshalJSON

func (j *JobLimits) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// Description for the output.
	Description *string
}

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.

func (JobOutput) MarshalJSON

func (j JobOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobOutput.

func (*JobOutput) UnmarshalJSON

func (j *JobOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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 JobResourceConfiguration

type JobResourceConfiguration struct {
	// Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the
	// system, or in this section. This parameter is only supported for Azure ML
	// compute types.
	DockerArgs *string

	// Optional number of instances or nodes used by the compute target.
	InstanceCount *int32

	// Optional type of VM used as supported by the compute target.
	InstanceType *string

	// Additional properties bag.
	Properties map[string]any

	// Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be
	// greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes),
	// or g(gigabytes).
	ShmSize *string
}

func (JobResourceConfiguration) MarshalJSON

func (j JobResourceConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobResourceConfiguration.

func (*JobResourceConfiguration) UnmarshalJSON

func (j *JobResourceConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobResourceConfiguration.

type JobScheduleAction

type JobScheduleAction struct {
	// REQUIRED; [Required] Specifies the action type of the schedule
	ActionType *ScheduleActionType

	// REQUIRED; [Required] Defines Schedule action definition details.
	JobDefinition JobBasePropertiesClassification
}

func (*JobScheduleAction) GetScheduleActionBase

func (j *JobScheduleAction) GetScheduleActionBase() *ScheduleActionBase

GetScheduleActionBase implements the ScheduleActionBaseClassification interface for type JobScheduleAction.

func (JobScheduleAction) MarshalJSON

func (j JobScheduleAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobScheduleAction.

func (*JobScheduleAction) UnmarshalJSON

func (j *JobScheduleAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobScheduleAction.

type JobService

type JobService struct {
	// Url for endpoint.
	Endpoint *string

	// Endpoint type.
	JobServiceType *string

	// Port for endpoint.
	Port *int32

	// Additional properties to set on the endpoint.
	Properties map[string]*string

	// READ-ONLY; Any error in the service.
	ErrorMessage *string

	// READ-ONLY; Status of endpoint.
	Status *string
}

JobService - Job endpoint definition

func (JobService) MarshalJSON

func (j JobService) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type JobService.

func (*JobService) UnmarshalJSON

func (j *JobService) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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 (
	JobTypeAutoML   JobType = "AutoML"
	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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewJobsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewJobsClient().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-10-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 (CreateOrUpdateAutoMlJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/AutoMLJob/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().CreateOrUpdate(ctx, "test-rg", "my-aml-workspace", "string", armmachinelearning.JobBase{
	Properties: &armmachinelearning.AutoMLJob{
		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),
		},
		IsArchived: to.Ptr(false),
		JobType:    to.Ptr(armmachinelearning.JobTypeAutoML),
		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"),
				},
			},
		},
		EnvironmentID: to.Ptr("string"),
		EnvironmentVariables: map[string]*string{
			"string": to.Ptr("string"),
		},
		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.JobResourceConfiguration{
			InstanceCount: to.Ptr[int32](1),
			InstanceType:  to.Ptr("string"),
			Properties: map[string]any{
				"string": map[string]any{
					"9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": nil,
				},
			},
		},
		TaskDetails: &armmachinelearning.ImageClassification{
			TargetColumnName: to.Ptr("string"),
			TaskType:         to.Ptr(armmachinelearning.TaskTypeImageClassification),
			TrainingData: &armmachinelearning.MLTableJobInput{
				URI:          to.Ptr("string"),
				JobInputType: to.Ptr(armmachinelearning.JobInputTypeMltable),
			},
			LimitSettings: &armmachinelearning.ImageLimitSettings{
				MaxTrials: to.Ptr[int32](2),
			},
			ModelSettings: &armmachinelearning.ImageModelSettingsClassification{
				ValidationCropSize: to.Ptr[int32](2),
			},
			SearchSpace: []*armmachinelearning.ImageModelDistributionSettingsClassification{
				{
					ValidationCropSize: to.Ptr("choice(2, 360)"),
				}},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeManagedIdentity),
// 	},
// 	Properties: &armmachinelearning.AutoMLJob{
// 		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),
// 		},
// 		IsArchived: to.Ptr(false),
// 		JobType: to.Ptr(armmachinelearning.JobTypeAutoML),
// 		Services: map[string]*armmachinelearning.JobService{
// 			"string": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatus("Scheduled")),
// 		EnvironmentID: to.Ptr("string"),
// 		EnvironmentVariables: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		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.JobResourceConfiguration{
// 			InstanceCount: to.Ptr[int32](1),
// 			InstanceType: to.Ptr("string"),
// 			Properties: map[string]any{
// 				"string": map[string]any{
// 					"9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": nil,
// 				},
// 			},
// 		},
// 		TaskDetails: &armmachinelearning.ImageClassification{
// 			TargetColumnName: to.Ptr("string"),
// 			TaskType: to.Ptr(armmachinelearning.TaskTypeImageClassification),
// 			TrainingData: &armmachinelearning.MLTableJobInput{
// 				URI: to.Ptr("string"),
// 				JobInputType: to.Ptr(armmachinelearning.JobInputTypeMltable),
// 			},
// 			LimitSettings: &armmachinelearning.ImageLimitSettings{
// 				MaxTrials: to.Ptr[int32](2),
// 			},
// 			ModelSettings: &armmachinelearning.ImageModelSettingsClassification{
// 				ValidationCropSize: to.Ptr[int32](2),
// 			},
// 			SearchSpace: []*armmachinelearning.ImageModelDistributionSettingsClassification{
// 				{
// 					ValidationCropSize: to.Ptr("choice(2, 360)"),
// 			}},
// 		},
// 	},
// }
Output:

Example (CreateOrUpdateCommandJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().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.JobResourceConfiguration{
			InstanceCount: to.Ptr[int32](1),
			InstanceType:  to.Ptr("string"),
			Properties: map[string]any{
				"string": map[string]any{
					"e6b6493e-7d5e-4db3-be1e-306ec641327e": nil,
				},
			},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
// 		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),
// 			},
// 		},
// 		Parameters: map[string]any{
// 			"string": "string",
// 		},
// 		Resources: &armmachinelearning.JobResourceConfiguration{
// 			InstanceCount: to.Ptr[int32](1),
// 			InstanceType: to.Ptr("string"),
// 			Properties: map[string]any{
// 				"string": map[string]any{
// 					"a0847709-f5aa-4561-8ba5-d915d403fdcf": nil,
// 				},
// 			},
// 		},
// 	},
// }
Output:

Example (CreateOrUpdatePipelineJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/PipelineJob/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().CreateOrUpdate(ctx, "test-rg", "my-aml-workspace", "string", armmachinelearning.JobBase{
	Properties: &armmachinelearning.PipelineJob{
		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"),
		JobType:        to.Ptr(armmachinelearning.JobTypePipeline),
		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"),
				},
			},
		},
		Inputs: map[string]armmachinelearning.JobInputClassification{
			"string": &armmachinelearning.LiteralJobInput{
				Description:  to.Ptr("string"),
				JobInputType: to.Ptr(armmachinelearning.JobInputTypeLiteral),
				Value:        to.Ptr("string"),
			},
		},
		Outputs: map[string]armmachinelearning.JobOutputClassification{
			"string": &armmachinelearning.URIFileJobOutput{
				Mode:          to.Ptr(armmachinelearning.OutputDeliveryModeUpload),
				URI:           to.Ptr("string"),
				Description:   to.Ptr("string"),
				JobOutputType: to.Ptr(armmachinelearning.JobOutputTypeURIFile),
			},
		},
		Settings: map[string]any{},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.PipelineJob{
// 		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"),
// 		JobType: to.Ptr(armmachinelearning.JobTypePipeline),
// 		Services: map[string]*armmachinelearning.JobService{
// 			"string": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
// 		Inputs: map[string]armmachinelearning.JobInputClassification{
// 			"string": &armmachinelearning.LiteralJobInput{
// 				Description: to.Ptr("string"),
// 				JobInputType: to.Ptr(armmachinelearning.JobInputTypeLiteral),
// 				Value: to.Ptr("string"),
// 			},
// 		},
// 		Outputs: map[string]armmachinelearning.JobOutputClassification{
// 			"string": &armmachinelearning.URIFileJobOutput{
// 				Mode: to.Ptr(armmachinelearning.OutputDeliveryModeUpload),
// 				URI: to.Ptr("string"),
// 				Description: to.Ptr("string"),
// 				JobOutputType: to.Ptr(armmachinelearning.JobOutputTypeURIFile),
// 			},
// 		},
// 		Settings: map[string]any{
// 		},
// 	},
// }
Output:

Example (CreateOrUpdateSweepJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/SweepJob/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().CreateOrUpdate(ctx, "test-rg", "my-aml-workspace", "string", armmachinelearning.JobBase{
	Properties: &armmachinelearning.SweepJob{
		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"),
		JobType:        to.Ptr(armmachinelearning.JobTypeSweep),
		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"),
				},
			},
		},
		EarlyTermination: &armmachinelearning.MedianStoppingPolicy{
			DelayEvaluation:    to.Ptr[int32](1),
			EvaluationInterval: to.Ptr[int32](1),
			PolicyType:         to.Ptr(armmachinelearning.EarlyTerminationPolicyTypeMedianStopping),
		},
		Limits: &armmachinelearning.SweepJobLimits{
			JobLimitsType:       to.Ptr(armmachinelearning.JobLimitsTypeSweep),
			MaxConcurrentTrials: to.Ptr[int32](1),
			MaxTotalTrials:      to.Ptr[int32](1),
			TrialTimeout:        to.Ptr("PT1S"),
		},
		Objective: &armmachinelearning.Objective{
			Goal:          to.Ptr(armmachinelearning.GoalMinimize),
			PrimaryMetric: to.Ptr("string"),
		},
		SamplingAlgorithm: &armmachinelearning.GridSamplingAlgorithm{
			SamplingAlgorithmType: to.Ptr(armmachinelearning.SamplingAlgorithmTypeGrid),
		},
		SearchSpace: map[string]any{
			"string": map[string]any{},
		},
		Trial: &armmachinelearning.TrialComponent{
			CodeID:  to.Ptr("string"),
			Command: to.Ptr("string"),
			Distribution: &armmachinelearning.Mpi{
				DistributionType:        to.Ptr(armmachinelearning.DistributionTypeMpi),
				ProcessCountPerInstance: to.Ptr[int32](1),
			},
			EnvironmentID: to.Ptr("string"),
			EnvironmentVariables: map[string]*string{
				"string": to.Ptr("string"),
			},
			Resources: &armmachinelearning.JobResourceConfiguration{
				InstanceCount: to.Ptr[int32](1),
				InstanceType:  to.Ptr("string"),
				Properties: map[string]any{
					"string": map[string]any{
						"e6b6493e-7d5e-4db3-be1e-306ec641327e": nil,
					},
				},
			},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.SweepJob{
// 		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"),
// 		JobType: to.Ptr(armmachinelearning.JobTypeSweep),
// 		Services: map[string]*armmachinelearning.JobService{
// 			"string": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
// 		EarlyTermination: &armmachinelearning.MedianStoppingPolicy{
// 			DelayEvaluation: to.Ptr[int32](1),
// 			EvaluationInterval: to.Ptr[int32](1),
// 			PolicyType: to.Ptr(armmachinelearning.EarlyTerminationPolicyTypeMedianStopping),
// 		},
// 		Limits: &armmachinelearning.SweepJobLimits{
// 			JobLimitsType: to.Ptr(armmachinelearning.JobLimitsTypeSweep),
// 			MaxConcurrentTrials: to.Ptr[int32](1),
// 			MaxTotalTrials: to.Ptr[int32](1),
// 			TrialTimeout: to.Ptr("PT1S"),
// 		},
// 		Objective: &armmachinelearning.Objective{
// 			Goal: to.Ptr(armmachinelearning.GoalMinimize),
// 			PrimaryMetric: to.Ptr("string"),
// 		},
// 		SamplingAlgorithm: &armmachinelearning.GridSamplingAlgorithm{
// 			SamplingAlgorithmType: to.Ptr(armmachinelearning.SamplingAlgorithmTypeGrid),
// 		},
// 		SearchSpace: map[string]any{
// 			"string":map[string]any{
// 			},
// 		},
// 		Trial: &armmachinelearning.TrialComponent{
// 			CodeID: to.Ptr("string"),
// 			Command: to.Ptr("string"),
// 			Distribution: &armmachinelearning.Mpi{
// 				DistributionType: to.Ptr(armmachinelearning.DistributionTypeMpi),
// 				ProcessCountPerInstance: to.Ptr[int32](1),
// 			},
// 			EnvironmentID: to.Ptr("string"),
// 			EnvironmentVariables: map[string]*string{
// 				"string": to.Ptr("string"),
// 			},
// 			Resources: &armmachinelearning.JobResourceConfiguration{
// 				InstanceCount: to.Ptr[int32](1),
// 				InstanceType: to.Ptr("string"),
// 				Properties: map[string]any{
// 					"string": map[string]any{
// 						"e6b6493e-7d5e-4db3-be1e-306ec641327e": nil,
// 					},
// 				},
// 			},
// 		},
// 	},
// }
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-10-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 (GetAutoMlJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/AutoMLJob/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeManagedIdentity),
// 	},
// 	Properties: &armmachinelearning.AutoMLJob{
// 		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),
// 		},
// 		IsArchived: to.Ptr(false),
// 		JobType: to.Ptr(armmachinelearning.JobTypeAutoML),
// 		Services: map[string]*armmachinelearning.JobService{
// 			"string": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatus("Scheduled")),
// 		EnvironmentID: to.Ptr("string"),
// 		EnvironmentVariables: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		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.JobResourceConfiguration{
// 			InstanceCount: to.Ptr[int32](1),
// 			InstanceType: to.Ptr("string"),
// 			Properties: map[string]any{
// 				"string": map[string]any{
// 					"9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": nil,
// 				},
// 			},
// 		},
// 		TaskDetails: &armmachinelearning.ImageClassification{
// 			TargetColumnName: to.Ptr("string"),
// 			TaskType: to.Ptr(armmachinelearning.TaskTypeImageClassification),
// 			TrainingData: &armmachinelearning.MLTableJobInput{
// 				URI: to.Ptr("string"),
// 				JobInputType: to.Ptr(armmachinelearning.JobInputTypeMltable),
// 			},
// 			LimitSettings: &armmachinelearning.ImageLimitSettings{
// 				MaxTrials: to.Ptr[int32](2),
// 			},
// 			ModelSettings: &armmachinelearning.ImageModelSettingsClassification{
// 				ValidationCropSize: to.Ptr[int32](2),
// 			},
// 			SearchSpace: []*armmachinelearning.ImageModelDistributionSettingsClassification{
// 				{
// 					ValidationCropSize: to.Ptr("choice(2, 360)"),
// 			}},
// 		},
// 	},
// }
Output:

Example (GetCommandJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
// 		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),
// 			},
// 		},
// 		Parameters: map[string]any{
// 			"string": "string",
// 		},
// 		Resources: &armmachinelearning.JobResourceConfiguration{
// 			InstanceCount: to.Ptr[int32](1),
// 			InstanceType: to.Ptr("string"),
// 			Properties: map[string]any{
// 				"string": map[string]any{
// 					"8385cf05-78c0-41ef-b31d-36796a678e19": nil,
// 				},
// 			},
// 		},
// 	},
// }
Output:

Example (GetPipelineJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/PipelineJob/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.PipelineJob{
// 		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"),
// 		JobType: to.Ptr(armmachinelearning.JobTypePipeline),
// 		Services: map[string]*armmachinelearning.JobService{
// 			"string": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
// 		Inputs: map[string]armmachinelearning.JobInputClassification{
// 			"string": &armmachinelearning.LiteralJobInput{
// 				Description: to.Ptr("string"),
// 				JobInputType: to.Ptr(armmachinelearning.JobInputTypeLiteral),
// 				Value: to.Ptr("string"),
// 			},
// 		},
// 		Outputs: map[string]armmachinelearning.JobOutputClassification{
// 			"string": &armmachinelearning.URIFileJobOutput{
// 				Mode: to.Ptr(armmachinelearning.OutputDeliveryModeUpload),
// 				URI: to.Ptr("string"),
// 				Description: to.Ptr("string"),
// 				JobOutputType: to.Ptr(armmachinelearning.JobOutputTypeURIFile),
// 			},
// 		},
// 		Settings: map[string]any{
// 		},
// 	},
// }
Output:

Example (GetSweepJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/SweepJob/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewJobsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.JobBase = armmachinelearning.JobBase{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.SweepJob{
// 		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"),
// 		JobType: to.Ptr(armmachinelearning.JobTypeSweep),
// 		Services: map[string]*armmachinelearning.JobService{
// 			"string": &armmachinelearning.JobService{
// 				Endpoint: to.Ptr("string"),
// 				ErrorMessage: to.Ptr("string"),
// 				JobServiceType: to.Ptr("string"),
// 				Port: to.Ptr[int32](1),
// 				Properties: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 				Status: to.Ptr("string"),
// 			},
// 		},
// 		Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
// 		EarlyTermination: &armmachinelearning.MedianStoppingPolicy{
// 			DelayEvaluation: to.Ptr[int32](1),
// 			EvaluationInterval: to.Ptr[int32](1),
// 			PolicyType: to.Ptr(armmachinelearning.EarlyTerminationPolicyTypeMedianStopping),
// 		},
// 		Limits: &armmachinelearning.SweepJobLimits{
// 			JobLimitsType: to.Ptr(armmachinelearning.JobLimitsTypeSweep),
// 			MaxConcurrentTrials: to.Ptr[int32](1),
// 			MaxTotalTrials: to.Ptr[int32](1),
// 			TrialTimeout: to.Ptr("PT1S"),
// 		},
// 		Objective: &armmachinelearning.Objective{
// 			Goal: to.Ptr(armmachinelearning.GoalMinimize),
// 			PrimaryMetric: to.Ptr("string"),
// 		},
// 		SamplingAlgorithm: &armmachinelearning.GridSamplingAlgorithm{
// 			SamplingAlgorithmType: to.Ptr(armmachinelearning.SamplingAlgorithmTypeGrid),
// 		},
// 		SearchSpace: map[string]any{
// 			"string":map[string]any{
// 			},
// 		},
// 		Trial: &armmachinelearning.TrialComponent{
// 			CodeID: to.Ptr("string"),
// 			Command: to.Ptr("string"),
// 			Distribution: &armmachinelearning.Mpi{
// 				DistributionType: to.Ptr(armmachinelearning.DistributionTypeMpi),
// 				ProcessCountPerInstance: to.Ptr[int32](1),
// 			},
// 			EnvironmentID: to.Ptr("string"),
// 			EnvironmentVariables: map[string]*string{
// 				"string": to.Ptr("string"),
// 			},
// 			Resources: &armmachinelearning.JobResourceConfiguration{
// 				InstanceCount: to.Ptr[int32](1),
// 				InstanceType: to.Ptr("string"),
// 				Properties: map[string]any{
// 					"string": map[string]any{
// 						"e6b6493e-7d5e-4db3-be1e-306ec641327e": nil,
// 					},
// 				},
// 			},
// 		},
// 	},
// }
Output:

func (*JobsClient) NewListPager

func (client *JobsClient) NewListPager(resourceGroupName string, workspaceName string, options *JobsClientListOptions) *runtime.Pager[JobsClientListResponse]

NewListPager - Lists Jobs in the workspace.

Generated from API version 2022-10-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.NewListPager method.
Example (ListAutoMlJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/AutoMLJob/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("test-rg", "my-aml-workspace", &armmachinelearning.JobsClientListOptions{Skip: nil,
	JobType:      nil,
	Tag:          nil,
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.JobBaseResourceArmPaginatedResult = armmachinelearning.JobBaseResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.JobBase{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeManagedIdentity),
	// 			},
	// 			Properties: &armmachinelearning.AutoMLJob{
	// 				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),
	// 				},
	// 				IsArchived: to.Ptr(false),
	// 				JobType: to.Ptr(armmachinelearning.JobTypeAutoML),
	// 				Services: map[string]*armmachinelearning.JobService{
	// 					"string": &armmachinelearning.JobService{
	// 						Endpoint: to.Ptr("string"),
	// 						ErrorMessage: to.Ptr("string"),
	// 						JobServiceType: to.Ptr("string"),
	// 						Port: to.Ptr[int32](1),
	// 						Properties: map[string]*string{
	// 							"string": to.Ptr("string"),
	// 						},
	// 						Status: to.Ptr("string"),
	// 					},
	// 				},
	// 				Status: to.Ptr(armmachinelearning.JobStatus("Scheduled")),
	// 				EnvironmentID: to.Ptr("string"),
	// 				EnvironmentVariables: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 				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.JobResourceConfiguration{
	// 					InstanceCount: to.Ptr[int32](1),
	// 					InstanceType: to.Ptr("string"),
	// 					Properties: map[string]any{
	// 						"string": map[string]any{
	// 							"9bec0ab0-c62f-4fa9-a97c-7b24bbcc90ad": nil,
	// 						},
	// 					},
	// 				},
	// 				TaskDetails: &armmachinelearning.ImageClassification{
	// 					TargetColumnName: to.Ptr("string"),
	// 					TaskType: to.Ptr(armmachinelearning.TaskTypeImageClassification),
	// 					TrainingData: &armmachinelearning.MLTableJobInput{
	// 						URI: to.Ptr("string"),
	// 						JobInputType: to.Ptr(armmachinelearning.JobInputTypeMltable),
	// 					},
	// 					LimitSettings: &armmachinelearning.ImageLimitSettings{
	// 						MaxTrials: to.Ptr[int32](2),
	// 					},
	// 					ModelSettings: &armmachinelearning.ImageModelSettingsClassification{
	// 						ValidationCropSize: to.Ptr[int32](2),
	// 					},
	// 					SearchSpace: []*armmachinelearning.ImageModelDistributionSettingsClassification{
	// 						{
	// 							ValidationCropSize: to.Ptr("choice(2, 360)"),
	// 					}},
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

Example (ListCommandJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("test-rg", "my-aml-workspace", &armmachinelearning.JobsClientListOptions{Skip: nil,
	JobType:      to.Ptr("string"),
	Tag:          to.Ptr("string"),
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.JobBaseResourceArmPaginatedResult = armmachinelearning.JobBaseResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.JobBase{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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": &armmachinelearning.JobService{
	// 						Endpoint: to.Ptr("string"),
	// 						ErrorMessage: to.Ptr("string"),
	// 						JobServiceType: to.Ptr("string"),
	// 						Port: to.Ptr[int32](1),
	// 						Properties: map[string]*string{
	// 							"string": to.Ptr("string"),
	// 						},
	// 						Status: to.Ptr("string"),
	// 					},
	// 				},
	// 				Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
	// 				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),
	// 					},
	// 				},
	// 				Parameters: map[string]any{
	// 					"string": "string",
	// 				},
	// 				Resources: &armmachinelearning.JobResourceConfiguration{
	// 					InstanceCount: to.Ptr[int32](1),
	// 					InstanceType: to.Ptr("string"),
	// 					Properties: map[string]any{
	// 						"string": map[string]any{
	// 							"7aad5998-6c83-4ca9-b50a-b44dfc43f420": nil,
	// 						},
	// 					},
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

Example (ListPipelineJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/PipelineJob/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("test-rg", "my-aml-workspace", &armmachinelearning.JobsClientListOptions{Skip: nil,
	JobType:      to.Ptr("string"),
	Tag:          to.Ptr("string"),
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.JobBaseResourceArmPaginatedResult = armmachinelearning.JobBaseResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.JobBase{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.PipelineJob{
	// 				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"),
	// 				JobType: to.Ptr(armmachinelearning.JobTypePipeline),
	// 				Services: map[string]*armmachinelearning.JobService{
	// 					"string": &armmachinelearning.JobService{
	// 						Endpoint: to.Ptr("string"),
	// 						ErrorMessage: to.Ptr("string"),
	// 						JobServiceType: to.Ptr("string"),
	// 						Port: to.Ptr[int32](1),
	// 						Properties: map[string]*string{
	// 							"string": to.Ptr("string"),
	// 						},
	// 						Status: to.Ptr("string"),
	// 					},
	// 				},
	// 				Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
	// 				Inputs: map[string]armmachinelearning.JobInputClassification{
	// 					"string": &armmachinelearning.LiteralJobInput{
	// 						Description: to.Ptr("string"),
	// 						JobInputType: to.Ptr(armmachinelearning.JobInputTypeLiteral),
	// 						Value: to.Ptr("string"),
	// 					},
	// 				},
	// 				Outputs: map[string]armmachinelearning.JobOutputClassification{
	// 					"string": &armmachinelearning.URIFileJobOutput{
	// 						Mode: to.Ptr(armmachinelearning.OutputDeliveryModeUpload),
	// 						URI: to.Ptr("string"),
	// 						Description: to.Ptr("string"),
	// 						JobOutputType: to.Ptr(armmachinelearning.JobOutputTypeURIFile),
	// 					},
	// 				},
	// 				Settings: map[string]any{
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

Example (ListSweepJob)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Job/SweepJob/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("test-rg", "my-aml-workspace", &armmachinelearning.JobsClientListOptions{Skip: nil,
	JobType:      to.Ptr("string"),
	Tag:          to.Ptr("string"),
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.JobBaseResourceArmPaginatedResult = armmachinelearning.JobBaseResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.JobBase{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.SweepJob{
	// 				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"),
	// 				JobType: to.Ptr(armmachinelearning.JobTypeSweep),
	// 				Services: map[string]*armmachinelearning.JobService{
	// 					"string": &armmachinelearning.JobService{
	// 						Endpoint: to.Ptr("string"),
	// 						ErrorMessage: to.Ptr("string"),
	// 						JobServiceType: to.Ptr("string"),
	// 						Port: to.Ptr[int32](1),
	// 						Properties: map[string]*string{
	// 							"string": to.Ptr("string"),
	// 						},
	// 						Status: to.Ptr("string"),
	// 					},
	// 				},
	// 				Status: to.Ptr(armmachinelearning.JobStatusNotStarted),
	// 				EarlyTermination: &armmachinelearning.MedianStoppingPolicy{
	// 					DelayEvaluation: to.Ptr[int32](1),
	// 					EvaluationInterval: to.Ptr[int32](1),
	// 					PolicyType: to.Ptr(armmachinelearning.EarlyTerminationPolicyTypeMedianStopping),
	// 				},
	// 				Limits: &armmachinelearning.SweepJobLimits{
	// 					JobLimitsType: to.Ptr(armmachinelearning.JobLimitsTypeSweep),
	// 					MaxConcurrentTrials: to.Ptr[int32](1),
	// 					MaxTotalTrials: to.Ptr[int32](1),
	// 					TrialTimeout: to.Ptr("PT1S"),
	// 				},
	// 				Objective: &armmachinelearning.Objective{
	// 					Goal: to.Ptr(armmachinelearning.GoalMinimize),
	// 					PrimaryMetric: to.Ptr("string"),
	// 				},
	// 				SamplingAlgorithm: &armmachinelearning.GridSamplingAlgorithm{
	// 					SamplingAlgorithmType: to.Ptr(armmachinelearning.SamplingAlgorithmTypeGrid),
	// 				},
	// 				SearchSpace: map[string]any{
	// 					"string":map[string]any{
	// 					},
	// 				},
	// 				Trial: &armmachinelearning.TrialComponent{
	// 					CodeID: to.Ptr("string"),
	// 					Command: to.Ptr("string"),
	// 					Distribution: &armmachinelearning.Mpi{
	// 						DistributionType: to.Ptr(armmachinelearning.DistributionTypeMpi),
	// 						ProcessCountPerInstance: to.Ptr[int32](1),
	// 					},
	// 					EnvironmentID: to.Ptr("string"),
	// 					EnvironmentVariables: map[string]*string{
	// 						"string": to.Ptr("string"),
	// 					},
	// 					Resources: &armmachinelearning.JobResourceConfiguration{
	// 						InstanceCount: to.Ptr[int32](1),
	// 						InstanceType: to.Ptr("string"),
	// 						Properties: map[string]any{
	// 							"string": map[string]any{
	// 								"e6b6493e-7d5e-4db3-be1e-306ec641327e": nil,
	// 							},
	// 						},
	// 					},
	// 				},
	// 			},
	// 	}},
	// }
}
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.BeginCancel.

type JobsClientCreateOrUpdateOptions

type JobsClientCreateOrUpdateOptions struct {
}

JobsClientCreateOrUpdateOptions contains the optional parameters for the JobsClient.CreateOrUpdate method.

type JobsClientCreateOrUpdateResponse

type JobsClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	JobBase
}

JobsClientCreateOrUpdateResponse contains the response from method JobsClient.CreateOrUpdate.

type JobsClientDeleteResponse

type JobsClientDeleteResponse struct {
}

JobsClientDeleteResponse contains the response from method JobsClient.BeginDelete.

type JobsClientGetOptions

type JobsClientGetOptions struct {
}

JobsClientGetOptions contains the optional parameters for the JobsClient.Get method.

type JobsClientGetResponse

type JobsClientGetResponse struct {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type JobsClientListResponse

type JobsClientListResponse struct {
	// A paginated list of JobBase entities.
	JobBaseResourceArmPaginatedResult
}

JobsClientListResponse contains the response from method JobsClient.NewListPager.

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

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool

	// Properties of Kubernetes
	Properties *KubernetesProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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

	// If true, enables Application Insights logging.
	AppInsightsEnabled *bool

	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration

	// The resource requirements for the container (cpu and memory).
	ContainerResourceRequirements *ContainerResourceRequirements

	// Description of the endpoint deployment.
	Description *string

	// If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.
	EgressPublicNetworkAccess *EgressPublicNetworkAccessType

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string

	// Compute instance type.
	InstanceType *string

	// Liveness probe monitors the health of the container regularly.
	LivenessProbe *ProbeSettings

	// The URI path to the model.
	Model *string

	// The path to mount the model in custom container.
	ModelMountPath *string

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string

	// Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness
	// probe.
	ReadinessProbe *ProbeSettings

	// Request settings for the deployment.
	RequestSettings *OnlineRequestSettings

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

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState
}

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

	// Extension instance release train.
	ExtensionInstanceReleaseTrain *string

	// Extension principal-id.
	ExtensionPrincipalID *string

	// Instance Type Schema
	InstanceTypes map[string]*InstanceTypeSchema

	// Compute namespace
	Namespace *string

	// Relay connection string.
	RelayConnectionString *string

	// ServiceBus connection string.
	ServiceBusConnectionString *string

	// VC name.
	VcName *string
}

KubernetesProperties - Kubernetes properties

func (KubernetesProperties) MarshalJSON

func (k KubernetesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesProperties.

func (*KubernetesProperties) UnmarshalJSON

func (k *KubernetesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesProperties.

type KubernetesSchema

type KubernetesSchema struct {
	// Properties of Kubernetes
	Properties *KubernetesProperties
}

KubernetesSchema - Kubernetes Compute Schema

func (KubernetesSchema) MarshalJSON

func (k KubernetesSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesSchema.

func (*KubernetesSchema) UnmarshalJSON

func (k *KubernetesSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesSchema.

type LearningRateScheduler

type LearningRateScheduler string

LearningRateScheduler - Learning rate scheduler enum.

const (
	// LearningRateSchedulerNone - No learning rate scheduler selected.
	LearningRateSchedulerNone LearningRateScheduler = "None"
	// LearningRateSchedulerStep - Step learning rate scheduler.
	LearningRateSchedulerStep LearningRateScheduler = "Step"
	// LearningRateSchedulerWarmupCosine - Cosine Annealing With Warmup.
	LearningRateSchedulerWarmupCosine LearningRateScheduler = "WarmupCosine"
)

func PossibleLearningRateSchedulerValues

func PossibleLearningRateSchedulerValues() []LearningRateScheduler

PossibleLearningRateSchedulerValues returns the possible values for the LearningRateScheduler const type.

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

	// READ-ONLY; The list of AML user facing features.
	Value []*AmlUserFeature
}

ListAmlUserFeatureResult - The List Aml user feature operation response.

func (ListAmlUserFeatureResult) MarshalJSON

func (l ListAmlUserFeatureResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListAmlUserFeatureResult.

func (*ListAmlUserFeatureResult) UnmarshalJSON

func (l *ListAmlUserFeatureResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListAmlUserFeatureResult.

type ListNotebookKeysResult

type ListNotebookKeysResult struct {
	// READ-ONLY
	PrimaryAccessKey *string

	// READ-ONLY
	SecondaryAccessKey *string
}

func (ListNotebookKeysResult) MarshalJSON

func (l ListNotebookKeysResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListNotebookKeysResult.

func (*ListNotebookKeysResult) UnmarshalJSON

func (l *ListNotebookKeysResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListNotebookKeysResult.

type ListStorageAccountKeysResult

type ListStorageAccountKeysResult struct {
	// READ-ONLY
	UserStorageKey *string
}

func (ListStorageAccountKeysResult) MarshalJSON

func (l ListStorageAccountKeysResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListStorageAccountKeysResult.

func (*ListStorageAccountKeysResult) UnmarshalJSON

func (l *ListStorageAccountKeysResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListStorageAccountKeysResult.

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

	// READ-ONLY; The list of AML resource usages.
	Value []*Usage
}

ListUsagesResult - The List Usages operation response.

func (ListUsagesResult) MarshalJSON

func (l ListUsagesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListUsagesResult.

func (*ListUsagesResult) UnmarshalJSON

func (l *ListUsagesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListUsagesResult.

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

	// READ-ONLY
	ContainerRegistryCredentials *RegistryListCredentialsResult

	// READ-ONLY
	NotebookAccessKeys *ListNotebookKeysResult

	// READ-ONLY
	UserStorageKey *string

	// READ-ONLY
	UserStorageResourceID *string
}

func (ListWorkspaceKeysResult) MarshalJSON

func (l ListWorkspaceKeysResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListWorkspaceKeysResult.

func (*ListWorkspaceKeysResult) UnmarshalJSON

func (l *ListWorkspaceKeysResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListWorkspaceKeysResult.

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

	// READ-ONLY; The list of Workspace Quotas by VM Family
	Value []*ResourceQuota
}

ListWorkspaceQuotas - The List WorkspaceQuotasByVMFamily operation response.

func (ListWorkspaceQuotas) MarshalJSON

func (l ListWorkspaceQuotas) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListWorkspaceQuotas.

func (*ListWorkspaceQuotas) UnmarshalJSON

func (l *ListWorkspaceQuotas) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListWorkspaceQuotas.

type LiteralJobInput

type LiteralJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType

	// REQUIRED; [Required] Literal value for the input.
	Value *string

	// Description for the input.
	Description *string
}

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 LogVerbosity

type LogVerbosity string

LogVerbosity - Enum for setting log verbosity.

const (
	// LogVerbosityCritical - Only critical statements logged.
	LogVerbosityCritical LogVerbosity = "Critical"
	// LogVerbosityDebug - Debug and above log statements logged.
	LogVerbosityDebug LogVerbosity = "Debug"
	// LogVerbosityError - Error and above log statements logged.
	LogVerbosityError LogVerbosity = "Error"
	// LogVerbosityInfo - Info and above log statements logged.
	LogVerbosityInfo LogVerbosity = "Info"
	// LogVerbosityNotSet - No logs emitted.
	LogVerbosityNotSet LogVerbosity = "NotSet"
	// LogVerbosityWarning - Warning and above log statements logged.
	LogVerbosityWarning LogVerbosity = "Warning"
)

func PossibleLogVerbosityValues

func PossibleLogVerbosityValues() []LogVerbosity

PossibleLogVerbosityValues returns the possible values for the LogVerbosity const type.

type MLFlowModelJobInput

type MLFlowModelJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType

	// REQUIRED; [Required] Input Asset URI.
	URI *string

	// Description for the input.
	Description *string

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode
}

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

	// Description for the output.
	Description *string

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode

	// Output Asset URI.
	URI *string
}

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

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20221001.Assets.DataVersionBase.DataType
	DataURI *string

	// The asset description text.
	Description *string

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Uris referenced in the MLTable definition (required for lineage)
	ReferencedUris []*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

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

	// REQUIRED; [Required] Input Asset URI.
	URI *string

	// Description for the input.
	Description *string

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode
}

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

	// Description for the output.
	Description *string

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode

	// Output Asset URI.
	URI *string
}

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

	// Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.
	ClientID *string

	// Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.
	ObjectID *string

	// Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.
	ResourceID *string
}

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

	// Category of the connection
	Category    *ConnectionCategory
	Credentials *WorkspaceConnectionManagedIdentity
	Target      *string

	// Value details of the workspace connection.
	Value *string

	// format for the workspace connection value
	ValueFormat *ValueFormat
}

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

	// If true, enables Application Insights logging.
	AppInsightsEnabled *bool

	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration

	// Description of the endpoint deployment.
	Description *string

	// If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.
	EgressPublicNetworkAccess *EgressPublicNetworkAccessType

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string

	// Compute instance type.
	InstanceType *string

	// Liveness probe monitors the health of the container regularly.
	LivenessProbe *ProbeSettings

	// The URI path to the model.
	Model *string

	// The path to mount the model in custom container.
	ModelMountPath *string

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string

	// Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness
	// probe.
	ReadinessProbe *ProbeSettings

	// Request settings for the deployment.
	RequestSettings *OnlineRequestSettings

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

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState
}

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

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

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string
}

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.

func (*ManagedServiceIdentity) UnmarshalJSON

func (m *ManagedServiceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32
}

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ModelContainer - Azure Resource Manager resource envelope.

func (ModelContainer) MarshalJSON

func (m ModelContainer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelContainer.

func (*ModelContainer) UnmarshalJSON

func (m *ModelContainer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ModelContainer.

type ModelContainerProperties

type ModelContainerProperties struct {
	// The asset description text.
	Description *string

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; The latest version inside this container.
	LatestVersion *string

	// READ-ONLY; The next auto incremental version
	NextVersion *string
}

func (ModelContainerProperties) MarshalJSON

func (m ModelContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelContainerProperties.

func (*ModelContainerProperties) UnmarshalJSON

func (m *ModelContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type ModelContainer.
	Value []*ModelContainer
}

ModelContainerResourceArmPaginatedResult - A paginated list of ModelContainer entities.

func (ModelContainerResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ModelContainerResourceArmPaginatedResult.

func (*ModelContainerResourceArmPaginatedResult) UnmarshalJSON

func (m *ModelContainerResourceArmPaginatedResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ModelContainerResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewModelContainersClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ModelContainer = armmachinelearning.ModelContainer{
// 	Name: to.Ptr("testContainer"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/models"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("John Smith"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("John Smith"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.ModelContainerProperties{
// 		Description: to.Ptr("Model container description"),
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("value1"),
// 			"tag2": to.Ptr("value2"),
// 		},
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewModelContainersClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewModelContainersClient().Get(ctx, "testrg123", "workspace123", "testContainer", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ModelContainer = armmachinelearning.ModelContainer{
// 	Name: to.Ptr("testContainer"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/models"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("John Smith"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("John Smith"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Properties: &armmachinelearning.ModelContainerProperties{
// 		Description: to.Ptr("Model container description"),
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("value1"),
// 			"tag2": to.Ptr("value2"),
// 		},
// 	},
// }
Output:

func (*ModelContainersClient) NewListPager

func (client *ModelContainersClient) NewListPager(resourceGroupName string, workspaceName string, options *ModelContainersClientListOptions) *runtime.Pager[ModelContainersClientListResponse]

NewListPager - List model containers.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewModelContainersClient().NewListPager("testrg123", "workspace123", &armmachinelearning.ModelContainersClientListOptions{Skip: nil,
	Count:        nil,
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ModelContainerResourceArmPaginatedResult = armmachinelearning.ModelContainerResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.ModelContainer{
	// 		{
	// 			Name: to.Ptr("testContainer"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/models"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/models/testContainer"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("John Smith"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("John Smith"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Properties: &armmachinelearning.ModelContainerProperties{
	// 				Description: to.Ptr("Model container description"),
	// 				Tags: map[string]*string{
	// 					"tag1": to.Ptr("value1"),
	// 					"tag2": to.Ptr("value2"),
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type ModelContainersClientCreateOrUpdateOptions

type ModelContainersClientCreateOrUpdateOptions struct {
}

ModelContainersClientCreateOrUpdateOptions contains the optional parameters for the ModelContainersClient.CreateOrUpdate method.

type ModelContainersClientCreateOrUpdateResponse

type ModelContainersClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type ModelContainersClientListResponse

type ModelContainersClientListResponse struct {
	// A paginated list of ModelContainer entities.
	ModelContainerResourceArmPaginatedResult
}

ModelContainersClientListResponse contains the response from method ModelContainersClient.NewListPager.

type ModelSize

type ModelSize string

ModelSize - Image model size.

const (
	// ModelSizeExtraLarge - Extra large size.
	ModelSizeExtraLarge ModelSize = "ExtraLarge"
	// ModelSizeLarge - Large size.
	ModelSizeLarge ModelSize = "Large"
	// ModelSizeMedium - Medium size.
	ModelSizeMedium ModelSize = "Medium"
	// ModelSizeNone - No value selected.
	ModelSizeNone ModelSize = "None"
	// ModelSizeSmall - Small size.
	ModelSizeSmall ModelSize = "Small"
)

func PossibleModelSizeValues

func PossibleModelSizeValues() []ModelSize

PossibleModelSizeValues returns the possible values for the ModelSize const type.

type ModelVersion

type ModelVersion struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *ModelVersionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ModelVersion - Azure Resource Manager resource envelope.

func (ModelVersion) MarshalJSON

func (m ModelVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelVersion.

func (*ModelVersion) UnmarshalJSON

func (m *ModelVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ModelVersion.

type ModelVersionProperties

type ModelVersionProperties struct {
	// The asset description text.
	Description *string

	// Mapping of model flavors to their properties.
	Flavors map[string]*FlavorData

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// Name of the training job which produced this model
	JobName *string

	// The storage format for this entity. Used for NCD.
	ModelType *string

	// The URI path to the model contents.
	ModelURI *string

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

ModelVersionProperties - Model asset version details.

func (ModelVersionProperties) MarshalJSON

func (m ModelVersionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelVersionProperties.

func (*ModelVersionProperties) UnmarshalJSON

func (m *ModelVersionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type ModelVersion.
	Value []*ModelVersion
}

ModelVersionResourceArmPaginatedResult - A paginated list of ModelVersion entities.

func (ModelVersionResourceArmPaginatedResult) MarshalJSON

func (m ModelVersionResourceArmPaginatedResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ModelVersionResourceArmPaginatedResult.

func (*ModelVersionResourceArmPaginatedResult) UnmarshalJSON

func (m *ModelVersionResourceArmPaginatedResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ModelVersionResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewModelVersionsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ModelVersion = armmachinelearning.ModelVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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": &armmachinelearning.FlavorData{
// 				Data: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 			},
// 		},
// 		ModelType: to.Ptr("CustomModel"),
// 		ModelURI: to.Ptr("string"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewModelVersionsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewModelVersionsClient().Get(ctx, "test-rg", "my-aml-workspace", "string", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ModelVersion = armmachinelearning.ModelVersion{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	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": &armmachinelearning.FlavorData{
// 				Data: map[string]*string{
// 					"string": to.Ptr("string"),
// 				},
// 			},
// 		},
// 		ModelType: to.Ptr("CustomModel"),
// 		ModelURI: to.Ptr("string"),
// 	},
// }
Output:

func (*ModelVersionsClient) NewListPager

func (client *ModelVersionsClient) NewListPager(resourceGroupName string, workspaceName string, name string, options *ModelVersionsClientListOptions) *runtime.Pager[ModelVersionsClientListResponse]

NewListPager - List model versions.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewModelVersionsClient().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() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ModelVersionResourceArmPaginatedResult = armmachinelearning.ModelVersionResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.ModelVersion{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			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": &armmachinelearning.FlavorData{
	// 						Data: map[string]*string{
	// 							"string": to.Ptr("string"),
	// 						},
	// 					},
	// 				},
	// 				ModelType: to.Ptr("CustomModel"),
	// 				ModelURI: to.Ptr("string"),
	// 			},
	// 	}},
	// }
}
Output:

type ModelVersionsClientCreateOrUpdateOptions

type ModelVersionsClientCreateOrUpdateOptions struct {
}

ModelVersionsClientCreateOrUpdateOptions contains the optional parameters for the ModelVersionsClient.CreateOrUpdate method.

type ModelVersionsClientCreateOrUpdateResponse

type ModelVersionsClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	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 {
	// Azure Resource Manager resource envelope.
	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.NewListPager method.

type ModelVersionsClientListResponse

type ModelVersionsClientListResponse struct {
	// A paginated list of ModelVersion entities.
	ModelVersionResourceArmPaginatedResult
}

ModelVersionsClientListResponse contains the response from method ModelVersionsClient.NewListPager.

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

	// Number of processes per MPI node.
	ProcessCountPerInstance *int32
}

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 NCrossValidations

type NCrossValidations struct {
	// REQUIRED; [Required] Mode for determining N-Cross validations.
	Mode *NCrossValidationsMode
}

NCrossValidations - N-Cross validations value.

func (*NCrossValidations) GetNCrossValidations

func (n *NCrossValidations) GetNCrossValidations() *NCrossValidations

GetNCrossValidations implements the NCrossValidationsClassification interface for type NCrossValidations.

func (NCrossValidations) MarshalJSON

func (n NCrossValidations) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NCrossValidations.

func (*NCrossValidations) UnmarshalJSON

func (n *NCrossValidations) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NCrossValidations.

type NCrossValidationsClassification

type NCrossValidationsClassification interface {
	// GetNCrossValidations returns the NCrossValidations content of the underlying type.
	GetNCrossValidations() *NCrossValidations
}

NCrossValidationsClassification provides polymorphic access to related types. Call the interface's GetNCrossValidations() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AutoNCrossValidations, *CustomNCrossValidations, *NCrossValidations

type NCrossValidationsMode

type NCrossValidationsMode string

NCrossValidationsMode - Determines how N-Cross validations value is determined.

const (
	// NCrossValidationsModeAuto - Determine N-Cross validations value automatically. Supported only for 'Forecasting' AutoML
	// task.
	NCrossValidationsModeAuto NCrossValidationsMode = "Auto"
	// NCrossValidationsModeCustom - Use custom N-Cross validations value.
	NCrossValidationsModeCustom NCrossValidationsMode = "Custom"
)

func PossibleNCrossValidationsModeValues

func PossibleNCrossValidationsModeValues() []NCrossValidationsMode

PossibleNCrossValidationsModeValues returns the possible values for the NCrossValidationsMode const type.

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 NlpVertical

type NlpVertical struct {
	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *NlpVerticalFeaturizationSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *NlpVerticalLimitSettings

	// Validation data inputs.
	ValidationData *MLTableJobInput
}

NlpVertical - Abstract class for NLP related AutoML tasks. NLP - Natural Language Processing.

func (NlpVertical) MarshalJSON

func (n NlpVertical) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NlpVertical.

func (*NlpVertical) UnmarshalJSON

func (n *NlpVertical) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NlpVertical.

type NlpVerticalFeaturizationSettings

type NlpVerticalFeaturizationSettings struct {
	// Dataset language, useful for the text data.
	DatasetLanguage *string
}

func (NlpVerticalFeaturizationSettings) MarshalJSON

func (n NlpVerticalFeaturizationSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NlpVerticalFeaturizationSettings.

func (*NlpVerticalFeaturizationSettings) UnmarshalJSON

func (n *NlpVerticalFeaturizationSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NlpVerticalFeaturizationSettings.

type NlpVerticalLimitSettings

type NlpVerticalLimitSettings struct {
	// Maximum Concurrent AutoML iterations.
	MaxConcurrentTrials *int32

	// Number of AutoML iterations.
	MaxTrials *int32

	// AutoML job timeout.
	Timeout *string
}

NlpVerticalLimitSettings - Job execution constraints.

func (NlpVerticalLimitSettings) MarshalJSON

func (n NlpVerticalLimitSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NlpVerticalLimitSettings.

func (*NlpVerticalLimitSettings) UnmarshalJSON

func (n *NlpVerticalLimitSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NlpVerticalLimitSettings.

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

	// READ-ONLY; Number of compute nodes which are leaving the amlCompute.
	LeavingNodeCount *int32

	// READ-ONLY; Number of compute nodes which are in preempted state.
	PreemptedNodeCount *int32

	// READ-ONLY; Number of compute nodes which are being prepared.
	PreparingNodeCount *int32

	// READ-ONLY; Number of compute nodes which are running jobs.
	RunningNodeCount *int32

	// READ-ONLY; Number of compute nodes which are in unusable state.
	UnusableNodeCount *int32
}

NodeStateCounts - Counts of various compute node states on the amlCompute.

func (NodeStateCounts) MarshalJSON

func (n NodeStateCounts) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NodeStateCounts.

func (*NodeStateCounts) UnmarshalJSON

func (n *NodeStateCounts) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NodeStateCounts.

type NoneAuthTypeWorkspaceConnectionProperties

type NoneAuthTypeWorkspaceConnectionProperties struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType

	// Category of the connection
	Category *ConnectionCategory
	Target   *string

	// Value details of the workspace connection.
	Value *string

	// format for the workspace connection value
	ValueFormat *ValueFormat
}

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
}

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

	// READ-ONLY
	ExpiresIn *int32

	// READ-ONLY
	HostName *string

	// READ-ONLY
	NotebookResourceID *string

	// READ-ONLY
	PublicDNS *string

	// READ-ONLY
	RefreshToken *string

	// READ-ONLY
	Scope *string

	// READ-ONLY
	TokenType *string
}

func (NotebookAccessTokenResult) MarshalJSON

func (n NotebookAccessTokenResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotebookAccessTokenResult.

func (*NotebookAccessTokenResult) UnmarshalJSON

func (n *NotebookAccessTokenResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NotebookAccessTokenResult.

type NotebookPreparationError

type NotebookPreparationError struct {
	ErrorMessage *string
	StatusCode   *int32
}

func (NotebookPreparationError) MarshalJSON

func (n NotebookPreparationError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotebookPreparationError.

func (*NotebookPreparationError) UnmarshalJSON

func (n *NotebookPreparationError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NotebookPreparationError.

type NotebookResourceInfo

type NotebookResourceInfo struct {
	Fqdn *string

	// The error that occurs when preparing notebook.
	NotebookPreparationError *NotebookPreparationError

	// the data plane resourceId that used to initialize notebook component
	ResourceID *string
}

func (NotebookResourceInfo) MarshalJSON

func (n NotebookResourceInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NotebookResourceInfo.

func (*NotebookResourceInfo) UnmarshalJSON

func (n *NotebookResourceInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NotebookResourceInfo.

type ObjectDetectionPrimaryMetrics

type ObjectDetectionPrimaryMetrics string

ObjectDetectionPrimaryMetrics - Primary metrics for Image ObjectDetection task.

const (
	// ObjectDetectionPrimaryMetricsMeanAveragePrecision - Mean Average Precision (MAP) is the average of AP (Average Precision).
	// AP is calculated for each class and averaged to get the MAP.
	ObjectDetectionPrimaryMetricsMeanAveragePrecision ObjectDetectionPrimaryMetrics = "MeanAveragePrecision"
)

func PossibleObjectDetectionPrimaryMetricsValues

func PossibleObjectDetectionPrimaryMetricsValues() []ObjectDetectionPrimaryMetrics

PossibleObjectDetectionPrimaryMetricsValues returns the possible values for the ObjectDetectionPrimaryMetrics const type.

type Objective

type Objective struct {
	// REQUIRED; [Required] Defines supported metric goals for hyperparameter tuning
	Goal *Goal

	// REQUIRED; [Required] Name of the metric to optimize.
	PrimaryMetric *string
}

Objective - Optimization objective.

func (Objective) MarshalJSON

func (o Objective) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Objective.

func (*Objective) UnmarshalJSON

func (o *Objective) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Objective.

type OnlineDeployment

type OnlineDeployment struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties OnlineDeploymentPropertiesClassification

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

	// If true, enables Application Insights logging.
	AppInsightsEnabled *bool

	// Code configuration for the endpoint deployment.
	CodeConfiguration *CodeConfiguration

	// Description of the endpoint deployment.
	Description *string

	// If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled.
	EgressPublicNetworkAccess *EgressPublicNetworkAccessType

	// ARM resource ID or AssetId of the environment specification for the endpoint deployment.
	EnvironmentID *string

	// Environment variables configuration for the deployment.
	EnvironmentVariables map[string]*string

	// Compute instance type.
	InstanceType *string

	// Liveness probe monitors the health of the container regularly.
	LivenessProbe *ProbeSettings

	// The URI path to the model.
	Model *string

	// The path to mount the model in custom container.
	ModelMountPath *string

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string

	// Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness
	// probe.
	ReadinessProbe *ProbeSettings

	// Request settings for the deployment.
	RequestSettings *OnlineRequestSettings

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

	// READ-ONLY; Provisioning state for the endpoint deployment.
	ProvisioningState *DeploymentProvisioningState
}

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

	// An array of objects of type OnlineDeployment.
	Value []*OnlineDeployment
}

OnlineDeploymentTrackedResourceArmPaginatedResult - A paginated list of OnlineDeployment entities.

func (OnlineDeploymentTrackedResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type OnlineDeploymentTrackedResourceArmPaginatedResult.

func (*OnlineDeploymentTrackedResourceArmPaginatedResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type OnlineDeploymentTrackedResourceArmPaginatedResult.

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-10-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 (CreateOrUpdateKubernetesOnlineDeployment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineDeploymentsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineDeployment = armmachinelearning.OnlineDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		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),
// 	},
// }
Output:

Example (CreateOrUpdateManagedOnlineDeployment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineDeploymentsClient().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.ManagedOnlineDeployment{
		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.EndpointComputeTypeManaged),
		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"),
		ReadinessProbe: &armmachinelearning.ProbeSettings{
			FailureThreshold: to.Ptr[int32](30),
			InitialDelay:     to.Ptr("PT1S"),
			Period:           to.Ptr("PT10S"),
			SuccessThreshold: to.Ptr[int32](1),
			Timeout:          to.Ptr("PT2S"),
		},
		RequestSettings: &armmachinelearning.OnlineRequestSettings{
			MaxConcurrentRequestsPerInstance: to.Ptr[int32](1),
			MaxQueueWait:                     to.Ptr("PT5M"),
			RequestTimeout:                   to.Ptr("PT5M"),
		},
		ScaleSettings: &armmachinelearning.DefaultScaleSettings{
			ScaleType: to.Ptr(armmachinelearning.ScaleTypeDefault),
		},
	},
	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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineDeployment = armmachinelearning.OnlineDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.ManagedOnlineDeployment{
// 		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.EndpointComputeTypeManaged),
// 		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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		ReadinessProbe: &armmachinelearning.ProbeSettings{
// 			FailureThreshold: to.Ptr[int32](30),
// 			InitialDelay: to.Ptr("PT1S"),
// 			Period: to.Ptr("PT10S"),
// 			SuccessThreshold: to.Ptr[int32](1),
// 			Timeout: to.Ptr("PT2S"),
// 		},
// 		RequestSettings: &armmachinelearning.OnlineRequestSettings{
// 			MaxConcurrentRequestsPerInstance: to.Ptr[int32](1),
// 			MaxQueueWait: to.Ptr("PT5M"),
// 			RequestTimeout: to.Ptr("PT5M"),
// 		},
// 		ScaleSettings: &armmachinelearning.DefaultScaleSettings{
// 			ScaleType: to.Ptr(armmachinelearning.ScaleTypeDefault),
// 		},
// 	},
// 	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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineDeploymentsClient().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-10-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 (UpdateKubernetesOnlineDeployment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineDeploymentsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineDeployment = armmachinelearning.OnlineDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		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),
// 	},
// }
Output:

Example (UpdateManagedOnlineDeployment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/update.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineDeploymentsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineDeployment = armmachinelearning.OnlineDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.ManagedOnlineDeployment{
// 		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.EndpointComputeTypeManaged),
// 		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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		ReadinessProbe: &armmachinelearning.ProbeSettings{
// 			FailureThreshold: to.Ptr[int32](30),
// 			InitialDelay: to.Ptr("PT1S"),
// 			Period: to.Ptr("PT10S"),
// 			SuccessThreshold: to.Ptr[int32](1),
// 			Timeout: to.Ptr("PT2S"),
// 		},
// 		RequestSettings: &armmachinelearning.OnlineRequestSettings{
// 			MaxConcurrentRequestsPerInstance: to.Ptr[int32](1),
// 			MaxQueueWait: to.Ptr("PT5M"),
// 			RequestTimeout: to.Ptr("PT5M"),
// 		},
// 		ScaleSettings: &armmachinelearning.DefaultScaleSettings{
// 			ScaleType: to.Ptr(armmachinelearning.ScaleTypeDefault),
// 		},
// 	},
// 	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),
// 	},
// }
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-10-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 (GetKubernetesOnlineDeployment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOnlineDeploymentsClient().Get(ctx, "test-rg", "my-aml-workspace", "testEndpointName", "testDeploymentName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineDeployment = armmachinelearning.OnlineDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		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),
// 	},
// }
Output:

Example (GetManagedOnlineDeployment)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOnlineDeploymentsClient().Get(ctx, "test-rg", "my-aml-workspace", "testEndpointName", "testDeploymentName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineDeployment = armmachinelearning.OnlineDeployment{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.ManagedOnlineDeployment{
// 		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.EndpointComputeTypeManaged),
// 		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"),
// 		ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
// 		ReadinessProbe: &armmachinelearning.ProbeSettings{
// 			FailureThreshold: to.Ptr[int32](30),
// 			InitialDelay: to.Ptr("PT1S"),
// 			Period: to.Ptr("PT10S"),
// 			SuccessThreshold: to.Ptr[int32](1),
// 			Timeout: to.Ptr("PT2S"),
// 		},
// 		RequestSettings: &armmachinelearning.OnlineRequestSettings{
// 			MaxConcurrentRequestsPerInstance: to.Ptr[int32](1),
// 			MaxQueueWait: to.Ptr("PT5M"),
// 			RequestTimeout: to.Ptr("PT5M"),
// 		},
// 		ScaleSettings: &armmachinelearning.DefaultScaleSettings{
// 			ScaleType: to.Ptr(armmachinelearning.ScaleTypeDefault),
// 		},
// 	},
// 	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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOnlineDeploymentsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeploymentLogs = armmachinelearning.DeploymentLogs{
// 	Content: to.Ptr("string"),
// }
Output:

func (*OnlineDeploymentsClient) NewListPager

func (client *OnlineDeploymentsClient) NewListPager(resourceGroupName string, workspaceName string, endpointName string, options *OnlineDeploymentsClientListOptions) *runtime.Pager[OnlineDeploymentsClientListResponse]

NewListPager - List Inference Endpoint Deployments.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOnlineDeploymentsClient().NewListPager("test-rg", "my-aml-workspace", "testEndpointName", &armmachinelearning.OnlineDeploymentsClientListOptions{OrderBy: to.Ptr("string"),
	Top:  to.Ptr[int32](1),
	Skip: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OnlineDeploymentTrackedResourceArmPaginatedResult = armmachinelearning.OnlineDeploymentTrackedResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.OnlineDeployment{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("string"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Identity: &armmachinelearning.ManagedServiceIdentity{
	// 				Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
	// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
	// 					"string": &armmachinelearning.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 						PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 					},
	// 				},
	// 			},
	// 			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"),
	// 				ProvisioningState: to.Ptr(armmachinelearning.DeploymentProvisioningStateSucceeded),
	// 				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),
	// 			},
	// 	}},
	// }
}
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.

Generated from API version 2022-10-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.NewListSKUsPager method.
Example (ListKubernetesOnlineDeploymentSkus)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/OnlineDeployment/KubernetesOnlineDeployment/listSkus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOnlineDeploymentsClient().NewListSKUsPager("test-rg", "my-aml-workspace", "testEndpointName", "testDeploymentName", &armmachinelearning.OnlineDeploymentsClientListSKUsOptions{Count: to.Ptr[int32](1),
	Skip: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SKUResourceArmPaginatedResult = armmachinelearning.SKUResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.SKUResource{
	// 		{
	// 			Capacity: &armmachinelearning.SKUCapacity{
	// 				Default: to.Ptr[int32](1),
	// 				Maximum: to.Ptr[int32](1),
	// 				Minimum: to.Ptr[int32](1),
	// 				ScaleType: to.Ptr(armmachinelearning.SKUScaleTypeAutomatic),
	// 			},
	// 			ResourceType: to.Ptr("Microsoft.MachineLearning.Services/endpoints/deployments"),
	// 			SKU: &armmachinelearning.SKUSetting{
	// 				Name: to.Ptr("string"),
	// 				Tier: to.Ptr(armmachinelearning.SKUTierFree),
	// 			},
	// 	}},
	// }
}
Output:

Example (ListManagedOnlineDeploymentSkus)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/OnlineDeployment/ManagedOnlineDeployment/listSkus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOnlineDeploymentsClient().NewListSKUsPager("test-rg", "my-aml-workspace", "testEndpointName", "testDeploymentName", &armmachinelearning.OnlineDeploymentsClientListSKUsOptions{Count: to.Ptr[int32](1),
	Skip: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SKUResourceArmPaginatedResult = armmachinelearning.SKUResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.SKUResource{
	// 		{
	// 			Capacity: &armmachinelearning.SKUCapacity{
	// 				Default: to.Ptr[int32](1),
	// 				Maximum: to.Ptr[int32](1),
	// 				Minimum: to.Ptr[int32](1),
	// 				ScaleType: to.Ptr(armmachinelearning.SKUScaleTypeAutomatic),
	// 			},
	// 			ResourceType: to.Ptr("Microsoft.MachineLearning.Services/endpoints/deployments"),
	// 			SKU: &armmachinelearning.SKUSetting{
	// 				Name: to.Ptr("string"),
	// 				Tier: to.Ptr(armmachinelearning.SKUTierFree),
	// 			},
	// 	}},
	// }
}
Output:

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.BeginCreateOrUpdate.

type OnlineDeploymentsClientDeleteResponse

type OnlineDeploymentsClientDeleteResponse struct {
}

OnlineDeploymentsClientDeleteResponse contains the response from method OnlineDeploymentsClient.BeginDelete.

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.NewListPager method.

type OnlineDeploymentsClientListResponse

type OnlineDeploymentsClientListResponse struct {
	// A paginated list of OnlineDeployment entities.
	OnlineDeploymentTrackedResourceArmPaginatedResult
}

OnlineDeploymentsClientListResponse contains the response from method OnlineDeploymentsClient.NewListPager.

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.NewListSKUsPager method.

type OnlineDeploymentsClientListSKUsResponse

type OnlineDeploymentsClientListSKUsResponse struct {
	// A paginated list of SkuResource entities.
	SKUResourceArmPaginatedResult
}

OnlineDeploymentsClientListSKUsResponse contains the response from method OnlineDeploymentsClient.NewListSKUsPager.

type OnlineDeploymentsClientUpdateResponse

type OnlineDeploymentsClientUpdateResponse struct {
	OnlineDeployment
}

OnlineDeploymentsClientUpdateResponse contains the response from method OnlineDeploymentsClient.BeginUpdate.

type OnlineEndpoint

type OnlineEndpoint struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *OnlineEndpointProperties

	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity

	// Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
	Kind *string

	// Sku details required for ARM contract for Autoscaling.
	SKU *SKU

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

func (OnlineEndpoint) MarshalJSON

func (o OnlineEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineEndpoint.

func (*OnlineEndpoint) UnmarshalJSON

func (o *OnlineEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// ARM resource ID of the compute if it exists. optional
	Compute *string

	// Description of the inference endpoint.
	Description *string

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

	// Property dictionary. Properties can be added, but not removed or altered.
	Properties map[string]*string

	// Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
	PublicNetworkAccess *PublicNetworkAccessType

	// Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.
	Traffic map[string]*int32

	// READ-ONLY; Provisioning state for the endpoint.
	ProvisioningState *EndpointProvisioningState

	// READ-ONLY; Endpoint URI.
	ScoringURI *string

	// READ-ONLY; Endpoint Swagger URI.
	SwaggerURI *string
}

OnlineEndpointProperties - Online endpoint configuration

func (OnlineEndpointProperties) MarshalJSON

func (o OnlineEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineEndpointProperties.

func (*OnlineEndpointProperties) UnmarshalJSON

func (o *OnlineEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// An array of objects of type OnlineEndpoint.
	Value []*OnlineEndpoint
}

OnlineEndpointTrackedResourceArmPaginatedResult - A paginated list of OnlineEndpoint entities.

func (OnlineEndpointTrackedResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type OnlineEndpointTrackedResourceArmPaginatedResult.

func (*OnlineEndpointTrackedResourceArmPaginatedResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type OnlineEndpointTrackedResourceArmPaginatedResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineEndpointsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineEndpoint = armmachinelearning.OnlineEndpoint{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.OnlineEndpointProperties{
// 		Description: to.Ptr("string"),
// 		AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		ScoringURI: to.Ptr("https://www.contoso.com/example"),
// 		SwaggerURI: to.Ptr("https://www.contoso.com/example"),
// 		Compute: to.Ptr("string"),
// 		ProvisioningState: to.Ptr(armmachinelearning.EndpointProvisioningStateSucceeded),
// 		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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineEndpointsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineEndpointsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOnlineEndpointsClient().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]any{
			"string": map[string]any{},
		},
	},
}, 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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineEndpoint = armmachinelearning.OnlineEndpoint{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.OnlineEndpointProperties{
// 		Description: to.Ptr("string"),
// 		AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		ScoringURI: to.Ptr("https://www.contoso.com/example"),
// 		SwaggerURI: to.Ptr("https://www.contoso.com/example"),
// 		Compute: to.Ptr("string"),
// 		ProvisioningState: to.Ptr(armmachinelearning.EndpointProvisioningStateSucceeded),
// 		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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOnlineEndpointsClient().Get(ctx, "test-rg", "my-aml-workspace", "testEndpointName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OnlineEndpoint = armmachinelearning.OnlineEndpoint{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("string"),
// 	Tags: map[string]*string{
// 	},
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"string": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Kind: to.Ptr("string"),
// 	Properties: &armmachinelearning.OnlineEndpointProperties{
// 		Description: to.Ptr("string"),
// 		AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		ScoringURI: to.Ptr("https://www.contoso.com/example"),
// 		SwaggerURI: to.Ptr("https://www.contoso.com/example"),
// 		Compute: to.Ptr("string"),
// 		ProvisioningState: to.Ptr(armmachinelearning.EndpointProvisioningStateSucceeded),
// 		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),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOnlineEndpointsClient().GetToken(ctx, "test-rg", "my-aml-workspace", "testEndpointName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EndpointAuthToken = armmachinelearning.EndpointAuthToken{
// 	AccessToken: to.Ptr("string"),
// 	ExpiryTimeUTC: to.Ptr[int64](1),
// 	RefreshAfterTimeUTC: to.Ptr[int64](1),
// 	TokenType: to.Ptr("string"),
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewOnlineEndpointsClient().ListKeys(ctx, "test-rg", "my-aml-workspace", "testEndpointName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.EndpointAuthKeys = armmachinelearning.EndpointAuthKeys{
// 	PrimaryKey: to.Ptr("string"),
// 	SecondaryKey: to.Ptr("string"),
// }
Output:

func (*OnlineEndpointsClient) NewListPager

func (client *OnlineEndpointsClient) NewListPager(resourceGroupName string, workspaceName string, options *OnlineEndpointsClientListOptions) *runtime.Pager[OnlineEndpointsClientListResponse]

NewListPager - List Online Endpoints.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOnlineEndpointsClient().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() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OnlineEndpointTrackedResourceArmPaginatedResult = armmachinelearning.OnlineEndpointTrackedResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.OnlineEndpoint{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("string"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Identity: &armmachinelearning.ManagedServiceIdentity{
	// 				Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
	// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 				UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
	// 					"string": &armmachinelearning.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 						PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
	// 					},
	// 				},
	// 			},
	// 			Kind: to.Ptr("string"),
	// 			Properties: &armmachinelearning.OnlineEndpointProperties{
	// 				Description: to.Ptr("string"),
	// 				AuthMode: to.Ptr(armmachinelearning.EndpointAuthModeAMLToken),
	// 				Properties: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 				ScoringURI: to.Ptr("https://www.contoso.com/example"),
	// 				SwaggerURI: to.Ptr("https://www.contoso.com/example"),
	// 				Compute: to.Ptr("string"),
	// 				ProvisioningState: to.Ptr(armmachinelearning.EndpointProvisioningStateSucceeded),
	// 				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),
	// 			},
	// 	}},
	// }
}
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.BeginCreateOrUpdate.

type OnlineEndpointsClientDeleteResponse

type OnlineEndpointsClientDeleteResponse struct {
}

OnlineEndpointsClientDeleteResponse contains the response from method OnlineEndpointsClient.BeginDelete.

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 {
	// Service Token
	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 {
	// Keys for endpoint authentication.
	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.NewListPager method.

type OnlineEndpointsClientListResponse

type OnlineEndpointsClientListResponse struct {
	// A paginated list of OnlineEndpoint entities.
	OnlineEndpointTrackedResourceArmPaginatedResult
}

OnlineEndpointsClientListResponse contains the response from method OnlineEndpointsClient.NewListPager.

type OnlineEndpointsClientRegenerateKeysResponse

type OnlineEndpointsClientRegenerateKeysResponse struct {
}

OnlineEndpointsClientRegenerateKeysResponse contains the response from method OnlineEndpointsClient.BeginRegenerateKeys.

type OnlineEndpointsClientUpdateResponse

type OnlineEndpointsClientUpdateResponse struct {
	OnlineEndpoint
}

OnlineEndpointsClientUpdateResponse contains the response from method OnlineEndpointsClient.BeginUpdate.

type OnlineRequestSettings

type OnlineRequestSettings struct {
	// The number of maximum concurrent requests per node allowed per deployment. Defaults to 1.
	MaxConcurrentRequestsPerInstance *int32

	// The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms.
	MaxQueueWait *string

	// The scoring timeout in ISO 8601 format. Defaults to 5000ms.
	RequestTimeout *string
}

OnlineRequestSettings - Online deployment scoring requests configuration.

func (OnlineRequestSettings) MarshalJSON

func (o OnlineRequestSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineRequestSettings.

func (*OnlineRequestSettings) UnmarshalJSON

func (o *OnlineRequestSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OnlineRequestSettings.

type OnlineScaleSettings

type OnlineScaleSettings struct {
	// REQUIRED; [Required] Type of deployment scaling algorithm
	ScaleType *ScaleType
}

OnlineScaleSettings - Online deployment scaling configuration.

func (*OnlineScaleSettings) GetOnlineScaleSettings

func (o *OnlineScaleSettings) GetOnlineScaleSettings() *OnlineScaleSettings

GetOnlineScaleSettings implements the OnlineScaleSettingsClassification interface for type OnlineScaleSettings.

func (OnlineScaleSettings) MarshalJSON

func (o OnlineScaleSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OnlineScaleSettings.

func (*OnlineScaleSettings) UnmarshalJSON

func (o *OnlineScaleSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

Generated from API version 2022-10-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AmlOperationListResult = armmachinelearning.AmlOperationListResult{
	// 	Value: []*armmachinelearning.AmlOperation{
	// 		{
	// 			Name: to.Ptr("Microsoft.MachineLearningServices/workspaces/write"),
	// 			Display: &armmachinelearning.AmlOperationDisplay{
	// 				Operation: to.Ptr("Create/Update Machine Learning workspaces"),
	// 				Provider: to.Ptr("Microsoft MachineLearningServices"),
	// 				Resource: to.Ptr("workspaces"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.MachineLearningServices/workspaces/delete"),
	// 			Display: &armmachinelearning.AmlOperationDisplay{
	// 				Operation: to.Ptr("Delete Machine Learning workspaces"),
	// 				Provider: to.Ptr("Microsoft MachineLearningServices"),
	// 				Resource: to.Ptr("workspaces"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.MachineLearningServices/workspaces/listkeys/action"),
	// 			Display: &armmachinelearning.AmlOperationDisplay{
	// 				Operation: to.Ptr("List workspace Keys"),
	// 				Provider: to.Ptr("Microsoft MachineLearningServices"),
	// 				Resource: to.Ptr("workspaces"),
	// 			},
	// 	}},
	// }
}
Output:

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	// An array of operations supported by the resource provider.
	AmlOperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

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

	// ARM resource ID of the job.
	JobID *string

	// The path of the file/directory in the job output.
	Path *string
}

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

	// Category of the connection
	Category    *ConnectionCategory
	Credentials *WorkspaceConnectionPersonalAccessToken
	Target      *string

	// Value details of the workspace connection.
	Value *string

	// format for the workspace connection value
	ValueFormat *ValueFormat
}

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

	// An array of Machine Learning compute objects wrapped in ARM resource envelope.
	Value []*ComputeResource
}

PaginatedComputeResourcesList - Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.

func (PaginatedComputeResourcesList) MarshalJSON

func (p PaginatedComputeResourcesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PaginatedComputeResourcesList.

func (*PaginatedComputeResourcesList) UnmarshalJSON

func (p *PaginatedComputeResourcesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PaginatedComputeResourcesList.

type PartialBatchDeployment

type PartialBatchDeployment struct {
	// Description of the endpoint deployment.
	Description *string
}

PartialBatchDeployment - Mutable batch inference settings per deployment.

func (PartialBatchDeployment) MarshalJSON

func (p PartialBatchDeployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartialBatchDeployment.

func (*PartialBatchDeployment) UnmarshalJSON

func (p *PartialBatchDeployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartialBatchDeployment.

type PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties

type PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties struct {
	// Additional attributes of the entity.
	Properties *PartialBatchDeployment

	// Resource tags.
	Tags map[string]*string
}

PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties - Strictly used in update requests.

func (PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties.

func (*PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties.

type PartialManagedServiceIdentity

type PartialManagedServiceIdentity struct {
	// Managed service identity (system assigned and/or user assigned identities)
	Type *ManagedServiceIdentityType

	// 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]any
}

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.

func (*PartialManagedServiceIdentity) UnmarshalJSON

func (p *PartialManagedServiceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartialManagedServiceIdentity.

type PartialMinimalTrackedResource

type PartialMinimalTrackedResource struct {
	// Resource tags.
	Tags map[string]*string
}

PartialMinimalTrackedResource - Strictly used in update requests.

func (PartialMinimalTrackedResource) MarshalJSON

func (p PartialMinimalTrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartialMinimalTrackedResource.

func (*PartialMinimalTrackedResource) UnmarshalJSON

func (p *PartialMinimalTrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartialMinimalTrackedResource.

type PartialMinimalTrackedResourceWithIdentity

type PartialMinimalTrackedResourceWithIdentity struct {
	// Managed service identity (system assigned and/or user assigned identities)
	Identity *PartialManagedServiceIdentity

	// Resource tags.
	Tags map[string]*string
}

PartialMinimalTrackedResourceWithIdentity - Strictly used in update requests.

func (PartialMinimalTrackedResourceWithIdentity) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PartialMinimalTrackedResourceWithIdentity.

func (*PartialMinimalTrackedResourceWithIdentity) UnmarshalJSON

func (p *PartialMinimalTrackedResourceWithIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartialMinimalTrackedResourceWithIdentity.

type PartialMinimalTrackedResourceWithSKU

type PartialMinimalTrackedResourceWithSKU struct {
	// Sku details required for ARM contract for Autoscaling.
	SKU *PartialSKU

	// Resource tags.
	Tags map[string]*string
}

PartialMinimalTrackedResourceWithSKU - Strictly used in update requests.

func (PartialMinimalTrackedResourceWithSKU) MarshalJSON

func (p PartialMinimalTrackedResourceWithSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartialMinimalTrackedResourceWithSKU.

func (*PartialMinimalTrackedResourceWithSKU) UnmarshalJSON

func (p *PartialMinimalTrackedResourceWithSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// If the service has different generations of hardware, for the same SKU, then that can be captured here.
	Family *string

	// The name of the SKU. Ex - P3. It is typically a letter+number code.
	Name *string

	// The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
	Size *string

	// 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
}

PartialSKU - Common SKU definition.

func (PartialSKU) MarshalJSON

func (p PartialSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PartialSKU.

func (*PartialSKU) UnmarshalJSON

func (p *PartialSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PartialSKU.

type Password

type Password struct {
	// READ-ONLY
	Name *string

	// READ-ONLY
	Value *string
}

func (Password) MarshalJSON

func (p Password) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Password.

func (*Password) UnmarshalJSON

func (p *Password) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Password.

type PersonalComputeInstanceSettings

type PersonalComputeInstanceSettings struct {
	// A user explicitly assigned to a personal compute instance.
	AssignedUser *AssignedUser
}

PersonalComputeInstanceSettings - Settings for a personal compute instance.

func (PersonalComputeInstanceSettings) MarshalJSON

func (p PersonalComputeInstanceSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PersonalComputeInstanceSettings.

func (*PersonalComputeInstanceSettings) UnmarshalJSON

func (p *PersonalComputeInstanceSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PersonalComputeInstanceSettings.

type PipelineJob

type PipelineJob struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobType *JobType

	// ARM resource ID of the component resource.
	ComponentID *string

	// ARM resource ID of the compute resource.
	ComputeID *string

	// The asset description text.
	Description *string

	// Display name of job.
	DisplayName *string

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

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification

	// Inputs for the pipeline job.
	Inputs map[string]JobInputClassification

	// Is the asset archived?
	IsArchived *bool

	// Jobs construct the Pipeline Job.
	Jobs map[string]any

	// Outputs for the pipeline job
	Outputs map[string]JobOutputClassification

	// The asset property dictionary.
	Properties map[string]*string

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

	// Pipeline settings, for things like ContinueRunOnStepFailure etc.
	Settings any

	// ARM resource ID of source job.
	SourceJobID *string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Status of the job.
	Status *JobStatus
}

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

	// READ-ONLY; The ARM identifier for Subnet resource that private endpoint links to
	SubnetArmID *string
}

PrivateEndpoint - The Private Endpoint resource.

func (PrivateEndpoint) MarshalJSON

func (p PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

func (*PrivateEndpoint) UnmarshalJSON

func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity

	// Specifies the location of the resource.
	Location *string

	// Resource properties.
	Properties *PrivateEndpointConnectionProperties

	// The sku of the workspace.
	SKU *SKU

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

PrivateEndpointConnection - The Private Endpoint Connection resource.

func (PrivateEndpointConnection) MarshalJSON

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON

func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection
}

PrivateEndpointConnectionListResult - List of private endpoint connection associated with the specified workspace

func (PrivateEndpointConnectionListResult) MarshalJSON

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

func (*PrivateEndpointConnectionListResult) UnmarshalJSON

func (p *PrivateEndpointConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

func (PrivateEndpointConnectionProperties) MarshalJSON

func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON

func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armmachinelearning.PrivateEndpointConnection{
// 	Name: to.Ptr("{privateEndpointConnectionName}"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}"),
// 	Properties: &armmachinelearning.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armmachinelearning.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01"),
// 		},
// 		PrivateLinkServiceConnectionState: &armmachinelearning.PrivateLinkServiceConnectionState{
// 			Description: to.Ptr("Auto-Approved"),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr(armmachinelearning.PrivateEndpointServiceConnectionStatusApproved),
// 		},
// 		ProvisioningState: to.Ptr(armmachinelearning.PrivateEndpointConnectionProvisioningStateSucceeded),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewPrivateEndpointConnectionsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "rg-1234", "testworkspace", "{privateEndpointConnectionName}", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armmachinelearning.PrivateEndpointConnection{
// 	Name: to.Ptr("{privateEndpointConnectionName}"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}"),
// 	Properties: &armmachinelearning.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armmachinelearning.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01"),
// 		},
// 		PrivateLinkServiceConnectionState: &armmachinelearning.PrivateLinkServiceConnectionState{
// 			Description: to.Ptr("Auto-Approved"),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr(armmachinelearning.PrivateEndpointServiceConnectionStatusApproved),
// 		},
// 		ProvisioningState: to.Ptr(armmachinelearning.PrivateEndpointConnectionProvisioningStateSucceeded),
// 	},
// }
Output:

func (*PrivateEndpointConnectionsClient) NewListPager

NewListPager - List all the private endpoint connections associated with the workspace.

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListPager("rg-1234", "testworkspace", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PrivateEndpointConnectionListResult = armmachinelearning.PrivateEndpointConnectionListResult{
	// 	Value: []*armmachinelearning.PrivateEndpointConnection{
	// 		{
	// 			Name: to.Ptr("{privateEndpointConnectionName}"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}"),
	// 			Properties: &armmachinelearning.PrivateEndpointConnectionProperties{
	// 				PrivateEndpoint: &armmachinelearning.PrivateEndpoint{
	// 					ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armmachinelearning.PrivateLinkServiceConnectionState{
	// 					Description: to.Ptr("Auto-Approved"),
	// 					ActionsRequired: to.Ptr("None"),
	// 					Status: to.Ptr(armmachinelearning.PrivateEndpointServiceConnectionStatusApproved),
	// 				},
	// 				ProvisioningState: to.Ptr(armmachinelearning.PrivateEndpointConnectionProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("{privateEndpointConnectionName}"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}"),
	// 			Properties: &armmachinelearning.PrivateEndpointConnectionProperties{
	// 				PrivateEndpoint: &armmachinelearning.PrivateEndpoint{
	// 					ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armmachinelearning.PrivateLinkServiceConnectionState{
	// 					Description: to.Ptr("Auto-Approved"),
	// 					ActionsRequired: to.Ptr("None"),
	// 					Status: to.Ptr(armmachinelearning.PrivateEndpointServiceConnectionStatusApproved),
	// 				},
	// 				ProvisioningState: to.Ptr(armmachinelearning.PrivateEndpointConnectionProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}
Output:

type PrivateEndpointConnectionsClientCreateOrUpdateOptions

type PrivateEndpointConnectionsClientCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	// The Private Endpoint Connection resource.
	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 {
	// The Private Endpoint Connection resource.
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListPager method.

type PrivateEndpointConnectionsClientListResponse

type PrivateEndpointConnectionsClientListResponse struct {
	// List of private endpoint connection associated with the specified workspace
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.NewListPager.

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

	// Specifies the location of the resource.
	Location *string

	// Resource properties.
	Properties *PrivateLinkResourceProperties

	// The sku of the workspace.
	SKU *SKU

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON

func (p PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON

func (p *PrivateLinkResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource
}

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

func (*PrivateLinkResourceListResult) UnmarshalJSON

func (p *PrivateLinkResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string

	// READ-ONLY; The private link resource group id.
	GroupID *string

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string
}

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.

func (*PrivateLinkResourceProperties) UnmarshalJSON

func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkResourcesClient().List(ctx, "rg-1234", "testworkspace", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateLinkResourceListResult = armmachinelearning.PrivateLinkResourceListResult{
// 	Value: []*armmachinelearning.PrivateLinkResource{
// 		{
// 			Name: to.Ptr("amlworkspace"),
// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/privateLinkResources"),
// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateLinkResources/amlworkspace"),
// 			Properties: &armmachinelearning.PrivateLinkResourceProperties{
// 				GroupID: to.Ptr("amlworkspace"),
// 				RequiredMembers: []*string{
// 					to.Ptr("default")},
// 				},
// 		}},
// 	}
Output:

type PrivateLinkResourcesClientListOptions

type PrivateLinkResourcesClientListOptions struct {
}

PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

type PrivateLinkResourcesClientListResponse

type PrivateLinkResourcesClientListResponse struct {
	// A list of private link resources
	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

	// The reason for approval/rejection of the connection.
	Description *string

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

func (PrivateLinkServiceConnectionState) MarshalJSON

func (p PrivateLinkServiceConnectionState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionState.

func (*PrivateLinkServiceConnectionState) UnmarshalJSON

func (p *PrivateLinkServiceConnectionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnectionState.

type ProbeSettings

type ProbeSettings struct {
	// The number of failures to allow before returning an unhealthy status.
	FailureThreshold *int32

	// The delay before the first probe in ISO 8601 format.
	InitialDelay *string

	// The length of time between probes in ISO 8601 format.
	Period *string

	// The number of successful probes before returning a healthy status.
	SuccessThreshold *int32

	// The probe timeout in ISO 8601 format.
	Timeout *string
}

ProbeSettings - Deployment container liveness/readiness probe configuration.

func (ProbeSettings) MarshalJSON

func (p ProbeSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProbeSettings.

func (*ProbeSettings) UnmarshalJSON

func (p *ProbeSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProbeSettings.

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 PublicNetworkAccessType

type PublicNetworkAccessType string

PublicNetworkAccessType - Enum to determine whether PublicNetworkAccess is Enabled or Disabled.

const (
	PublicNetworkAccessTypeDisabled PublicNetworkAccessType = "Disabled"
	PublicNetworkAccessTypeEnabled  PublicNetworkAccessType = "Enabled"
)

func PossiblePublicNetworkAccessTypeValues

func PossiblePublicNetworkAccessTypeValues() []PublicNetworkAccessType

PossiblePublicNetworkAccessTypeValues returns the possible values for the PublicNetworkAccessType const type.

type PyTorch

type PyTorch struct {
	// REQUIRED; [Required] Specifies the type of distribution framework.
	DistributionType *DistributionType

	// Number of processes per node.
	ProcessCountPerInstance *int32
}

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

	// The maximum permitted quota of the resource.
	Limit *int64

	// Specifies the resource type.
	Type *string

	// An enum describing the unit of quota measurement.
	Unit *QuotaUnit
}

QuotaBaseProperties - The properties for Quota update or retrieval.

func (QuotaBaseProperties) MarshalJSON

func (q QuotaBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaBaseProperties.

func (*QuotaBaseProperties) UnmarshalJSON

func (q *QuotaBaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QuotaBaseProperties.

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

	// The list for update quota.
	Value []*QuotaBaseProperties
}

QuotaUpdateParameters - Quota update parameters.

func (QuotaUpdateParameters) MarshalJSON

func (q QuotaUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaUpdateParameters.

func (*QuotaUpdateParameters) UnmarshalJSON

func (q *QuotaUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

Generated from API version 2022-10-01

  • location - The location for which resource usage is queried.
  • options - QuotasClientListOptions contains the optional parameters for the QuotasClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewQuotasClient().NewListPager("eastus", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ListWorkspaceQuotas = armmachinelearning.ListWorkspaceQuotas{
	// 	Value: []*armmachinelearning.ResourceQuota{
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](48),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_D_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](12),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_D_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](12),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quota"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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](12),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](12),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_Dv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_Dv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_FSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_FSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](12),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NCv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NCv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NCv3_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NCv3_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_ND_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_ND_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NDv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NDv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NV_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 			},
	// 			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_NV_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.ResourceName{
	// 				LocalizedValue: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/quotas"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
	// 	}},
	// }
}
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewQuotasClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.UpdateWorkspaceQuotasResult = armmachinelearning.UpdateWorkspaceQuotasResult{
// 	Value: []*armmachinelearning.UpdateWorkspaceQuotas{
// 		{
// 			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),
// 			Status: to.Ptr(armmachinelearning.StatusSuccess),
// 			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),
// 			Status: to.Ptr(armmachinelearning.StatusSuccess),
// 			Unit: to.Ptr(armmachinelearning.QuotaUnitCount),
// 	}},
// }
Output:

type QuotasClientListOptions

type QuotasClientListOptions struct {
}

QuotasClientListOptions contains the optional parameters for the QuotasClient.NewListPager method.

type QuotasClientListResponse

type QuotasClientListResponse struct {
	// The List WorkspaceQuotasByVMFamily operation response.
	ListWorkspaceQuotas
}

QuotasClientListResponse contains the response from method QuotasClient.NewListPager.

type QuotasClientUpdateOptions

type QuotasClientUpdateOptions struct {
}

QuotasClientUpdateOptions contains the optional parameters for the QuotasClient.Update method.

type QuotasClientUpdateResponse

type QuotasClientUpdateResponse struct {
	// The result of update workspace quota.
	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

	// The specific type of random algorithm
	Rule *RandomSamplingAlgorithmRule

	// An optional integer to use as the seed for random number generation
	Seed *int32
}

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 RecurrenceFrequency

type RecurrenceFrequency string

RecurrenceFrequency - Enum to describe the frequency of a recurrence schedule

const (
	// RecurrenceFrequencyDay - Day frequency
	RecurrenceFrequencyDay RecurrenceFrequency = "Day"
	// RecurrenceFrequencyHour - Hour frequency
	RecurrenceFrequencyHour RecurrenceFrequency = "Hour"
	// RecurrenceFrequencyMinute - Minute frequency
	RecurrenceFrequencyMinute RecurrenceFrequency = "Minute"
	// RecurrenceFrequencyMonth - Month frequency
	RecurrenceFrequencyMonth RecurrenceFrequency = "Month"
	// RecurrenceFrequencyWeek - Week frequency
	RecurrenceFrequencyWeek RecurrenceFrequency = "Week"
)

func PossibleRecurrenceFrequencyValues

func PossibleRecurrenceFrequencyValues() []RecurrenceFrequency

PossibleRecurrenceFrequencyValues returns the possible values for the RecurrenceFrequency const type.

type RecurrenceSchedule

type RecurrenceSchedule struct {
	// REQUIRED; [Required] List of hours for the schedule.
	Hours []*int32

	// REQUIRED; [Required] List of minutes for the schedule.
	Minutes []*int32

	// List of month days for the schedule
	MonthDays []*int32

	// List of days for the schedule.
	WeekDays []*WeekDay
}

func (RecurrenceSchedule) MarshalJSON

func (r RecurrenceSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecurrenceSchedule.

func (*RecurrenceSchedule) UnmarshalJSON

func (r *RecurrenceSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecurrenceSchedule.

type RecurrenceTrigger

type RecurrenceTrigger struct {
	// REQUIRED; [Required] The frequency to trigger schedule.
	Frequency *RecurrenceFrequency

	// REQUIRED; [Required] Specifies schedule interval in conjunction with frequency
	Interval *int32

	// REQUIRED; [Required]
	TriggerType *TriggerType

	// Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented
	// format would be "2022-06-01T00:00:01" If not present, the schedule will
	// run indefinitely
	EndTime *string

	// The recurrence schedule.
	Schedule *RecurrenceSchedule

	// Specifies start time of schedule in ISO 8601 format, but without a UTC offset.
	StartTime *string

	// Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer:
	// https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11
	TimeZone *string
}

func (*RecurrenceTrigger) GetTriggerBase

func (r *RecurrenceTrigger) GetTriggerBase() *TriggerBase

GetTriggerBase implements the TriggerBaseClassification interface for type RecurrenceTrigger.

func (RecurrenceTrigger) MarshalJSON

func (r RecurrenceTrigger) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecurrenceTrigger.

func (*RecurrenceTrigger) UnmarshalJSON

func (r *RecurrenceTrigger) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecurrenceTrigger.

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

	// The value the key is set to.
	KeyValue *string
}

func (RegenerateEndpointKeysRequest) MarshalJSON

func (r RegenerateEndpointKeysRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegenerateEndpointKeysRequest.

func (*RegenerateEndpointKeysRequest) UnmarshalJSON

func (r *RegenerateEndpointKeysRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegenerateEndpointKeysRequest.

type RegistryListCredentialsResult

type RegistryListCredentialsResult struct {
	Passwords []*Password

	// READ-ONLY
	Location *string

	// READ-ONLY
	Username *string
}

func (RegistryListCredentialsResult) MarshalJSON

func (r RegistryListCredentialsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegistryListCredentialsResult.

func (*RegistryListCredentialsResult) UnmarshalJSON

func (r *RegistryListCredentialsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegistryListCredentialsResult.

type Regression

type Regression struct {
	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Columns to use for CVSplit data.
	CvSplitColumnNames []*string

	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *TableVerticalFeaturizationSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *TableVerticalLimitSettings

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Number of cross validation folds to be applied on training dataset when validation dataset is not provided.
	NCrossValidations NCrossValidationsClassification

	// Primary metric for regression task.
	PrimaryMetric *RegressionPrimaryMetrics

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Test data input.
	TestData *MLTableJobInput

	// The fraction of test dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied when
	// validation dataset is not provided.
	TestDataSize *float64

	// Inputs for training phase for an AutoML Job.
	TrainingSettings *RegressionTrainingSettings

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64

	// The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to
	// be weighted up or down.
	WeightColumnName *string
}

Regression task in AutoML Table vertical.

func (*Regression) GetAutoMLVertical

func (r *Regression) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type Regression.

func (Regression) MarshalJSON

func (r Regression) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Regression.

func (*Regression) UnmarshalJSON

func (r *Regression) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Regression.

type RegressionModels

type RegressionModels string

RegressionModels - Enum for all Regression models supported by AutoML.

const (
	// RegressionModelsDecisionTree - Decision Trees are a non-parametric supervised learning method used for both classification
	// and regression tasks.
	// The goal is to create a model that predicts the value of a target variable by learning simple decision rules inferred from
	// the data features.
	RegressionModelsDecisionTree RegressionModels = "DecisionTree"
	// RegressionModelsElasticNet - Elastic net is a popular type of regularized linear regression that combines two popular penalties,
	// specifically the L1 and L2 penalty functions.
	RegressionModelsElasticNet RegressionModels = "ElasticNet"
	// RegressionModelsExtremeRandomTrees - Extreme Trees is an ensemble machine learning algorithm that combines the predictions
	// from many decision trees. It is related to the widely used random forest algorithm.
	RegressionModelsExtremeRandomTrees RegressionModels = "ExtremeRandomTrees"
	// RegressionModelsGradientBoosting - The technique of transiting week learners into a strong learner is called Boosting.
	// The gradient boosting algorithm process works on this theory of execution.
	RegressionModelsGradientBoosting RegressionModels = "GradientBoosting"
	// RegressionModelsKNN - K-nearest neighbors (KNN) algorithm uses 'feature similarity' to predict the values of new datapoints
	// which further means that the new data point will be assigned a value based on how closely it matches the points in the
	// training set.
	RegressionModelsKNN RegressionModels = "KNN"
	// RegressionModelsLassoLars - Lasso model fit with Least Angle Regression a.k.a. Lars. It is a Linear Model trained with
	// an L1 prior as regularizer.
	RegressionModelsLassoLars RegressionModels = "LassoLars"
	// RegressionModelsLightGBM - LightGBM is a gradient boosting framework that uses tree based learning algorithms.
	RegressionModelsLightGBM RegressionModels = "LightGBM"
	// RegressionModelsRandomForest - Random forest is a supervised learning algorithm.
	// The "forest" it builds, is an ensemble of decision trees, usually trained with the “bagging” method.
	// The general idea of the bagging method is that a combination of learning models increases the overall result.
	RegressionModelsRandomForest RegressionModels = "RandomForest"
	// RegressionModelsSGD - SGD: Stochastic gradient descent is an optimization algorithm often used in machine learning applications
	// to find the model parameters that correspond to the best fit between predicted and actual outputs.
	// It's an inexact but powerful technique.
	RegressionModelsSGD RegressionModels = "SGD"
	// RegressionModelsXGBoostRegressor - XGBoostRegressor: Extreme Gradient Boosting Regressor is a supervised machine learning
	// model using ensemble of base learners.
	RegressionModelsXGBoostRegressor RegressionModels = "XGBoostRegressor"
)

func PossibleRegressionModelsValues

func PossibleRegressionModelsValues() []RegressionModels

PossibleRegressionModelsValues returns the possible values for the RegressionModels const type.

type RegressionPrimaryMetrics

type RegressionPrimaryMetrics string

RegressionPrimaryMetrics - Primary metrics for Regression task.

const (
	// RegressionPrimaryMetricsNormalizedMeanAbsoluteError - The Normalized Mean Absolute Error (NMAE) is a validation metric
	// to compare the Mean Absolute Error (MAE) of (time) series with different scales.
	RegressionPrimaryMetricsNormalizedMeanAbsoluteError RegressionPrimaryMetrics = "NormalizedMeanAbsoluteError"
	// RegressionPrimaryMetricsNormalizedRootMeanSquaredError - The Normalized Root Mean Squared Error (NRMSE) the RMSE facilitates
	// the comparison between models with different scales.
	RegressionPrimaryMetricsNormalizedRootMeanSquaredError RegressionPrimaryMetrics = "NormalizedRootMeanSquaredError"
	// RegressionPrimaryMetricsR2Score - The R2 score is one of the performance evaluation measures for forecasting-based machine
	// learning models.
	RegressionPrimaryMetricsR2Score RegressionPrimaryMetrics = "R2Score"
	// RegressionPrimaryMetricsSpearmanCorrelation - The Spearman's rank coefficient of correlation is a nonparametric measure
	// of rank correlation.
	RegressionPrimaryMetricsSpearmanCorrelation RegressionPrimaryMetrics = "SpearmanCorrelation"
)

func PossibleRegressionPrimaryMetricsValues

func PossibleRegressionPrimaryMetricsValues() []RegressionPrimaryMetrics

PossibleRegressionPrimaryMetricsValues returns the possible values for the RegressionPrimaryMetrics const type.

type RegressionTrainingSettings

type RegressionTrainingSettings struct {
	// Allowed models for regression task.
	AllowedTrainingAlgorithms []*RegressionModels

	// Blocked models for regression task.
	BlockedTrainingAlgorithms []*RegressionModels

	// Enable recommendation of DNN models.
	EnableDnnTraining *bool

	// Flag to turn on explainability on best model.
	EnableModelExplainability *bool

	// Flag for enabling onnx compatible models.
	EnableOnnxCompatibleModels *bool

	// Enable stack ensemble run.
	EnableStackEnsemble *bool

	// Enable voting ensemble run.
	EnableVoteEnsemble *bool

	// During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.
	// Configure this parameter with a higher value than 300 secs, if more time
	// is needed.
	EnsembleModelDownloadTimeout *string

	// Stack ensemble settings for stack ensemble run.
	StackEnsembleSettings *StackEnsembleSettings
}

RegressionTrainingSettings - Regression Training related configuration.

func (RegressionTrainingSettings) MarshalJSON

func (r RegressionTrainingSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RegressionTrainingSettings.

func (*RegressionTrainingSettings) UnmarshalJSON

func (r *RegressionTrainingSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegressionTrainingSettings.

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

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceBase

type ResourceBase struct {
	// The asset description text.
	Description *string

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

func (ResourceBase) MarshalJSON

func (r ResourceBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceBase.

func (*ResourceBase) UnmarshalJSON

func (r *ResourceBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceBase.

type ResourceConfiguration

type ResourceConfiguration struct {
	// Optional number of instances or nodes used by the compute target.
	InstanceCount *int32

	// Optional type of VM used as supported by the compute target.
	InstanceType *string

	// Additional properties bag.
	Properties map[string]any
}

func (ResourceConfiguration) MarshalJSON

func (r ResourceConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceConfiguration.

func (*ResourceConfiguration) UnmarshalJSON

func (r *ResourceConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceConfiguration.

type ResourceID

type ResourceID struct {
	// REQUIRED; The ID of the resource
	ID *string
}

ResourceID - Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

func (ResourceID) MarshalJSON

func (r ResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceID.

func (*ResourceID) UnmarshalJSON

func (r *ResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceID.

type ResourceName

type ResourceName struct {
	// READ-ONLY; The localized name of the resource.
	LocalizedValue *string

	// READ-ONLY; The name of the resource.
	Value *string
}

ResourceName - The Resource Name.

func (ResourceName) MarshalJSON

func (r ResourceName) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceName.

func (*ResourceName) UnmarshalJSON

func (r *ResourceName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceName.

type ResourceQuota

type ResourceQuota struct {
	// READ-ONLY; Region of the AML workspace in the id.
	AmlWorkspaceLocation *string

	// READ-ONLY; Specifies the resource ID.
	ID *string

	// READ-ONLY; The maximum permitted quota of the resource.
	Limit *int64

	// READ-ONLY; Name of the resource.
	Name *ResourceName

	// READ-ONLY; Specifies the resource type.
	Type *string

	// READ-ONLY; An enum describing the unit of quota measurement.
	Unit *QuotaUnit
}

ResourceQuota - The quota assigned to a resource.

func (ResourceQuota) MarshalJSON

func (r ResourceQuota) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceQuota.

func (*ResourceQuota) UnmarshalJSON

func (r *ResourceQuota) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceQuota.

type Route

type Route struct {
	// REQUIRED; [Required] The path for the route.
	Path *string

	// REQUIRED; [Required] The port for the route.
	Port *int32
}

func (Route) MarshalJSON

func (r Route) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Route.

func (*Route) UnmarshalJSON

func (r *Route) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Route.

type SASAuthTypeWorkspaceConnectionProperties

type SASAuthTypeWorkspaceConnectionProperties struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType

	// Category of the connection
	Category    *ConnectionCategory
	Credentials *WorkspaceConnectionSharedAccessSignature
	Target      *string

	// Value details of the workspace connection.
	Value *string

	// format for the workspace connection value
	ValueFormat *ValueFormat
}

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

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

	// If the service has different generations of hardware, for the same SKU, then that can be captured here.
	Family *string

	// The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
	Size *string

	// 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
}

SKU - The resource model definition representing SKU

func (SKU) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SKUCapacity

type SKUCapacity struct {
	// Gets or sets the default capacity.
	Default *int32

	// Gets or sets the maximum.
	Maximum *int32

	// Gets or sets the minimum.
	Minimum *int32

	// Gets or sets the type of the scale.
	ScaleType *SKUScaleType
}

SKUCapacity - SKU capacity information

func (SKUCapacity) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKUCapacity.

func (*SKUCapacity) UnmarshalJSON

func (s *SKUCapacity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUCapacity.

type SKUResource

type SKUResource struct {
	// Gets or sets the Sku Capacity.
	Capacity *SKUCapacity

	// Gets or sets the Sku.
	SKU *SKUSetting

	// READ-ONLY; The resource type name.
	ResourceType *string
}

SKUResource - Fulfills ARM Contract requirement to list all available SKUS for a resource.

func (SKUResource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKUResource.

func (*SKUResource) UnmarshalJSON

func (s *SKUResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUResource.

type SKUResourceArmPaginatedResult

type SKUResourceArmPaginatedResult struct {
	// The link to the next page of SkuResource objects. If null, there are no additional pages.
	NextLink *string

	// An array of objects of type SkuResource.
	Value []*SKUResource
}

SKUResourceArmPaginatedResult - A paginated list of SkuResource entities.

func (SKUResourceArmPaginatedResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKUResourceArmPaginatedResult.

func (*SKUResourceArmPaginatedResult) UnmarshalJSON

func (s *SKUResourceArmPaginatedResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUResourceArmPaginatedResult.

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

	// 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
}

SKUSetting - SkuSetting fulfills the need for stripped down SKU info in ARM contract.

func (SKUSetting) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SKUSetting.

func (*SKUSetting) UnmarshalJSON

func (s *SKUSetting) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUSetting.

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 (
	SKUTierBasic    SKUTier = "Basic"
	SKUTierFree     SKUTier = "Free"
	SKUTierPremium  SKUTier = "Premium"
	SKUTierStandard SKUTier = "Standard"
)

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

	// CNAME of the cert
	Cname *string

	// Key data
	Key *string

	// Leaf domain label of public endpoint
	LeafDomainLabel *string

	// Indicates whether to overwrite existing domain label.
	OverwriteExistingDomain *bool

	// Enable or disable ssl for scoring
	Status *SSLConfigStatus
}

SSLConfiguration - The ssl configuration for scoring

func (SSLConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SSLConfiguration.

func (*SSLConfiguration) UnmarshalJSON

func (s *SSLConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SSLConfiguration.

type SamplingAlgorithm

type SamplingAlgorithm struct {
	// REQUIRED; [Required] The algorithm used for generating hyperparameter values, along with configuration properties
	SamplingAlgorithmType *SamplingAlgorithmType
}

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.

func (SamplingAlgorithm) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SamplingAlgorithm.

func (*SamplingAlgorithm) UnmarshalJSON

func (s *SamplingAlgorithm) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

	// REQUIRED; [Required] Storage container secrets.
	Secrets *SasDatastoreSecrets
}

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

	// Storage container SAS token.
	SasToken *string
}

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

	// Min number of nodes to use
	MinNodeCount *int32

	// Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.
	NodeIdleTimeBeforeScaleDown *string
}

ScaleSettings - scale settings for AML Compute

func (ScaleSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScaleSettings.

func (*ScaleSettings) UnmarshalJSON

func (s *ScaleSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScaleSettings.

type ScaleSettingsInformation

type ScaleSettingsInformation struct {
	// scale settings for AML Compute
	ScaleSettings *ScaleSettings
}

ScaleSettingsInformation - Desired scale settings for the amlCompute.

func (ScaleSettingsInformation) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScaleSettingsInformation.

func (*ScaleSettingsInformation) UnmarshalJSON

func (s *ScaleSettingsInformation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScaleSettingsInformation.

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 Schedule

type Schedule struct {
	// REQUIRED; [Required] Additional attributes of the entity.
	Properties *ScheduleProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Schedule - Azure Resource Manager resource envelope.

func (Schedule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Schedule.

func (*Schedule) UnmarshalJSON

func (s *Schedule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Schedule.

type ScheduleActionBase

type ScheduleActionBase struct {
	// REQUIRED; [Required] Specifies the action type of the schedule
	ActionType *ScheduleActionType
}

func (*ScheduleActionBase) GetScheduleActionBase

func (s *ScheduleActionBase) GetScheduleActionBase() *ScheduleActionBase

GetScheduleActionBase implements the ScheduleActionBaseClassification interface for type ScheduleActionBase.

func (ScheduleActionBase) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScheduleActionBase.

func (*ScheduleActionBase) UnmarshalJSON

func (s *ScheduleActionBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleActionBase.

type ScheduleActionBaseClassification

type ScheduleActionBaseClassification interface {
	// GetScheduleActionBase returns the ScheduleActionBase content of the underlying type.
	GetScheduleActionBase() *ScheduleActionBase
}

ScheduleActionBaseClassification provides polymorphic access to related types. Call the interface's GetScheduleActionBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EndpointScheduleAction, *JobScheduleAction, *ScheduleActionBase

type ScheduleActionType

type ScheduleActionType string
const (
	ScheduleActionTypeCreateJob           ScheduleActionType = "CreateJob"
	ScheduleActionTypeInvokeBatchEndpoint ScheduleActionType = "InvokeBatchEndpoint"
)

func PossibleScheduleActionTypeValues

func PossibleScheduleActionTypeValues() []ScheduleActionType

PossibleScheduleActionTypeValues returns the possible values for the ScheduleActionType const type.

type ScheduleBase

type ScheduleBase struct {
	// A system assigned id for the schedule.
	ID *string

	// The current deployment state of schedule.
	ProvisioningStatus *ScheduleProvisioningState

	// Is the schedule enabled or disabled?
	Status *ScheduleStatus
}

func (ScheduleBase) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScheduleBase.

func (*ScheduleBase) UnmarshalJSON

func (s *ScheduleBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleBase.

type ScheduleListViewType

type ScheduleListViewType string
const (
	ScheduleListViewTypeAll          ScheduleListViewType = "All"
	ScheduleListViewTypeDisabledOnly ScheduleListViewType = "DisabledOnly"
	ScheduleListViewTypeEnabledOnly  ScheduleListViewType = "EnabledOnly"
)

func PossibleScheduleListViewTypeValues

func PossibleScheduleListViewTypeValues() []ScheduleListViewType

PossibleScheduleListViewTypeValues returns the possible values for the ScheduleListViewType const type.

type ScheduleProperties

type ScheduleProperties struct {
	// REQUIRED; [Required] Specifies the action of the schedule
	Action ScheduleActionBaseClassification

	// REQUIRED; [Required] Specifies the trigger details
	Trigger TriggerBaseClassification

	// The asset description text.
	Description *string

	// Display name of schedule.
	DisplayName *string

	// Is the schedule enabled?
	IsEnabled *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Provisioning state for the schedule.
	ProvisioningState *ScheduleProvisioningStatus
}

ScheduleProperties - Base definition of a schedule

func (ScheduleProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScheduleProperties.

func (*ScheduleProperties) UnmarshalJSON

func (s *ScheduleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleProperties.

type ScheduleProvisioningState

type ScheduleProvisioningState string

ScheduleProvisioningState - The current deployment state of schedule.

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 ScheduleProvisioningStatus

type ScheduleProvisioningStatus string
const (
	ScheduleProvisioningStatusCanceled  ScheduleProvisioningStatus = "Canceled"
	ScheduleProvisioningStatusCreating  ScheduleProvisioningStatus = "Creating"
	ScheduleProvisioningStatusDeleting  ScheduleProvisioningStatus = "Deleting"
	ScheduleProvisioningStatusFailed    ScheduleProvisioningStatus = "Failed"
	ScheduleProvisioningStatusSucceeded ScheduleProvisioningStatus = "Succeeded"
	ScheduleProvisioningStatusUpdating  ScheduleProvisioningStatus = "Updating"
)

func PossibleScheduleProvisioningStatusValues

func PossibleScheduleProvisioningStatusValues() []ScheduleProvisioningStatus

PossibleScheduleProvisioningStatusValues returns the possible values for the ScheduleProvisioningStatus const type.

type ScheduleResourceArmPaginatedResult

type ScheduleResourceArmPaginatedResult struct {
	// The link to the next page of Schedule objects. If null, there are no additional pages.
	NextLink *string

	// An array of objects of type Schedule.
	Value []*Schedule
}

ScheduleResourceArmPaginatedResult - A paginated list of Schedule entities.

func (ScheduleResourceArmPaginatedResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScheduleResourceArmPaginatedResult.

func (*ScheduleResourceArmPaginatedResult) UnmarshalJSON

func (s *ScheduleResourceArmPaginatedResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScheduleResourceArmPaginatedResult.

type ScheduleStatus

type ScheduleStatus string

ScheduleStatus - Is the schedule enabled or disabled?

const (
	ScheduleStatusDisabled ScheduleStatus = "Disabled"
	ScheduleStatusEnabled  ScheduleStatus = "Enabled"
)

func PossibleScheduleStatusValues

func PossibleScheduleStatusValues() []ScheduleStatus

PossibleScheduleStatusValues returns the possible values for the ScheduleStatus const type.

type SchedulesClient

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

SchedulesClient contains the methods for the Schedules group. Don't use this type directly, use NewSchedulesClient() instead.

func NewSchedulesClient

func NewSchedulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SchedulesClient, error)

NewSchedulesClient creates a new instance of SchedulesClient 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 (*SchedulesClient) BeginCreateOrUpdate

func (client *SchedulesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, name string, body Schedule, options *SchedulesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SchedulesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-10-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - Name of Azure Machine Learning workspace.
  • name - Schedule name.
  • body - Schedule definition.
  • options - SchedulesClientBeginCreateOrUpdateOptions contains the optional parameters for the SchedulesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Schedule/createOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSchedulesClient().BeginCreateOrUpdate(ctx, "test-rg", "my-aml-workspace", "string", armmachinelearning.Schedule{
	Properties: &armmachinelearning.ScheduleProperties{
		Description: to.Ptr("string"),
		Properties: map[string]*string{
			"string": to.Ptr("string"),
		},
		Tags: map[string]*string{
			"string": to.Ptr("string"),
		},
		Action: &armmachinelearning.EndpointScheduleAction{
			ActionType: to.Ptr(armmachinelearning.ScheduleActionTypeInvokeBatchEndpoint),
			EndpointInvocationDefinition: map[string]any{
				"9965593e-526f-4b89-bb36-761138cf2794": nil,
			},
		},
		DisplayName: to.Ptr("string"),
		IsEnabled:   to.Ptr(false),
		Trigger: &armmachinelearning.CronTrigger{
			EndTime:     to.Ptr("string"),
			StartTime:   to.Ptr("string"),
			TimeZone:    to.Ptr("string"),
			TriggerType: to.Ptr(armmachinelearning.TriggerTypeCron),
			Expression:  to.Ptr("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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Schedule = armmachinelearning.Schedule{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeKey),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeApplication),
// 	},
// 	Properties: &armmachinelearning.ScheduleProperties{
// 		Description: to.Ptr("string"),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Tags: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Action: &armmachinelearning.EndpointScheduleAction{
// 			ActionType: to.Ptr(armmachinelearning.ScheduleActionTypeInvokeBatchEndpoint),
// 			EndpointInvocationDefinition: map[string]any{
// 				"d77a9a9a-4bb5-4c0c-8a77-459be8b82b9f": nil,
// 			},
// 		},
// 		DisplayName: to.Ptr("string"),
// 		IsEnabled: to.Ptr(false),
// 		ProvisioningState: to.Ptr(armmachinelearning.ScheduleProvisioningStatusSucceeded),
// 		Trigger: &armmachinelearning.CronTrigger{
// 			EndTime: to.Ptr("string"),
// 			StartTime: to.Ptr("string"),
// 			TimeZone: to.Ptr("string"),
// 			TriggerType: to.Ptr(armmachinelearning.TriggerTypeCron),
// 			Expression: to.Ptr("string"),
// 		},
// 	},
// }
Output:

func (*SchedulesClient) BeginDelete

func (client *SchedulesClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *SchedulesClientBeginDeleteOptions) (*runtime.Poller[SchedulesClientDeleteResponse], error)

BeginDelete - Delete schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-10-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - Name of Azure Machine Learning workspace.
  • name - Schedule name.
  • options - SchedulesClientBeginDeleteOptions contains the optional parameters for the SchedulesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Schedule/delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSchedulesClient().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 (*SchedulesClient) Get

func (client *SchedulesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, name string, options *SchedulesClientGetOptions) (SchedulesClientGetResponse, error)

Get - Get schedule. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-10-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - Name of Azure Machine Learning workspace.
  • name - Schedule name.
  • options - SchedulesClientGetOptions contains the optional parameters for the SchedulesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Schedule/get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSchedulesClient().Get(ctx, "test-rg", "my-aml-workspace", "string", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Schedule = armmachinelearning.Schedule{
// 	Name: to.Ptr("string"),
// 	Type: to.Ptr("string"),
// 	ID: to.Ptr("string"),
// 	SystemData: &armmachinelearning.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		CreatedBy: to.Ptr("string"),
// 		CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeKey),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
// 		LastModifiedBy: to.Ptr("string"),
// 		LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeKey),
// 	},
// 	Properties: &armmachinelearning.ScheduleProperties{
// 		Description: to.Ptr("string"),
// 		Properties: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Tags: map[string]*string{
// 			"string": to.Ptr("string"),
// 		},
// 		Action: &armmachinelearning.EndpointScheduleAction{
// 			ActionType: to.Ptr(armmachinelearning.ScheduleActionTypeInvokeBatchEndpoint),
// 			EndpointInvocationDefinition: map[string]any{
// 				"a108545b-def1-4c86-8e53-dbcb1de3a8bc": nil,
// 			},
// 		},
// 		DisplayName: to.Ptr("string"),
// 		IsEnabled: to.Ptr(false),
// 		ProvisioningState: to.Ptr(armmachinelearning.ScheduleProvisioningStatusSucceeded),
// 		Trigger: &armmachinelearning.CronTrigger{
// 			EndTime: to.Ptr("string"),
// 			StartTime: to.Ptr("string"),
// 			TimeZone: to.Ptr("string"),
// 			TriggerType: to.Ptr(armmachinelearning.TriggerTypeCron),
// 			Expression: to.Ptr("string"),
// 		},
// 	},
// }
Output:

func (*SchedulesClient) NewListPager

func (client *SchedulesClient) NewListPager(resourceGroupName string, workspaceName string, options *SchedulesClientListOptions) *runtime.Pager[SchedulesClientListResponse]

NewListPager - List schedules in specified workspace.

Generated from API version 2022-10-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • workspaceName - Name of Azure Machine Learning workspace.
  • options - SchedulesClientListOptions contains the optional parameters for the SchedulesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-01/examples/Schedule/list.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSchedulesClient().NewListPager("test-rg", "my-aml-workspace", &armmachinelearning.SchedulesClientListOptions{Skip: nil,
	ListViewType: nil,
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ScheduleResourceArmPaginatedResult = armmachinelearning.ScheduleResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.Schedule{
	// 		{
	// 			Name: to.Ptr("string"),
	// 			Type: to.Ptr("string"),
	// 			ID: to.Ptr("string"),
	// 			SystemData: &armmachinelearning.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				CreatedBy: to.Ptr("string"),
	// 				CreatedByType: to.Ptr(armmachinelearning.CreatedByTypeKey),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:34:56.999Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("string"),
	// 				LastModifiedByType: to.Ptr(armmachinelearning.CreatedByTypeApplication),
	// 			},
	// 			Properties: &armmachinelearning.ScheduleProperties{
	// 				Description: to.Ptr("string"),
	// 				Properties: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 				Tags: map[string]*string{
	// 					"string": to.Ptr("string"),
	// 				},
	// 				Action: &armmachinelearning.EndpointScheduleAction{
	// 					ActionType: to.Ptr(armmachinelearning.ScheduleActionTypeInvokeBatchEndpoint),
	// 					EndpointInvocationDefinition: map[string]any{
	// 						"00cd1396-a094-4d48-8d86-14c43a55a6af": nil,
	// 					},
	// 				},
	// 				DisplayName: to.Ptr("string"),
	// 				IsEnabled: to.Ptr(false),
	// 				ProvisioningState: to.Ptr(armmachinelearning.ScheduleProvisioningStatusSucceeded),
	// 				Trigger: &armmachinelearning.CronTrigger{
	// 					EndTime: to.Ptr("string"),
	// 					StartTime: to.Ptr("string"),
	// 					TimeZone: to.Ptr("string"),
	// 					TriggerType: to.Ptr(armmachinelearning.TriggerTypeCron),
	// 					Expression: to.Ptr("string"),
	// 				},
	// 			},
	// 	}},
	// }
}
Output:

type SchedulesClientBeginCreateOrUpdateOptions

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

SchedulesClientBeginCreateOrUpdateOptions contains the optional parameters for the SchedulesClient.BeginCreateOrUpdate method.

type SchedulesClientBeginDeleteOptions

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

SchedulesClientBeginDeleteOptions contains the optional parameters for the SchedulesClient.BeginDelete method.

type SchedulesClientCreateOrUpdateResponse

type SchedulesClientCreateOrUpdateResponse struct {
	// Azure Resource Manager resource envelope.
	Schedule
}

SchedulesClientCreateOrUpdateResponse contains the response from method SchedulesClient.BeginCreateOrUpdate.

type SchedulesClientDeleteResponse

type SchedulesClientDeleteResponse struct {
}

SchedulesClientDeleteResponse contains the response from method SchedulesClient.BeginDelete.

type SchedulesClientGetOptions

type SchedulesClientGetOptions struct {
}

SchedulesClientGetOptions contains the optional parameters for the SchedulesClient.Get method.

type SchedulesClientGetResponse

type SchedulesClientGetResponse struct {
	// Azure Resource Manager resource envelope.
	Schedule
}

SchedulesClientGetResponse contains the response from method SchedulesClient.Get.

type SchedulesClientListOptions

type SchedulesClientListOptions struct {
	// Status filter for schedule.
	ListViewType *ScheduleListViewType

	// Continuation token for pagination.
	Skip *string
}

SchedulesClientListOptions contains the optional parameters for the SchedulesClient.NewListPager method.

type SchedulesClientListResponse

type SchedulesClientListResponse struct {
	// A paginated list of Schedule entities.
	ScheduleResourceArmPaginatedResult
}

SchedulesClientListResponse contains the response from method SchedulesClient.NewListPager.

type ScriptReference

type ScriptReference struct {
	// Optional command line arguments passed to the script to run.
	ScriptArguments *string

	// The location of scripts in the mounted volume.
	ScriptData *string

	// The storage source of the script: workspace.
	ScriptSource *string

	// Optional time period passed to timeout command.
	Timeout *string
}

ScriptReference - Script reference

func (ScriptReference) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScriptReference.

func (*ScriptReference) UnmarshalJSON

func (s *ScriptReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScriptReference.

type ScriptsToExecute

type ScriptsToExecute struct {
	// Script that's run only once during provision of the compute.
	CreationScript *ScriptReference

	// Script that's run every time the machine starts.
	StartupScript *ScriptReference
}

ScriptsToExecute - Customized setup scripts

func (ScriptsToExecute) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ScriptsToExecute.

func (*ScriptsToExecute) UnmarshalJSON

func (s *ScriptsToExecute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScriptsToExecute.

type Seasonality

type Seasonality struct {
	// REQUIRED; [Required] Seasonality mode.
	Mode *SeasonalityMode
}

Seasonality - Forecasting seasonality.

func (*Seasonality) GetSeasonality

func (s *Seasonality) GetSeasonality() *Seasonality

GetSeasonality implements the SeasonalityClassification interface for type Seasonality.

func (Seasonality) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Seasonality.

func (*Seasonality) UnmarshalJSON

func (s *Seasonality) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Seasonality.

type SeasonalityClassification

type SeasonalityClassification interface {
	// GetSeasonality returns the Seasonality content of the underlying type.
	GetSeasonality() *Seasonality
}

SeasonalityClassification provides polymorphic access to related types. Call the interface's GetSeasonality() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AutoSeasonality, *CustomSeasonality, *Seasonality

type SeasonalityMode

type SeasonalityMode string

SeasonalityMode - Forecasting seasonality mode.

const (
	// SeasonalityModeAuto - Seasonality to be determined automatically.
	SeasonalityModeAuto SeasonalityMode = "Auto"
	// SeasonalityModeCustom - Use the custom seasonality value.
	SeasonalityModeCustom SeasonalityMode = "Custom"
)

func PossibleSeasonalityModeValues

func PossibleSeasonalityModeValues() []SeasonalityMode

PossibleSeasonalityModeValues returns the possible values for the SeasonalityMode const type.

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
}

func (ServiceManagedResourcesSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ServiceManagedResourcesSettings.

func (*ServiceManagedResourcesSettings) UnmarshalJSON

func (s *ServiceManagedResourcesSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceManagedResourcesSettings.

type ServicePrincipalDatastoreCredentials

type ServicePrincipalDatastoreCredentials struct {
	// REQUIRED; [Required] Service principal client ID.
	ClientID *string

	// REQUIRED; [Required] Credential type used to authentication with storage.
	CredentialsType *CredentialsType

	// REQUIRED; [Required] Service principal secrets.
	Secrets *ServicePrincipalDatastoreSecrets

	// REQUIRED; [Required] ID of the tenant to which the service principal belongs.
	TenantID *string

	// Authority URL used for authentication.
	AuthorityURL *string

	// Resource the service principal has access to.
	ResourceURL *string
}

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

	// Service principal secret.
	ClientSecret *string
}

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
}

SetupScripts - Details of customized scripts to execute for setting up the cluster.

func (SetupScripts) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SetupScripts.

func (*SetupScripts) UnmarshalJSON

func (s *SetupScripts) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SetupScripts.

type SharedPrivateLinkResource

type SharedPrivateLinkResource struct {
	// Unique name of the private link.
	Name *string

	// Resource properties.
	Properties *SharedPrivateLinkResourceProperty
}

func (SharedPrivateLinkResource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SharedPrivateLinkResource.

func (*SharedPrivateLinkResource) UnmarshalJSON

func (s *SharedPrivateLinkResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SharedPrivateLinkResource.

type SharedPrivateLinkResourceProperty

type SharedPrivateLinkResourceProperty struct {
	// The private link resource group id.
	GroupID *string

	// The resource id that private link links to.
	PrivateLinkResourceID *string

	// Request message.
	RequestMessage *string

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus
}

SharedPrivateLinkResourceProperty - Properties of a shared private link resource.

func (SharedPrivateLinkResourceProperty) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SharedPrivateLinkResourceProperty.

func (*SharedPrivateLinkResourceProperty) UnmarshalJSON

func (s *SharedPrivateLinkResourceProperty) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SharedPrivateLinkResourceProperty.

type ShortSeriesHandlingConfiguration

type ShortSeriesHandlingConfiguration string

ShortSeriesHandlingConfiguration - The parameter defining how if AutoML should handle short time series.

const (
	// ShortSeriesHandlingConfigurationAuto - Short series will be padded if there are no long series, otherwise short series
	// will be dropped.
	ShortSeriesHandlingConfigurationAuto ShortSeriesHandlingConfiguration = "Auto"
	// ShortSeriesHandlingConfigurationDrop - All the short series will be dropped.
	ShortSeriesHandlingConfigurationDrop ShortSeriesHandlingConfiguration = "Drop"
	// ShortSeriesHandlingConfigurationNone - Represents no/null value.
	ShortSeriesHandlingConfigurationNone ShortSeriesHandlingConfiguration = "None"
	// ShortSeriesHandlingConfigurationPad - All the short series will be padded.
	ShortSeriesHandlingConfigurationPad ShortSeriesHandlingConfiguration = "Pad"
)

func PossibleShortSeriesHandlingConfigurationValues

func PossibleShortSeriesHandlingConfigurationValues() []ShortSeriesHandlingConfiguration

PossibleShortSeriesHandlingConfigurationValues returns the possible values for the ShortSeriesHandlingConfiguration const type.

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 StackEnsembleSettings

type StackEnsembleSettings struct {
	// Optional parameters to pass to the initializer of the meta-learner.
	StackMetaLearnerKWargs any

	// Specifies the proportion of the training set (when choosing train and validation type of training) to be reserved for training
	// the meta-learner. Default value is 0.2.
	StackMetaLearnerTrainPercentage *float64

	// The meta-learner is a model trained on the output of the individual heterogeneous models.
	StackMetaLearnerType *StackMetaLearnerType
}

StackEnsembleSettings - Advances setting to customize StackEnsemble run.

func (StackEnsembleSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type StackEnsembleSettings.

func (*StackEnsembleSettings) UnmarshalJSON

func (s *StackEnsembleSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StackEnsembleSettings.

type StackMetaLearnerType

type StackMetaLearnerType string

StackMetaLearnerType - The meta-learner is a model trained on the output of the individual heterogeneous models. Default meta-learners are LogisticRegression for classification tasks (or LogisticRegressionCV if cross-validation is enabled) and ElasticNet for regression/forecasting tasks (or ElasticNetCV if cross-validation is enabled). This parameter can be one of the following strings: LogisticRegression, LogisticRegressionCV, LightGBMClassifier, ElasticNet, ElasticNetCV, LightGBMRegressor, or LinearRegression

const (
	// StackMetaLearnerTypeElasticNet - Default meta-learners are LogisticRegression for regression task.
	StackMetaLearnerTypeElasticNet StackMetaLearnerType = "ElasticNet"
	// StackMetaLearnerTypeElasticNetCV - Default meta-learners are LogisticRegression for regression task when CV is on.
	StackMetaLearnerTypeElasticNetCV       StackMetaLearnerType = "ElasticNetCV"
	StackMetaLearnerTypeLightGBMClassifier StackMetaLearnerType = "LightGBMClassifier"
	StackMetaLearnerTypeLightGBMRegressor  StackMetaLearnerType = "LightGBMRegressor"
	StackMetaLearnerTypeLinearRegression   StackMetaLearnerType = "LinearRegression"
	// StackMetaLearnerTypeLogisticRegression - Default meta-learners are LogisticRegression for classification tasks.
	StackMetaLearnerTypeLogisticRegression StackMetaLearnerType = "LogisticRegression"
	// StackMetaLearnerTypeLogisticRegressionCV - Default meta-learners are LogisticRegression for classification task when CV
	// is on.
	StackMetaLearnerTypeLogisticRegressionCV StackMetaLearnerType = "LogisticRegressionCV"
	StackMetaLearnerTypeNone                 StackMetaLearnerType = "None"
)

func PossibleStackMetaLearnerTypeValues

func PossibleStackMetaLearnerTypeValues() []StackMetaLearnerType

PossibleStackMetaLearnerTypeValues returns the possible values for the StackMetaLearnerType 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 StochasticOptimizer

type StochasticOptimizer string

StochasticOptimizer - Stochastic optimizer for image models.

const (
	// StochasticOptimizerAdam - Adam is algorithm the optimizes stochastic objective functions based on adaptive estimates of
	// moments
	StochasticOptimizerAdam StochasticOptimizer = "Adam"
	// StochasticOptimizerAdamw - AdamW is a variant of the optimizer Adam that has an improved implementation of weight decay.
	StochasticOptimizerAdamw StochasticOptimizer = "Adamw"
	// StochasticOptimizerNone - No optimizer selected.
	StochasticOptimizerNone StochasticOptimizer = "None"
	// StochasticOptimizerSgd - Stochastic Gradient Descent optimizer.
	StochasticOptimizerSgd StochasticOptimizer = "Sgd"
)

func PossibleStochasticOptimizerValues

func PossibleStochasticOptimizerValues() []StochasticOptimizer

PossibleStochasticOptimizerValues returns the possible values for the StochasticOptimizer 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

	// REQUIRED; [Required] Optimization objective.
	Objective *Objective

	// REQUIRED; [Required] The hyperparameter sampling algorithm
	SamplingAlgorithm SamplingAlgorithmClassification

	// REQUIRED; [Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the
	// parameter
	SearchSpace any

	// REQUIRED; [Required] Trial component definition.
	Trial *TrialComponent

	// ARM resource ID of the component resource.
	ComponentID *string

	// ARM resource ID of the compute resource.
	ComputeID *string

	// The asset description text.
	Description *string

	// Display name of job.
	DisplayName *string

	// Early termination policies enable canceling poor-performing runs before they complete
	EarlyTermination EarlyTerminationPolicyClassification

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

	// Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken
	// if null.
	Identity IdentityConfigurationClassification

	// Mapping of input data bindings used in the job.
	Inputs map[string]JobInputClassification

	// Is the asset archived?
	IsArchived *bool

	// Sweep Job limit.
	Limits *SweepJobLimits

	// Mapping of output data bindings used in the job.
	Outputs map[string]JobOutputClassification

	// The asset property dictionary.
	Properties map[string]*string

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

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string

	// READ-ONLY; Status of the job.
	Status *JobStatus
}

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

	// Sweep Job max concurrent trials.
	MaxConcurrentTrials *int32

	// Sweep Job max total trials.
	MaxTotalTrials *int32

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

	// Sweep Job Trial timeout value.
	TrialTimeout *string
}

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

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool
	Properties       *SynapseSparkProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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

	// Auto scale properties.
	AutoScaleProperties *AutoScaleProperties

	// The number of compute nodes currently assigned to the compute.
	NodeCount *int32

	// Node size.
	NodeSize *string

	// Node size family.
	NodeSizeFamily *string

	// Pool name.
	PoolName *string

	// Name of the resource group in which workspace is located.
	ResourceGroup *string

	// Spark version.
	SparkVersion *string

	// Azure subscription identifier.
	SubscriptionID *string

	// Name of Azure Machine Learning workspace.
	WorkspaceName *string
}

func (SynapseSparkProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SynapseSparkProperties.

func (*SynapseSparkProperties) UnmarshalJSON

func (s *SynapseSparkProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SynapseSparkProperties.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

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

	// READ-ONLY; The type of this system service.
	SystemServiceType *string

	// READ-ONLY; The version for this type.
	Version *string
}

SystemService - A system service running on a compute.

func (SystemService) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SystemService.

func (*SystemService) UnmarshalJSON

func (s *SystemService) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemService.

type TableVertical

type TableVertical struct {
	// Columns to use for CVSplit data.
	CvSplitColumnNames []*string

	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *TableVerticalFeaturizationSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *TableVerticalLimitSettings

	// Number of cross validation folds to be applied on training dataset when validation dataset is not provided.
	NCrossValidations NCrossValidationsClassification

	// Test data input.
	TestData *MLTableJobInput

	// The fraction of test dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied when
	// validation dataset is not provided.
	TestDataSize *float64

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// The fraction of training dataset that needs to be set aside for validation purpose. Values between (0.0 , 1.0) Applied
	// when validation dataset is not provided.
	ValidationDataSize *float64

	// The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to
	// be weighted up or down.
	WeightColumnName *string
}

TableVertical - Abstract class for AutoML tasks that use table dataset as input - such as Classification/Regression/Forecasting.

func (TableVertical) MarshalJSON

func (t TableVertical) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TableVertical.

func (*TableVertical) UnmarshalJSON

func (t *TableVertical) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TableVertical.

type TableVerticalFeaturizationSettings

type TableVerticalFeaturizationSettings struct {
	// These transformers shall not be used in featurization.
	BlockedTransformers []*BlockedTransformers

	// Dictionary of column name and its type (int, float, string, datetime etc).
	ColumnNameAndTypes map[string]*string

	// Dataset language, useful for the text data.
	DatasetLanguage *string

	// Determines whether to use Dnn based featurizers for data featurization.
	EnableDnnFeaturization *bool

	// Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the
	// data in featurization phase. If 'Off' is selected then no featurization is done.
	// If 'Custom' is selected then user can specify additional inputs to customize how featurization is done.
	Mode *FeaturizationMode

	// User can specify additional transformers to be used along with the columns to which it would be applied and parameters
	// for the transformer constructor.
	TransformerParams map[string][]*ColumnTransformer
}

TableVerticalFeaturizationSettings - Featurization Configuration.

func (TableVerticalFeaturizationSettings) MarshalJSON

func (t TableVerticalFeaturizationSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TableVerticalFeaturizationSettings.

func (*TableVerticalFeaturizationSettings) UnmarshalJSON

func (t *TableVerticalFeaturizationSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TableVerticalFeaturizationSettings.

type TableVerticalLimitSettings

type TableVerticalLimitSettings struct {
	// Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement
	// in last 20 iterations.
	EnableEarlyTermination *bool

	// Exit score for the AutoML job.
	ExitScore *float64

	// Maximum Concurrent iterations.
	MaxConcurrentTrials *int32

	// Max cores per iteration.
	MaxCoresPerTrial *int32

	// Number of iterations.
	MaxTrials *int32

	// AutoML job timeout.
	Timeout *string

	// Iteration timeout.
	TrialTimeout *string
}

TableVerticalLimitSettings - Job execution constraints.

func (TableVerticalLimitSettings) MarshalJSON

func (t TableVerticalLimitSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TableVerticalLimitSettings.

func (*TableVerticalLimitSettings) UnmarshalJSON

func (t *TableVerticalLimitSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TableVerticalLimitSettings.

type TargetAggregationFunction

type TargetAggregationFunction string

TargetAggregationFunction - Target aggregate function.

const (
	TargetAggregationFunctionMax  TargetAggregationFunction = "Max"
	TargetAggregationFunctionMean TargetAggregationFunction = "Mean"
	TargetAggregationFunctionMin  TargetAggregationFunction = "Min"
	// TargetAggregationFunctionNone - Represent no value set.
	TargetAggregationFunctionNone TargetAggregationFunction = "None"
	TargetAggregationFunctionSum  TargetAggregationFunction = "Sum"
)

func PossibleTargetAggregationFunctionValues

func PossibleTargetAggregationFunctionValues() []TargetAggregationFunction

PossibleTargetAggregationFunctionValues returns the possible values for the TargetAggregationFunction const type.

type TargetLags

type TargetLags struct {
	// REQUIRED; [Required] Set target lags mode - Auto/Custom
	Mode *TargetLagsMode
}

TargetLags - The number of past periods to lag from the target column.

func (*TargetLags) GetTargetLags

func (t *TargetLags) GetTargetLags() *TargetLags

GetTargetLags implements the TargetLagsClassification interface for type TargetLags.

func (TargetLags) MarshalJSON

func (t TargetLags) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TargetLags.

func (*TargetLags) UnmarshalJSON

func (t *TargetLags) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TargetLags.

type TargetLagsClassification

type TargetLagsClassification interface {
	// GetTargetLags returns the TargetLags content of the underlying type.
	GetTargetLags() *TargetLags
}

TargetLagsClassification provides polymorphic access to related types. Call the interface's GetTargetLags() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AutoTargetLags, *CustomTargetLags, *TargetLags

type TargetLagsMode

type TargetLagsMode string

TargetLagsMode - Target lags selection modes.

const (
	// TargetLagsModeAuto - Target lags to be determined automatically.
	TargetLagsModeAuto TargetLagsMode = "Auto"
	// TargetLagsModeCustom - Use the custom target lags.
	TargetLagsModeCustom TargetLagsMode = "Custom"
)

func PossibleTargetLagsModeValues

func PossibleTargetLagsModeValues() []TargetLagsMode

PossibleTargetLagsModeValues returns the possible values for the TargetLagsMode const type.

type TargetRollingWindowSize

type TargetRollingWindowSize struct {
	// REQUIRED; [Required] TargetRollingWindowSiz detection mode.
	Mode *TargetRollingWindowSizeMode
}

TargetRollingWindowSize - Forecasting target rolling window size.

func (*TargetRollingWindowSize) GetTargetRollingWindowSize

func (t *TargetRollingWindowSize) GetTargetRollingWindowSize() *TargetRollingWindowSize

GetTargetRollingWindowSize implements the TargetRollingWindowSizeClassification interface for type TargetRollingWindowSize.

func (TargetRollingWindowSize) MarshalJSON

func (t TargetRollingWindowSize) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TargetRollingWindowSize.

func (*TargetRollingWindowSize) UnmarshalJSON

func (t *TargetRollingWindowSize) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TargetRollingWindowSize.

type TargetRollingWindowSizeClassification

type TargetRollingWindowSizeClassification interface {
	// GetTargetRollingWindowSize returns the TargetRollingWindowSize content of the underlying type.
	GetTargetRollingWindowSize() *TargetRollingWindowSize
}

TargetRollingWindowSizeClassification provides polymorphic access to related types. Call the interface's GetTargetRollingWindowSize() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AutoTargetRollingWindowSize, *CustomTargetRollingWindowSize, *TargetRollingWindowSize

type TargetRollingWindowSizeMode

type TargetRollingWindowSizeMode string

TargetRollingWindowSizeMode - Target rolling windows size mode.

const (
	// TargetRollingWindowSizeModeAuto - Determine rolling windows size automatically.
	TargetRollingWindowSizeModeAuto TargetRollingWindowSizeMode = "Auto"
	// TargetRollingWindowSizeModeCustom - Use the specified rolling window size.
	TargetRollingWindowSizeModeCustom TargetRollingWindowSizeMode = "Custom"
)

func PossibleTargetRollingWindowSizeModeValues

func PossibleTargetRollingWindowSizeModeValues() []TargetRollingWindowSizeMode

PossibleTargetRollingWindowSizeModeValues returns the possible values for the TargetRollingWindowSizeMode const type.

type TargetUtilizationScaleSettings

type TargetUtilizationScaleSettings struct {
	// REQUIRED; [Required] Type of deployment scaling algorithm
	ScaleType *ScaleType

	// The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances.
	MaxInstances *int32

	// The minimum number of instances to always be present.
	MinInstances *int32

	// The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds.
	PollingInterval *string

	// Target CPU usage for the autoscaler.
	TargetUtilizationPercentage *int32
}

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 TaskType

type TaskType string

TaskType - AutoMLJob Task type.

const (
	// TaskTypeClassification - Classification in machine learning and statistics is a supervised learning approach in which
	// the computer program learns from the data given to it and make new observations or classifications.
	TaskTypeClassification TaskType = "Classification"
	// TaskTypeForecasting - Forecasting is a special kind of regression task that deals with time-series data and creates forecasting
	// model
	// that can be used to predict the near future values based on the inputs.
	TaskTypeForecasting TaskType = "Forecasting"
	// TaskTypeImageClassification - Image Classification. Multi-class image classification is used when an image is classified
	// with only a single label
	// from a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'.
	TaskTypeImageClassification TaskType = "ImageClassification"
	// TaskTypeImageClassificationMultilabel - Image Classification Multilabel. Multi-label image classification is used when
	// an image could have one or more labels
	// from a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'.
	TaskTypeImageClassificationMultilabel TaskType = "ImageClassificationMultilabel"
	// TaskTypeImageInstanceSegmentation - Image Instance Segmentation. Instance segmentation is used to identify objects in an
	// image at the pixel level,
	// drawing a polygon around each object in the image.
	TaskTypeImageInstanceSegmentation TaskType = "ImageInstanceSegmentation"
	// TaskTypeImageObjectDetection - Image Object Detection. Object detection is used to identify objects in an image and locate
	// each object with a
	// bounding box e.g. locate all dogs and cats in an image and draw a bounding box around each.
	TaskTypeImageObjectDetection TaskType = "ImageObjectDetection"
	// TaskTypeRegression - Regression means to predict the value using the input data. Regression models are used to predict
	// a continuous value.
	TaskTypeRegression TaskType = "Regression"
	// TaskTypeTextClassification - Text classification (also known as text tagging or text categorization) is the process of
	// sorting texts into categories.
	// Categories are mutually exclusive.
	TaskTypeTextClassification TaskType = "TextClassification"
	// TaskTypeTextClassificationMultilabel - Multilabel classification task assigns each sample to a group (zero or more) of
	// target labels.
	TaskTypeTextClassificationMultilabel TaskType = "TextClassificationMultilabel"
	// TaskTypeTextNER - Text Named Entity Recognition a.k.a. TextNER.
	// Named Entity Recognition (NER) is the ability to take free-form text and identify the occurrences of entities such as people,
	// locations, organizations, and more.
	TaskTypeTextNER TaskType = "TextNER"
)

func PossibleTaskTypeValues

func PossibleTaskTypeValues() []TaskType

PossibleTaskTypeValues returns the possible values for the TaskType const type.

type TensorFlow

type TensorFlow struct {
	// REQUIRED; [Required] Specifies the type of distribution framework.
	DistributionType *DistributionType

	// Number of parameter server tasks.
	ParameterServerCount *int32

	// Number of workers. If not specified, will default to the instance count.
	WorkerCount *int32
}

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 TextClassification

type TextClassification struct {
	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *NlpVerticalFeaturizationSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *NlpVerticalLimitSettings

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Primary metric for Text-Classification task.
	PrimaryMetric *ClassificationPrimaryMetrics

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Validation data inputs.
	ValidationData *MLTableJobInput
}

TextClassification - Text Classification task in AutoML NLP vertical. NLP - Natural Language Processing.

func (*TextClassification) GetAutoMLVertical

func (t *TextClassification) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type TextClassification.

func (TextClassification) MarshalJSON

func (t TextClassification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TextClassification.

func (*TextClassification) UnmarshalJSON

func (t *TextClassification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TextClassification.

type TextClassificationMultilabel

type TextClassificationMultilabel struct {
	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *NlpVerticalFeaturizationSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *NlpVerticalLimitSettings

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// READ-ONLY; Primary metric for Text-Classification-Multilabel task. Currently only Accuracy is supported as primary metric,
	// hence user need not set it explicitly.
	PrimaryMetric *ClassificationMultilabelPrimaryMetrics
}

TextClassificationMultilabel - Text Classification Multilabel task in AutoML NLP vertical. NLP - Natural Language Processing.

func (*TextClassificationMultilabel) GetAutoMLVertical

func (t *TextClassificationMultilabel) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type TextClassificationMultilabel.

func (TextClassificationMultilabel) MarshalJSON

func (t TextClassificationMultilabel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TextClassificationMultilabel.

func (*TextClassificationMultilabel) UnmarshalJSON

func (t *TextClassificationMultilabel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TextClassificationMultilabel.

type TextNer

type TextNer struct {
	// REQUIRED; [Required] Task type for AutoMLJob.
	TaskType *TaskType

	// REQUIRED; [Required] Training data input.
	TrainingData *MLTableJobInput

	// Featurization inputs needed for AutoML job.
	FeaturizationSettings *NlpVerticalFeaturizationSettings

	// Execution constraints for AutoMLJob.
	LimitSettings *NlpVerticalLimitSettings

	// Log verbosity for the job.
	LogVerbosity *LogVerbosity

	// Target column name: This is prediction values column. Also known as label column name in context of classification tasks.
	TargetColumnName *string

	// Validation data inputs.
	ValidationData *MLTableJobInput

	// READ-ONLY; Primary metric for Text-NER task. Only 'Accuracy' is supported for Text-NER, so user need not set this explicitly.
	PrimaryMetric *ClassificationPrimaryMetrics
}

TextNer - Text-NER task in AutoML NLP vertical. NER - Named Entity Recognition. NLP - Natural Language Processing.

func (*TextNer) GetAutoMLVertical

func (t *TextNer) GetAutoMLVertical() *AutoMLVertical

GetAutoMLVertical implements the AutoMLVerticalClassification interface for type TextNer.

func (TextNer) MarshalJSON

func (t TextNer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TextNer.

func (*TextNer) UnmarshalJSON

func (t *TextNer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TextNer.

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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.

func (*TrackedResource) UnmarshalJSON

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type TrainingSettings

type TrainingSettings struct {
	// Enable recommendation of DNN models.
	EnableDnnTraining *bool

	// Flag to turn on explainability on best model.
	EnableModelExplainability *bool

	// Flag for enabling onnx compatible models.
	EnableOnnxCompatibleModels *bool

	// Enable stack ensemble run.
	EnableStackEnsemble *bool

	// Enable voting ensemble run.
	EnableVoteEnsemble *bool

	// During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded.
	// Configure this parameter with a higher value than 300 secs, if more time
	// is needed.
	EnsembleModelDownloadTimeout *string

	// Stack ensemble settings for stack ensemble run.
	StackEnsembleSettings *StackEnsembleSettings
}

TrainingSettings - Training related configuration.

func (TrainingSettings) MarshalJSON

func (t TrainingSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrainingSettings.

func (*TrainingSettings) UnmarshalJSON

func (t *TrainingSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrainingSettings.

type TrialComponent

type TrialComponent struct {
	// REQUIRED; [Required] The command to execute on startup of the job. eg. "python train.py"
	Command *string

	// REQUIRED; [Required] The ARM resource ID of the Environment specification for the job.
	EnvironmentID *string

	// ARM resource ID of the code asset.
	CodeID *string

	// Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.
	Distribution DistributionConfigurationClassification

	// Environment variables included in the job.
	EnvironmentVariables map[string]*string

	// Compute Resource configuration for the job.
	Resources *JobResourceConfiguration
}

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 TriggerBase

type TriggerBase struct {
	// REQUIRED; [Required]
	TriggerType *TriggerType

	// Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented
	// format would be "2022-06-01T00:00:01" If not present, the schedule will
	// run indefinitely
	EndTime *string

	// Specifies start time of schedule in ISO 8601 format, but without a UTC offset.
	StartTime *string

	// Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer:
	// https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11
	TimeZone *string
}

func (*TriggerBase) GetTriggerBase

func (t *TriggerBase) GetTriggerBase() *TriggerBase

GetTriggerBase implements the TriggerBaseClassification interface for type TriggerBase.

func (TriggerBase) MarshalJSON

func (t TriggerBase) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggerBase.

func (*TriggerBase) UnmarshalJSON

func (t *TriggerBase) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TriggerBase.

type TriggerBaseClassification

type TriggerBaseClassification interface {
	// GetTriggerBase returns the TriggerBase content of the underlying type.
	GetTriggerBase() *TriggerBase
}

TriggerBaseClassification provides polymorphic access to related types. Call the interface's GetTriggerBase() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CronTrigger, *RecurrenceTrigger, *TriggerBase

type TriggerType

type TriggerType string
const (
	TriggerTypeCron       TriggerType = "Cron"
	TriggerTypeRecurrence TriggerType = "Recurrence"
)

func PossibleTriggerTypeValues

func PossibleTriggerTypeValues() []TriggerType

PossibleTriggerTypeValues returns the possible values for the TriggerType const type.

type TritonModelJobInput

type TritonModelJobInput struct {
	// REQUIRED; [Required] Specifies the type of job.
	JobInputType *JobInputType

	// REQUIRED; [Required] Input Asset URI.
	URI *string

	// Description for the input.
	Description *string

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode
}

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

	// Description for the output.
	Description *string

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode

	// Output Asset URI.
	URI *string
}

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

	// Number of intervals by which to delay the first evaluation.
	DelayEvaluation *int32

	// Interval (number of runs) between policy evaluations.
	EvaluationInterval *int32

	// The percentage of runs to cancel at each evaluation interval.
	TruncationPercentage *int32
}

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

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20221001.Assets.DataVersionBase.DataType
	DataURI *string

	// The asset description text.
	Description *string

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

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

	// REQUIRED; [Required] Input Asset URI.
	URI *string

	// Description for the input.
	Description *string

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode
}

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

	// Description for the output.
	Description *string

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode

	// Output Asset URI.
	URI *string
}

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

	// REQUIRED; [Required] Uri of the data. Usage/meaning depends on Microsoft.MachineLearning.ManagementFrontEnd.Contracts.V20221001.Assets.DataVersionBase.DataType
	DataURI *string

	// The asset description text.
	Description *string

	// If the name version are system generated (anonymous registration).
	IsAnonymous *bool

	// Is the asset archived?
	IsArchived *bool

	// The asset property dictionary.
	Properties map[string]*string

	// Tag dictionary. Tags can be added, removed, and updated.
	Tags map[string]*string
}

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

	// REQUIRED; [Required] Input Asset URI.
	URI *string

	// Description for the input.
	Description *string

	// Input Asset Delivery Mode.
	Mode *InputDeliveryMode
}

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

	// Description for the output.
	Description *string

	// Output Asset Delivery Mode.
	Mode *OutputDeliveryMode

	// Output Asset URI.
	URI *string
}

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

	// Status of update workspace quota.
	Status *Status

	// READ-ONLY; Specifies the resource ID.
	ID *string

	// READ-ONLY; Specifies the resource type.
	Type *string

	// READ-ONLY; An enum describing the unit of quota measurement.
	Unit *QuotaUnit
}

UpdateWorkspaceQuotas - The properties for update Quota response.

func (UpdateWorkspaceQuotas) MarshalJSON

func (u UpdateWorkspaceQuotas) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateWorkspaceQuotas.

func (*UpdateWorkspaceQuotas) UnmarshalJSON

func (u *UpdateWorkspaceQuotas) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateWorkspaceQuotas.

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

	// READ-ONLY; The list of workspace quota update result.
	Value []*UpdateWorkspaceQuotas
}

UpdateWorkspaceQuotasResult - The result of update workspace quota.

func (UpdateWorkspaceQuotasResult) MarshalJSON

func (u UpdateWorkspaceQuotasResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UpdateWorkspaceQuotasResult.

func (*UpdateWorkspaceQuotasResult) UnmarshalJSON

func (u *UpdateWorkspaceQuotasResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateWorkspaceQuotasResult.

type Usage

type Usage struct {
	// READ-ONLY; Region of the AML workspace in the id.
	AmlWorkspaceLocation *string

	// READ-ONLY; The current usage of the resource.
	CurrentValue *int64

	// READ-ONLY; Specifies the resource ID.
	ID *string

	// READ-ONLY; The maximum permitted usage of the resource.
	Limit *int64

	// READ-ONLY; The name of the type of usage.
	Name *UsageName

	// READ-ONLY; Specifies the resource type.
	Type *string

	// READ-ONLY; An enum describing the unit of usage measurement.
	Unit *UsageUnit
}

Usage - Describes AML Resource Usage.

func (Usage) MarshalJSON

func (u Usage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Usage.

func (*Usage) UnmarshalJSON

func (u *Usage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Usage.

type UsageName

type UsageName struct {
	// READ-ONLY; The localized name of the resource.
	LocalizedValue *string

	// READ-ONLY; The name of the resource.
	Value *string
}

UsageName - The Usage Names.

func (UsageName) MarshalJSON

func (u UsageName) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UsageName.

func (*UsageName) UnmarshalJSON

func (u *UsageName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UsageName.

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.

Generated from API version 2022-10-01

  • location - The location for which resource usage is queried.
  • options - UsagesClientListOptions contains the optional parameters for the UsagesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewUsagesClient().NewListPager("eastus", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ListUsagesResult = armmachinelearning.ListUsagesResult{
	// 	Value: []*armmachinelearning.Usage{
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Clusters"),
	// 				Value: to.Ptr("Clusters"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/totalCores/usages"),
	// 			CurrentValue: to.Ptr[int64](7),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages"),
	// 			Limit: to.Ptr[int64](100),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Total Cluster Dedicated Regional vCPUs"),
	// 				Value: to.Ptr("Total Cluster Dedicated Regional vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/dedicatedCores/usages"),
	// 			CurrentValue: to.Ptr[int64](14),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard D Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](48),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](2),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/usages"),
	// 			CurrentValue: to.Ptr[int64](2),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes/usages"),
	// 			CurrentValue: to.Ptr[int64](2),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster2_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard Dv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard FSv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](12),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspace/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspace/computes/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/computes/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluser1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NCv3 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard ND Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NDv2 Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](0),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 				Value: to.Ptr("Standard NV Family Cluster Dedicated vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_Dedicated_vCPUs"),
	// 			Limit: to.Ptr[int64](24),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Total Cluster LowPriority Regional vCPUs"),
	// 				Value: to.Ptr("Total Cluster LowPriority Regional vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/lowPriorityCores/usages"),
	// 			CurrentValue: to.Ptr[int64](18),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages"),
	// 			Limit: to.Ptr[int64](50),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard D Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard D Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard DSv2 Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard DSv2 Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard Dv2 Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard Dv2 Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard FSv2 Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard FSv2 Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](18),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspace/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspace/computes/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspace/usages"),
	// 			CurrentValue: to.Ptr[int64](12),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspace/computes/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NC Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspace/computes/usages"),
	// 			CurrentValue: to.Ptr[int64](6),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NCv2 Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NCv2 Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NCv3 Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NCv3 Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard ND Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard ND Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NDv2 Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NDv2 Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 		},
	// 		{
	// 			Name: &armmachinelearning.UsageName{
	// 				LocalizedValue: to.Ptr("Standard NV Family Cluster LowPriority vCPUs"),
	// 				Value: to.Ptr("Standard NV Family Cluster LowPriority vCPUs"),
	// 			},
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/vmFamily/usages"),
	// 			CurrentValue: to.Ptr[int64](0),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_LowPriority_vCPUs"),
	// 			Limit: to.Ptr[int64](-1),
	// 			Unit: to.Ptr(armmachinelearning.UsageUnitCount),
	// 	}},
	// }
}
Output:

type UsagesClientListOptions

type UsagesClientListOptions struct {
}

UsagesClientListOptions contains the optional parameters for the UsagesClient.NewListPager method.

type UsagesClientListResponse

type UsagesClientListResponse struct {
	// The List Usages operation response.
	ListUsagesResult
}

UsagesClientListResponse contains the response from method UsagesClient.NewListPager.

type UseStl

type UseStl string

UseStl - Configure STL Decomposition of the time-series target column.

const (
	// UseStlNone - No stl decomposition.
	UseStlNone        UseStl = "None"
	UseStlSeason      UseStl = "Season"
	UseStlSeasonTrend UseStl = "SeasonTrend"
)

func PossibleUseStlValues

func PossibleUseStlValues() []UseStl

PossibleUseStlValues returns the possible values for the UseStl const type.

type UserAccountCredentials

type UserAccountCredentials struct {
	// REQUIRED; Name of the administrator user account which can be used to SSH to nodes.
	AdminUserName *string

	// Password of the administrator user account.
	AdminUserPassword *string

	// SSH public key of the administrator user account.
	AdminUserSSHPublicKey *string
}

UserAccountCredentials - Settings for user account that gets created on each on the nodes of a compute.

func (UserAccountCredentials) MarshalJSON

func (u UserAccountCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAccountCredentials.

func (*UserAccountCredentials) UnmarshalJSON

func (u *UserAccountCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAccountCredentials.

type UserAssignedIdentity

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string
}

UserAssignedIdentity - User assigned identity properties

func (UserAssignedIdentity) MarshalJSON

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON

func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.

type UserIdentity

type UserIdentity struct {
	// REQUIRED; [Required] Specifies the type of identity framework.
	IdentityType *IdentityConfigurationType
}

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

	// Category of the connection
	Category    *ConnectionCategory
	Credentials *WorkspaceConnectionUsernamePassword
	Target      *string

	// Value details of the workspace connection.
	Value *string

	// format for the workspace connection value
	ValueFormat *ValueFormat
}

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 ValidationMetricType

type ValidationMetricType string

ValidationMetricType - Metric computation method to use for validation metrics in image tasks.

const (
	// ValidationMetricTypeCoco - Coco metric.
	ValidationMetricTypeCoco ValidationMetricType = "Coco"
	// ValidationMetricTypeCocoVoc - CocoVoc metric.
	ValidationMetricTypeCocoVoc ValidationMetricType = "CocoVoc"
	// ValidationMetricTypeNone - No metric.
	ValidationMetricTypeNone ValidationMetricType = "None"
	// ValidationMetricTypeVoc - Voc metric.
	ValidationMetricTypeVoc ValidationMetricType = "Voc"
)

func PossibleValidationMetricTypeValues

func PossibleValidationMetricTypeValues() []ValidationMetricType

PossibleValidationMetricTypeValues returns the possible values for the ValidationMetricType 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

	// Location for the underlying compute
	ComputeLocation *string

	// The description of the Machine Learning compute.
	Description *string

	// Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
	DisableLocalAuth *bool
	Properties       *VirtualMachineSchemaProperties

	// ARM resource id of the underlying compute
	ResourceID *string

	// READ-ONLY; The time at which the compute was created.
	CreatedOn *time.Time

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

	// READ-ONLY; The time at which the compute was last modified.
	ModifiedOn *time.Time

	// READ-ONLY; Errors during provisioning
	ProvisioningErrors []*ErrorResponse

	// READ-ONLY; The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
	ProvisioningState *ProvisioningState
}

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
}

VirtualMachineImage - Virtual Machine image for Windows AML Compute

func (VirtualMachineImage) MarshalJSON

func (v VirtualMachineImage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachineImage.

func (*VirtualMachineImage) UnmarshalJSON

func (v *VirtualMachineImage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineImage.

type VirtualMachineSSHCredentials

type VirtualMachineSSHCredentials struct {
	// Password of admin account
	Password *string

	// Private key data
	PrivateKeyData *string

	// Public key data
	PublicKeyData *string

	// Username of admin account
	Username *string
}

VirtualMachineSSHCredentials - Admin credentials for virtual machine

func (VirtualMachineSSHCredentials) MarshalJSON

func (v VirtualMachineSSHCredentials) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachineSSHCredentials.

func (*VirtualMachineSSHCredentials) UnmarshalJSON

func (v *VirtualMachineSSHCredentials) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSSHCredentials.

type VirtualMachineSchema

type VirtualMachineSchema struct {
	Properties *VirtualMachineSchemaProperties
}

func (VirtualMachineSchema) MarshalJSON

func (v VirtualMachineSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachineSchema.

func (*VirtualMachineSchema) UnmarshalJSON

func (v *VirtualMachineSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSchema.

type VirtualMachineSchemaProperties

type VirtualMachineSchemaProperties struct {
	// Public IP address of the virtual machine.
	Address *string

	// Admin credentials for virtual machine
	AdministratorAccount *VirtualMachineSSHCredentials

	// Indicates whether this compute will be used for running notebooks.
	IsNotebookInstanceCompute *bool

	// Notebook server port open for ssh connections.
	NotebookServerPort *int32

	// Port open for ssh connections.
	SSHPort *int32

	// Virtual Machine size
	VirtualMachineSize *string
}

func (VirtualMachineSchemaProperties) MarshalJSON

func (v VirtualMachineSchemaProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachineSchemaProperties.

func (*VirtualMachineSchemaProperties) UnmarshalJSON

func (v *VirtualMachineSchemaProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSchemaProperties.

type VirtualMachineSecrets

type VirtualMachineSecrets struct {
	// REQUIRED; The type of compute
	ComputeType *ComputeType

	// Admin credentials for virtual machine.
	AdministratorAccount *VirtualMachineSSHCredentials
}

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

func (v VirtualMachineSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller 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
}

func (VirtualMachineSecretsSchema) MarshalJSON

func (v VirtualMachineSecretsSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachineSecretsSchema.

func (*VirtualMachineSecretsSchema) UnmarshalJSON

func (v *VirtualMachineSecretsSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSecretsSchema.

type VirtualMachineSize

type VirtualMachineSize struct {
	// The estimated price information for using a VM.
	EstimatedVMPrices *EstimatedVMPrices

	// Specifies the compute types supported by the virtual machine size.
	SupportedComputeTypes []*string

	// READ-ONLY; The family name of the virtual machine size.
	Family *string

	// READ-ONLY; The number of gPUs supported by the virtual machine size.
	Gpus *int32

	// READ-ONLY; Specifies if the virtual machine size supports low priority VMs.
	LowPriorityCapable *bool

	// READ-ONLY; The resource volume size, in MB, allowed by the virtual machine size.
	MaxResourceVolumeMB *int32

	// READ-ONLY; The amount of memory, in GB, supported by the virtual machine size.
	MemoryGB *float64

	// READ-ONLY; The name of the virtual machine size.
	Name *string

	// READ-ONLY; The OS VHD disk size, in MB, allowed by the virtual machine size.
	OSVhdSizeMB *int32

	// READ-ONLY; Specifies if the virtual machine size supports premium IO.
	PremiumIO *bool

	// READ-ONLY; The number of vCPUs supported by the virtual machine size.
	VCPUs *int32
}

VirtualMachineSize - Describes the properties of a VM size.

func (VirtualMachineSize) MarshalJSON

func (v VirtualMachineSize) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachineSize.

func (*VirtualMachineSize) UnmarshalJSON

func (v *VirtualMachineSize) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSize.

type VirtualMachineSizeListResult

type VirtualMachineSizeListResult struct {
	// The list of virtual machine sizes supported by AmlCompute.
	Value []*VirtualMachineSize
}

VirtualMachineSizeListResult - The List Virtual Machine size operation response.

func (VirtualMachineSizeListResult) MarshalJSON

func (v VirtualMachineSizeListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachineSizeListResult.

func (*VirtualMachineSizeListResult) UnmarshalJSON

func (v *VirtualMachineSizeListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSizeListResult.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewVirtualMachineSizesClient().List(ctx, "eastus", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.VirtualMachineSizeListResult = armmachinelearning.VirtualMachineSizeListResult{
// 	Value: []*armmachinelearning.VirtualMachineSize{
// 		{
// 			Name: to.Ptr("Standard_DS1_v2"),
// 			EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 				BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 				UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 				Values: []*armmachinelearning.EstimatedVMPrice{
// 					{
// 						OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 						RetailPrice: to.Ptr[float64](0.13),
// 						VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 					},
// 					{
// 						OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 						RetailPrice: to.Ptr[float64](0.01),
// 						VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 					},
// 					{
// 						OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 						RetailPrice: to.Ptr[float64](0.07),
// 						VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 					},
// 					{
// 						OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 						RetailPrice: to.Ptr[float64](0.05),
// 						VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 				}},
// 			},
// 			Family: to.Ptr("standardDSv2Family"),
// 			Gpus: to.Ptr[int32](0),
// 			LowPriorityCapable: to.Ptr(true),
// 			MaxResourceVolumeMB: to.Ptr[int32](7168),
// 			MemoryGB: to.Ptr[float64](3.5),
// 			OSVhdSizeMB: to.Ptr[int32](1047552),
// 			PremiumIO: to.Ptr(true),
// 			SupportedComputeTypes: []*string{
// 				to.Ptr("AmlCompute"),
// 				to.Ptr("ComputeInstance")},
// 				VCPUs: to.Ptr[int32](1),
// 			},
// 			{
// 				Name: to.Ptr("Standard_DS2_v2"),
// 				EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 					BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 					UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 					Values: []*armmachinelearning.EstimatedVMPrice{
// 						{
// 							OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 							RetailPrice: to.Ptr[float64](0.03),
// 							VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 						},
// 						{
// 							OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 							RetailPrice: to.Ptr[float64](0.15),
// 							VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 						},
// 						{
// 							OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 							RetailPrice: to.Ptr[float64](0.1),
// 							VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 						},
// 						{
// 							OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 							RetailPrice: to.Ptr[float64](0.25),
// 							VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 					}},
// 				},
// 				Family: to.Ptr("standardDSv2Family"),
// 				Gpus: to.Ptr[int32](0),
// 				LowPriorityCapable: to.Ptr(true),
// 				MaxResourceVolumeMB: to.Ptr[int32](14336),
// 				MemoryGB: to.Ptr[float64](7),
// 				OSVhdSizeMB: to.Ptr[int32](1047552),
// 				PremiumIO: to.Ptr(true),
// 				SupportedComputeTypes: []*string{
// 					to.Ptr("AmlCompute"),
// 					to.Ptr("ComputeInstance"),
// 					to.Ptr("MIR")},
// 					VCPUs: to.Ptr[int32](2),
// 				},
// 				{
// 					Name: to.Ptr("Standard_DS3_v2"),
// 					EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 						BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 						UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 						Values: []*armmachinelearning.EstimatedVMPrice{
// 							{
// 								OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 								RetailPrice: to.Ptr[float64](0.2),
// 								VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 							},
// 							{
// 								OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 								RetailPrice: to.Ptr[float64](0.06),
// 								VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 							},
// 							{
// 								OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 								RetailPrice: to.Ptr[float64](0.5),
// 								VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 							},
// 							{
// 								OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 								RetailPrice: to.Ptr[float64](0.29),
// 								VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 						}},
// 					},
// 					Family: to.Ptr("standardDSv2Family"),
// 					Gpus: to.Ptr[int32](0),
// 					LowPriorityCapable: to.Ptr(true),
// 					MaxResourceVolumeMB: to.Ptr[int32](28672),
// 					MemoryGB: to.Ptr[float64](14),
// 					OSVhdSizeMB: to.Ptr[int32](1047552),
// 					PremiumIO: to.Ptr(true),
// 					SupportedComputeTypes: []*string{
// 						to.Ptr("AmlCompute"),
// 						to.Ptr("ComputeInstance"),
// 						to.Ptr("MIR")},
// 						VCPUs: to.Ptr[int32](4),
// 					},
// 					{
// 						Name: to.Ptr("Standard_DS4_v2"),
// 						EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 							BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 							UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 							Values: []*armmachinelearning.EstimatedVMPrice{
// 								{
// 									OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 									RetailPrice: to.Ptr[float64](0.12),
// 									VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 								},
// 								{
// 									OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 									RetailPrice: to.Ptr[float64](0.4),
// 									VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 								},
// 								{
// 									OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 									RetailPrice: to.Ptr[float64](1.01),
// 									VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 								},
// 								{
// 									OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 									RetailPrice: to.Ptr[float64](0.58),
// 									VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 							}},
// 						},
// 						Family: to.Ptr("standardDSv2Family"),
// 						Gpus: to.Ptr[int32](0),
// 						LowPriorityCapable: to.Ptr(true),
// 						MaxResourceVolumeMB: to.Ptr[int32](57344),
// 						MemoryGB: to.Ptr[float64](28),
// 						OSVhdSizeMB: to.Ptr[int32](1047552),
// 						PremiumIO: to.Ptr(true),
// 						SupportedComputeTypes: []*string{
// 							to.Ptr("AmlCompute"),
// 							to.Ptr("ComputeInstance"),
// 							to.Ptr("MIR")},
// 							VCPUs: to.Ptr[int32](8),
// 						},
// 						{
// 							Name: to.Ptr("Standard_DS5_v2"),
// 							EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 								BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 								UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 								Values: []*armmachinelearning.EstimatedVMPrice{
// 									{
// 										OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 										RetailPrice: to.Ptr[float64](1.17),
// 										VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 									},
// 									{
// 										OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 										RetailPrice: to.Ptr[float64](0.81),
// 										VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 									},
// 									{
// 										OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 										RetailPrice: to.Ptr[float64](2.02),
// 										VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 									},
// 									{
// 										OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 										RetailPrice: to.Ptr[float64](0.23),
// 										VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 								}},
// 							},
// 							Family: to.Ptr("standardDSv2Family"),
// 							Gpus: to.Ptr[int32](0),
// 							LowPriorityCapable: to.Ptr(true),
// 							MaxResourceVolumeMB: to.Ptr[int32](114688),
// 							MemoryGB: to.Ptr[float64](56),
// 							OSVhdSizeMB: to.Ptr[int32](1047552),
// 							PremiumIO: to.Ptr(true),
// 							SupportedComputeTypes: []*string{
// 								to.Ptr("AmlCompute"),
// 								to.Ptr("ComputeInstance"),
// 								to.Ptr("MIR")},
// 								VCPUs: to.Ptr[int32](16),
// 							},
// 							{
// 								Name: to.Ptr("Standard_DS11_v2"),
// 								EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 									BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 									UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 									Values: []*armmachinelearning.EstimatedVMPrice{
// 										{
// 											OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 											RetailPrice: to.Ptr[float64](0.26),
// 											VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 										},
// 										{
// 											OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 											RetailPrice: to.Ptr[float64](0.18),
// 											VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 										},
// 										{
// 											OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 											RetailPrice: to.Ptr[float64](0.11),
// 											VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 										},
// 										{
// 											OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 											RetailPrice: to.Ptr[float64](0.04),
// 											VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 									}},
// 								},
// 								Family: to.Ptr("standardDSv2Family"),
// 								Gpus: to.Ptr[int32](0),
// 								LowPriorityCapable: to.Ptr(true),
// 								MaxResourceVolumeMB: to.Ptr[int32](28672),
// 								MemoryGB: to.Ptr[float64](14),
// 								OSVhdSizeMB: to.Ptr[int32](1047552),
// 								PremiumIO: to.Ptr(true),
// 								SupportedComputeTypes: []*string{
// 									to.Ptr("AmlCompute"),
// 									to.Ptr("ComputeInstance")},
// 									VCPUs: to.Ptr[int32](2),
// 								},
// 								{
// 									Name: to.Ptr("Standard_DS12_v2"),
// 									EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 										BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 										UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 										Values: []*armmachinelearning.EstimatedVMPrice{
// 											{
// 												OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 												RetailPrice: to.Ptr[float64](0.37),
// 												VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 											},
// 											{
// 												OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 												RetailPrice: to.Ptr[float64](0.53),
// 												VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 											},
// 											{
// 												OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 												RetailPrice: to.Ptr[float64](0.21),
// 												VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 											},
// 											{
// 												OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 												RetailPrice: to.Ptr[float64](0.07),
// 												VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 										}},
// 									},
// 									Family: to.Ptr("standardDSv2Family"),
// 									Gpus: to.Ptr[int32](0),
// 									LowPriorityCapable: to.Ptr(true),
// 									MaxResourceVolumeMB: to.Ptr[int32](57344),
// 									MemoryGB: to.Ptr[float64](28),
// 									OSVhdSizeMB: to.Ptr[int32](1047552),
// 									PremiumIO: to.Ptr(true),
// 									SupportedComputeTypes: []*string{
// 										to.Ptr("AmlCompute"),
// 										to.Ptr("ComputeInstance")},
// 										VCPUs: to.Ptr[int32](4),
// 									},
// 									{
// 										Name: to.Ptr("Standard_DS13_v2"),
// 										EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 											BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 											UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 											Values: []*armmachinelearning.EstimatedVMPrice{
// 												{
// 													OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 													RetailPrice: to.Ptr[float64](0.15),
// 													VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 												},
// 												{
// 													OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 													RetailPrice: to.Ptr[float64](0.42),
// 													VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 												},
// 												{
// 													OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 													RetailPrice: to.Ptr[float64](0.74),
// 													VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 												},
// 												{
// 													OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 													RetailPrice: to.Ptr[float64](1.06),
// 													VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 											}},
// 										},
// 										Family: to.Ptr("standardDSv2Family"),
// 										Gpus: to.Ptr[int32](0),
// 										LowPriorityCapable: to.Ptr(true),
// 										MaxResourceVolumeMB: to.Ptr[int32](114688),
// 										MemoryGB: to.Ptr[float64](56),
// 										OSVhdSizeMB: to.Ptr[int32](1047552),
// 										PremiumIO: to.Ptr(true),
// 										SupportedComputeTypes: []*string{
// 											to.Ptr("AmlCompute"),
// 											to.Ptr("ComputeInstance")},
// 											VCPUs: to.Ptr[int32](8),
// 										},
// 										{
// 											Name: to.Ptr("Standard_DS14_v2"),
// 											EstimatedVMPrices: &armmachinelearning.EstimatedVMPrices{
// 												BillingCurrency: to.Ptr(armmachinelearning.BillingCurrencyUSD),
// 												UnitOfMeasure: to.Ptr(armmachinelearning.UnitOfMeasureOneHour),
// 												Values: []*armmachinelearning.EstimatedVMPrice{
// 													{
// 														OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 														RetailPrice: to.Ptr[float64](0.3),
// 														VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 													},
// 													{
// 														OSType: to.Ptr(armmachinelearning.VMPriceOSTypeLinux),
// 														RetailPrice: to.Ptr[float64](1.48),
// 														VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 													},
// 													{
// 														OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 														RetailPrice: to.Ptr[float64](0.84),
// 														VMTier: to.Ptr(armmachinelearning.VMTierLowPriority),
// 													},
// 													{
// 														OSType: to.Ptr(armmachinelearning.VMPriceOSTypeWindows),
// 														RetailPrice: to.Ptr[float64](2.11),
// 														VMTier: to.Ptr(armmachinelearning.VMTierStandard),
// 												}},
// 											},
// 											Family: to.Ptr("standardDSv2Family"),
// 											Gpus: to.Ptr[int32](0),
// 											LowPriorityCapable: to.Ptr(true),
// 											MaxResourceVolumeMB: to.Ptr[int32](229376),
// 											MemoryGB: to.Ptr[float64](112),
// 											OSVhdSizeMB: to.Ptr[int32](1047552),
// 											PremiumIO: to.Ptr(true),
// 											SupportedComputeTypes: []*string{
// 												to.Ptr("AmlCompute"),
// 												to.Ptr("ComputeInstance")},
// 												VCPUs: to.Ptr[int32](16),
// 										}},
// 									}
Output:

type VirtualMachineSizesClientListOptions

type VirtualMachineSizesClientListOptions struct {
}

VirtualMachineSizesClientListOptions contains the optional parameters for the VirtualMachineSizesClient.List method.

type VirtualMachineSizesClientListResponse

type VirtualMachineSizesClientListResponse struct {
	// The List Virtual Machine size operation response.
	VirtualMachineSizeListResult
}

VirtualMachineSizesClientListResponse contains the response from method VirtualMachineSizesClient.List.

type WeekDay

type WeekDay string

WeekDay - Enum of weekday

const (
	// WeekDayFriday - Friday weekday
	WeekDayFriday WeekDay = "Friday"
	// WeekDayMonday - Monday weekday
	WeekDayMonday WeekDay = "Monday"
	// WeekDaySaturday - Saturday weekday
	WeekDaySaturday WeekDay = "Saturday"
	// WeekDaySunday - Sunday weekday
	WeekDaySunday WeekDay = "Sunday"
	// WeekDayThursday - Thursday weekday
	WeekDayThursday WeekDay = "Thursday"
	// WeekDayTuesday - Tuesday weekday
	WeekDayTuesday WeekDay = "Tuesday"
	// WeekDayWednesday - Wednesday weekday
	WeekDayWednesday WeekDay = "Wednesday"
)

func PossibleWeekDayValues

func PossibleWeekDayValues() []WeekDay

PossibleWeekDayValues returns the possible values for the WeekDay const type.

type Workspace

type Workspace struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity

	// Specifies the location of the resource.
	Location *string

	// The properties of the machine learning workspace.
	Properties *WorkspaceProperties

	// The sku of the workspace.
	SKU *SKU

	// Contains resource tags defined as key/value pairs.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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.

func (*Workspace) UnmarshalJSON

func (w *Workspace) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Workspace.

type WorkspaceConnectionManagedIdentity

type WorkspaceConnectionManagedIdentity struct {
	ClientID   *string
	ResourceID *string
}

func (WorkspaceConnectionManagedIdentity) MarshalJSON

func (w WorkspaceConnectionManagedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceConnectionManagedIdentity.

func (*WorkspaceConnectionManagedIdentity) UnmarshalJSON

func (w *WorkspaceConnectionManagedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceConnectionManagedIdentity.

type WorkspaceConnectionPersonalAccessToken

type WorkspaceConnectionPersonalAccessToken struct {
	Pat *string
}

func (WorkspaceConnectionPersonalAccessToken) MarshalJSON

func (w WorkspaceConnectionPersonalAccessToken) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceConnectionPersonalAccessToken.

func (*WorkspaceConnectionPersonalAccessToken) UnmarshalJSON

func (w *WorkspaceConnectionPersonalAccessToken) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceConnectionPersonalAccessToken.

type WorkspaceConnectionPropertiesV2

type WorkspaceConnectionPropertiesV2 struct {
	// REQUIRED; Authentication type of the connection target
	AuthType *ConnectionAuthType

	// Category of the connection
	Category *ConnectionCategory
	Target   *string

	// Value details of the workspace connection.
	Value *string

	// format for the workspace connection value
	ValueFormat *ValueFormat
}

func (*WorkspaceConnectionPropertiesV2) GetWorkspaceConnectionPropertiesV2

func (w *WorkspaceConnectionPropertiesV2) GetWorkspaceConnectionPropertiesV2() *WorkspaceConnectionPropertiesV2

GetWorkspaceConnectionPropertiesV2 implements the WorkspaceConnectionPropertiesV2Classification interface for type WorkspaceConnectionPropertiesV2.

func (WorkspaceConnectionPropertiesV2) MarshalJSON

func (w WorkspaceConnectionPropertiesV2) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceConnectionPropertiesV2.

func (*WorkspaceConnectionPropertiesV2) UnmarshalJSON

func (w *WorkspaceConnectionPropertiesV2) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceConnectionPropertiesV2.

type WorkspaceConnectionPropertiesV2BasicResource

type WorkspaceConnectionPropertiesV2BasicResource struct {
	// REQUIRED
	Properties WorkspaceConnectionPropertiesV2Classification

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

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

	// READ-ONLY
	NextLink *string
}

func (WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult.

func (*WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult.

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
}

func (WorkspaceConnectionSharedAccessSignature) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type WorkspaceConnectionSharedAccessSignature.

func (*WorkspaceConnectionSharedAccessSignature) UnmarshalJSON

func (w *WorkspaceConnectionSharedAccessSignature) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceConnectionSharedAccessSignature.

type WorkspaceConnectionUsernamePassword

type WorkspaceConnectionUsernamePassword struct {
	Password *string
	Username *string
}

func (WorkspaceConnectionUsernamePassword) MarshalJSON

func (w WorkspaceConnectionUsernamePassword) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceConnectionUsernamePassword.

func (*WorkspaceConnectionUsernamePassword) UnmarshalJSON

func (w *WorkspaceConnectionUsernamePassword) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceConnectionUsernamePassword.

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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspaceConnectionsClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.WorkspaceConnectionPropertiesV2BasicResource = armmachinelearning.WorkspaceConnectionPropertiesV2BasicResource{
// 	Name: to.Ptr("connection-1"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/connections"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1"),
// 	Properties: &armmachinelearning.NoneAuthTypeWorkspaceConnectionProperties{
// 		AuthType: to.Ptr(armmachinelearning.ConnectionAuthTypeNone),
// 		Category: to.Ptr(armmachinelearning.ConnectionCategoryContainerRegistry),
// 		Target: to.Ptr("www.facebook.com"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewWorkspaceConnectionsClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspaceConnectionsClient().Get(ctx, "resourceGroup-1", "workspace-1", "connection-1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.WorkspaceConnectionPropertiesV2BasicResource = armmachinelearning.WorkspaceConnectionPropertiesV2BasicResource{
// 	Name: to.Ptr("connection-1"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/connections"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1"),
// 	Properties: &armmachinelearning.NoneAuthTypeWorkspaceConnectionProperties{
// 		AuthType: to.Ptr(armmachinelearning.ConnectionAuthTypeNone),
// 		Category: to.Ptr(armmachinelearning.ConnectionCategoryContainerRegistry),
// 		Target: to.Ptr("www.facebook.com"),
// 	},
// }
Output:

func (*WorkspaceConnectionsClient) NewListPager

  • 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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewWorkspaceConnectionsClient().NewListPager("resourceGroup-1", "workspace-1", &armmachinelearning.WorkspaceConnectionsClientListOptions{Target: to.Ptr("www.facebook.com"),
	Category: to.Ptr("ContainerRegistry"),
})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult = armmachinelearning.WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult{
	// 	Value: []*armmachinelearning.WorkspaceConnectionPropertiesV2BasicResource{
	// 		{
	// 			Name: to.Ptr("connection-1"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/connections"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-1"),
	// 			Properties: &armmachinelearning.PATAuthTypeWorkspaceConnectionProperties{
	// 				AuthType: to.Ptr(armmachinelearning.ConnectionAuthTypePAT),
	// 				Category: to.Ptr(armmachinelearning.ConnectionCategoryContainerRegistry),
	// 				Target: to.Ptr("www.facebook.com"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("connection-2"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/connections"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-2"),
	// 			Properties: &armmachinelearning.PATAuthTypeWorkspaceConnectionProperties{
	// 				AuthType: to.Ptr(armmachinelearning.ConnectionAuthTypePAT),
	// 				Category: to.Ptr(armmachinelearning.ConnectionCategoryContainerRegistry),
	// 				Target: to.Ptr("www.facebook.com"),
	// 			},
	// 	}},
	// }
}
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.NewListPager method.

type WorkspaceConnectionsClientListResponse

type WorkspaceConnectionsClientListResponse struct {
	WorkspaceConnectionPropertiesV2BasicResourceArmPaginatedResult
}

WorkspaceConnectionsClientListResponse contains the response from method WorkspaceConnectionsClient.NewListPager.

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

Generated from API version 2022-10-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.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewWorkspaceFeaturesClient().NewListPager("myResourceGroup", "testworkspace", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ListAmlUserFeatureResult = armmachinelearning.ListAmlUserFeatureResult{
	// 	Value: []*armmachinelearning.AmlUserFeature{
	// 		{
	// 			Description: to.Ptr("Create, edit or delete AutoML experiments in the SDK"),
	// 			DisplayName: to.Ptr("Create edit experiments UI"),
	// 			ID: to.Ptr("automatedml_createeditexperimentsui"),
	// 		},
	// 		{
	// 			Description: to.Ptr("Upgrade workspace from Basic to enterprise from the UI"),
	// 			DisplayName: to.Ptr("Upgrade workspace UI"),
	// 			ID: to.Ptr("workspace_upgradeworkspaceui"),
	// 	}},
	// }
}
Output:

type WorkspaceFeaturesClientListOptions

type WorkspaceFeaturesClientListOptions struct {
}

WorkspaceFeaturesClientListOptions contains the optional parameters for the WorkspaceFeaturesClient.NewListPager method.

type WorkspaceFeaturesClientListResponse

type WorkspaceFeaturesClientListResponse struct {
	// The List Aml user feature operation response.
	ListAmlUserFeatureResult
}

WorkspaceFeaturesClientListResponse contains the response from method WorkspaceFeaturesClient.NewListPager.

type WorkspaceListResult

type WorkspaceListResult struct {
	// The URI that can be used to request the next list of machine learning workspaces.
	NextLink *string

	// 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
}

WorkspaceListResult - The result of a request to list machine learning workspaces.

func (WorkspaceListResult) MarshalJSON

func (w WorkspaceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceListResult.

func (*WorkspaceListResult) UnmarshalJSON

func (w *WorkspaceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceListResult.

type WorkspaceProperties

type WorkspaceProperties struct {
	// The flag to indicate whether to allow public access when behind VNet.
	AllowPublicAccessWhenBehindVnet *bool

	// ARM id of the application insights associated with this workspace.
	ApplicationInsights *string

	// ARM id of the container registry associated with this workspace.
	ContainerRegistry *string

	// The description of this workspace.
	Description *string

	// Url for the discovery service to identify regional endpoints for machine learning experimentation services
	DiscoveryURL *string

	// The encryption settings of Azure ML workspace.
	Encryption *EncryptionProperty

	// The friendly name for this workspace. This name in mutable
	FriendlyName *string

	// The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
	HbiWorkspace *bool

	// The compute name for image build
	ImageBuildCompute *string

	// ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
	KeyVault *string

	// The user assigned identity resource id that represents the workspace identity.
	PrimaryUserAssignedIdentity *string

	// Whether requests from Public Network are allowed.
	PublicNetworkAccess *PublicNetworkAccess

	// The service managed resource settings.
	ServiceManagedResourcesSettings *ServiceManagedResourcesSettings

	// The list of shared private link resources in this workspace.
	SharedPrivateLinkResources []*SharedPrivateLinkResource

	// ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
	StorageAccount *string

	// Enabling v1legacymode may prevent you from using features provided by the v2 API.
	V1LegacyMode *bool

	// READ-ONLY; The URI associated with this workspace that machine learning flow must point at to set up tracking.
	MlFlowTrackingURI *string

	// READ-ONLY; The notebook info of Azure ML workspace.
	NotebookInfo *NotebookResourceInfo

	// READ-ONLY; The list of private endpoint connections in the workspace.
	PrivateEndpointConnections []*PrivateEndpointConnection

	// READ-ONLY; Count of private connections in the workspace
	PrivateLinkCount *int32

	// READ-ONLY; The current deployment state of workspace resource. The provisioningState is to indicate states for resource
	// provisioning.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The name of the managed resource group created by workspace RP in customer subscription if the workspace is
	// CMK workspace
	ServiceProvisionedResourceGroup *string

	// READ-ONLY; If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
	StorageHnsEnabled *bool

	// READ-ONLY; The tenant id associated with this workspace.
	TenantID *string

	// READ-ONLY; The immutable id associated with this workspace.
	WorkspaceID *string
}

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.

func (*WorkspaceProperties) UnmarshalJSON

func (w *WorkspaceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceProperties.

type WorkspacePropertiesUpdateParameters

type WorkspacePropertiesUpdateParameters struct {
	// ARM id of the application insights associated with this workspace.
	ApplicationInsights *string

	// ARM id of the container registry associated with this workspace.
	ContainerRegistry *string

	// The description of this workspace.
	Description *string

	// The friendly name for this workspace.
	FriendlyName *string

	// The compute name for image build
	ImageBuildCompute *string

	// The user assigned identity resource id that represents the workspace identity.
	PrimaryUserAssignedIdentity *string

	// Whether requests from Public Network are allowed.
	PublicNetworkAccess *PublicNetworkAccess

	// The service managed resource settings.
	ServiceManagedResourcesSettings *ServiceManagedResourcesSettings
}

WorkspacePropertiesUpdateParameters - The parameters for updating the properties of a machine learning workspace.

func (WorkspacePropertiesUpdateParameters) MarshalJSON

func (w WorkspacePropertiesUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspacePropertiesUpdateParameters.

func (*WorkspacePropertiesUpdateParameters) UnmarshalJSON

func (w *WorkspacePropertiesUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspacePropertiesUpdateParameters.

type WorkspaceUpdateParameters

type WorkspaceUpdateParameters struct {
	// The identity of the resource.
	Identity *ManagedServiceIdentity

	// The properties that the machine learning workspace will be updated with.
	Properties *WorkspacePropertiesUpdateParameters

	// The sku of the workspace.
	SKU *SKU

	// The resource tags for the machine learning workspace.
	Tags map[string]*string
}

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.

func (*WorkspaceUpdateParameters) UnmarshalJSON

func (w *WorkspaceUpdateParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewWorkspacesClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Workspace = armmachinelearning.Workspace{
// 	Name: to.Ptr("testworkspace"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace"),
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus2euap"),
// 	Properties: &armmachinelearning.WorkspaceProperties{
// 		Description: to.Ptr("test description"),
// 		AllowPublicAccessWhenBehindVnet: to.Ptr(false),
// 		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"),
// 		DiscoveryURL: to.Ptr("http://example.com"),
// 		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"),
// 		PublicNetworkAccess: to.Ptr(armmachinelearning.PublicNetworkAccessDisabled),
// 		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"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewWorkspacesClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewWorkspacesClient().BeginDiagnose(ctx, "workspace-1234", "testworkspace", &armmachinelearning.WorkspacesClientBeginDiagnoseOptions{Parameters: &armmachinelearning.DiagnoseWorkspaceParameters{
	Value: &armmachinelearning.DiagnoseRequestProperties{
		ApplicationInsights: map[string]any{},
		ContainerRegistry:   map[string]any{},
		DNSResolution:       map[string]any{},
		KeyVault:            map[string]any{},
		Nsg:                 map[string]any{},
		Others:              map[string]any{},
		ResourceLock:        map[string]any{},
		StorageAccount:      map[string]any{},
		Udr:                 map[string]any{},
	},
},
})
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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DiagnoseResponseResult = armmachinelearning.DiagnoseResponseResult{
// 	Value: &armmachinelearning.DiagnoseResponseResultValue{
// 		ApplicationInsightsResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 		ContainerRegistryResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 		DNSResolutionResults: []*armmachinelearning.DiagnoseResult{
// 			{
// 				Code: to.Ptr("CustomDNSInUse"),
// 				Level: to.Ptr(armmachinelearning.DiagnoseResultLevelWarning),
// 				Message: to.Ptr("We have detected an on-premise dns server is configured. Please make sure conditional forwarding is configured correctly according to doc https://foo"),
// 		}},
// 		KeyVaultResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 		NetworkSecurityRuleResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 		OtherResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 		ResourceLockResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 		StorageAccountResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 		UserDefinedRouteResults: []*armmachinelearning.DiagnoseResult{
// 		},
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewWorkspacesClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NotebookResourceInfo = armmachinelearning.NotebookResourceInfo{
// 	Fqdn: to.Ptr("testnotebook.notebooks.azure.com"),
// 	NotebookPreparationError: &armmachinelearning.NotebookPreparationError{
// 		ErrorMessage: to.Ptr("general error"),
// 		StatusCode: to.Ptr[int32](500),
// 	},
// 	ResourceID: to.Ptr("aabbccddee112233445566778899"),
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewWorkspacesClient().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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewWorkspacesClient().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)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Workspace = armmachinelearning.Workspace{
// 	Name: to.Ptr("testworkspace"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace"),
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 	},
// 	Location: to.Ptr("eastus2euap"),
// 	Properties: &armmachinelearning.WorkspaceProperties{
// 		Description: to.Ptr("new 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"),
// 		DiscoveryURL: to.Ptr("http://example.com"),
// 		FriendlyName: to.Ptr("New friendly name"),
// 		KeyVault: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv"),
// 		PublicNetworkAccess: to.Ptr(armmachinelearning.PublicNetworkAccessDisabled),
// 		StorageAccount: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspacesClient().Get(ctx, "workspace-1234", "testworkspace", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Workspace = armmachinelearning.Workspace{
// 	Name: to.Ptr("testworkspace"),
// 	Type: to.Ptr("Microsoft.MachineLearningServices/workspaces"),
// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace"),
// 	Identity: &armmachinelearning.ManagedServiceIdentity{
// 		Type: to.Ptr(armmachinelearning.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
// 		PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		TenantID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 		UserAssignedIdentities: map[string]*armmachinelearning.UserAssignedIdentity{
// 			"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": &armmachinelearning.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 				PrincipalID: to.Ptr("00000000-1111-2222-3333-444444444444"),
// 			},
// 		},
// 	},
// 	Location: to.Ptr("eastus2euap"),
// 	Properties: &armmachinelearning.WorkspaceProperties{
// 		Description: to.Ptr("test description"),
// 		AllowPublicAccessWhenBehindVnet: to.Ptr(false),
// 		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"),
// 		DiscoveryURL: to.Ptr("http://example.com"),
// 		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),
// 		ImageBuildCompute: to.Ptr("testcompute"),
// 		KeyVault: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv"),
// 		PrivateEndpointConnections: []*armmachinelearning.PrivateEndpointConnection{
// 			{
// 				Name: to.Ptr("testprivatelinkconnection"),
// 				Type: to.Ptr("Microsoft.MachineLearningServices/workspaces/privateEndpointConnections"),
// 				ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/testprivatelinkconnection"),
// 				Properties: &armmachinelearning.PrivateEndpointConnectionProperties{
// 					PrivateEndpoint: &armmachinelearning.PrivateEndpoint{
// 						ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01"),
// 					},
// 					PrivateLinkServiceConnectionState: &armmachinelearning.PrivateLinkServiceConnectionState{
// 						Description: to.Ptr("Auto-Approved"),
// 						ActionsRequired: to.Ptr("None"),
// 						Status: to.Ptr(armmachinelearning.PrivateEndpointServiceConnectionStatusApproved),
// 					},
// 					ProvisioningState: to.Ptr(armmachinelearning.PrivateEndpointConnectionProvisioningStateSucceeded),
// 				},
// 		}},
// 		PrivateLinkCount: to.Ptr[int32](0),
// 		PublicNetworkAccess: to.Ptr(armmachinelearning.PublicNetworkAccessDisabled),
// 		ServiceProvisionedResourceGroup: to.Ptr("testworkspace_0000111122223333"),
// 		SharedPrivateLinkResources: []*armmachinelearning.SharedPrivateLinkResource{
// 			{
// 				Name: to.Ptr("testcosmosdbresource"),
// 				Properties: &armmachinelearning.SharedPrivateLinkResourceProperty{
// 					GroupID: to.Ptr("Sql"),
// 					PrivateLinkResourceID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testcosmosdbresource/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"),
// 	},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspacesClient().ListKeys(ctx, "testrg123", "workspaces123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ListWorkspaceKeysResult = armmachinelearning.ListWorkspaceKeysResult{
// 	ContainerRegistryCredentials: &armmachinelearning.RegistryListCredentialsResult{
// 		Passwords: []*armmachinelearning.Password{
// 			{
// 				Name: to.Ptr("password"),
// 				Value: to.Ptr("<value>"),
// 			},
// 			{
// 				Name: to.Ptr("password2"),
// 				Value: to.Ptr("0KARRQoQHSUq1yViPWg7YFernOS=Ic/t"),
// 		}},
// 		Username: to.Ptr("testdemoworkjmjmeykp"),
// 	},
// 	NotebookAccessKeys: &armmachinelearning.ListNotebookKeysResult{
// 	},
// 	UserStorageResourceID: to.Ptr("/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr"),
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspacesClient().ListNotebookAccessToken(ctx, "workspace-1234", "testworkspace", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NotebookAccessTokenResult = armmachinelearning.NotebookAccessTokenResult{
// 	ExpiresIn: to.Ptr[int32](28800),
// 	HostName: to.Ptr("Host product name"),
// 	NotebookResourceID: to.Ptr("94350843095843059"),
// 	PublicDNS: to.Ptr("resource.notebooks.azure.net"),
// 	Scope: to.Ptr("aznb_identity"),
// 	TokenType: to.Ptr("Bearer"),
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspacesClient().ListNotebookKeys(ctx, "testrg123", "workspaces123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ListNotebookKeysResult = armmachinelearning.ListNotebookKeysResult{
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspacesClient().ListOutboundNetworkDependenciesEndpoints(ctx, "workspace-1234", "testworkspace", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ExternalFQDNResponse = armmachinelearning.ExternalFQDNResponse{
// 	Value: []*armmachinelearning.FQDNEndpoints{
// 		{
// 			Properties: &armmachinelearning.FQDNEndpointsProperties{
// 				Category: to.Ptr("Azure Active Directory"),
// 				Endpoints: []*armmachinelearning.FQDNEndpoint{
// 					{
// 						DomainName: to.Ptr("login.microsoftonline.com"),
// 						EndpointDetails: []*armmachinelearning.FQDNEndpointDetail{
// 							{
// 								Port: to.Ptr[int32](443),
// 						}},
// 				}},
// 			},
// 		},
// 		{
// 			Properties: &armmachinelearning.FQDNEndpointsProperties{
// 				Category: to.Ptr("Azure portal"),
// 				Endpoints: []*armmachinelearning.FQDNEndpoint{
// 					{
// 						DomainName: to.Ptr("management.azure.com"),
// 						EndpointDetails: []*armmachinelearning.FQDNEndpointDetail{
// 							{
// 								Port: to.Ptr[int32](443),
// 						}},
// 				}},
// 			},
// 	}},
// }
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-10-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/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWorkspacesClient().ListStorageAccountKeys(ctx, "testrg123", "workspaces123", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ListStorageAccountKeysResult = armmachinelearning.ListStorageAccountKeysResult{
// }
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.

Generated from API version 2022-10-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - WorkspacesClientListByResourceGroupOptions contains the optional parameters for the WorkspacesClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewWorkspacesClient().NewListByResourceGroupPager("workspace-1234", &armmachinelearning.WorkspacesClientListByResourceGroupOptions{Skip: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.WorkspaceListResult = armmachinelearning.WorkspaceListResult{
	// 	Value: []*armmachinelearning.Workspace{
	// 		{
	// 			Name: to.Ptr("testworkspace"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace"),
	// 			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"),
	// 				DiscoveryURL: to.Ptr("http://example.com"),
	// 				FriendlyName: to.Ptr("HelloName"),
	// 				KeyVault: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv"),
	// 				StorageAccount: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("testworkspace1"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1"),
	// 			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/testRegistryNew"),
	// 				DiscoveryURL: to.Ptr("http://example.com"),
	// 				FriendlyName: to.Ptr("HelloName 1"),
	// 				KeyVault: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew"),
	// 				StorageAccount: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld"),
	// 			},
	// 	}},
	// }
}
Output:

func (*WorkspacesClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Lists all the available machine learning workspaces under the specified subscription.

Generated from API version 2022-10-01

  • options - WorkspacesClientListBySubscriptionOptions contains the optional parameters for the WorkspacesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/aafb0944f7ab936e8cfbad8969bd5eb32263fb4f/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2022-10-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()
clientFactory, err := armmachinelearning.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewWorkspacesClient().NewListBySubscriptionPager(&armmachinelearning.WorkspacesClientListBySubscriptionOptions{Skip: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.WorkspaceListResult = armmachinelearning.WorkspaceListResult{
	// 	Value: []*armmachinelearning.Workspace{
	// 		{
	// 			Name: to.Ptr("testworkspace"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace"),
	// 			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"),
	// 				DiscoveryURL: to.Ptr("http://example.com"),
	// 				FriendlyName: to.Ptr("HelloName"),
	// 				KeyVault: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv"),
	// 				StorageAccount: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("testworkspace"),
	// 			Type: to.Ptr("Microsoft.MachineLearningServices/workspaces"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace"),
	// 			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/testRegistryNew"),
	// 				DiscoveryURL: to.Ptr("http://example.com"),
	// 				FriendlyName: to.Ptr("HelloName"),
	// 				KeyVault: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew"),
	// 				StorageAccount: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld"),
	// 			},
	// 	}},
	// }
}
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 {
	// An object that represents a machine learning workspace.
	Workspace
}

WorkspacesClientCreateOrUpdateResponse contains the response from method WorkspacesClient.BeginCreateOrUpdate.

type WorkspacesClientDeleteResponse

type WorkspacesClientDeleteResponse struct {
}

WorkspacesClientDeleteResponse contains the response from method WorkspacesClient.BeginDelete.

type WorkspacesClientDiagnoseResponse

type WorkspacesClientDiagnoseResponse struct {
	DiagnoseResponseResult
}

WorkspacesClientDiagnoseResponse contains the response from method WorkspacesClient.BeginDiagnose.

type WorkspacesClientGetOptions

type WorkspacesClientGetOptions struct {
}

WorkspacesClientGetOptions contains the optional parameters for the WorkspacesClient.Get method.

type WorkspacesClientGetResponse

type WorkspacesClientGetResponse struct {
	// An object that represents a machine learning workspace.
	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.NewListByResourceGroupPager method.

type WorkspacesClientListByResourceGroupResponse

type WorkspacesClientListByResourceGroupResponse struct {
	// The result of a request to list machine learning workspaces.
	WorkspaceListResult
}

WorkspacesClientListByResourceGroupResponse contains the response from method WorkspacesClient.NewListByResourceGroupPager.

type WorkspacesClientListBySubscriptionOptions

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

WorkspacesClientListBySubscriptionOptions contains the optional parameters for the WorkspacesClient.NewListBySubscriptionPager method.

type WorkspacesClientListBySubscriptionResponse

type WorkspacesClientListBySubscriptionResponse struct {
	// The result of a request to list machine learning workspaces.
	WorkspaceListResult
}

WorkspacesClientListBySubscriptionResponse contains the response from method WorkspacesClient.NewListBySubscriptionPager.

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.BeginPrepareNotebook.

type WorkspacesClientResyncKeysResponse

type WorkspacesClientResyncKeysResponse struct {
}

WorkspacesClientResyncKeysResponse contains the response from method WorkspacesClient.BeginResyncKeys.

type WorkspacesClientUpdateResponse

type WorkspacesClientUpdateResponse struct {
	// An object that represents a machine learning workspace.
	Workspace
}

WorkspacesClientUpdateResponse contains the response from method WorkspacesClient.BeginUpdate.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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