Microsoft.Databricks (preview:2025-03-01)

2025/03/25 • 24 new methods

AccessConnectors_Get (new)
Description :  Gets an Azure Databricks Access Connector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/accessConnectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the Azure Databricks Access Connector. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Azure Databricks Access Connector properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning status of the Access Connector. ,
Enum:
{
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
referedBy:
{
Description: List of workspaces referring this Access Connector. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
AccessConnectors_Delete (new)
Description :  Deletes the Azure Databricks Access Connector.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/accessConnectors/{connectorName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the Azure Databricks Access Connector. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
AccessConnectors_CreateOrUpdate (new)
Description :  Creates or updates Azure Databricks Access Connector.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/accessConnectors/{connectorName}
{
parameters:
{
Description: Parameters supplied to the create or update an Azure Databricks Access Connector. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Azure Databricks Access Connector properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning status of the Access Connector. ,
Enum:
{
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
referedBy:
{
Description: List of workspaces referring this Access Connector. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the Azure Databricks Access Connector. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Azure Databricks Access Connector properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning status of the Access Connector. ,
Enum:
{
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
referedBy:
{
Description: List of workspaces referring this Access Connector. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Azure Databricks Access Connector properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning status of the Access Connector. ,
Enum:
{
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
referedBy:
{
Description: List of workspaces referring this Access Connector. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
AccessConnectors_Update (new)
Description :  Updates an Azure Databricks Access Connector.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/accessConnectors/{connectorName}
{
parameters:
{
Description: The update to the Azure Databricks Access Connector. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
}
,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectorName:
{
Description: The name of the Azure Databricks Access Connector. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Azure Databricks Access Connector properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning status of the Access Connector. ,
Enum:
{
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
referedBy:
{
Description: List of workspaces referring this Access Connector. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
AccessConnectors_ListByResourceGroup (new)
Description :  Gets all the Azure Databricks Access Connectors within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/accessConnectors
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of Azure Databricks Access Connector. ,
Required: False ,
}
[
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Azure Databricks Access Connector properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning status of the Access Connector. ,
Enum:
{
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
referedBy:
{
Description: List of workspaces referring this Access Connector. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
AccessConnectors_ListBySubscription (new)
Description :  Gets all the Azure Databricks Access Connectors within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Databricks/accessConnectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of Azure Databricks Access Connector. ,
Required: False ,
}
[
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Azure Databricks Access Connector properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning status of the Access Connector. ,
Enum:
{
Deleted: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
referedBy:
{
Description: List of workspaces referring this Access Connector. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_Get (new)
Description :  Gets the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_Delete (new)
Description :  Deletes the workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
forceDeletion:
{
Description: Optional parameter to retain default unity catalog data. By default the data will retained if Uc is enabled on the workspace. ,
Required: False ,
}
boolean ,
}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_CreateOrUpdate (new)
Description :  Creates a new workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
{
parameters:
{
Description: Parameters supplied to the create or update a workspace. ,
Required: True ,
}
{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_Update (new)
Description :  Updates a workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}
{
parameters:
{
Description: The update to the workspace. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
Workspaces_ListByResourceGroup (new)
Description :  Gets all the workspaces within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Workspaces_ListBySubscription (new)
Description :  Gets all the workspaces within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: The workspace properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
parameters:
{
Description: The workspace's custom parameters. ,
Required: False ,
}
{
amlWorkspaceId:
{
Description: The ID of a Azure Machine Learning workspace to link with Databricks workspace ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customVirtualNetworkId:
{
Description: The ID of a Virtual Network where this Databricks Cluster should be created ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPublicSubnetName:
{
Description: The name of a Public Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
customPrivateSubnetName:
{
Description: The name of the Private Subnet within the Virtual Network ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
enableNoPublicIp:
{
Description: Boolean indicating whether the public IP should be disabled. Default value is true ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
loadBalancerBackendPoolName:
{
Description: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
loadBalancerId:
{
Description: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
natGatewayName:
{
Description: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
publicIpName:
{
Description: Name of the Public IP for No Public IP workspace with managed vNet. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
prepareEncryption:
{
Description: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
encryption:
{
Description: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault ,
Enum:
{
Default: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
KeyName:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
}
,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
boolean ,
}
,
storageAccountName:
{
Description: Default DBFS storage account name. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
storageAccountSkuName:
{
Description: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
vnetAddressPrefix:
{
Description: Address prefix for Managed virtual network. Default value for this input is 10.139. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
string ,
}
,
resourceTags:
{
Description: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. ,
Required: False ,
}
{
type:
{
Description: The type of variable that this is ,
Enum:
{
Bool: No description available. ,
Object: No description available. ,
String: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value which should be used for this field. ,
Required: True ,
}
object ,
}
,
}
,
provisioningState:
{
Description: The workspace provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
authorizations:
{
Description: The workspace provider authorizations. ,
Required: False ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. ,
Format: uuid ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
createdBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that created the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace. ,
Required: False ,
}
{
oid:
{
Description: The Object ID that created the workspace. ,
Format: uuid ,
Required: False ,
}
string ,
puid:
{
Description: The Personal Object ID corresponding to the object ID above ,
Required: False ,
}
string ,
applicationId:
{
Description: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Specifies the date and time when the workspace is created. ,
Format: date-time ,
Required: False ,
}
string ,
workspaceId:
{
Description: The unique identifier of the databricks workspace in databricks control plane. ,
Required: False ,
}
string ,
workspaceUrl:
{
Description: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net' ,
Required: False ,
}
string ,
storageAccountIdentity:
{
Description: The details of Managed Identity of Storage Account ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
managedDiskIdentity:
{
Description: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption ,
Required: False ,
}
{
principalId:
{
Description: The objectId of the Managed Identity that is linked to the Managed Storage account. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant Id where the Managed Identity is created. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The type of Identity created. It can be either SystemAssigned or UserAssigned. ,
Required: False ,
}
string ,
}
,
diskEncryptionSetId:
{
Description: The resource Id of the managed disk encryption set. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for databricks workspace ,
Required: False ,
}
{
entities:
{
Description: Encryption entities definition for the workspace. ,
Required: True ,
}
{
managedServices:
{
Description: Encryption properties for the databricks managed services. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
}
,
managedDisk:
{
Description: Encryption properties for the databricks managed disks. ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault ,
Enum:
{
Microsoft.Keyvault: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: Key Vault input properties for encryption. ,
Required: True ,
}
{
keyVaultUri:
{
Description: The URI of KeyVault. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of KeyVault key. ,
Required: True ,
}
string ,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Indicate whether the latest key version should be automatically used for Managed Disk Encryption. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
enhancedSecurityCompliance:
{
Description: Contains settings related to the Enhanced Security and Compliance Add-On. ,
Required: False ,
}
{
automaticClusterUpdate:
{
Description: Status of automated cluster updates feature. ,
Required: False ,
}
string ,
complianceSecurityProfile:
{
Description: Status of Compliance Security Profile feature. ,
Required: False ,
}
{
complianceStandards:
{
Description: Compliance standards associated with the workspace. ,
Required: False ,
}
[
string ,
]
,
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enhancedSecurityMonitoring:
{
Description: Status of Enhanced Security Monitoring feature. ,
Required: False ,
}
{
value:
{
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
privateEndpointConnections:
{
Description: Private endpoint connections created on the workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: The network access type for accessing workspace. Set value to disabled to access workspace only via private link. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
requiredNsgRules:
{
Description: Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only. ,
Enum:
{
AllRules: No description available. ,
NoAzureDatabricksRules: No description available. ,
NoAzureServiceRules: No description available. ,
}
,
Required: False ,
}
enum ,
defaultCatalog:
{
Description: Properties for Default Catalog configuration during workspace creation. ,
Required: False ,
}
{
initialType:
{
Description: Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog ,
Enum:
{
HiveMetastore: No description available. ,
UnityCatalog: No description available. ,
}
,
Required: False ,
}
enum ,
initialName:
{
Description: Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. ,
Required: False ,
}
string ,
}
,
isUcEnabled:
{
Description: Indicates whether unity catalog enabled for the workspace or not. ,
Required: False ,
}
boolean ,
accessConnector:
{
Description: Access Connector Resource that is going to be associated with Databricks Workspace ,
Required: False ,
}
{
id:
{
Description: The resource ID of Azure Databricks Access Connector Resource. ,
Format: arm-id ,
Required: True ,
}
string ,
identityType:
{
Description: The identity type of the Access Connector Resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityId:
{
Description: The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
defaultStorageFirewall:
{
Description: Gets or Sets Default Storage Firewall configuration information ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: True ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available RP operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Databricks/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Resource Provider operations supported by the Resource Provider resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: ex Microsoft.Databricks ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description for the resource operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_List (new)
Description :  List private link resources for a given workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of available private link resources for a workspace ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The group id properties. ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of private link resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_Get (new)
Description :  Get the specified private link resource for the given group id (sub-resource)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
groupId:
{
Description: The name of the private link resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The group id properties. ,
Required: True ,
}
{
groupId:
{
Description: The group id ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The required members for a specific group id ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The required DNS zones for a specific group id ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_List (new)
Description :  List private endpoint connections of the workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of returned private endpoint connection. ,
Required: False ,
}
[
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of endpoint connections. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Get a private endpoint connection properties for a workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Create (new)
Description :  Update the status of a private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The private endpoint connection with updated properties ,
Required: True ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
privateEndpoint:
{
Description: Private endpoint ,
Required: False ,
}
{
id:
{
Description: The resource identifier. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: GroupIds from the private link service resource. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Private endpoint connection state ,
Required: True ,
}
{
status:
{
Description: The status of a private endpoint connection ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The description for the current state of a private endpoint connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Actions required for a private endpoint connection ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state of the private endpoint connection. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Remove private endpoint connection with the specified name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
OutboundNetworkDependenciesEndpoints_List (new)
Description :  Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You must configure outbound access with these endpoints. For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
category:
{
Description: The category of endpoints accessed by the Workspace, e.g. azure-storage, azure-mysql, etc. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that Workspace connect to ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The Ports used when connecting to domainName. ,
Required: False ,
}
[
{
ipAddress:
{
Description: An IP Address that Domain Name currently resolves to. ,
Required: False ,
}
string ,
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
latency:
{
Description: The time in milliseconds it takes for the connection to be created from the Workspace to this IpAddress at this Port. ,
Format: double ,
Required: False ,
}
number ,
isAccessible:
{
Description: Whether it is possible to create a connection from the Workspace to this IpAddress at this Port. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
vNetPeering_Get (new)
Description :  Gets the workspace vNet Peering.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the workspace vNet peering. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: List of properties for vNet Peering ,
Required: True ,
}
{
allowVirtualNetworkAccess:
{
Description: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. ,
Required: False ,
}
boolean ,
allowForwardedTraffic:
{
Description: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. ,
Required: False ,
}
boolean ,
allowGatewayTransit:
{
Description: If gateway links can be used in remote virtual networking to link to this virtual network. ,
Required: False ,
}
boolean ,
useRemoteGateways:
{
Description: If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. ,
Required: False ,
}
boolean ,
databricksVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: False ,
}
{
id:
{
Description: The Id of the databricks virtual network. ,
Required: False ,
}
string ,
}
,
databricksAddressSpace:
{
Description: The reference to the databricks virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
remoteVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: True ,
}
{
id:
{
Description: The Id of the remote virtual network. ,
Required: False ,
}
string ,
}
,
remoteAddressSpace:
{
Description: The reference to the remote virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
peeringState:
{
Description: The status of the virtual network peering. ,
Enum:
{
Initiated: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual network peering resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the virtual network peering resource ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
type:
{
Description: type of the virtual network peering resource ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
vNetPeering_Delete (new)
Description :  Deletes the workspace vNetPeering.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the workspace vNet peering. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
vNetPeering_CreateOrUpdate (new)
Description :  Creates vNet Peering for workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}
{
VirtualNetworkPeeringParameters:
{
Description: Parameters supplied to the create workspace vNet Peering. ,
Required: True ,
}
{
properties:
{
Description: List of properties for vNet Peering ,
Required: True ,
}
{
allowVirtualNetworkAccess:
{
Description: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. ,
Required: False ,
}
boolean ,
allowForwardedTraffic:
{
Description: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. ,
Required: False ,
}
boolean ,
allowGatewayTransit:
{
Description: If gateway links can be used in remote virtual networking to link to this virtual network. ,
Required: False ,
}
boolean ,
useRemoteGateways:
{
Description: If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. ,
Required: False ,
}
boolean ,
databricksVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: False ,
}
{
id:
{
Description: The Id of the databricks virtual network. ,
Required: False ,
}
string ,
}
,
databricksAddressSpace:
{
Description: The reference to the databricks virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
remoteVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: True ,
}
{
id:
{
Description: The Id of the remote virtual network. ,
Required: False ,
}
string ,
}
,
remoteAddressSpace:
{
Description: The reference to the remote virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
peeringState:
{
Description: The status of the virtual network peering. ,
Enum:
{
Initiated: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual network peering resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the virtual network peering resource ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
type:
{
Description: type of the virtual network peering resource ,
Required: False ,
}
string ,
}
,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
peeringName:
{
Description: The name of the workspace vNet peering. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: List of properties for vNet Peering ,
Required: True ,
}
{
allowVirtualNetworkAccess:
{
Description: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. ,
Required: False ,
}
boolean ,
allowForwardedTraffic:
{
Description: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. ,
Required: False ,
}
boolean ,
allowGatewayTransit:
{
Description: If gateway links can be used in remote virtual networking to link to this virtual network. ,
Required: False ,
}
boolean ,
useRemoteGateways:
{
Description: If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. ,
Required: False ,
}
boolean ,
databricksVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: False ,
}
{
id:
{
Description: The Id of the databricks virtual network. ,
Required: False ,
}
string ,
}
,
databricksAddressSpace:
{
Description: The reference to the databricks virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
remoteVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: True ,
}
{
id:
{
Description: The Id of the remote virtual network. ,
Required: False ,
}
string ,
}
,
remoteAddressSpace:
{
Description: The reference to the remote virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
peeringState:
{
Description: The status of the virtual network peering. ,
Enum:
{
Initiated: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual network peering resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the virtual network peering resource ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
type:
{
Description: type of the virtual network peering resource ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: List of properties for vNet Peering ,
Required: True ,
}
{
allowVirtualNetworkAccess:
{
Description: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. ,
Required: False ,
}
boolean ,
allowForwardedTraffic:
{
Description: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. ,
Required: False ,
}
boolean ,
allowGatewayTransit:
{
Description: If gateway links can be used in remote virtual networking to link to this virtual network. ,
Required: False ,
}
boolean ,
useRemoteGateways:
{
Description: If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. ,
Required: False ,
}
boolean ,
databricksVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: False ,
}
{
id:
{
Description: The Id of the databricks virtual network. ,
Required: False ,
}
string ,
}
,
databricksAddressSpace:
{
Description: The reference to the databricks virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
remoteVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: True ,
}
{
id:
{
Description: The Id of the remote virtual network. ,
Required: False ,
}
string ,
}
,
remoteAddressSpace:
{
Description: The reference to the remote virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
peeringState:
{
Description: The status of the virtual network peering. ,
Enum:
{
Initiated: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual network peering resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the virtual network peering resource ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
type:
{
Description: type of the virtual network peering resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}
vNetPeering_ListByWorkspace (new)
Description :  Lists the workspace vNet Peerings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of virtual network peerings on workspace. ,
Required: False ,
}
[
{
properties:
{
Description: List of properties for vNet Peering ,
Required: True ,
}
{
allowVirtualNetworkAccess:
{
Description: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. ,
Required: False ,
}
boolean ,
allowForwardedTraffic:
{
Description: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. ,
Required: False ,
}
boolean ,
allowGatewayTransit:
{
Description: If gateway links can be used in remote virtual networking to link to this virtual network. ,
Required: False ,
}
boolean ,
useRemoteGateways:
{
Description: If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. ,
Required: False ,
}
boolean ,
databricksVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: False ,
}
{
id:
{
Description: The Id of the databricks virtual network. ,
Required: False ,
}
string ,
}
,
databricksAddressSpace:
{
Description: The reference to the databricks virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
remoteVirtualNetwork:
{
Description: The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). ,
Required: True ,
}
{
id:
{
Description: The Id of the remote virtual network. ,
Required: False ,
}
string ,
}
,
remoteAddressSpace:
{
Description: The reference to the remote virtual network address space. ,
Required: False ,
}
{
addressPrefixes:
{
Description: A list of address blocks reserved for this virtual network in CIDR notation. ,
Required: False ,
}
[
string ,
]
,
}
,
peeringState:
{
Description: The status of the virtual network peering. ,
Enum:
{
Initiated: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual network peering resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Name of the virtual network peering resource ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
type:
{
Description: type of the virtual network peering resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of virtual network peering list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: A machine readable error code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
details:
{
Description: error details. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: Inner error details if they exist. ,
Required: False ,
}
string ,
}
,
}