models Package

Classes

AKS

A Machine Learning compute based on AKS.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

AKSProperties

AKS properties.

Variables are only populated by the server, and will be ignored when sending a request.

AksComputeSecrets

Secrets related to a Machine Learning compute based on AKS.

All required parameters must be populated in order to send to Azure.

AksNetworkingConfiguration

Advance configuration for AKS networking.

AmlCompute

An Azure Machine Learning compute.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

AmlComputeNodeInformation

Compute node information related to a AmlCompute.

Variables are only populated by the server, and will be ignored when sending a request.

AmlComputeNodesInformation

Compute node information related to a AmlCompute.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

AmlComputeProperties

AML Compute properties.

Variables are only populated by the server, and will be ignored when sending a request.

AmlUserFeature

Features enabled for a workspace.

ClusterUpdateParameters

AmlCompute update parameters.

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties.

Variables are only populated by the server, and will be ignored when sending a request.

Compute

Machine Learning compute object.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AKS, AmlCompute, ComputeInstance, DataFactory, DataLakeAnalytics, Databricks, HDInsight, VirtualMachine.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

ComputeInstance

An Azure Machine Learning compute instance.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

ComputeInstanceApplication

Defines an Aml Instance application and its connectivity endpoint URI.

ComputeInstanceConnectivityEndpoints

Defines all connectivity endpoints and properties for a ComputeInstance.

Variables are only populated by the server, and will be ignored when sending a request.

ComputeInstanceCreatedBy

Describes information on user who created this ComputeInstance.

Variables are only populated by the server, and will be ignored when sending a request.

ComputeInstanceLastOperation

The last operation on ComputeInstance.

ComputeInstanceProperties

Compute Instance properties.

Variables are only populated by the server, and will be ignored when sending a request.

ComputeInstanceSshSettings

Specifies policy and settings for SSH access.

Variables are only populated by the server, and will be ignored when sending a request.

ComputeNodesInformation

Compute nodes information related to a Machine Learning compute. Might differ for every type of compute.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AmlComputeNodesInformation.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

ComputeResource

Machine Learning compute object wrapped into ARM resource envelope.

Variables are only populated by the server, and will be ignored when sending a request.

ComputeSecrets

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AksComputeSecrets, DatabricksComputeSecrets, VirtualMachineSecrets.

All required parameters must be populated in order to send to Azure.

DataFactory

A DataFactory compute.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataLakeAnalytics

A DataLakeAnalytics compute.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DataLakeAnalyticsProperties

DataLakeAnalyticsProperties.

Databricks

A DataFactory compute.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

DatabricksComputeSecrets

Secrets related to a Machine Learning compute based on Databricks.

All required parameters must be populated in order to send to Azure.

DatabricksProperties

DatabricksProperties.

EncryptionProperty

EncryptionProperty.

All required parameters must be populated in order to send to Azure.

ErrorDetail

Error detail information.

All required parameters must be populated in order to send to Azure.

ErrorResponse

Error response information.

Variables are only populated by the server, and will be ignored when sending a request.

EstimatedVMPrice

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

All required parameters must be populated in order to send to Azure.

EstimatedVMPrices

The estimated price info for using a VM.

All required parameters must be populated in order to send to Azure.

HDInsight

A HDInsight compute.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

HDInsightProperties

HDInsightProperties.

Identity

Identity for the resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

KeyVaultProperties

KeyVaultProperties.

All required parameters must be populated in order to send to Azure.

ListAmlUserFeatureResult

The List Aml user feature operation response.

Variables are only populated by the server, and will be ignored when sending a request.

ListUsagesResult

The List Usages operation response.

Variables are only populated by the server, and will be ignored when sending a request.

ListWorkspaceKeysResult

ListWorkspaceKeysResult.

Variables are only populated by the server, and will be ignored when sending a request.

ListWorkspaceQuotas

The List WorkspaceQuotasByVMFamily operation response.

Variables are only populated by the server, and will be ignored when sending a request.

MachineLearningServiceError

Wrapper for error response to follow ARM guidelines.

Variables are only populated by the server, and will be ignored when sending a request.

NodeStateCounts

Counts of various compute node states on the amlCompute.

Variables are only populated by the server, and will be ignored when sending a request.

NotebookListCredentialsResult

NotebookListCredentialsResult.

NotebookPreparationError

NotebookPreparationError.

NotebookResourceInfo

NotebookResourceInfo.

Operation

Azure Machine Learning workspace REST API operation.

OperationDisplay

Display name of operation.

OperationListResult

An array of operations supported by the resource provider.

PaginatedComputeResourcesList

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

PaginatedWorkspaceConnectionsList

Paginated list of Workspace connection objects.

Password

Password.

Variables are only populated by the server, and will be ignored when sending a request.

PrivateEndpoint

The Private Endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

PrivateEndpointConnection

The Private Endpoint Connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

PrivateLinkResource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

PrivateLinkResourceListResult

A list of private link resources.

PrivateLinkServiceConnectionState

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

QuotaBaseProperties

The properties for Quota update or retrieval.

QuotaUpdateParameters

Quota update parameters.

RegistryListCredentialsResult

RegistryListCredentialsResult.

Variables are only populated by the server, and will be ignored when sending a request.

Resource

Azure Resource Manager resource envelope.

Variables are only populated by the server, and will be ignored when sending a request.

ResourceId

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

All required parameters must be populated in order to send to Azure.

ResourceName

The Resource Name.

Variables are only populated by the server, and will be ignored when sending a request.

ResourceQuota

The quota assigned to a resource.

Variables are only populated by the server, and will be ignored when sending a request.

ResourceSkuLocationInfo

ResourceSkuLocationInfo.

Variables are only populated by the server, and will be ignored when sending a request.

ResourceSkuZoneDetails

Describes The zonal capabilities of a SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Restriction

The restriction because of which SKU cannot be used.

Variables are only populated by the server, and will be ignored when sending a request.

SKUCapability

Features/user capabilities associated with the sku.

ScaleSettings

scale settings for AML Compute.

All required parameters must be populated in order to send to Azure.

ServicePrincipalCredentials

Service principal credentials.

All required parameters must be populated in order to send to Azure.

SharedPrivateLinkResource

SharedPrivateLinkResource.

Sku

Sku of the resource.

SkuListResult

List of skus with features.

SkuSettings

Describes Workspace Sku details and features.

Variables are only populated by the server, and will be ignored when sending a request.

SslConfiguration

The ssl configuration for scoring.

SystemService

A system service running on a compute.

Variables are only populated by the server, and will be ignored when sending a request.

UpdateWorkspaceQuotas

The properties for update Quota response.

Variables are only populated by the server, and will be ignored when sending a request.

UpdateWorkspaceQuotasResult

The result of update workspace quota.

Variables are only populated by the server, and will be ignored when sending a request.

Usage

Describes AML Resource Usage.

Variables are only populated by the server, and will be ignored when sending a request.

UsageName

The Usage Names.

Variables are only populated by the server, and will be ignored when sending a request.

UserAccountCredentials

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

All required parameters must be populated in order to send to Azure.

VirtualMachine

A Machine Learning compute based on Azure Virtual Machines.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

VirtualMachineProperties

VirtualMachineProperties.

VirtualMachineSecrets

Secrets related to a Machine Learning compute based on AKS.

All required parameters must be populated in order to send to Azure.

VirtualMachineSize

Describes the properties of a VM size.

Variables are only populated by the server, and will be ignored when sending a request.

VirtualMachineSizeListResult

The List Virtual Machine size operation response.

VirtualMachineSshCredentials

Admin credentials for virtual machine.

Workspace

An object that represents a machine learning workspace.

Variables are only populated by the server, and will be ignored when sending a request.

WorkspaceConnection

Workspace connection.

Variables are only populated by the server, and will be ignored when sending a request.

WorkspaceConnectionDto

object used for creating workspace connection.

WorkspaceListResult

The result of a request to list machine learning workspaces.

WorkspaceSku

AML workspace sku information.

Variables are only populated by the server, and will be ignored when sending a request.

WorkspaceUpdateParameters

The parameters for updating a machine learning workspace.

Enums

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.

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.

BillingCurrency

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

ComputeInstanceState

Current state of a ComputeInstance.

ComputeType

The type of compute

EncryptionStatus

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

NodeState

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

OperationName

Name of the last operation.

OperationStatus

Operation status.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

ProvisioningState

The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.

QuotaUnit

An enum describing the unit of quota measurement.

ReasonCode

The reason for the restriction.

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.

ResourceIdentityType

The identity type.

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.

SslConfigurationStatus

Enable or disable ssl for scoring

Status

Status of update workspace quota.

UnderlyingResourceAction

An enumeration.

UnitOfMeasure

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

UsageUnit

An enum describing the unit of usage measurement.

VMPriceOSType

Operating system type used by the VM.

VMTier

The type of the VM.

VmPriority

Virtual Machine priority