active_directory_connectors

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

Overview

Name	active_directory_connectors
Type	Resource
Id	azure.azure_arc_data.active_directory_connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	null

list

Name	Datatype	Description
properties	object	null

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dataControllerName, activeDirectoryConnectorName	api-version	Retrieves an Active Directory connector resource
list	select	subscriptionId, resourceGroupName, dataControllerName	api-version
create	insert	subscriptionId, resourceGroupName, dataControllerName, activeDirectoryConnectorName, data__properties	api-version	Creates or replaces an Active Directory connector resource.
delete	delete	subscriptionId, resourceGroupName, dataControllerName, activeDirectoryConnectorName	api-version	Deletes an Active Directory connector resource

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
activeDirectoryConnectorName	string	The name of the Active Directory connector instance
dataControllerName	string	The name of the data controller
resourceGroupName	string	The name of the Azure resource group
subscriptionId	string	The ID of the Azure subscription
api-version	string	The API version to use for the request

SELECT examples

get

Retrieves an Active Directory connector resource

SELECT
properties
FROM azure.azure_arc_data.active_directory_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataControllerName = '{{ dataControllerName }}' -- required
AND activeDirectoryConnectorName = '{{ activeDirectoryConnectorName }}' -- required
AND api-version = '{{ api-version }}'
;

list

OK

SELECT
properties
FROM azure.azure_arc_data.active_directory_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataControllerName = '{{ dataControllerName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates or replaces an Active Directory connector resource.

INSERT INTO azure.azure_arc_data.active_directory_connectors (
data__properties,
subscriptionId,
resourceGroupName,
dataControllerName,
activeDirectoryConnectorName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataControllerName }}',
'{{ activeDirectoryConnectorName }}',
'{{ api-version }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: active_directory_connectors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the active_directory_connectors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the active_directory_connectors resource.
    - name: dataControllerName
      value: string
      description: Required parameter for the active_directory_connectors resource.
    - name: activeDirectoryConnectorName
      value: string
      description: Required parameter for the active_directory_connectors resource.
    - name: properties
      value: object
      description: |
        null
    - name: api-version
      value: string
      description: The API version to use for the request

DELETE examples

delete

Deletes an Active Directory connector resource

DELETE FROM azure.azure_arc_data.active_directory_connectors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataControllerName = '{{ dataControllerName }}' --required
AND activeDirectoryConnectorName = '{{ activeDirectoryConnectorName }}' --required
AND api-version = '{{ api-version }}'
;