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

OK - Returns the Access Connector.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	Azure Databricks Access Connector properties
systemData	object	The system metadata relating to this resource
tags	object	Resource tags.

list_by_resource_group

OK - Returns an array of Azure Databricks Access Connectors.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	Azure Databricks Access Connector properties
systemData	object	The system metadata relating to this resource
tags	object	Resource tags.

list_by_subscription

OK - Returns an array of Azure Databricks Access Connectors.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	Azure Databricks Access Connector properties
systemData	object	The system metadata relating to this resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, connectorName, subscriptionId		Gets an Azure Databricks Access Connector.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the Azure Databricks Access Connectors within a resource group.
list_by_subscription	select	subscriptionId		Gets all the Azure Databricks Access Connectors within a subscription.
create_or_update	insert	resourceGroupName, connectorName, subscriptionId		Creates or updates Azure Databricks Access Connector.
update	update	resourceGroupName, connectorName, subscriptionId		Updates an Azure Databricks Access Connector.
delete	delete	resourceGroupName, connectorName, subscriptionId		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
connectorName	string	The name of the Azure Databricks Access Connector.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets an Azure Databricks Access Connector.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_isv.databricks.access_connectors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND connectorName = '{{ connectorName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

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

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_isv.databricks.access_connectors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Gets all the Azure Databricks Access Connectors within a subscription.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure_isv.databricks.access_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates Azure Databricks Access Connector.

INSERT INTO azure_isv.databricks.access_connectors (
data__identity,
data__properties,
data__tags,
data__location,
resourceGroupName,
connectorName,
subscriptionId
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ connectorName }}',
'{{ subscriptionId }}'
RETURNING
identity,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: access_connectors
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the access_connectors resource.
    - name: connectorName
      value: string
      description: Required parameter for the access_connectors resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the access_connectors resource.
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)
    - name: properties
      value: object
      description: |
        Azure Databricks Access Connector properties
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates an Azure Databricks Access Connector.

UPDATE azure_isv.databricks.access_connectors
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND connectorName = '{{ connectorName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes the Azure Databricks Access Connector.

DELETE FROM azure_isv.databricks.access_connectors
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND connectorName = '{{ connectorName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;