access_connectors

Creates, updates, deletes, gets or lists an access_connectors resource.

Overview

Name	access_connectors
Type	Resource
Id	azure_isv.databricks.access_connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning status of the Access Connector. Known values are: "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Updating)
referedBy	array	List of workspaces referring this Access Connector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning status of the Access Connector. Known values are: "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Updating)
referedBy	array	List of workspaces referring this Access Connector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning status of the Access Connector. Known values are: "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", and "Updating". (Accepted, Running, Ready, Creating, Created, Deleting, Deleted, Canceled, Failed, Succeeded, Updating)
referedBy	array	List of workspaces referring this Access Connector.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, connector_name, subscription_id		Gets an Azure Databricks Access Connector.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the Azure Databricks Access Connectors within a resource group.
list_by_subscription	select	subscription_id		Gets all the Azure Databricks Access Connectors within a subscription.
create_or_update	insert	resource_group_name, connector_name, subscription_id, location		Creates or updates Azure Databricks Access Connector.
update	update	resource_group_name, connector_name, subscription_id		Updates an Azure Databricks Access Connector.
create_or_update	replace	resource_group_name, connector_name, subscription_id, location		Creates or updates Azure Databricks Access Connector.
delete	delete	resource_group_name, connector_name, subscription_id		Deletes the Azure Databricks Access Connector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connector_name	string	The name of the Azure Databricks Access Connector. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an Azure Databricks Access Connector.

SELECT
id,
name,
identity,
location,
provisioningState,
referedBy,
systemData,
tags,
type
FROM azure_isv.databricks.access_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND connector_name = '{{ connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the Azure Databricks Access Connectors within a resource group.

SELECT
id,
name,
identity,
location,
provisioningState,
referedBy,
systemData,
tags,
type
FROM azure_isv.databricks.access_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all the Azure Databricks Access Connectors within a subscription.

SELECT
id,
name,
identity,
location,
provisioningState,
referedBy,
systemData,
tags,
type
FROM azure_isv.databricks.access_connectors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates Azure Databricks Access Connector.

INSERT INTO azure_isv.databricks.access_connectors (
tags,
location,
properties,
identity,
resource_group_name,
connector_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: access_connectors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the access_connectors resource.
  - name: connector_name
    value: "{{ connector_name }}"
    description: Required parameter for the access_connectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the access_connectors resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Azure Databricks Access Connector properties.
    value:
      provisioningState: "{{ provisioningState }}"
      referedBy:
        - "{{ referedBy }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates an Azure Databricks Access Connector.

UPDATE azure_isv.databricks.access_connectors
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates Azure Databricks Access Connector.

REPLACE azure_isv.databricks.access_connectors
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the Azure Databricks Access Connector.

DELETE FROM azure_isv.databricks.access_connectors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;