armmachinelearningservices

package module
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: May 30, 2022 License: MIT Imports: 16 Imported by: 1

README

Azure Machine Learning Services Module for Go

PkgGoDev

The armmachinelearningservices module provides operations for working with Azure Machine Learning Services.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Machine Learning Services module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices

Authorization

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

cred, err := azidentity.NewDefaultAzureCredential(nil)

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

Clients

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

client, err := armmachinelearningservices.NewQuotasClient(<subscription ID>, cred, nil)

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

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

Provide Feedback

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

Contributing

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

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

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

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AKS

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

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

AKS - A Machine Learning compute based on AKS.

func (*AKS) GetCompute added in v0.2.0

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 AKSProperties

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

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

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

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

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

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

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

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

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

AKSProperties - AKS properties

func (AKSProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AKSProperties.

type AksComputeSecrets

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

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

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

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

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

func (*AksComputeSecrets) GetComputeSecrets added in v0.2.0

func (a *AksComputeSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type AksComputeSecrets.

func (*AksComputeSecrets) UnmarshalJSON added in v0.2.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AksComputeSecrets.

type AksComputeSecretsProperties

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

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

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

AksComputeSecretsProperties - Properties of AksComputeSecrets

type AksNetworkingConfiguration

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

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

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

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

AksNetworkingConfiguration - Advance configuration for AKS networking

type AllocationState

type AllocationState string

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

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

func PossibleAllocationStateValues

func PossibleAllocationStateValues() []AllocationState

PossibleAllocationStateValues returns the possible values for the AllocationState const type.

type AmlCompute

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

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

AmlCompute - Properties(top level) of AmlCompute

func (*AmlCompute) GetCompute added in v0.2.0

func (a *AmlCompute) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type AmlCompute.

func (AmlCompute) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlCompute.

func (*AmlCompute) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlCompute.

type AmlComputeNodeInformation

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

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

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

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

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

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

AmlComputeNodeInformation - Compute node information related to a AmlCompute.

type AmlComputeNodesInformation

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

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

AmlComputeNodesInformation - Result of AmlCompute Nodes

type AmlComputeProperties

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AmlComputeProperties - AML Compute properties

func (AmlComputeProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AmlComputeProperties.

func (*AmlComputeProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AmlComputeProperties.

type AmlUserFeature

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

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

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

AmlUserFeature - Features enabled for a workspace

type ApplicationSharingPolicy

type ApplicationSharingPolicy string

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

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

func PossibleApplicationSharingPolicyValues

func PossibleApplicationSharingPolicyValues() []ApplicationSharingPolicy

PossibleApplicationSharingPolicyValues returns the possible values for the ApplicationSharingPolicy const type.

type AssignedUser

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

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

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

type AutoPauseProperties

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

AutoPauseProperties - Auto pause properties

type AutoScaleProperties

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

AutoScaleProperties - Auto scale properties

type 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 ClusterPurpose

type ClusterPurpose string

ClusterPurpose - Intended usage of the cluster

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

func PossibleClusterPurposeValues

func PossibleClusterPurposeValues() []ClusterPurpose

PossibleClusterPurposeValues returns the possible values for the ClusterPurpose const type.

type ClusterUpdateParameters

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

ClusterUpdateParameters - AmlCompute update parameters.

func (ClusterUpdateParameters) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ClusterUpdateParameters.

type ClusterUpdateProperties

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

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

type Components1D3SwueSchemasComputeresourceAllof1

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

func (Components1D3SwueSchemasComputeresourceAllof1) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type Components1D3SwueSchemasComputeresourceAllof1.

func (*Components1D3SwueSchemasComputeresourceAllof1) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Components1D3SwueSchemasComputeresourceAllof1.

type Compute

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

Compute - Machine Learning compute object.

func (*Compute) GetCompute

func (c *Compute) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type Compute.

func (Compute) MarshalJSON added in v0.2.0

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 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. parameters - Payload with Machine Learning compute definition. options - ComputeClientBeginCreateOrUpdateOptions contains the optional parameters for the ComputeClient.BeginCreateOrUpdate method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) BeginDelete

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewComputeClient("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"testrg123",
		"workspaces123",
		"compute123",
		armmachinelearningservices.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 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. computeName - Name of the Azure Machine Learning compute. options - ComputeClientBeginRestartOptions contains the optional parameters for the ComputeClient.BeginRestart method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) BeginStart

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) BeginStop

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) BeginUpdate

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) Get

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) ListKeys

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) NewListNodesPager added in v0.4.0

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*ComputeClient) NewListPager added in v0.4.0

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

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

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

type ComputeClientBeginCreateOrUpdateOptions added in v0.2.0

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

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

type ComputeClientBeginDeleteOptions added in v0.2.0

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

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

type ComputeClientBeginRestartOptions added in v0.2.0

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

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

type ComputeClientBeginStartOptions added in v0.2.0

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

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

type ComputeClientBeginStopOptions added in v0.2.0

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

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

type ComputeClientBeginUpdateOptions added in v0.2.0

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

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

type ComputeClientCreateOrUpdateResponse added in v0.2.0

type ComputeClientCreateOrUpdateResponse struct {
	ComputeResource
}

ComputeClientCreateOrUpdateResponse contains the response from method ComputeClient.CreateOrUpdate.

type ComputeClientDeleteResponse added in v0.2.0

type ComputeClientDeleteResponse struct {
}

ComputeClientDeleteResponse contains the response from method ComputeClient.Delete.

type ComputeClientGetOptions added in v0.2.0

type ComputeClientGetOptions struct {
}

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

type ComputeClientGetResponse added in v0.2.0

type ComputeClientGetResponse struct {
	ComputeResource
}

ComputeClientGetResponse contains the response from method ComputeClient.Get.

type ComputeClientListKeysOptions added in v0.2.0

type ComputeClientListKeysOptions struct {
}

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

type ComputeClientListKeysResponse added in v0.2.0

type ComputeClientListKeysResponse struct {
	ComputeSecretsClassification
}

ComputeClientListKeysResponse contains the response from method ComputeClient.ListKeys.

func (*ComputeClientListKeysResponse) UnmarshalJSON added in v0.3.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeClientListKeysResponse.

type ComputeClientListNodesOptions added in v0.2.0

type ComputeClientListNodesOptions struct {
}

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

type ComputeClientListNodesResponse added in v0.2.0

type ComputeClientListNodesResponse struct {
	AmlComputeNodesInformation
}

ComputeClientListNodesResponse contains the response from method ComputeClient.ListNodes.

type ComputeClientListOptions added in v0.2.0

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

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

type ComputeClientListResponse added in v0.2.0

type ComputeClientListResponse struct {
	PaginatedComputeResourcesList
}

ComputeClientListResponse contains the response from method ComputeClient.List.

type ComputeClientRestartResponse added in v0.2.0

type ComputeClientRestartResponse struct {
}

ComputeClientRestartResponse contains the response from method ComputeClient.Restart.

type ComputeClientStartResponse added in v0.2.0

type ComputeClientStartResponse struct {
}

ComputeClientStartResponse contains the response from method ComputeClient.Start.

type ComputeClientStopResponse added in v0.2.0

type ComputeClientStopResponse struct {
}

ComputeClientStopResponse contains the response from method ComputeClient.Stop.

type ComputeClientUpdateResponse added in v0.2.0

type ComputeClientUpdateResponse struct {
	ComputeResource
}

ComputeClientUpdateResponse contains the response from method ComputeClient.Update.

type ComputeInstance

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

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

ComputeInstance - Properties(top level) of ComputeInstance

func (*ComputeInstance) GetCompute added in v0.2.0

func (c *ComputeInstance) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type ComputeInstance.

func (ComputeInstance) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstance.

func (*ComputeInstance) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstance.

type ComputeInstanceApplication

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

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

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

type ComputeInstanceAuthorizationType

type ComputeInstanceAuthorizationType string

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

const (
	ComputeInstanceAuthorizationTypePersonal ComputeInstanceAuthorizationType = "personal"
)

func PossibleComputeInstanceAuthorizationTypeValues

func PossibleComputeInstanceAuthorizationTypeValues() []ComputeInstanceAuthorizationType

PossibleComputeInstanceAuthorizationTypeValues returns the possible values for the ComputeInstanceAuthorizationType const type.

type ComputeInstanceConnectivityEndpoints

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

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

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

type ComputeInstanceCreatedBy

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

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

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

ComputeInstanceCreatedBy - Describes information on user who created this ComputeInstance.

type ComputeInstanceLastOperation

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

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

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

ComputeInstanceLastOperation - The last operation on ComputeInstance.

func (ComputeInstanceLastOperation) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceLastOperation.

func (*ComputeInstanceLastOperation) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeInstanceLastOperation.

type ComputeInstanceProperties

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

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

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

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

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

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

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

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

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

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

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

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

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

ComputeInstanceProperties - Compute Instance properties

func (ComputeInstanceProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeInstanceProperties.

type ComputeInstanceSSHSettings

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

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

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

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

ComputeInstanceSSHSettings - Specifies policy and settings for SSH access.

type 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 ComputeResource

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

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

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

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

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

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

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

	// READ-ONLY; System data
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

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

func (ComputeResource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ComputeResource.

func (*ComputeResource) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComputeResource.

type ComputeSecrets

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

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

func (*ComputeSecrets) GetComputeSecrets

func (c *ComputeSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type ComputeSecrets.

type ComputeSecretsClassification

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

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

type 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 ContainerResourceRequirements

type ContainerResourceRequirements struct {
	// The minimum amount of CPU cores to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	CPU *float64 `json:"cpu,omitempty"`

	// The maximum amount of CPU cores allowed to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	CPULimit *float64 `json:"cpuLimit,omitempty"`

	// The number of FPGA PCIE devices exposed to the container. Must be multiple of 2.
	Fpga *int32 `json:"fpga,omitempty"`

	// The number of GPU cores in the container.
	Gpu *int32 `json:"gpu,omitempty"`

	// The minimum amount of memory (in GB) to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	MemoryInGB *float64 `json:"memoryInGB,omitempty"`

	// The maximum amount of memory (in GB) allowed to be used by the container. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	MemoryInGBLimit *float64 `json:"memoryInGBLimit,omitempty"`
}

ContainerResourceRequirements - The resource requirements for the container (cpu and memory).

type CosmosDbSettings

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

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

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

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type DataFactory

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

DataFactory - A DataFactory compute.

func (*DataFactory) GetCompute added in v0.2.0

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 added in v0.2.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DataFactory.

type DataLakeAnalytics

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

DataLakeAnalytics - A DataLakeAnalytics compute.

func (*DataLakeAnalytics) GetCompute added in v0.2.0

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 DataLakeAnalyticsProperties

type DataLakeAnalyticsProperties struct {
	// DataLake Store Account Name
	DataLakeStoreAccountName *string `json:"dataLakeStoreAccountName,omitempty"`
}

type Databricks

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

	// Properties of Databricks
	Properties *DatabricksProperties `json:"properties,omitempty"`

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

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

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

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

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

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

Databricks - A DataFactory compute.

func (*Databricks) GetCompute added in v0.2.0

func (d *Databricks) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type Databricks.

func (Databricks) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Databricks.

func (*Databricks) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Databricks.

type DatabricksComputeSecrets

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

	// access token for databricks account.
	DatabricksAccessToken *string `json:"databricksAccessToken,omitempty"`
}

DatabricksComputeSecrets - Secrets related to a Machine Learning compute based on Databricks.

func (*DatabricksComputeSecrets) GetComputeSecrets added in v0.2.0

func (d *DatabricksComputeSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type DatabricksComputeSecrets.

func (*DatabricksComputeSecrets) UnmarshalJSON added in v0.2.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type DatabricksComputeSecrets.

type DatabricksComputeSecretsProperties

type DatabricksComputeSecretsProperties struct {
	// access token for databricks account.
	DatabricksAccessToken *string `json:"databricksAccessToken,omitempty"`
}

DatabricksComputeSecretsProperties - Properties of Databricks Compute Secrets

type DatabricksProperties

type DatabricksProperties struct {
	// Databricks access token
	DatabricksAccessToken *string `json:"databricksAccessToken,omitempty"`

	// Workspace Url
	WorkspaceURL *string `json:"workspaceUrl,omitempty"`
}

DatabricksProperties - Properties of Databricks

type DiagnoseRequestProperties

type DiagnoseRequestProperties struct {
	// Setting for diagnosing dependent application insights
	ApplicationInsights map[string]interface{} `json:"applicationInsights,omitempty"`

	// Setting for diagnosing dependent container registry
	ContainerRegistry map[string]interface{} `json:"containerRegistry,omitempty"`

	// Setting for diagnosing dns resolution
	DNSResolution map[string]interface{} `json:"dnsResolution,omitempty"`

	// Setting for diagnosing dependent key vault
	KeyVault map[string]interface{} `json:"keyVault,omitempty"`

	// Setting for diagnosing network security group
	Nsg map[string]interface{} `json:"nsg,omitempty"`

	// Setting for diagnosing unclassified category of problems
	Others map[string]interface{} `json:"others,omitempty"`

	// Setting for diagnosing resource lock
	ResourceLock map[string]interface{} `json:"resourceLock,omitempty"`

	// Setting for diagnosing dependent storage account
	StorageAccount map[string]interface{} `json:"storageAccount,omitempty"`

	// Setting for diagnosing user defined routing
	Udr map[string]interface{} `json:"udr,omitempty"`
}

func (DiagnoseRequestProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type DiagnoseRequestProperties.

type DiagnoseResponseResult

type DiagnoseResponseResult struct {
	Value *DiagnoseResponseResultValue `json:"value,omitempty"`
}

type DiagnoseResponseResultValue

type DiagnoseResponseResultValue struct {
	ApplicationInsightsResults []*DiagnoseResult `json:"applicationInsightsResults,omitempty"`
	ContainerRegistryResults   []*DiagnoseResult `json:"containerRegistryResults,omitempty"`
	DNSResolutionResults       []*DiagnoseResult `json:"dnsResolutionResults,omitempty"`
	KeyVaultResults            []*DiagnoseResult `json:"keyVaultResults,omitempty"`
	NetworkSecurityRuleResults []*DiagnoseResult `json:"networkSecurityRuleResults,omitempty"`
	OtherResults               []*DiagnoseResult `json:"otherResults,omitempty"`
	ResourceLockResults        []*DiagnoseResult `json:"resourceLockResults,omitempty"`
	StorageAccountResults      []*DiagnoseResult `json:"storageAccountResults,omitempty"`
	UserDefinedRouteResults    []*DiagnoseResult `json:"userDefinedRouteResults,omitempty"`
}

type DiagnoseResult

type DiagnoseResult struct {
	// READ-ONLY; Code for workspace setup error
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; Level of workspace setup error
	Level *DiagnoseResultLevel `json:"level,omitempty" azure:"ro"`

	// READ-ONLY; Message of workspace setup error
	Message *string `json:"message,omitempty" azure:"ro"`
}

DiagnoseResult - Result of Diagnose

type DiagnoseResultLevel

type DiagnoseResultLevel string

DiagnoseResultLevel - Level of workspace setup error

const (
	DiagnoseResultLevelError       DiagnoseResultLevel = "Error"
	DiagnoseResultLevelInformation DiagnoseResultLevel = "Information"
	DiagnoseResultLevelWarning     DiagnoseResultLevel = "Warning"
)

func PossibleDiagnoseResultLevelValues

func PossibleDiagnoseResultLevelValues() []DiagnoseResultLevel

PossibleDiagnoseResultLevelValues returns the possible values for the DiagnoseResultLevel const type.

type DiagnoseWorkspaceParameters

type DiagnoseWorkspaceParameters struct {
	// Value of Parameters
	Value *DiagnoseRequestProperties `json:"value,omitempty"`
}

DiagnoseWorkspaceParameters - Parameters to diagnose a workspace

type EncryptionProperty

type EncryptionProperty struct {
	// REQUIRED; Customer Key vault properties.
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`

	// REQUIRED; Indicates whether or not the encryption is enabled for the workspace.
	Status *EncryptionStatus `json:"status,omitempty"`

	// The identity that will be used to access the key vault for encryption at rest.
	Identity *IdentityForCmk `json:"identity,omitempty"`
}

type EncryptionStatus

type EncryptionStatus string

EncryptionStatus - Indicates whether or not the encryption is enabled for the workspace.

const (
	EncryptionStatusDisabled EncryptionStatus = "Disabled"
	EncryptionStatusEnabled  EncryptionStatus = "Enabled"
)

func PossibleEncryptionStatusValues

func PossibleEncryptionStatusValues() []EncryptionStatus

PossibleEncryptionStatusValues returns the possible values for the EncryptionStatus const type.

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDetail

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

type ErrorResponse

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type EstimatedVMPrice

type EstimatedVMPrice struct {
	// REQUIRED; Operating system type used by the VM.
	OSType *VMPriceOSType `json:"osType,omitempty"`

	// REQUIRED; The price charged for using the VM.
	RetailPrice *float64 `json:"retailPrice,omitempty"`

	// REQUIRED; The type of the VM.
	VMTier *VMTier `json:"vmTier,omitempty"`
}

EstimatedVMPrice - The estimated price info for using a VM of a particular OS type, tier, etc.

type EstimatedVMPrices

type EstimatedVMPrices struct {
	// REQUIRED; Three lettered code specifying the currency of the VM price. Example: USD
	BillingCurrency *BillingCurrency `json:"billingCurrency,omitempty"`

	// REQUIRED; The unit of time measurement for the specified VM price. Example: OneHour
	UnitOfMeasure *UnitOfMeasure `json:"unitOfMeasure,omitempty"`

	// REQUIRED; The list of estimated prices for using a VM of a particular OS type, tier, etc.
	Values []*EstimatedVMPrice `json:"values,omitempty"`
}

EstimatedVMPrices - The estimated price info for using a VM.

type ExternalFQDNResponse

type ExternalFQDNResponse struct {
	Value []*FQDNEndpoints `json:"value,omitempty"`
}

type FQDNEndpoint

type FQDNEndpoint struct {
	DomainName      *string               `json:"domainName,omitempty"`
	EndpointDetails []*FQDNEndpointDetail `json:"endpointDetails,omitempty"`
}

type FQDNEndpointDetail

type FQDNEndpointDetail struct {
	Port *int32 `json:"port,omitempty"`
}

type FQDNEndpoints

type FQDNEndpoints struct {
	Properties *FQDNEndpointsProperties `json:"properties,omitempty"`
}

type FQDNEndpointsProperties

type FQDNEndpointsProperties struct {
	Category  *string         `json:"category,omitempty"`
	Endpoints []*FQDNEndpoint `json:"endpoints,omitempty"`
}

type HDInsight

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

	// HDInsight compute properties
	Properties *HDInsightProperties `json:"properties,omitempty"`

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

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

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

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

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

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

HDInsight - A HDInsight compute.

func (*HDInsight) GetCompute added in v0.2.0

func (h *HDInsight) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type HDInsight.

func (HDInsight) MarshalJSON

func (h HDInsight) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HDInsight.

func (*HDInsight) UnmarshalJSON

func (h *HDInsight) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HDInsight.

type HDInsightProperties

type HDInsightProperties struct {
	// Public IP address of the master node of the cluster.
	Address *string `json:"address,omitempty"`

	// Admin credentials for master node of the cluster
	AdministratorAccount *VirtualMachineSSHCredentials `json:"administratorAccount,omitempty"`

	// Port open for ssh connections on the master node of the cluster.
	SSHPort *int32 `json:"sshPort,omitempty"`
}

HDInsightProperties - HDInsight compute properties

type Identity

type Identity struct {
	// The identity type.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// The user assigned identities associated with the resource.
	UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

Identity for the resource.

func (Identity) MarshalJSON

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Identity.

type IdentityForCmk

type IdentityForCmk struct {
	// The ArmId of the user assigned identity that will be used to access the customer managed key vault
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

IdentityForCmk - Identity that will be used to access key vault for encryption at rest

type InstanceTypeSchema

type InstanceTypeSchema struct {
	// Node Selector
	NodeSelector map[string]*string `json:"nodeSelector,omitempty"`

	// Resource requests/limits for this instance type
	Resources *InstanceTypeSchemaResources `json:"resources,omitempty"`
}

InstanceTypeSchema - Instance type schema.

func (InstanceTypeSchema) MarshalJSON

func (i InstanceTypeSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InstanceTypeSchema.

type InstanceTypeSchemaResources

type InstanceTypeSchemaResources struct {
	// Resource limits for this instance type
	Limits map[string]*string `json:"limits,omitempty"`

	// Resource requests for this instance type
	Requests map[string]*string `json:"requests,omitempty"`
}

InstanceTypeSchemaResources - Resource requests/limits for this instance type

func (InstanceTypeSchemaResources) MarshalJSON

func (i InstanceTypeSchemaResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InstanceTypeSchemaResources.

type KeyVaultProperties

type KeyVaultProperties struct {
	// REQUIRED; Key vault uri to access the encryption key.
	KeyIdentifier *string `json:"keyIdentifier,omitempty"`

	// REQUIRED; The ArmId of the keyVault where the customer owned encryption key is present.
	KeyVaultArmID *string `json:"keyVaultArmId,omitempty"`

	// For future use - The client id of the identity which will be used to access key vault.
	IdentityClientID *string `json:"identityClientId,omitempty"`
}

type Kubernetes

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

	// Properties of Kubernetes
	Properties *KubernetesProperties `json:"properties,omitempty"`

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

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

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

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

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

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

Kubernetes - A Machine Learning compute based on Kubernetes Compute.

func (*Kubernetes) GetCompute added in v0.2.0

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 added in v0.2.0

func (k *Kubernetes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Kubernetes.

type KubernetesProperties

type KubernetesProperties struct {
	// Default instance type
	DefaultInstanceType *string `json:"defaultInstanceType,omitempty"`

	// Extension instance release train.
	ExtensionInstanceReleaseTrain *string `json:"extensionInstanceReleaseTrain,omitempty"`

	// Extension principal-id.
	ExtensionPrincipalID *string `json:"extensionPrincipalId,omitempty"`

	// Instance Type Schema
	InstanceTypes map[string]*InstanceTypeSchema `json:"instanceTypes,omitempty"`

	// Compute namespace
	Namespace *string `json:"namespace,omitempty"`

	// Relay connection string.
	RelayConnectionString *string `json:"relayConnectionString,omitempty"`

	// ServiceBus connection string.
	ServiceBusConnectionString *string `json:"serviceBusConnectionString,omitempty"`

	// VC name.
	VcName *string `json:"vcName,omitempty"`
}

KubernetesProperties - Kubernetes properties

func (KubernetesProperties) MarshalJSON

func (k KubernetesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesProperties.

type KubernetesSchema

type KubernetesSchema struct {
	// Properties of Kubernetes
	Properties *KubernetesProperties `json:"properties,omitempty"`
}

KubernetesSchema - Kubernetes Compute Schema

type ListAmlUserFeatureResult

type ListAmlUserFeatureResult struct {
	// READ-ONLY; The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next
	// page of AML user features information.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of AML user facing features.
	Value []*AmlUserFeature `json:"value,omitempty" azure:"ro"`
}

ListAmlUserFeatureResult - The List Aml user feature operation response.

type ListNotebookKeysResult

type ListNotebookKeysResult struct {
	// READ-ONLY
	PrimaryAccessKey *string `json:"primaryAccessKey,omitempty" azure:"ro"`

	// READ-ONLY
	SecondaryAccessKey *string `json:"secondaryAccessKey,omitempty" azure:"ro"`
}

type ListStorageAccountKeysResult

type ListStorageAccountKeysResult struct {
	// READ-ONLY
	UserStorageKey *string `json:"userStorageKey,omitempty" azure:"ro"`
}

type ListUsagesResult

type ListUsagesResult struct {
	// READ-ONLY; The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next
	// page of AML resource usage information.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of AML resource usages.
	Value []*Usage `json:"value,omitempty" azure:"ro"`
}

ListUsagesResult - The List Usages operation response.

type ListWorkspaceKeysResult

type ListWorkspaceKeysResult struct {
	// READ-ONLY
	AppInsightsInstrumentationKey *string `json:"appInsightsInstrumentationKey,omitempty" azure:"ro"`

	// READ-ONLY
	ContainerRegistryCredentials *RegistryListCredentialsResult `json:"containerRegistryCredentials,omitempty" azure:"ro"`

	// READ-ONLY
	NotebookAccessKeys *ListNotebookKeysResult `json:"notebookAccessKeys,omitempty" azure:"ro"`

	// READ-ONLY
	UserStorageKey *string `json:"userStorageKey,omitempty" azure:"ro"`

	// READ-ONLY
	UserStorageResourceID *string `json:"userStorageResourceId,omitempty" azure:"ro"`
}

type ListWorkspaceQuotas

type ListWorkspaceQuotas struct {
	// READ-ONLY; The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch
	// the next page of Workspace Quota information.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of Workspace Quotas by VM Family
	Value []*ResourceQuota `json:"value,omitempty" azure:"ro"`
}

ListWorkspaceQuotas - The List WorkspaceQuotasByVMFamily operation response.

type 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 NodeState

type NodeState string

NodeState - State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.

const (
	NodeStateIdle      NodeState = "idle"
	NodeStateLeaving   NodeState = "leaving"
	NodeStatePreempted NodeState = "preempted"
	NodeStatePreparing NodeState = "preparing"
	NodeStateRunning   NodeState = "running"
	NodeStateUnusable  NodeState = "unusable"
)

func PossibleNodeStateValues

func PossibleNodeStateValues() []NodeState

PossibleNodeStateValues returns the possible values for the NodeState const type.

type NodeStateCounts

type NodeStateCounts struct {
	// READ-ONLY; Number of compute nodes in idle state.
	IdleNodeCount *int32 `json:"idleNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are leaving the amlCompute.
	LeavingNodeCount *int32 `json:"leavingNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are in preempted state.
	PreemptedNodeCount *int32 `json:"preemptedNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are being prepared.
	PreparingNodeCount *int32 `json:"preparingNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are running jobs.
	RunningNodeCount *int32 `json:"runningNodeCount,omitempty" azure:"ro"`

	// READ-ONLY; Number of compute nodes which are in unusable state.
	UnusableNodeCount *int32 `json:"unusableNodeCount,omitempty" azure:"ro"`
}

NodeStateCounts - Counts of various compute node states on the amlCompute.

type NotebookAccessTokenResult

type NotebookAccessTokenResult struct {
	// READ-ONLY
	AccessToken *string `json:"accessToken,omitempty" azure:"ro"`

	// READ-ONLY
	ExpiresIn *int32 `json:"expiresIn,omitempty" azure:"ro"`

	// READ-ONLY
	HostName *string `json:"hostName,omitempty" azure:"ro"`

	// READ-ONLY
	NotebookResourceID *string `json:"notebookResourceId,omitempty" azure:"ro"`

	// READ-ONLY
	PublicDNS *string `json:"publicDns,omitempty" azure:"ro"`

	// READ-ONLY
	RefreshToken *string `json:"refreshToken,omitempty" azure:"ro"`

	// READ-ONLY
	Scope *string `json:"scope,omitempty" azure:"ro"`

	// READ-ONLY
	TokenType *string `json:"tokenType,omitempty" azure:"ro"`
}

type NotebookPreparationError

type NotebookPreparationError struct {
	ErrorMessage *string `json:"errorMessage,omitempty"`
	StatusCode   *int32  `json:"statusCode,omitempty"`
}

type NotebookResourceInfo

type NotebookResourceInfo struct {
	Fqdn *string `json:"fqdn,omitempty"`

	// The error that occurs when preparing notebook.
	NotebookPreparationError *NotebookPreparationError `json:"notebookPreparationError,omitempty"`

	// the data plane resourceId that used to initialize notebook component
	ResourceID *string `json:"resourceId,omitempty"`
}

type Operation

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

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

Operation - Azure Machine Learning workspace REST API operation

type OperationDisplay

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

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

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

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

OperationDisplay - Display name of operation

type OperationListResult

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

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

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 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 added in v0.4.0

NewListPager - Lists all of the available Azure Machine Learning Workspaces REST API operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListOptions added in v0.2.0

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

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 PaginatedComputeResourcesList

type PaginatedComputeResourcesList struct {
	// A continuation link (absolute URI) to the next page of results in the list.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of Machine Learning compute objects wrapped in ARM resource envelope.
	Value []*ComputeResource `json:"value,omitempty"`
}

PaginatedComputeResourcesList - Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.

type PaginatedWorkspaceConnectionsList

type PaginatedWorkspaceConnectionsList struct {
	// A continuation link (absolute URI) to the next page of results in the list.
	NextLink *string `json:"nextLink,omitempty"`

	// An array of Workspace connection objects.
	Value []*WorkspaceConnection `json:"value,omitempty"`
}

PaginatedWorkspaceConnectionsList - Paginated list of Workspace connection objects.

type Password

type Password struct {
	// READ-ONLY
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY
	Value *string `json:"value,omitempty" azure:"ro"`
}

type PersonalComputeInstanceSettings

type PersonalComputeInstanceSettings struct {
	// A user explicitly assigned to a personal compute instance.
	AssignedUser *AssignedUser `json:"assignedUser,omitempty"`
}

PersonalComputeInstanceSettings - Settings for a personal compute instance.

type PrivateEndpoint

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The ARM identifier for Subnet resource that private endpoint links to
	SubnetArmID *string `json:"subnetArmId,omitempty" azure:"ro"`
}

PrivateEndpoint - The Private Endpoint resource.

type PrivateEndpointConnection

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

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

	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

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

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

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

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

	// READ-ONLY; System data
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

PrivateEndpointConnection - The Private Endpoint Connection resource.

func (PrivateEndpointConnection) MarshalJSON

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - List of private endpoint connection associated with the specified workspace

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state.

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

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

func (*PrivateEndpointConnectionsClient) CreateOrUpdate

func (client *PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, properties PrivateEndpointConnection, options *PrivateEndpointConnectionsClientCreateOrUpdateOptions) (PrivateEndpointConnectionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Update the state of specified private endpoint connection associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. privateEndpointConnectionName - The name of the private endpoint connection associated with the workspace properties - The private endpoint connection properties. options - PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdate(ctx,
		"rg-1234",
		"testworkspace",
		"{privateEndpointConnectionName}",
		armmachinelearningservices.PrivateEndpointConnection{
			Properties: &armmachinelearningservices.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armmachinelearningservices.PrivateLinkServiceConnectionState{
					Description: to.Ptr("Auto-Approved"),
					Status:      to.Ptr(armmachinelearningservices.PrivateEndpointServiceConnectionStatusApproved),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PrivateEndpointConnectionsClient) Delete

func (client *PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientDeleteOptions) (PrivateEndpointConnectionsClientDeleteResponse, error)

Delete - Deletes the specified private endpoint connection associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. privateEndpointConnectionName - The name of the private endpoint connection associated with the workspace options - PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewPrivateEndpointConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"rg-1234",
		"testworkspace",
		"{privateEndpointConnectionName}",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*PrivateEndpointConnectionsClient) Get

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. privateEndpointConnectionName - The name of the private endpoint connection associated with the workspace options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*PrivateEndpointConnectionsClient) NewListPager added in v0.4.0

NewListPager - List all the private endpoint connections associated with the workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

type PrivateEndpointConnectionsClientCreateOrUpdateOptions added in v0.2.0

type PrivateEndpointConnectionsClientCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionsClientCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.CreateOrUpdate method.

type PrivateEndpointConnectionsClientCreateOrUpdateResponse added in v0.2.0

type PrivateEndpointConnectionsClientCreateOrUpdateResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateOrUpdateResponse contains the response from method PrivateEndpointConnectionsClient.CreateOrUpdate.

type PrivateEndpointConnectionsClientDeleteOptions added in v0.2.0

type PrivateEndpointConnectionsClientDeleteOptions struct {
}

PrivateEndpointConnectionsClientDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Delete method.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions added in v0.2.0

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

type PrivateEndpointConnectionsClientListResponse added in v0.2.0

type PrivateEndpointConnectionsClientListResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.List.

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status.

const (
	PrivateEndpointServiceConnectionStatusApproved     PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusDisconnected PrivateEndpointServiceConnectionStatus = "Disconnected"
	PrivateEndpointServiceConnectionStatusPending      PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected     PrivateEndpointServiceConnectionStatus = "Rejected"
	PrivateEndpointServiceConnectionStatusTimeout      PrivateEndpointServiceConnectionStatus = "Timeout"
)

func PossiblePrivateEndpointServiceConnectionStatusValues

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource

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

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

	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

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

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

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

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

	// READ-ONLY; System data
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON

func (p PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

type PrivateLinkResourceProperties

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

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

func (*PrivateLinkResourcesClient) List

List - Gets the private link resources that need to be created for a workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

type PrivateLinkResourcesClientListOptions added in v0.2.0

type PrivateLinkResourcesClientListOptions struct {
}

PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

type PrivateLinkResourcesClientListResponse added in v0.2.0

type PrivateLinkResourcesClientListResponse struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListResponse contains the response from method PrivateLinkResourcesClient.List.

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type 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 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 QuotaBaseProperties

type QuotaBaseProperties struct {
	// Specifies the resource ID.
	ID *string `json:"id,omitempty"`

	// The maximum permitted quota of the resource.
	Limit *int64 `json:"limit,omitempty"`

	// Specifies the resource type.
	Type *string `json:"type,omitempty"`

	// An enum describing the unit of quota measurement.
	Unit *QuotaUnit `json:"unit,omitempty"`
}

QuotaBaseProperties - The properties for Quota update or retrieval.

type QuotaUnit

type QuotaUnit string

QuotaUnit - An enum describing the unit of quota measurement.

const (
	QuotaUnitCount QuotaUnit = "Count"
)

func PossibleQuotaUnitValues

func PossibleQuotaUnitValues() []QuotaUnit

PossibleQuotaUnitValues returns the possible values for the QuotaUnit const type.

type QuotaUpdateParameters

type QuotaUpdateParameters struct {
	// Region of workspace quota to be updated.
	Location *string `json:"location,omitempty"`

	// The list for update quota.
	Value []*QuotaBaseProperties `json:"value,omitempty"`
}

QuotaUpdateParameters - Quota update parameters.

func (QuotaUpdateParameters) MarshalJSON

func (q QuotaUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaUpdateParameters.

type QuotasClient

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

QuotasClient contains the methods for the Quotas group. Don't use this type directly, use NewQuotasClient() instead.

func NewQuotasClient

func NewQuotasClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*QuotasClient, error)

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

func (*QuotasClient) NewListPager added in v0.4.0

func (client *QuotasClient) NewListPager(location string, options *QuotasClientListOptions) *runtime.Pager[QuotasClientListResponse]

NewListPager - Gets the currently assigned Workspace Quotas based on VMFamily. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 location - The location for which resource usage is queried. options - QuotasClientListOptions contains the optional parameters for the QuotasClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewQuotasClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("eastus",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*QuotasClient) Update

Update - Update quota for each VM family in workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 location - The location for update quota is queried. parameters - Quota update parameters. options - QuotasClientUpdateOptions contains the optional parameters for the QuotasClient.Update method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewQuotasClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"eastus",
		armmachinelearningservices.QuotaUpdateParameters{
			Value: []*armmachinelearningservices.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(armmachinelearningservices.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(armmachinelearningservices.QuotaUnitCount),
				}},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type QuotasClientListOptions added in v0.2.0

type QuotasClientListOptions struct {
}

QuotasClientListOptions contains the optional parameters for the QuotasClient.List method.

type QuotasClientListResponse added in v0.2.0

type QuotasClientListResponse struct {
	ListWorkspaceQuotas
}

QuotasClientListResponse contains the response from method QuotasClient.List.

type QuotasClientUpdateOptions added in v0.2.0

type QuotasClientUpdateOptions struct {
}

QuotasClientUpdateOptions contains the optional parameters for the QuotasClient.Update method.

type QuotasClientUpdateResponse added in v0.2.0

type QuotasClientUpdateResponse struct {
	UpdateWorkspaceQuotasResult
}

QuotasClientUpdateResponse contains the response from method QuotasClient.Update.

type ReasonCode

type ReasonCode string

ReasonCode - The reason for the restriction.

const (
	ReasonCodeNotAvailableForRegion       ReasonCode = "NotAvailableForRegion"
	ReasonCodeNotAvailableForSubscription ReasonCode = "NotAvailableForSubscription"
	ReasonCodeNotSpecified                ReasonCode = "NotSpecified"
)

func PossibleReasonCodeValues

func PossibleReasonCodeValues() []ReasonCode

PossibleReasonCodeValues returns the possible values for the ReasonCode const type.

type RegistryListCredentialsResult

type RegistryListCredentialsResult struct {
	Passwords []*Password `json:"passwords,omitempty"`

	// READ-ONLY
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY
	Username *string `json:"username,omitempty" azure:"ro"`
}

type RemoteLoginPortPublicAccess

type RemoteLoginPortPublicAccess string

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

const (
	RemoteLoginPortPublicAccessDisabled     RemoteLoginPortPublicAccess = "Disabled"
	RemoteLoginPortPublicAccessEnabled      RemoteLoginPortPublicAccess = "Enabled"
	RemoteLoginPortPublicAccessNotSpecified RemoteLoginPortPublicAccess = "NotSpecified"
)

func PossibleRemoteLoginPortPublicAccessValues

func PossibleRemoteLoginPortPublicAccessValues() []RemoteLoginPortPublicAccess

PossibleRemoteLoginPortPublicAccessValues returns the possible values for the RemoteLoginPortPublicAccess const type.

type Resource

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

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

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

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type ResourceID

type ResourceID struct {
	// REQUIRED; The ID of the resource
	ID *string `json:"id,omitempty"`
}

ResourceID - Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

type ResourceIdentityType

type ResourceIdentityType string

ResourceIdentityType - The identity type.

const (
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned,UserAssigned"
	ResourceIdentityTypeUserAssigned               ResourceIdentityType = "UserAssigned"
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
)

func PossibleResourceIdentityTypeValues

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

type ResourceName

type ResourceName struct {
	// READ-ONLY; The localized name of the resource.
	LocalizedValue *string `json:"localizedValue,omitempty" azure:"ro"`

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

ResourceName - The Resource Name.

type ResourceQuota

type ResourceQuota struct {
	// READ-ONLY; Region of the AML workspace in the id.
	AmlWorkspaceLocation *string `json:"amlWorkspaceLocation,omitempty" azure:"ro"`

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

	// READ-ONLY; The maximum permitted quota of the resource.
	Limit *int64 `json:"limit,omitempty" azure:"ro"`

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

	// READ-ONLY; Specifies the resource type.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; An enum describing the unit of quota measurement.
	Unit *QuotaUnit `json:"unit,omitempty" azure:"ro"`
}

ResourceQuota - The quota assigned to a resource.

type ResourceSKULocationInfo

type ResourceSKULocationInfo struct {
	// READ-ONLY; Location of the SKU
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Details of capabilities available to a SKU in specific zones.
	ZoneDetails []*ResourceSKUZoneDetails `json:"zoneDetails,omitempty" azure:"ro"`

	// READ-ONLY; List of availability zones where the SKU is supported.
	Zones []*string `json:"zones,omitempty" azure:"ro"`
}

type ResourceSKUZoneDetails

type ResourceSKUZoneDetails struct {
	// READ-ONLY; A list of capabilities that are available for the SKU in the specified list of zones.
	Capabilities []*SKUCapability `json:"capabilities,omitempty" azure:"ro"`

	// READ-ONLY; The set of zones that the SKU is available in with the specified capabilities.
	Name []*string `json:"name,omitempty" azure:"ro"`
}

ResourceSKUZoneDetails - Describes The zonal capabilities of a SKU.

type Restriction

type Restriction struct {
	// The reason for the restriction.
	ReasonCode *ReasonCode `json:"reasonCode,omitempty"`

	// READ-ONLY; The type of restrictions. As of now only possible value for this is location.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where
	// the SKU is restricted.
	Values []*string `json:"values,omitempty" azure:"ro"`
}

Restriction - The restriction because of which SKU cannot be used.

type SKU

type SKU struct {
	// Name of the sku
	Name *string `json:"name,omitempty"`

	// Tier of the sku like Basic or Enterprise
	Tier *string `json:"tier,omitempty"`
}

SKU - Sku of the resource

type SKUCapability

type SKUCapability struct {
	// Capability/Feature ID
	Name *string `json:"name,omitempty"`

	// Details about the feature/capability
	Value *string `json:"value,omitempty"`
}

SKUCapability - Features/user capabilities associated with the sku

type SKUListResult

type SKUListResult struct {
	// The URI to fetch the next page of Workspace Skus. Call ListNext() with this URI to fetch the next page of Workspace Skus
	NextLink *string         `json:"nextLink,omitempty"`
	Value    []*WorkspaceSKU `json:"value,omitempty"`
}

SKUListResult - List of skus with features

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 SSLConfiguration

type SSLConfiguration struct {
	// Cert data
	Cert *string `json:"cert,omitempty"`

	// CNAME of the cert
	Cname *string `json:"cname,omitempty"`

	// Key data
	Key *string `json:"key,omitempty"`

	// Leaf domain label of public endpoint
	LeafDomainLabel *string `json:"leafDomainLabel,omitempty"`

	// Indicates whether to overwrite existing domain label.
	OverwriteExistingDomain *bool `json:"overwriteExistingDomain,omitempty"`

	// Enable or disable ssl for scoring
	Status *SSLConfigurationStatus `json:"status,omitempty"`
}

SSLConfiguration - The ssl configuration for scoring

type SSLConfigurationStatus

type SSLConfigurationStatus string

SSLConfigurationStatus - Enable or disable ssl for scoring

const (
	SSLConfigurationStatusAuto     SSLConfigurationStatus = "Auto"
	SSLConfigurationStatusDisabled SSLConfigurationStatus = "Disabled"
	SSLConfigurationStatusEnabled  SSLConfigurationStatus = "Enabled"
)

func PossibleSSLConfigurationStatusValues

func PossibleSSLConfigurationStatusValues() []SSLConfigurationStatus

PossibleSSLConfigurationStatusValues returns the possible values for the SSLConfigurationStatus const type.

type ScaleSettings

type ScaleSettings struct {
	// REQUIRED; Max number of nodes to use
	MaxNodeCount *int32 `json:"maxNodeCount,omitempty"`

	// Min number of nodes to use
	MinNodeCount *int32 `json:"minNodeCount,omitempty"`

	// Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.
	NodeIdleTimeBeforeScaleDown *string `json:"nodeIdleTimeBeforeScaleDown,omitempty"`
}

ScaleSettings - scale settings for AML Compute

type ScaleSettingsInformation

type ScaleSettingsInformation struct {
	// scale settings for AML Compute
	ScaleSettings *ScaleSettings `json:"scaleSettings,omitempty"`
}

ScaleSettingsInformation - Desired scale settings for the amlCompute.

type ScriptReference

type ScriptReference struct {
	// Optional command line arguments passed to the script to run.
	ScriptArguments *string `json:"scriptArguments,omitempty"`

	// The location of scripts in the mounted volume.
	ScriptData *string `json:"scriptData,omitempty"`

	// The storage source of the script: inline, workspace.
	ScriptSource *string `json:"scriptSource,omitempty"`

	// Optional time period passed to timeout command.
	Timeout *string `json:"timeout,omitempty"`
}

ScriptReference - Script reference

type ScriptsToExecute

type ScriptsToExecute struct {
	// Script that's run only once during provision of the compute.
	CreationScript *ScriptReference `json:"creationScript,omitempty"`

	// Script that's run every time the machine starts.
	StartupScript *ScriptReference `json:"startupScript,omitempty"`
}

ScriptsToExecute - Customized setup scripts

type ServiceManagedResourcesSettings

type ServiceManagedResourcesSettings struct {
	// The settings for the service managed cosmosdb account.
	CosmosDb *CosmosDbSettings `json:"cosmosDb,omitempty"`
}

type ServicePrincipalCredentials

type ServicePrincipalCredentials struct {
	// REQUIRED; Client Id
	ClientID *string `json:"clientId,omitempty"`

	// REQUIRED; Client secret
	ClientSecret *string `json:"clientSecret,omitempty"`
}

ServicePrincipalCredentials - Service principal credentials.

type SetupScripts

type SetupScripts struct {
	// Customized setup scripts
	Scripts *ScriptsToExecute `json:"scripts,omitempty"`
}

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

type SharedPrivateLinkResource

type SharedPrivateLinkResource struct {
	// Unique name of the private link.
	Name *string `json:"name,omitempty"`

	// Resource properties.
	Properties *SharedPrivateLinkResourceProperty `json:"properties,omitempty"`
}

type SharedPrivateLinkResourceProperty

type SharedPrivateLinkResourceProperty struct {
	// The private link resource group id.
	GroupID *string `json:"groupId,omitempty"`

	// The resource id that private link links to.
	PrivateLinkResourceID *string `json:"privateLinkResourceId,omitempty"`

	// Request message.
	RequestMessage *string `json:"requestMessage,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

SharedPrivateLinkResourceProperty - Properties of a shared private link resource.

type 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 SynapseSpark

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

SynapseSpark - A SynapseSpark compute.

func (*SynapseSpark) GetCompute added in v0.2.0

func (s *SynapseSpark) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type SynapseSpark.

func (SynapseSpark) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SynapseSpark.

func (*SynapseSpark) UnmarshalJSON

func (s *SynapseSpark) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SynapseSpark.

type SynapseSparkProperties

type SynapseSparkProperties struct {
	// Auto pause properties.
	AutoPauseProperties *AutoPauseProperties `json:"autoPauseProperties,omitempty"`

	// Auto scale properties.
	AutoScaleProperties *AutoScaleProperties `json:"autoScaleProperties,omitempty"`

	// The number of compute nodes currently assigned to the compute.
	NodeCount *int32 `json:"nodeCount,omitempty"`

	// Node size.
	NodeSize *string `json:"nodeSize,omitempty"`

	// Node size family.
	NodeSizeFamily *string `json:"nodeSizeFamily,omitempty"`

	// Pool name.
	PoolName *string `json:"poolName,omitempty"`

	// Name of the resource group in which workspace is located.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// Spark version.
	SparkVersion *string `json:"sparkVersion,omitempty"`

	// Azure subscription identifier.
	SubscriptionID *string `json:"subscriptionId,omitempty"`

	// Name of Azure Machine Learning workspace.
	WorkspaceName *string `json:"workspaceName,omitempty"`
}

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type SystemService

type SystemService struct {
	// READ-ONLY; Public IP address
	PublicIPAddress *string `json:"publicIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; The type of this system service.
	SystemServiceType *string `json:"systemServiceType,omitempty" azure:"ro"`

	// READ-ONLY; The version for this type.
	Version *string `json:"version,omitempty" azure:"ro"`
}

SystemService - A system service running on a compute.

type UnderlyingResourceAction

type UnderlyingResourceAction string
const (
	UnderlyingResourceActionDelete UnderlyingResourceAction = "Delete"
	UnderlyingResourceActionDetach UnderlyingResourceAction = "Detach"
)

func PossibleUnderlyingResourceActionValues

func PossibleUnderlyingResourceActionValues() []UnderlyingResourceAction

PossibleUnderlyingResourceActionValues returns the possible values for the UnderlyingResourceAction const type.

type UnitOfMeasure

type UnitOfMeasure string

UnitOfMeasure - The unit of time measurement for the specified VM price. Example: OneHour

const (
	UnitOfMeasureOneHour UnitOfMeasure = "OneHour"
)

func PossibleUnitOfMeasureValues

func PossibleUnitOfMeasureValues() []UnitOfMeasure

PossibleUnitOfMeasureValues returns the possible values for the UnitOfMeasure const type.

type UpdateWorkspaceQuotas

type UpdateWorkspaceQuotas struct {
	// The maximum permitted quota of the resource.
	Limit *int64 `json:"limit,omitempty"`

	// Status of update workspace quota.
	Status *Status `json:"status,omitempty"`

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

	// READ-ONLY; Specifies the resource type.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; An enum describing the unit of quota measurement.
	Unit *QuotaUnit `json:"unit,omitempty" azure:"ro"`
}

UpdateWorkspaceQuotas - The properties for update Quota response.

type UpdateWorkspaceQuotasResult

type UpdateWorkspaceQuotasResult struct {
	// READ-ONLY; The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next
	// page of Workspace Quota update result.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The list of workspace quota update result.
	Value []*UpdateWorkspaceQuotas `json:"value,omitempty" azure:"ro"`
}

UpdateWorkspaceQuotasResult - The result of update workspace quota.

type Usage

type Usage struct {
	// READ-ONLY; Region of the AML workspace in the id.
	AmlWorkspaceLocation *string `json:"amlWorkspaceLocation,omitempty" azure:"ro"`

	// READ-ONLY; The current usage of the resource.
	CurrentValue *int64 `json:"currentValue,omitempty" azure:"ro"`

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

	// READ-ONLY; The maximum permitted usage of the resource.
	Limit *int64 `json:"limit,omitempty" azure:"ro"`

	// READ-ONLY; The name of the type of usage.
	Name *UsageName `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Specifies the resource type.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; An enum describing the unit of usage measurement.
	Unit *UsageUnit `json:"unit,omitempty" azure:"ro"`
}

Usage - Describes AML Resource Usage.

type UsageName

type UsageName struct {
	// READ-ONLY; The localized name of the resource.
	LocalizedValue *string `json:"localizedValue,omitempty" azure:"ro"`

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

UsageName - The Usage Names.

type UsageUnit

type UsageUnit string

UsageUnit - An enum describing the unit of usage measurement.

const (
	UsageUnitCount UsageUnit = "Count"
)

func PossibleUsageUnitValues

func PossibleUsageUnitValues() []UsageUnit

PossibleUsageUnitValues returns the possible values for the UsageUnit const type.

type UsagesClient

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

UsagesClient contains the methods for the Usages group. Don't use this type directly, use NewUsagesClient() instead.

func NewUsagesClient

func NewUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*UsagesClient, error)

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

func (*UsagesClient) NewListPager added in v0.4.0

func (client *UsagesClient) NewListPager(location string, options *UsagesClientListOptions) *runtime.Pager[UsagesClientListResponse]

NewListPager - Gets the current usage information as well as limits for AML resources for given subscription and location. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 location - The location for which resource usage is queried. options - UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewUsagesClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("eastus",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type UsagesClientListOptions added in v0.2.0

type UsagesClientListOptions struct {
}

UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

type UsagesClientListResponse added in v0.2.0

type UsagesClientListResponse struct {
	ListUsagesResult
}

UsagesClientListResponse contains the response from method UsagesClient.List.

type UserAccountCredentials

type UserAccountCredentials struct {
	// REQUIRED; Name of the administrator user account which can be used to SSH to nodes.
	AdminUserName *string `json:"adminUserName,omitempty"`

	// Password of the administrator user account.
	AdminUserPassword *string `json:"adminUserPassword,omitempty"`

	// SSH public key of the administrator user account.
	AdminUserSSHPublicKey *string `json:"adminUserSshPublicKey,omitempty"`
}

UserAccountCredentials - Settings for user account that gets created on each on the nodes of a compute.

type UserAssignedIdentity

type UserAssignedIdentity struct {
	// READ-ONLY; The clientId(aka appId) of the user assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal ID of the user assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of the user assigned identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

UserAssignedIdentity - User Assigned Identity

type VMPriceOSType

type VMPriceOSType string

VMPriceOSType - Operating system type used by the VM.

const (
	VMPriceOSTypeLinux   VMPriceOSType = "Linux"
	VMPriceOSTypeWindows VMPriceOSType = "Windows"
)

func PossibleVMPriceOSTypeValues

func PossibleVMPriceOSTypeValues() []VMPriceOSType

PossibleVMPriceOSTypeValues returns the possible values for the VMPriceOSType const type.

type VMPriority

type VMPriority string

VMPriority - Virtual Machine priority

const (
	VMPriorityDedicated   VMPriority = "Dedicated"
	VMPriorityLowPriority VMPriority = "LowPriority"
)

func PossibleVMPriorityValues

func PossibleVMPriorityValues() []VMPriority

PossibleVMPriorityValues returns the possible values for the VMPriority const type.

type VMTier

type VMTier string

VMTier - The type of the VM.

const (
	VMTierLowPriority VMTier = "LowPriority"
	VMTierSpot        VMTier = "Spot"
	VMTierStandard    VMTier = "Standard"
)

func PossibleVMTierValues

func PossibleVMTierValues() []VMTier

PossibleVMTierValues returns the possible values for the VMTier const type.

type ValueFormat

type ValueFormat string

ValueFormat - format for the workspace connection value

const (
	ValueFormatJSON ValueFormat = "JSON"
)

func PossibleValueFormatValues

func PossibleValueFormatValues() []ValueFormat

PossibleValueFormatValues returns the possible values for the ValueFormat const type.

type VirtualMachine

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

	// Location for the underlying compute
	ComputeLocation *string `json:"computeLocation,omitempty"`

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

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

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

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

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

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

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

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

VirtualMachine - A Machine Learning compute based on Azure Virtual Machines.

func (*VirtualMachine) GetCompute added in v0.2.0

func (v *VirtualMachine) GetCompute() *Compute

GetCompute implements the ComputeClassification interface for type VirtualMachine.

func (VirtualMachine) MarshalJSON

func (v VirtualMachine) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualMachine.

func (*VirtualMachine) UnmarshalJSON

func (v *VirtualMachine) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachine.

type VirtualMachineImage

type VirtualMachineImage struct {
	// REQUIRED; Virtual Machine image path
	ID *string `json:"id,omitempty"`
}

VirtualMachineImage - Virtual Machine image for Windows AML Compute

type VirtualMachineProperties

type VirtualMachineProperties struct {
	// Public IP address of the virtual machine.
	Address *string `json:"address,omitempty"`

	// Admin credentials for virtual machine
	AdministratorAccount *VirtualMachineSSHCredentials `json:"administratorAccount,omitempty"`

	// Indicates whether this compute will be used for running notebooks.
	IsNotebookInstanceCompute *bool `json:"isNotebookInstanceCompute,omitempty"`

	// Port open for ssh connections.
	SSHPort *int32 `json:"sshPort,omitempty"`

	// Virtual Machine size
	VirtualMachineSize *string `json:"virtualMachineSize,omitempty"`
}

type VirtualMachineSSHCredentials

type VirtualMachineSSHCredentials struct {
	// Password of admin account
	Password *string `json:"password,omitempty"`

	// Private key data
	PrivateKeyData *string `json:"privateKeyData,omitempty"`

	// Public key data
	PublicKeyData *string `json:"publicKeyData,omitempty"`

	// Username of admin account
	Username *string `json:"username,omitempty"`
}

VirtualMachineSSHCredentials - Admin credentials for virtual machine

type VirtualMachineSecrets

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

	// Admin credentials for virtual machine.
	AdministratorAccount *VirtualMachineSSHCredentials `json:"administratorAccount,omitempty"`
}

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

func (*VirtualMachineSecrets) GetComputeSecrets added in v0.2.0

func (v *VirtualMachineSecrets) GetComputeSecrets() *ComputeSecrets

GetComputeSecrets implements the ComputeSecretsClassification interface for type VirtualMachineSecrets.

func (*VirtualMachineSecrets) UnmarshalJSON

func (v *VirtualMachineSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineSecrets.

type VirtualMachineSize

type VirtualMachineSize struct {
	// The estimated price information for using a VM.
	EstimatedVMPrices *EstimatedVMPrices `json:"estimatedVMPrices,omitempty"`

	// Specifies the compute types supported by the virtual machine size.
	SupportedComputeTypes []*string `json:"supportedComputeTypes,omitempty"`

	// READ-ONLY; The family name of the virtual machine size.
	Family *string `json:"family,omitempty" azure:"ro"`

	// READ-ONLY; The number of gPUs supported by the virtual machine size.
	Gpus *int32 `json:"gpus,omitempty" azure:"ro"`

	// READ-ONLY; Specifies if the virtual machine size supports low priority VMs.
	LowPriorityCapable *bool `json:"lowPriorityCapable,omitempty" azure:"ro"`

	// READ-ONLY; The resource volume size, in MB, allowed by the virtual machine size.
	MaxResourceVolumeMB *int32 `json:"maxResourceVolumeMB,omitempty" azure:"ro"`

	// READ-ONLY; The amount of memory, in GB, supported by the virtual machine size.
	MemoryGB *float64 `json:"memoryGB,omitempty" azure:"ro"`

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

	// READ-ONLY; The OS VHD disk size, in MB, allowed by the virtual machine size.
	OSVhdSizeMB *int32 `json:"osVhdSizeMB,omitempty" azure:"ro"`

	// READ-ONLY; Specifies if the virtual machine size supports premium IO.
	PremiumIO *bool `json:"premiumIO,omitempty" azure:"ro"`

	// READ-ONLY; The number of vCPUs supported by the virtual machine size.
	VCPUs *int32 `json:"vCPUs,omitempty" azure:"ro"`
}

VirtualMachineSize - Describes the properties of a VM size.

type VirtualMachineSizeListResult

type VirtualMachineSizeListResult struct {
	// The list of virtual machine sizes supported by AmlCompute.
	Value []*VirtualMachineSize `json:"value,omitempty"`
}

VirtualMachineSizeListResult - The List Virtual Machine size operation response.

type VirtualMachineSizesClient

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

VirtualMachineSizesClient contains the methods for the VirtualMachineSizes group. Don't use this type directly, use NewVirtualMachineSizesClient() instead.

func NewVirtualMachineSizesClient

func NewVirtualMachineSizesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VirtualMachineSizesClient, error)

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

func (*VirtualMachineSizesClient) List

List - Returns supported VM Sizes in a location If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 location - The location upon which virtual-machine-sizes is queried. options - VirtualMachineSizesClientListOptions contains the optional parameters for the VirtualMachineSizesClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

type VirtualMachineSizesClientListOptions added in v0.2.0

type VirtualMachineSizesClientListOptions struct {
}

VirtualMachineSizesClientListOptions contains the optional parameters for the VirtualMachineSizesClient.List method.

type VirtualMachineSizesClientListResponse added in v0.2.0

type VirtualMachineSizesClientListResponse struct {
	VirtualMachineSizeListResult
}

VirtualMachineSizesClientListResponse contains the response from method VirtualMachineSizesClient.List.

type Workspace

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

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

	// The properties of the machine learning workspace.
	Properties *WorkspaceProperties `json:"properties,omitempty"`

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

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

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

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

	// READ-ONLY; System data
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

Workspace - An object that represents a machine learning workspace.

func (Workspace) MarshalJSON

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Workspace.

type WorkspaceConnection

type WorkspaceConnection struct {
	// Properties of workspace connection.
	Properties *WorkspaceConnectionProps `json:"properties,omitempty"`

	// READ-ONLY; ResourceId of the workspace connection.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Friendly name of the workspace connection.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type of workspace connection.
	Type *string `json:"type,omitempty" azure:"ro"`
}

WorkspaceConnection - Workspace connection.

type WorkspaceConnectionProps

type WorkspaceConnectionProps struct {
	// Authorization type of the workspace connection.
	AuthType *string `json:"authType,omitempty"`

	// Category of the workspace connection.
	Category *string `json:"category,omitempty"`

	// Target of the workspace connection.
	Target *string `json:"target,omitempty"`

	// Value details of the workspace connection.
	Value *string `json:"value,omitempty"`

	// format for the workspace connection value
	ValueFormat *ValueFormat `json:"valueFormat,omitempty"`
}

WorkspaceConnectionProps - Workspace Connection specific properties.

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

func (client *WorkspaceConnectionsClient) Create(ctx context.Context, resourceGroupName string, workspaceName string, connectionName string, parameters WorkspaceConnection, options *WorkspaceConnectionsClientCreateOptions) (WorkspaceConnectionsClientCreateResponse, error)

Create - Add a new workspace connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. connectionName - Friendly name of the workspace connection parameters - The object for creating or updating a new workspace connection options - WorkspaceConnectionsClientCreateOptions contains the optional parameters for the WorkspaceConnectionsClient.Create method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Create(ctx,
		"resourceGroup-1",
		"workspace-1",
		"connection-1",
		armmachinelearningservices.WorkspaceConnection{
			Properties: &armmachinelearningservices.WorkspaceConnectionProps{
				AuthType: to.Ptr("PAT"),
				Category: to.Ptr("ACR"),
				Target:   to.Ptr("www.facebook.com"),
				Value:    to.Ptr("secrets"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspaceConnectionsClient) Delete

func (client *WorkspaceConnectionsClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string, connectionName string, options *WorkspaceConnectionsClientDeleteOptions) (WorkspaceConnectionsClientDeleteResponse, error)

Delete - Delete a workspace connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. connectionName - Friendly name of the workspace connection options - WorkspaceConnectionsClientDeleteOptions contains the optional parameters for the WorkspaceConnectionsClient.Delete method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = client.Delete(ctx,
		"resourceGroup-1",
		"workspace-1",
		"connection-1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}
Output:

func (*WorkspaceConnectionsClient) Get

func (client *WorkspaceConnectionsClient) Get(ctx context.Context, resourceGroupName string, workspaceName string, connectionName string, options *WorkspaceConnectionsClientGetOptions) (WorkspaceConnectionsClientGetResponse, error)

Get - Get the detail of a workspace connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. connectionName - Friendly name of the workspace connection options - WorkspaceConnectionsClientGetOptions contains the optional parameters for the WorkspaceConnectionsClient.Get method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"resourceGroup-1",
		"workspace-1",
		"connection-1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspaceConnectionsClient) NewListPager added in v0.4.0

NewListPager - List all connections under a AML workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspaceConnectionsClientListOptions contains the optional parameters for the WorkspaceConnectionsClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspaceConnectionsClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("resourceGroup-1",
		"workspace-1",
		&armmachinelearningservices.WorkspaceConnectionsClientListOptions{Target: to.Ptr("www.facebook.com"),
			Category: to.Ptr("ACR"),
		})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type WorkspaceConnectionsClientCreateOptions added in v0.2.0

type WorkspaceConnectionsClientCreateOptions struct {
}

WorkspaceConnectionsClientCreateOptions contains the optional parameters for the WorkspaceConnectionsClient.Create method.

type WorkspaceConnectionsClientCreateResponse added in v0.2.0

type WorkspaceConnectionsClientCreateResponse struct {
	WorkspaceConnection
}

WorkspaceConnectionsClientCreateResponse contains the response from method WorkspaceConnectionsClient.Create.

type WorkspaceConnectionsClientDeleteOptions added in v0.2.0

type WorkspaceConnectionsClientDeleteOptions struct {
}

WorkspaceConnectionsClientDeleteOptions contains the optional parameters for the WorkspaceConnectionsClient.Delete method.

type WorkspaceConnectionsClientDeleteResponse added in v0.2.0

type WorkspaceConnectionsClientDeleteResponse struct {
}

WorkspaceConnectionsClientDeleteResponse contains the response from method WorkspaceConnectionsClient.Delete.

type WorkspaceConnectionsClientGetOptions added in v0.2.0

type WorkspaceConnectionsClientGetOptions struct {
}

WorkspaceConnectionsClientGetOptions contains the optional parameters for the WorkspaceConnectionsClient.Get method.

type WorkspaceConnectionsClientGetResponse added in v0.2.0

type WorkspaceConnectionsClientGetResponse struct {
	WorkspaceConnection
}

WorkspaceConnectionsClientGetResponse contains the response from method WorkspaceConnectionsClient.Get.

type WorkspaceConnectionsClientListOptions added in v0.2.0

type WorkspaceConnectionsClientListOptions struct {
	// Category of the workspace connection.
	Category *string
	// Target of the workspace connection.
	Target *string
}

WorkspaceConnectionsClientListOptions contains the optional parameters for the WorkspaceConnectionsClient.List method.

type WorkspaceConnectionsClientListResponse added in v0.2.0

type WorkspaceConnectionsClientListResponse struct {
	PaginatedWorkspaceConnectionsList
}

WorkspaceConnectionsClientListResponse contains the response from method WorkspaceConnectionsClient.List.

type WorkspaceFeaturesClient

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

WorkspaceFeaturesClient contains the methods for the WorkspaceFeatures group. Don't use this type directly, use NewWorkspaceFeaturesClient() instead.

func NewWorkspaceFeaturesClient

func NewWorkspaceFeaturesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceFeaturesClient, error)

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

func (*WorkspaceFeaturesClient) NewListPager added in v0.4.0

func (client *WorkspaceFeaturesClient) NewListPager(resourceGroupName string, workspaceName string, options *WorkspaceFeaturesClientListOptions) *runtime.Pager[WorkspaceFeaturesClientListResponse]

NewListPager - Lists all enabled features for a workspace If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspaceFeaturesClientListOptions contains the optional parameters for the WorkspaceFeaturesClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspaceFeaturesClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("myResourceGroup",
		"testworkspace",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type WorkspaceFeaturesClientListOptions added in v0.2.0

type WorkspaceFeaturesClientListOptions struct {
}

WorkspaceFeaturesClientListOptions contains the optional parameters for the WorkspaceFeaturesClient.List method.

type WorkspaceFeaturesClientListResponse added in v0.2.0

type WorkspaceFeaturesClientListResponse struct {
	ListAmlUserFeatureResult
}

WorkspaceFeaturesClientListResponse contains the response from method WorkspaceFeaturesClient.List.

type WorkspaceListResult

type WorkspaceListResult struct {
	// The URI that can be used to request the next list of machine learning workspaces.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request
	// the next list of machine learning workspaces.
	Value []*Workspace `json:"value,omitempty"`
}

WorkspaceListResult - The result of a request to list machine learning workspaces.

type WorkspaceProperties

type WorkspaceProperties struct {
	// The flag to indicate whether to allow public access when behind VNet.
	AllowPublicAccessWhenBehindVnet *bool `json:"allowPublicAccessWhenBehindVnet,omitempty"`

	// ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created
	ApplicationInsights *string `json:"applicationInsights,omitempty"`

	// ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created
	ContainerRegistry *string `json:"containerRegistry,omitempty"`

	// The description of this workspace.
	Description *string `json:"description,omitempty"`

	// Url for the discovery service to identify regional endpoints for machine learning experimentation services
	DiscoveryURL *string `json:"discoveryUrl,omitempty"`

	// The encryption settings of Azure ML workspace.
	Encryption *EncryptionProperty `json:"encryption,omitempty"`

	// The friendly name for this workspace. This name in mutable
	FriendlyName *string `json:"friendlyName,omitempty"`

	// The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
	HbiWorkspace *bool `json:"hbiWorkspace,omitempty"`

	// The compute name for image build
	ImageBuildCompute *string `json:"imageBuildCompute,omitempty"`

	// ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
	KeyVault *string `json:"keyVault,omitempty"`

	// The user assigned identity resource id that represents the workspace identity.
	PrimaryUserAssignedIdentity *string `json:"primaryUserAssignedIdentity,omitempty"`

	// Whether requests from Public Network are allowed.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// The service managed resource settings.
	ServiceManagedResourcesSettings *ServiceManagedResourcesSettings `json:"serviceManagedResourcesSettings,omitempty"`

	// The list of shared private link resources in this workspace.
	SharedPrivateLinkResources []*SharedPrivateLinkResource `json:"sharedPrivateLinkResources,omitempty"`

	// ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
	StorageAccount *string `json:"storageAccount,omitempty"`

	// READ-ONLY; The URI associated with this workspace that machine learning flow must point at to set up tracking.
	MlFlowTrackingURI *string `json:"mlFlowTrackingUri,omitempty" azure:"ro"`

	// READ-ONLY; The notebook info of Azure ML workspace.
	NotebookInfo *NotebookResourceInfo `json:"notebookInfo,omitempty" azure:"ro"`

	// READ-ONLY; The list of private endpoint connections in the workspace.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Count of private connections in the workspace
	PrivateLinkCount *int32 `json:"privateLinkCount,omitempty" azure:"ro"`

	// READ-ONLY; The current deployment state of workspace resource. The provisioningState is to indicate states for resource
	// provisioning.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The name of the managed resource group created by workspace RP in customer subscription if the workspace is
	// CMK workspace
	ServiceProvisionedResourceGroup *string `json:"serviceProvisionedResourceGroup,omitempty" azure:"ro"`

	// READ-ONLY; If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
	StorageHnsEnabled *bool `json:"storageHnsEnabled,omitempty" azure:"ro"`

	// READ-ONLY; The tenant id associated with this workspace.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`

	// READ-ONLY; The immutable id associated with this workspace.
	WorkspaceID *string `json:"workspaceId,omitempty" azure:"ro"`
}

WorkspaceProperties - The properties of a machine learning workspace.

func (WorkspaceProperties) MarshalJSON

func (w WorkspaceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceProperties.

type WorkspacePropertiesUpdateParameters

type WorkspacePropertiesUpdateParameters struct {
	// The description of this workspace.
	Description *string `json:"description,omitempty"`

	// The friendly name for this workspace.
	FriendlyName *string `json:"friendlyName,omitempty"`

	// The compute name for image build
	ImageBuildCompute *string `json:"imageBuildCompute,omitempty"`

	// The user assigned identity resource id that represents the workspace identity.
	PrimaryUserAssignedIdentity *string `json:"primaryUserAssignedIdentity,omitempty"`

	// Whether requests from Public Network are allowed.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// The service managed resource settings.
	ServiceManagedResourcesSettings *ServiceManagedResourcesSettings `json:"serviceManagedResourcesSettings,omitempty"`
}

WorkspacePropertiesUpdateParameters - The parameters for updating the properties of a machine learning workspace.

type WorkspaceSKU

type WorkspaceSKU struct {
	// The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
	Restrictions []*Restriction `json:"restrictions,omitempty"`

	// READ-ONLY; List of features/user capabilities associated with the sku
	Capabilities []*SKUCapability `json:"capabilities,omitempty" azure:"ro"`

	// READ-ONLY; A list of locations and availability zones in those locations where the SKU is available.
	LocationInfo []*ResourceSKULocationInfo `json:"locationInfo,omitempty" azure:"ro"`

	// READ-ONLY; The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g.
	// West US, East US, Southeast Asia, etc.).
	Locations []*string `json:"locations,omitempty" azure:"ro"`

	// READ-ONLY
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`

	// READ-ONLY; Sku Tier like Basic or Enterprise
	Tier *string `json:"tier,omitempty" azure:"ro"`
}

WorkspaceSKU - Describes Workspace Sku details and features

type WorkspaceSKUsClient

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

WorkspaceSKUsClient contains the methods for the WorkspaceSKUs group. Don't use this type directly, use NewWorkspaceSKUsClient() instead.

func NewWorkspaceSKUsClient

func NewWorkspaceSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceSKUsClient, error)

NewWorkspaceSKUsClient creates a new instance of WorkspaceSKUsClient 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 (*WorkspaceSKUsClient) NewListPager added in v0.4.0

NewListPager - Lists all skus with associated features If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 options - WorkspaceSKUsClientListOptions contains the optional parameters for the WorkspaceSKUsClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspaceSKUsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type WorkspaceSKUsClientListOptions added in v0.2.0

type WorkspaceSKUsClientListOptions struct {
}

WorkspaceSKUsClientListOptions contains the optional parameters for the WorkspaceSKUsClient.List method.

type WorkspaceSKUsClientListResponse added in v0.2.0

type WorkspaceSKUsClientListResponse struct {
	SKUListResult
}

WorkspaceSKUsClientListResponse contains the response from method WorkspaceSKUsClient.List.

type WorkspaceUpdateParameters

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

	// The properties that the machine learning workspace will be updated with.
	Properties *WorkspacePropertiesUpdateParameters `json:"properties,omitempty"`

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

	// The resource tags for the machine learning workspace.
	Tags map[string]*string `json:"tags,omitempty"`
}

WorkspaceUpdateParameters - The parameters for updating a machine learning workspace.

func (WorkspaceUpdateParameters) MarshalJSON

func (w WorkspaceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceUpdateParameters.

type WorkspacesClient

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

WorkspacesClient contains the methods for the Workspaces group. Don't use this type directly, use NewWorkspacesClient() instead.

func NewWorkspacesClient

func NewWorkspacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspacesClient, error)

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

func (*WorkspacesClient) BeginCreateOrUpdate

func (client *WorkspacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, parameters Workspace, options *WorkspacesClientBeginCreateOrUpdateOptions) (*runtime.Poller[WorkspacesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a workspace with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. parameters - The parameters for creating or updating a machine learning workspace. options - WorkspacesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspacesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/create.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"workspace-1234",
		"testworkspace",
		armmachinelearningservices.Workspace{
			Identity: &armmachinelearningservices.Identity{
				Type: to.Ptr(armmachinelearningservices.ResourceIdentityTypeSystemAssignedUserAssigned),
				UserAssignedIdentities: map[string]*armmachinelearningservices.UserAssignedIdentity{
					"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": {},
				},
			},
			Location: to.Ptr("eastus2euap"),
			Properties: &armmachinelearningservices.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: &armmachinelearningservices.EncryptionProperty{
					Identity: &armmachinelearningservices.IdentityForCmk{
						UserAssignedIdentity: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai"),
					},
					KeyVaultProperties: &armmachinelearningservices.KeyVaultProperties{
						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(armmachinelearningservices.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: []*armmachinelearningservices.SharedPrivateLinkResource{
					{
						Name: to.Ptr("testdbresource"),
						Properties: &armmachinelearningservices.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(armmachinelearningservices.PrivateEndpointServiceConnectionStatusApproved),
						},
					}},
				StorageAccount: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspacesClient) BeginDelete

func (client *WorkspacesClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginDeleteOptions) (*runtime.Poller[WorkspacesClientDeleteResponse], error)

BeginDelete - Deletes a machine learning workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginDeleteOptions contains the optional parameters for the WorkspacesClient.BeginDelete method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*WorkspacesClient) BeginDiagnose

func (client *WorkspacesClient) BeginDiagnose(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginDiagnoseOptions) (*runtime.Poller[WorkspacesClientDiagnoseResponse], error)

BeginDiagnose - Diagnose workspace setup issue. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginDiagnoseOptions contains the optional parameters for the WorkspacesClient.BeginDiagnose method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/diagnose.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDiagnose(ctx,
		"workspace-1234",
		"testworkspace",
		&armmachinelearningservices.WorkspacesClientBeginDiagnoseOptions{Parameters: &armmachinelearningservices.DiagnoseWorkspaceParameters{
			Value: &armmachinelearningservices.DiagnoseRequestProperties{
				ApplicationInsights: map[string]interface{}{},
				ContainerRegistry:   map[string]interface{}{},
				DNSResolution:       map[string]interface{}{},
				KeyVault:            map[string]interface{}{},
				Nsg:                 map[string]interface{}{},
				Others:              map[string]interface{}{},
				ResourceLock:        map[string]interface{}{},
				StorageAccount:      map[string]interface{}{},
				Udr:                 map[string]interface{}{},
			},
		},
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspacesClient) BeginPrepareNotebook

func (client *WorkspacesClient) BeginPrepareNotebook(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginPrepareNotebookOptions) (*runtime.Poller[WorkspacesClientPrepareNotebookResponse], error)

BeginPrepareNotebook - Prepare a notebook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginPrepareNotebookOptions contains the optional parameters for the WorkspacesClient.BeginPrepareNotebook method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Notebook/prepare.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginPrepareNotebook(ctx,
		"testrg123",
		"workspaces123",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspacesClient) BeginResyncKeys

func (client *WorkspacesClient) BeginResyncKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientBeginResyncKeysOptions) (*runtime.Poller[WorkspacesClientResyncKeysResponse], error)

BeginResyncKeys - Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientBeginResyncKeysOptions contains the optional parameters for the WorkspacesClient.BeginResyncKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/resyncKeys.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginResyncKeys(ctx,
		"testrg123",
		"workspaces123",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*WorkspacesClient) 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 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientGetOptions contains the optional parameters for the WorkspacesClient.Get method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*WorkspacesClient) ListKeys

func (client *WorkspacesClient) ListKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListKeysOptions) (WorkspacesClientListKeysResponse, error)

ListKeys - Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListKeysOptions contains the optional parameters for the WorkspacesClient.ListKeys method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListKeys(ctx,
		"testrg123",
		"workspaces123",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspacesClient) ListNotebookAccessToken

func (client *WorkspacesClient) ListNotebookAccessToken(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListNotebookAccessTokenOptions) (WorkspacesClientListNotebookAccessTokenResponse, error)

ListNotebookAccessToken - return notebook access token and refresh token If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListNotebookAccessTokenOptions contains the optional parameters for the WorkspacesClient.ListNotebookAccessToken method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listNotebookAccessToken.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*WorkspacesClient) ListNotebookKeys

func (client *WorkspacesClient) ListNotebookKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListNotebookKeysOptions) (WorkspacesClientListNotebookKeysResponse, error)

ListNotebookKeys - List keys of a notebook. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListNotebookKeysOptions contains the optional parameters for the WorkspacesClient.ListNotebookKeys method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListNotebookKeys(ctx,
		"testrg123",
		"workspaces123",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspacesClient) ListOutboundNetworkDependenciesEndpoints

func (client *WorkspacesClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions) (WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse, error)

ListOutboundNetworkDependenciesEndpoints - Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the WorkspacesClient.ListOutboundNetworkDependenciesEndpoints method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*WorkspacesClient) ListStorageAccountKeys

func (client *WorkspacesClient) ListStorageAccountKeys(ctx context.Context, resourceGroupName string, workspaceName string, options *WorkspacesClientListStorageAccountKeysOptions) (WorkspacesClientListStorageAccountKeysResponse, error)

ListStorageAccountKeys - List storage account keys of a workspace. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. workspaceName - Name of Azure Machine Learning workspace. options - WorkspacesClientListStorageAccountKeysOptions contains the optional parameters for the WorkspacesClient.ListStorageAccountKeys method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listStorageAccountKeys.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListStorageAccountKeys(ctx,
		"testrg123",
		"workspaces123",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*WorkspacesClient) NewListByResourceGroupPager added in v0.4.0

func (client *WorkspacesClient) NewListByResourceGroupPager(resourceGroupName string, options *WorkspacesClientListByResourceGroupOptions) *runtime.Pager[WorkspacesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Lists all the available machine learning workspaces under the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 resourceGroupName - The name of the resource group. The name is case insensitive. options - WorkspacesClientListByResourceGroupOptions contains the optional parameters for the WorkspacesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("workspace-1234",
		&armmachinelearningservices.WorkspacesClientListByResourceGroupOptions{Skip: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*WorkspacesClient) NewListBySubscriptionPager added in v0.4.0

NewListBySubscriptionPager - Lists all the available machine learning workspaces under the specified subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-01 options - WorkspacesClientListBySubscriptionOptions contains the optional parameters for the WorkspacesClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

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

func (*WorkspacesClient) Update

func (client *WorkspacesClient) Update(ctx context.Context, resourceGroupName string, workspaceName string, parameters WorkspaceUpdateParameters, options *WorkspacesClientUpdateOptions) (WorkspacesClientUpdateResponse, error)

Update - Updates a machine learning workspace with the specified parameters. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2021-07-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 - WorkspacesClientUpdateOptions contains the optional parameters for the WorkspacesClient.Update method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/machinelearningservices/armmachinelearningservices"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmachinelearningservices.NewWorkspacesClient("00000000-1111-2222-3333-444444444444", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"workspace-1234",
		"testworkspace",
		armmachinelearningservices.WorkspaceUpdateParameters{
			Properties: &armmachinelearningservices.WorkspacePropertiesUpdateParameters{
				Description:         to.Ptr("new description"),
				FriendlyName:        to.Ptr("New friendly name"),
				PublicNetworkAccess: to.Ptr(armmachinelearningservices.PublicNetworkAccessDisabled),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type WorkspacesClientBeginCreateOrUpdateOptions added in v0.2.0

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

WorkspacesClientBeginCreateOrUpdateOptions contains the optional parameters for the WorkspacesClient.BeginCreateOrUpdate method.

type WorkspacesClientBeginDeleteOptions added in v0.2.0

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

WorkspacesClientBeginDeleteOptions contains the optional parameters for the WorkspacesClient.BeginDelete method.

type WorkspacesClientBeginDiagnoseOptions added in v0.2.0

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 added in v0.2.0

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

WorkspacesClientBeginPrepareNotebookOptions contains the optional parameters for the WorkspacesClient.BeginPrepareNotebook method.

type WorkspacesClientBeginResyncKeysOptions added in v0.2.0

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

WorkspacesClientBeginResyncKeysOptions contains the optional parameters for the WorkspacesClient.BeginResyncKeys method.

type WorkspacesClientCreateOrUpdateResponse added in v0.2.0

type WorkspacesClientCreateOrUpdateResponse struct {
	Workspace
}

WorkspacesClientCreateOrUpdateResponse contains the response from method WorkspacesClient.CreateOrUpdate.

type WorkspacesClientDeleteResponse added in v0.2.0

type WorkspacesClientDeleteResponse struct {
}

WorkspacesClientDeleteResponse contains the response from method WorkspacesClient.Delete.

type WorkspacesClientDiagnoseResponse added in v0.2.0

type WorkspacesClientDiagnoseResponse struct {
	DiagnoseResponseResult
}

WorkspacesClientDiagnoseResponse contains the response from method WorkspacesClient.Diagnose.

type WorkspacesClientGetOptions added in v0.2.0

type WorkspacesClientGetOptions struct {
}

WorkspacesClientGetOptions contains the optional parameters for the WorkspacesClient.Get method.

type WorkspacesClientGetResponse added in v0.2.0

type WorkspacesClientGetResponse struct {
	Workspace
}

WorkspacesClientGetResponse contains the response from method WorkspacesClient.Get.

type WorkspacesClientListByResourceGroupOptions added in v0.2.0

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

WorkspacesClientListByResourceGroupOptions contains the optional parameters for the WorkspacesClient.ListByResourceGroup method.

type WorkspacesClientListByResourceGroupResponse added in v0.2.0

type WorkspacesClientListByResourceGroupResponse struct {
	WorkspaceListResult
}

WorkspacesClientListByResourceGroupResponse contains the response from method WorkspacesClient.ListByResourceGroup.

type WorkspacesClientListBySubscriptionOptions added in v0.2.0

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

WorkspacesClientListBySubscriptionOptions contains the optional parameters for the WorkspacesClient.ListBySubscription method.

type WorkspacesClientListBySubscriptionResponse added in v0.2.0

type WorkspacesClientListBySubscriptionResponse struct {
	WorkspaceListResult
}

WorkspacesClientListBySubscriptionResponse contains the response from method WorkspacesClient.ListBySubscription.

type WorkspacesClientListKeysOptions added in v0.2.0

type WorkspacesClientListKeysOptions struct {
}

WorkspacesClientListKeysOptions contains the optional parameters for the WorkspacesClient.ListKeys method.

type WorkspacesClientListKeysResponse added in v0.2.0

type WorkspacesClientListKeysResponse struct {
	ListWorkspaceKeysResult
}

WorkspacesClientListKeysResponse contains the response from method WorkspacesClient.ListKeys.

type WorkspacesClientListNotebookAccessTokenOptions added in v0.2.0

type WorkspacesClientListNotebookAccessTokenOptions struct {
}

WorkspacesClientListNotebookAccessTokenOptions contains the optional parameters for the WorkspacesClient.ListNotebookAccessToken method.

type WorkspacesClientListNotebookAccessTokenResponse added in v0.2.0

type WorkspacesClientListNotebookAccessTokenResponse struct {
	NotebookAccessTokenResult
}

WorkspacesClientListNotebookAccessTokenResponse contains the response from method WorkspacesClient.ListNotebookAccessToken.

type WorkspacesClientListNotebookKeysOptions added in v0.2.0

type WorkspacesClientListNotebookKeysOptions struct {
}

WorkspacesClientListNotebookKeysOptions contains the optional parameters for the WorkspacesClient.ListNotebookKeys method.

type WorkspacesClientListNotebookKeysResponse added in v0.2.0

type WorkspacesClientListNotebookKeysResponse struct {
	ListNotebookKeysResult
}

WorkspacesClientListNotebookKeysResponse contains the response from method WorkspacesClient.ListNotebookKeys.

type WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions added in v0.2.0

type WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions struct {
}

WorkspacesClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the WorkspacesClient.ListOutboundNetworkDependenciesEndpoints method.

type WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse added in v0.2.0

type WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse struct {
	ExternalFQDNResponse
}

WorkspacesClientListOutboundNetworkDependenciesEndpointsResponse contains the response from method WorkspacesClient.ListOutboundNetworkDependenciesEndpoints.

type WorkspacesClientListStorageAccountKeysOptions added in v0.2.0

type WorkspacesClientListStorageAccountKeysOptions struct {
}

WorkspacesClientListStorageAccountKeysOptions contains the optional parameters for the WorkspacesClient.ListStorageAccountKeys method.

type WorkspacesClientListStorageAccountKeysResponse added in v0.2.0

type WorkspacesClientListStorageAccountKeysResponse struct {
	ListStorageAccountKeysResult
}

WorkspacesClientListStorageAccountKeysResponse contains the response from method WorkspacesClient.ListStorageAccountKeys.

type WorkspacesClientPrepareNotebookResponse added in v0.2.0

type WorkspacesClientPrepareNotebookResponse struct {
	NotebookResourceInfo
}

WorkspacesClientPrepareNotebookResponse contains the response from method WorkspacesClient.PrepareNotebook.

type WorkspacesClientResyncKeysResponse added in v0.2.0

type WorkspacesClientResyncKeysResponse struct {
}

WorkspacesClientResyncKeysResponse contains the response from method WorkspacesClient.ResyncKeys.

type WorkspacesClientUpdateOptions added in v0.2.0

type WorkspacesClientUpdateOptions struct {
}

WorkspacesClientUpdateOptions contains the optional parameters for the WorkspacesClient.Update method.

type WorkspacesClientUpdateResponse added in v0.2.0

type WorkspacesClientUpdateResponse struct {
	Workspace
}

WorkspacesClientUpdateResponse contains the response from method WorkspacesClient.Update.

Jump to

Keyboard shortcuts

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