@azure/arm-machinelearningservices package

Classes

AzureMachineLearningWorkspaces

Interfaces

AKSProperties

AKS properties

AksComputeSecretsProperties

Properties of AksComputeSecrets

AksNetworkingConfiguration

Advance configuration for AKS networking

AmlComputeNodeInformation

Compute node information related to a AmlCompute.

AmlComputeNodesInformation

Result of AmlCompute Nodes

AmlComputeProperties

AML Compute properties

AmlUserFeature

Features enabled for a workspace

AssignedUser

A user that can be assigned to a compute instance.

AutoPauseProperties

Auto pause properties

AutoScaleProperties

Auto scale properties

AzureMachineLearningWorkspacesOptionalParams

Optional parameters.

ClusterUpdateParameters

AmlCompute update parameters.

Components1D3SwueSchemasComputeresourceAllof1
Compute

Machine Learning compute object.

ComputeCreateOrUpdateHeaders

Defines headers for Compute_createOrUpdate operation.

ComputeCreateOrUpdateOptionalParams

Optional parameters.

ComputeDeleteHeaders

Defines headers for Compute_delete operation.

ComputeDeleteOptionalParams

Optional parameters.

ComputeGetOptionalParams

Optional parameters.

ComputeInstanceApplication

Defines an Aml Instance application and its connectivity endpoint URI.

ComputeInstanceConnectivityEndpoints

Defines all connectivity endpoints and properties for an ComputeInstance.

ComputeInstanceCreatedBy

Describes information on user who created this ComputeInstance.

ComputeInstanceLastOperation

The last operation on ComputeInstance.

ComputeInstanceProperties

Compute Instance properties

ComputeInstanceSshSettings

Specifies policy and settings for SSH access.

ComputeListKeysOptionalParams

Optional parameters.

ComputeListNextOptionalParams

Optional parameters.

ComputeListNodesNextOptionalParams

Optional parameters.

ComputeListNodesOptionalParams

Optional parameters.

ComputeListOptionalParams

Optional parameters.

ComputeOperations

Interface representing a ComputeOperations.

ComputeRestartOptionalParams

Optional parameters.

ComputeSecrets

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

ComputeStartOptionalParams

Optional parameters.

ComputeStopOptionalParams

Optional parameters.

ComputeUpdateOptionalParams

Optional parameters.

ContainerResourceRequirements

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

CosmosDbSettings
DataLakeAnalyticsProperties
DatabricksComputeSecretsProperties

Properties of Databricks Compute Secrets

DatabricksProperties

Properties of Databricks

DiagnoseRequestProperties
DiagnoseResponseResult
DiagnoseResponseResultValue
DiagnoseResult

Result of Diagnose

DiagnoseWorkspaceParameters

Parameters to diagnose a workspace

EncryptionProperty
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

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

EstimatedVMPrice

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

EstimatedVMPrices

The estimated price info for using a VM.

ExternalFqdnResponse
FqdnEndpoint
FqdnEndpointDetail
FqdnEndpoints
FqdnEndpointsProperties
HDInsightProperties

HDInsight compute properties

Identity

Identity for the resource.

IdentityForCmk

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

InstanceTypeSchema

Instance type schema.

InstanceTypeSchemaResources

Resource requests/limits for this instance type

KeyVaultProperties
KubernetesProperties

Kubernetes properties

KubernetesSchema

Kubernetes Compute Schema

ListAmlUserFeatureResult

The List Aml user feature operation response.

ListNotebookKeysResult
ListStorageAccountKeysResult
ListUsagesResult

The List Usages operation response.

ListWorkspaceKeysResult
ListWorkspaceQuotas

The List WorkspaceQuotasByVMFamily operation response.

NodeStateCounts

Counts of various compute node states on the amlCompute.

NotebookAccessTokenResult
NotebookPreparationError
NotebookResourceInfo
Operation

Azure Machine Learning workspace REST API operation

OperationDisplay

Display name of operation

OperationListResult

An array of operations supported by the resource provider.

Operations

Interface representing a Operations.

OperationsListOptionalParams

Optional parameters.

PaginatedComputeResourcesList

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

PaginatedWorkspaceConnectionsList

Paginated list of Workspace connection objects.

Password
PersonalComputeInstanceSettings

Settings for a personal compute instance.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified workspace

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesListOptionalParams

Optional parameters.

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.

Quotas

Interface representing a Quotas.

QuotasListNextOptionalParams

Optional parameters.

QuotasListOptionalParams

Optional parameters.

QuotasUpdateOptionalParams

Optional parameters.

RegistryListCredentialsResult
Resource

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

ResourceId

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

ResourceName

The Resource Name.

ResourceQuota

The quota assigned to a resource.

ResourceSkuLocationInfo
ResourceSkuZoneDetails

Describes The zonal capabilities of a SKU.

Restriction

The restriction because of which SKU cannot be used.

SKUCapability

Features/user capabilities associated with the sku

ScaleSettings

scale settings for AML Compute

ScaleSettingsInformation

Desired scale settings for the amlCompute.

ScriptReference

Script reference

ScriptsToExecute

Customized setup scripts

ServiceManagedResourcesSettings
ServicePrincipalCredentials

Service principal credentials.

SetupScripts

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

SharedPrivateLinkResource
Sku

Sku of the resource

SkuListResult

List of skus with features

SslConfiguration

The ssl configuration for scoring

SynapseSparkProperties
SystemData

Metadata pertaining to creation and last modification of the resource.

SystemService

A system service running on a compute.

UpdateWorkspaceQuotas

The properties for update Quota response.

UpdateWorkspaceQuotasResult

The result of update workspace quota.

Usage

Describes AML Resource Usage.

UsageName

The Usage Names.

Usages

Interface representing a Usages.

UsagesListNextOptionalParams

Optional parameters.

UsagesListOptionalParams

Optional parameters.

UserAccountCredentials

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

UserAssignedIdentity

User Assigned Identity

VirtualMachineImage

Virtual Machine image for Windows AML Compute

VirtualMachineProperties
VirtualMachineSize

Describes the properties of a VM size.

VirtualMachineSizeListResult

The List Virtual Machine size operation response.

VirtualMachineSizes

Interface representing a VirtualMachineSizes.

VirtualMachineSizesListOptionalParams

Optional parameters.

VirtualMachineSshCredentials

Admin credentials for virtual machine

WorkspaceConnection

Workspace connection.

WorkspaceConnections

Interface representing a WorkspaceConnections.

WorkspaceConnectionsCreateOptionalParams

Optional parameters.

WorkspaceConnectionsDeleteOptionalParams

Optional parameters.

WorkspaceConnectionsGetOptionalParams

Optional parameters.

WorkspaceConnectionsListOptionalParams

Optional parameters.

WorkspaceFeatures

Interface representing a WorkspaceFeatures.

WorkspaceFeaturesListNextOptionalParams

Optional parameters.

WorkspaceFeaturesListOptionalParams

Optional parameters.

WorkspaceListResult

The result of a request to list machine learning workspaces.

WorkspaceSku

Describes Workspace Sku details and features

WorkspaceSkus

Interface representing a WorkspaceSkus.

WorkspaceSkusListNextOptionalParams

Optional parameters.

WorkspaceSkusListOptionalParams

Optional parameters.

WorkspaceUpdateParameters

The parameters for updating a machine learning workspace.

Workspaces

Interface representing a Workspaces.

WorkspacesCreateOrUpdateOptionalParams

Optional parameters.

WorkspacesDeleteOptionalParams

Optional parameters.

WorkspacesDiagnoseHeaders

Defines headers for Workspaces_diagnose operation.

WorkspacesDiagnoseOptionalParams

Optional parameters.

WorkspacesGetOptionalParams

Optional parameters.

WorkspacesListByResourceGroupNextOptionalParams

Optional parameters.

WorkspacesListByResourceGroupOptionalParams

Optional parameters.

WorkspacesListBySubscriptionNextOptionalParams

Optional parameters.

WorkspacesListBySubscriptionOptionalParams

Optional parameters.

WorkspacesListKeysOptionalParams

Optional parameters.

WorkspacesListNotebookAccessTokenOptionalParams

Optional parameters.

WorkspacesListNotebookKeysOptionalParams

Optional parameters.

WorkspacesListOutboundNetworkDependenciesEndpointsOptionalParams

Optional parameters.

WorkspacesListStorageAccountKeysOptionalParams

Optional parameters.

WorkspacesPrepareNotebookOptionalParams

Optional parameters.

WorkspacesResyncKeysOptionalParams

Optional parameters.

WorkspacesUpdateOptionalParams

Optional parameters.

Type Aliases

Aks

A Machine Learning compute based on AKS.

AksComputeSecrets

Secrets related to a Machine Learning compute based on AKS.

AllocationState

Defines values for AllocationState.
KnownAllocationState can be used interchangeably with AllocationState, this enum contains the known values that the service supports.

Known values supported by the service

Steady
Resizing

AmlCompute

Properties(top level) of AmlCompute

ApplicationSharingPolicy

Defines values for ApplicationSharingPolicy.
KnownApplicationSharingPolicy can be used interchangeably with ApplicationSharingPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Personal
Shared

BillingCurrency

Defines values for BillingCurrency.
KnownBillingCurrency can be used interchangeably with BillingCurrency, this enum contains the known values that the service supports.

Known values supported by the service

USD

ClusterPurpose

Defines values for ClusterPurpose.
KnownClusterPurpose can be used interchangeably with ClusterPurpose, this enum contains the known values that the service supports.

Known values supported by the service

FastProd
DenseProd
DevTest

ComputeCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ComputeGetResponse

Contains response data for the get operation.

ComputeInstance

Properties(top level) of ComputeInstance

ComputeInstanceAuthorizationType

Defines values for ComputeInstanceAuthorizationType.
KnownComputeInstanceAuthorizationType can be used interchangeably with ComputeInstanceAuthorizationType, this enum contains the known values that the service supports.

Known values supported by the service

personal

ComputeInstanceState

Defines values for ComputeInstanceState.
KnownComputeInstanceState can be used interchangeably with ComputeInstanceState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
CreateFailed
Deleting
Running
Restarting
JobRunning
SettingUp
SetupFailed
Starting
Stopped
Stopping
UserSettingUp
UserSetupFailed
Unknown
Unusable

ComputeListKeysResponse

Contains response data for the listKeys operation.

ComputeListNextResponse

Contains response data for the listNext operation.

ComputeListNodesNextResponse

Contains response data for the listNodesNext operation.

ComputeListNodesResponse

Contains response data for the listNodes operation.

ComputeListResponse

Contains response data for the list operation.

ComputeResource

Machine Learning compute object wrapped into ARM resource envelope.

ComputeSecretsUnion
ComputeType

Defines values for ComputeType.
KnownComputeType can be used interchangeably with ComputeType, this enum contains the known values that the service supports.

Known values supported by the service

AKS
Kubernetes
AmlCompute
ComputeInstance
DataFactory
VirtualMachine
HDInsight
Databricks
DataLakeAnalytics
SynapseSpark

ComputeUnion
ComputeUpdateResponse

Contains response data for the update operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DataFactory

A DataFactory compute.

DataLakeAnalytics

A DataLakeAnalytics compute.

Databricks

A DataFactory compute.

DatabricksComputeSecrets

Secrets related to a Machine Learning compute based on Databricks.

DiagnoseResultLevel

Defines values for DiagnoseResultLevel.
KnownDiagnoseResultLevel can be used interchangeably with DiagnoseResultLevel, this enum contains the known values that the service supports.

Known values supported by the service

Warning
Error
Information

EncryptionStatus

Defines values for EncryptionStatus.
KnownEncryptionStatus can be used interchangeably with EncryptionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

HDInsight

A HDInsight compute.

Kubernetes

A Machine Learning compute based on Kubernetes Compute.

LoadBalancerType

Defines values for LoadBalancerType.
KnownLoadBalancerType can be used interchangeably with LoadBalancerType, this enum contains the known values that the service supports.

Known values supported by the service

PublicIp
InternalLoadBalancer

NodeState

Defines values for NodeState.
KnownNodeState can be used interchangeably with NodeState, this enum contains the known values that the service supports.

Known values supported by the service

idle
running
preparing
unusable
leaving
preempted

OperationName

Defines values for OperationName.
KnownOperationName can be used interchangeably with OperationName, this enum contains the known values that the service supports.

Known values supported by the service

Create
Start
Stop
Restart
Reimage
Delete

OperationStatus

Defines values for OperationStatus.
KnownOperationStatus can be used interchangeably with OperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Succeeded
CreateFailed
StartFailed
StopFailed
RestartFailed
ReimageFailed
DeleteFailed

OperationsListResponse

Contains response data for the list operation.

OsType

Defines values for OsType.
KnownOsType can be used interchangeably with OsType, this enum contains the known values that the service supports.

Known values supported by the service

Linux
Windows

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected
Disconnected
Timeout

PrivateLinkResource

A private link resource

PrivateLinkResourcesListResponse

Contains response data for the list operation.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Updating
Creating
Deleting
Succeeded
Failed
Canceled

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

QuotaUnit

Defines values for QuotaUnit.
KnownQuotaUnit can be used interchangeably with QuotaUnit, this enum contains the known values that the service supports.

Known values supported by the service

Count

QuotasListNextResponse

Contains response data for the listNext operation.

QuotasListResponse

Contains response data for the list operation.

QuotasUpdateResponse

Contains response data for the update operation.

ReasonCode

Defines values for ReasonCode.
KnownReasonCode can be used interchangeably with ReasonCode, this enum contains the known values that the service supports.

Known values supported by the service

NotSpecified
NotAvailableForRegion
NotAvailableForSubscription

RemoteLoginPortPublicAccess

Defines values for RemoteLoginPortPublicAccess.
KnownRemoteLoginPortPublicAccess can be used interchangeably with RemoteLoginPortPublicAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled
NotSpecified

ResourceIdentityType

Defines values for ResourceIdentityType.

SshPublicAccess

Defines values for SshPublicAccess.
KnownSshPublicAccess can be used interchangeably with SshPublicAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

SslConfigurationStatus

Defines values for SslConfigurationStatus.
KnownSslConfigurationStatus can be used interchangeably with SslConfigurationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled
Auto

Status

Defines values for Status.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

Undefined
Success
Failure
InvalidQuotaBelowClusterMinimum
InvalidQuotaExceedsSubscriptionLimit
InvalidVMFamilyName
OperationNotSupportedForSku
OperationNotEnabledForRegion

SynapseSpark

A SynapseSpark compute.

UnderlyingResourceAction

Defines values for UnderlyingResourceAction.
KnownUnderlyingResourceAction can be used interchangeably with UnderlyingResourceAction, this enum contains the known values that the service supports.

Known values supported by the service

Delete
Detach

UnitOfMeasure

Defines values for UnitOfMeasure.
KnownUnitOfMeasure can be used interchangeably with UnitOfMeasure, this enum contains the known values that the service supports.

Known values supported by the service

OneHour

UsageUnit

Defines values for UsageUnit.
KnownUsageUnit can be used interchangeably with UsageUnit, this enum contains the known values that the service supports.

Known values supported by the service

Count

UsagesListNextResponse

Contains response data for the listNext operation.

UsagesListResponse

Contains response data for the list operation.

VMPriceOSType

Defines values for VMPriceOSType.
KnownVMPriceOSType can be used interchangeably with VMPriceOSType, this enum contains the known values that the service supports.

Known values supported by the service

Linux
Windows

VMTier

Defines values for VMTier.
KnownVMTier can be used interchangeably with VMTier, this enum contains the known values that the service supports.

Known values supported by the service

Standard
LowPriority
Spot

ValueFormat

Defines values for ValueFormat.
KnownValueFormat can be used interchangeably with ValueFormat, this enum contains the known values that the service supports.

Known values supported by the service

JSON

VirtualMachine

A Machine Learning compute based on Azure Virtual Machines.

VirtualMachineSecrets

Secrets related to a Machine Learning compute based on AKS.

VirtualMachineSizesListResponse

Contains response data for the list operation.

VmPriority

Defines values for VmPriority.
KnownVmPriority can be used interchangeably with VmPriority, this enum contains the known values that the service supports.

Known values supported by the service

Dedicated
LowPriority

Workspace

An object that represents a machine learning workspace.

WorkspaceConnectionsCreateResponse

Contains response data for the create operation.

WorkspaceConnectionsGetResponse

Contains response data for the get operation.

WorkspaceConnectionsListResponse

Contains response data for the list operation.

WorkspaceFeaturesListNextResponse

Contains response data for the listNext operation.

WorkspaceFeaturesListResponse

Contains response data for the list operation.

WorkspaceSkusListNextResponse

Contains response data for the listNext operation.

WorkspaceSkusListResponse

Contains response data for the list operation.

WorkspacesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

WorkspacesDiagnoseResponse

Contains response data for the diagnose operation.

WorkspacesGetResponse

Contains response data for the get operation.

WorkspacesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

WorkspacesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

WorkspacesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

WorkspacesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

WorkspacesListKeysResponse

Contains response data for the listKeys operation.

WorkspacesListNotebookAccessTokenResponse

Contains response data for the listNotebookAccessToken operation.

WorkspacesListNotebookKeysResponse

Contains response data for the listNotebookKeys operation.

WorkspacesListOutboundNetworkDependenciesEndpointsResponse

Contains response data for the listOutboundNetworkDependenciesEndpoints operation.

WorkspacesListStorageAccountKeysResponse

Contains response data for the listStorageAccountKeys operation.

WorkspacesPrepareNotebookResponse

Contains response data for the prepareNotebook operation.

WorkspacesUpdateResponse

Contains response data for the update operation.

Enums

KnownAllocationState

Known values of AllocationState that the service accepts.

KnownApplicationSharingPolicy

Known values of ApplicationSharingPolicy that the service accepts.

KnownBillingCurrency

Known values of BillingCurrency that the service accepts.

KnownClusterPurpose

Known values of ClusterPurpose that the service accepts.

KnownComputeInstanceAuthorizationType

Known values of ComputeInstanceAuthorizationType that the service accepts.

KnownComputeInstanceState

Known values of ComputeInstanceState that the service accepts.

KnownComputeType

Known values of ComputeType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDiagnoseResultLevel

Known values of DiagnoseResultLevel that the service accepts.

KnownEncryptionStatus

Known values of EncryptionStatus that the service accepts.

KnownLoadBalancerType

Known values of LoadBalancerType that the service accepts.

KnownNodeState

Known values of NodeState that the service accepts.

KnownOperationName

Known values of OperationName that the service accepts.

KnownOperationStatus

Known values of OperationStatus that the service accepts.

KnownOsType

Known values of OsType that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownQuotaUnit

Known values of QuotaUnit that the service accepts.

KnownReasonCode

Known values of ReasonCode that the service accepts.

KnownRemoteLoginPortPublicAccess

Known values of RemoteLoginPortPublicAccess that the service accepts.

KnownSshPublicAccess

Known values of SshPublicAccess that the service accepts.

KnownSslConfigurationStatus

Known values of SslConfigurationStatus that the service accepts.

KnownStatus

Known values of Status that the service accepts.

KnownUnderlyingResourceAction

Known values of UnderlyingResourceAction that the service accepts.

KnownUnitOfMeasure

Known values of UnitOfMeasure that the service accepts.

KnownUsageUnit

Known values of UsageUnit that the service accepts.

KnownVMPriceOSType

Known values of VMPriceOSType that the service accepts.

KnownVMTier

Known values of VMTier that the service accepts.

KnownValueFormat

Known values of ValueFormat that the service accepts.

KnownVmPriority

Known values of VmPriority that the service accepts.