Microsoft.MachineLearningServices (stable:2025-06-01)

2025/07/14 • 5 updated methods

Workspaces_Get (updated)
Description :  Gets the properties of the specified machine learning workspace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_4e8329eed47d466cbf02acaf1406e1bc": {
              "#name": "provisionNetworkNow",
              "Description": "Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the machine learning workspace. ,
Required: False ,
}
{
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of Azure ML workspace. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: The identity that will be used to access the key vault for encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The ArmId of the user assigned identity that will be used to access the customer managed key vault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: Customer Key vault properties. ,
Required: True ,
}
{
keyVaultArmId:
{
Description: The ArmId of the keyVault where the customer owned encryption key is present. ,
Required: True ,
}
string ,
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: True ,
}
string ,
identityClientId:
{
Description: For future use - The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
serverlessComputeSettings:
{
Description: Settings for serverless compute created in the workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource id that private link links to. ,
Required: False ,
}
string ,
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Description: The settings for the service managed cosmosdb account. ,
Required: False ,
}
{
collectionsThroughput:
{
Description: The throughput of the collections in cosmosdb database ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
managedNetworkKind:
{
Description: The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
}
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Description: Compute runtime config for feature store type workspace. ,
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (updated)
Description :  Creates or updates a workspace with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "@added_923d72fb43e5432396df1b477cf40d86": {
              "#name": "provisionNetworkNow",
              "Description": "Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_5cacda60e50c419da57e1c5f2b39ab9d": {
              "#name": "provisionNetworkNow",
              "Description": "Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for creating or updating a machine learning workspace. ,
Required: True ,
}
{
properties:
{
Description: The properties of the machine learning workspace. ,
Required: False ,
}
{
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of Azure ML workspace. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: The identity that will be used to access the key vault for encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The ArmId of the user assigned identity that will be used to access the customer managed key vault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: Customer Key vault properties. ,
Required: True ,
}
{
keyVaultArmId:
{
Description: The ArmId of the keyVault where the customer owned encryption key is present. ,
Required: True ,
}
string ,
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: True ,
}
string ,
identityClientId:
{
Description: For future use - The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
serverlessComputeSettings:
{
Description: Settings for serverless compute created in the workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource id that private link links to. ,
Required: False ,
}
string ,
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Description: The settings for the service managed cosmosdb account. ,
Required: False ,
}
{
collectionsThroughput:
{
Description: The throughput of the collections in cosmosdb database ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
managedNetworkKind:
{
Description: The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
}
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Description: Compute runtime config for feature store type workspace. ,
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the machine learning workspace. ,
Required: False ,
}
{
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of Azure ML workspace. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: The identity that will be used to access the key vault for encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The ArmId of the user assigned identity that will be used to access the customer managed key vault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: Customer Key vault properties. ,
Required: True ,
}
{
keyVaultArmId:
{
Description: The ArmId of the keyVault where the customer owned encryption key is present. ,
Required: True ,
}
string ,
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: True ,
}
string ,
identityClientId:
{
Description: For future use - The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
serverlessComputeSettings:
{
Description: Settings for serverless compute created in the workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource id that private link links to. ,
Required: False ,
}
string ,
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Description: The settings for the service managed cosmosdb account. ,
Required: False ,
}
{
collectionsThroughput:
{
Description: The throughput of the collections in cosmosdb database ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
managedNetworkKind:
{
Description: The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
}
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Description: Compute runtime config for feature store type workspace. ,
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URI to poll for asynchronous operation result. ,
}
string ,
retry-after:
{
Description: Duration the client should wait between requests, in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_Update (updated)
Description :  Updates a machine learning workspace with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_a9bb6ab6136542bc9344ef708140bb8b": {
              "#name": "provisionNetworkNow",
              "Description": "Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.",
              "Required": false,
              "Type": "boolean"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for updating a machine learning workspace. ,
Required: True ,
}
{
tags:
{
Description: The resource tags for the machine learning workspace. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties that the machine learning workspace will be updated with. ,
Required: False ,
}
{
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name for this workspace. ,
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Description: The settings for the service managed cosmosdb account. ,
Required: False ,
}
{
collectionsThroughput:
{
Description: The throughput of the collections in cosmosdb database ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
serverlessComputeSettings:
{
Description: Settings for serverless compute created in the workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Description: Compute runtime config for feature store type workspace. ,
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
managedNetworkKind:
{
Description: The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
}
,
enableDataIsolation:
{
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
keyVaultProperties:
{
Required: True ,
}
{
keyIdentifier:
{
Required: True ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the machine learning workspace. ,
Required: False ,
}
{
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of Azure ML workspace. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: The identity that will be used to access the key vault for encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The ArmId of the user assigned identity that will be used to access the customer managed key vault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: Customer Key vault properties. ,
Required: True ,
}
{
keyVaultArmId:
{
Description: The ArmId of the keyVault where the customer owned encryption key is present. ,
Required: True ,
}
string ,
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: True ,
}
string ,
identityClientId:
{
Description: For future use - The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
serverlessComputeSettings:
{
Description: Settings for serverless compute created in the workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource id that private link links to. ,
Required: False ,
}
string ,
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Description: The settings for the service managed cosmosdb account. ,
Required: False ,
}
{
collectionsThroughput:
{
Description: The throughput of the collections in cosmosdb database ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
managedNetworkKind:
{
Description: The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
}
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Description: Compute runtime config for feature store type workspace. ,
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URI to poll for asynchronous operation result. ,
}
string ,
retry-after:
{
Description: Duration the client should wait between requests, in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (updated)
Description :  Lists all the available machine learning workspaces under the specified resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "@added_5fd7aaa6d89341f7aa6b3d01ebc937c3": {
                  "#name": "provisionNetworkNow",
                  "Description": "Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.",
                  "Required": false,
                  "Type": "boolean"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: 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. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the machine learning workspace. ,
Required: False ,
}
{
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of Azure ML workspace. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: The identity that will be used to access the key vault for encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The ArmId of the user assigned identity that will be used to access the customer managed key vault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: Customer Key vault properties. ,
Required: True ,
}
{
keyVaultArmId:
{
Description: The ArmId of the keyVault where the customer owned encryption key is present. ,
Required: True ,
}
string ,
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: True ,
}
string ,
identityClientId:
{
Description: For future use - The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
serverlessComputeSettings:
{
Description: Settings for serverless compute created in the workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource id that private link links to. ,
Required: False ,
}
string ,
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Description: The settings for the service managed cosmosdb account. ,
Required: False ,
}
{
collectionsThroughput:
{
Description: The throughput of the collections in cosmosdb database ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
managedNetworkKind:
{
Description: The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
}
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Description: Compute runtime config for feature store type workspace. ,
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of machine learning workspaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ListBySubscription (updated)
Description :  Lists all the available machine learning workspaces under the specified subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "@added_076748418bcd42fba8ed9a53d022c494": {
                  "#name": "provisionNetworkNow",
                  "Description": "Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.",
                  "Required": false,
                  "Type": "boolean"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: 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. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the machine learning workspace. ,
Required: False ,
}
{
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The encryption settings of Azure ML workspace. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
identity:
{
Description: The identity that will be used to access the key vault for encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The ArmId of the user assigned identity that will be used to access the customer managed key vault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: Customer Key vault properties. ,
Required: True ,
}
{
keyVaultArmId:
{
Description: The ArmId of the keyVault where the customer owned encryption key is present. ,
Required: True ,
}
string ,
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: True ,
}
string ,
identityClientId:
{
Description: For future use - The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
serverlessComputeSettings:
{
Description: Settings for serverless compute created in the workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource id that private link links to. ,
Required: False ,
}
string ,
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message. ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Description: The settings for the service managed cosmosdb account. ,
Required: False ,
}
{
collectionsThroughput:
{
Description: The throughput of the collections in cosmosdb database ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
managedNetworkKind:
{
Description: The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
}
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Description: Compute runtime config for feature store type workspace. ,
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of machine learning workspaces. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}