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
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.
domainServiceAccountLoginInformation	object	Username and password for domain service account authentication.
provisioningState	string	The provisioning state of the Active Directory connector resource.
spec	object	null. Required.
status	object	null.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
domainServiceAccountLoginInformation	object	Username and password for domain service account authentication.
provisioningState	string	The provisioning state of the Active Directory connector resource.
spec	object	null. Required.
status	object	null.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, data_controller_name, active_directory_connector_name, subscription_id		Retrieves an Active Directory connector resource.
list	select	resource_group_name, data_controller_name, subscription_id		List the active directory connectors associated with the given data controller. List the active directory connectors associated with the given data controller.
create	insert	resource_group_name, data_controller_name, active_directory_connector_name, subscription_id, properties		Creates or replaces an Active Directory connector resource.
delete	delete	resource_group_name, data_controller_name, active_directory_connector_name, subscription_id		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
active_directory_connector_name	string	The name of the Active Directory connector instance. Required.
data_controller_name	string	The name of the data controller. Required.
resource_group_name	string	The name of the Azure resource group. Required.
subscription_id	string

SELECT examples

get

Retrieves an Active Directory connector resource.

SELECT
id,
name,
domainServiceAccountLoginInformation,
provisioningState,
spec,
status,
systemData,
type
FROM azure.azure_arc_data.active_directory_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_controller_name = '{{ data_controller_name }}' -- required
AND active_directory_connector_name = '{{ active_directory_connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List the active directory connectors associated with the given data controller. List the active directory connectors associated with the given data controller.

SELECT
id,
name,
domainServiceAccountLoginInformation,
provisioningState,
spec,
status,
systemData,
type
FROM azure.azure_arc_data.active_directory_connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_controller_name = '{{ data_controller_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or replaces an Active Directory connector resource.

INSERT INTO azure.azure_arc_data.active_directory_connectors (
properties,
resource_group_name,
data_controller_name,
active_directory_connector_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ data_controller_name }}',
'{{ active_directory_connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: active_directory_connectors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the active_directory_connectors resource.
  - name: data_controller_name
    value: "{{ data_controller_name }}"
    description: Required parameter for the active_directory_connectors resource.
  - name: active_directory_connector_name
    value: "{{ active_directory_connector_name }}"
    description: Required parameter for the active_directory_connectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the active_directory_connectors resource.
  - name: properties
    description: |
      null. Required.
    value:
      domainServiceAccountLoginInformation:
        username: "{{ username }}"
        password: "{{ password }}"
      provisioningState: "{{ provisioningState }}"
      spec:
        activeDirectory:
          realm: "{{ realm }}"
          netbiosDomainName: "{{ netbiosDomainName }}"
          serviceAccountProvisioning: "{{ serviceAccountProvisioning }}"
          ouDistinguishedName: "{{ ouDistinguishedName }}"
          domainControllers:
            primaryDomainController:
              hostname: "{{ hostname }}"
            secondaryDomainControllers:
              - hostname: "{{ hostname }}"
        dns:
          domainName: "{{ domainName }}"
          nameserverIPAddresses:
            - "{{ nameserverIPAddresses }}"
          replicas: {{ replicas }}
          preferK8sDnsForPtrLookups: {{ preferK8sDnsForPtrLookups }}
      status:
        : "{{  }}"
        lastUpdateTime: "{{ lastUpdateTime }}"
        observedGeneration: {{ observedGeneration }}
        state: "{{ state }}"

DELETE examples

delete

Deletes an Active Directory connector resource.

DELETE FROM azure.azure_arc_data.active_directory_connectors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND data_controller_name = '{{ data_controller_name }}' --required
AND active_directory_connector_name = '{{ active_directory_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;