Microsoft.Databricks accessConnectors
The accessConnectors resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
To create a Microsoft.Databricks/accessConnectors resource, add the following Bicep to your template.
Bicep
resource symbolicname 'Microsoft.Databricks/accessConnectors@2024-09-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
}
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | 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. | UserAssignedIdentities |
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| properties | Azure Databricks Access Connector properties | AccessConnectorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Databricks Access Connector | AVM Resource Module for Azure Databricks Access Connector |
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| AzureDatabricks Template for Default Storage Firewall | This template allows you to create a network security group, a virtual network, private endpoint, and a default storage firewall enabled Azure Databricks workspace with the virtual network and the system-assigned access connector. |
The accessConnectors resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
To create a Microsoft.Databricks/accessConnectors resource, add the following JSON to your template.
JSON
{
"type": "Microsoft.Databricks/accessConnectors",
"apiVersion": "2024-09-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
}
}
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | 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. | UserAssignedIdentities |
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-09-01-preview' |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| properties | Azure Databricks Access Connector properties | AccessConnectorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Databricks/accessConnectors' |
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
AzureDatabricks Template for Default Storage Firewall |
This template allows you to create a network security group, a virtual network, private endpoint, and a default storage firewall enabled Azure Databricks workspace with the virtual network and the system-assigned access connector. |
| AzureDatabricks Template with Default Storage Firewall |
This template allows you to create an Default Storage Firewall enabled Azure Databricks workspace with Privateendpoint, all three forms of CMK, and User-Assigned Access Connector. |
The accessConnectors resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
To create a Microsoft.Databricks/accessConnectors resource, add the following Terraform to your template.
Terraform
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Databricks/accessConnectors@2024-09-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
}
})
}
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | 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. | UserAssignedIdentities |
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| properties | Azure Databricks Access Connector properties | AccessConnectorProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Databricks/accessConnectors@2024-09-01-preview" |
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Databricks Access Connector | AVM Resource Module for Azure Databricks Access Connector |