Access Connectors - Create Or Update

Service:: Databricks

API Version:: 2024-05-01

Creates or updates Azure Databricks Access Connector.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/accessConnectors/{connectorName}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
connectorName	path	True	string minLength: 3 maxLength: 64	The name of the Azure Databricks Access Connector.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
identity		ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
properties		AccessConnectorProperties	Azure Databricks Access Connector properties
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	AccessConnector	Updated - Returns information about the Azure Databricks Access Connector.
201 Created	AccessConnector	Created - Returns information about the Azure Databricks Access Connector.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create an Azure Databricks Access Connector with SystemAssigned Identity

Create an Azure Databricks Access Connector with UserAssigned Identity

Create an Azure Databricks Access Connector with SystemAssigned Identity

Sample request

HTTP

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector?api-version=2024-05-01

{
  "location": "westus"
}

Sample response

Status code:: 200

{
  "name": "myAccessConnector",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector2",
  "type": "Microsoft.Databricks/accessConnectors",
  "location": "West US",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "referedBy": []
  },
  "identity": {
    "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d",
    "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da",
    "type": "SystemAssigned"
  }
}

Status code:: 201

{
  "name": "myAccessConnector",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
  "type": "Microsoft.Databricks/accessConnectors",
  "location": "West US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "referedBy": []
  },
  "identity": {
    "principalId": "5619ff16-afe1-47e5-ae67-8393c6c3223d",
    "tenantId": "e3fe3f22-4b98-4c04-82cc-d8817d1b17da",
    "type": "SystemAssigned"
  }
}

Create an Azure Databricks Access Connector with UserAssigned Identity

Sample request

HTTP

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector?api-version=2024-05-01

{
  "location": "westus"
}

Sample response

Status code:: 200

{
  "name": "myAccessConnector",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector2",
  "type": "Microsoft.Databricks/accessConnectors",
  "location": "West US",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "referedBy": []
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/11111111-1111-1111-1111-111111111111/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuseridentity": {
        "principalId": "329429bc-adec-4dce-9568-25a6d486e468",
        "clientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    }
  }
}

Status code:: 201

{
  "name": "myAccessConnector",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
  "type": "Microsoft.Databricks/accessConnectors",
  "location": "West US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "referedBy": []
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/11111111-1111-1111-1111-111111111111/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuseridentity": {
        "principalId": "329429bc-adec-4dce-9568-25a6d486e468",
        "clientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    }
  }
}

Definitions

Name	Description
AccessConnector	Information about Azure Databricks Access Connector.
AccessConnectorProperties
createdByType	The type of identity that created the resource.
ErrorDetail	Error details.
ErrorInfo	The code and message for an error.
ErrorResponse	Error response.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
ProvisioningState	Provisioning status of the workspace.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

AccessConnector

Object

Information about Azure Databricks Access Connector.

Name	Type	Description
id	string	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	AccessConnectorProperties	Azure Databricks Access Connector properties
systemData	systemData	The system metadata relating to this resource
tags	object	Resource tags.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

AccessConnectorProperties

Object

Name	Type	Description
provisioningState	ProvisioningState	Provisioning status of the Access Connector.
referedBy	string[]	List of workspaces referring this Access Connector.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorDetail

Object

Error details.

Name	Type	Description
code	string	The error's code.
message	string	A human readable error message.
target	string	Indicates which property in the request is responsible for the error.

ErrorInfo

Object

The code and message for an error.

Name	Type	Description
code	string	A machine readable error code.
details	ErrorDetail[]	error details.
innererror	string	Inner error details if they exist.
message	string	A human readable error message.

ErrorResponse

Object

Error response.

Name	Type	Description
error	ErrorInfo	The code and message for an error. The error details.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities 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.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Enumeration

Provisioning status of the workspace.

Value	Description
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

Share via

Access Connectors - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create an Azure Databricks Access Connector with SystemAssigned Identity

Sample request

Sample response

Create an Azure Databricks Access Connector with UserAssigned Identity

Sample request

Sample response

Definitions

AccessConnector

AccessConnectorProperties

createdByType

ErrorDetail

ErrorInfo

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

systemData

UserAssignedIdentity