Share via

Microsoft.AzureArcData dataControllers/activeDirectoryConnectors

  • Article
  • 12/09/2024
Choose a deployment language

Bicep resource definition

The dataControllers/activeDirectoryConnectors resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors@2025-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    domainServiceAccountLoginInformation: {
      password: 'string'
      username: 'string'
    }
    spec: {
      activeDirectory: {
        domainControllers: {
          primaryDomainController: {
            hostname: 'string'
          }
          secondaryDomainControllers: [
            {
              hostname: 'string'
            }
          ]
        }
        netbiosDomainName: 'string'
        ouDistinguishedName: 'string'
        realm: 'string'
        serviceAccountProvisioning: 'string'
      }
      dns: {
        domainName: 'string'
        nameserverIPAddresses: [
          'string'
        ]
        preferK8sDnsForPtrLookups: bool
        replicas: int
      }
    }
    status: {
      lastUpdateTime: 'string'
      observedGeneration: int
      state: 'string'
    }
  }
}

Property Values

ActiveDirectoryConnectorDNSDetails

Name Description Value
domainName DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. string
nameserverIPAddresses List of Active Directory DNS server IP addresses. string[] (required)
preferK8sDnsForPtrLookups Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. bool
replicas Replica count for DNS proxy service. Default value is 1. int

ActiveDirectoryConnectorDomainDetails

Name Description Value
domainControllers null ActiveDirectoryDomainControllers
netbiosDomainName NETBIOS name of the Active Directory domain. string
ouDistinguishedName The distinguished name of the Active Directory Organizational Unit. string
realm Name (uppercase) of the Active Directory domain that this AD connector will be associated with. string (required)
serviceAccountProvisioning The service account provisioning mode for this Active Directory connector. 'automatic'
'manual'

ActiveDirectoryConnectorProperties

Name Description Value
domainServiceAccountLoginInformation Username and password for domain service account authentication. BasicLoginInformation
spec null ActiveDirectoryConnectorSpec (required)
status null ActiveDirectoryConnectorStatus

ActiveDirectoryConnectorSpec

Name Description Value
activeDirectory null ActiveDirectoryConnectorDomainDetails (required)
dns null ActiveDirectoryConnectorDNSDetails (required)

ActiveDirectoryConnectorStatus

Name Description Value
lastUpdateTime The time that the custom resource was last updated. string
observedGeneration The version of the replicaSet associated with the AD connector custom resource. int
state The state of the AD connector custom resource. string

ActiveDirectoryDomainController

Name Description Value
hostname Fully-qualified domain name of a domain controller in the AD domain. string (required)

ActiveDirectoryDomainControllers

Name Description Value
primaryDomainController Information about the Primary Domain Controller (PDC) in the AD domain. ActiveDirectoryDomainController
secondaryDomainControllers null ActiveDirectoryDomainController[]

BasicLoginInformation

Name Description Value
password Login password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
username Login username. string

Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: dataControllers
properties null ActiveDirectoryConnectorProperties (required)

ARM template resource definition

The dataControllers/activeDirectoryConnectors resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "properties": {
    "domainServiceAccountLoginInformation": {
      "password": "string",
      "username": "string"
    },
    "spec": {
      "activeDirectory": {
        "domainControllers": {
          "primaryDomainController": {
            "hostname": "string"
          },
          "secondaryDomainControllers": [
            {
              "hostname": "string"
            }
          ]
        },
        "netbiosDomainName": "string",
        "ouDistinguishedName": "string",
        "realm": "string",
        "serviceAccountProvisioning": "string"
      },
      "dns": {
        "domainName": "string",
        "nameserverIPAddresses": [ "string" ],
        "preferK8sDnsForPtrLookups": "bool",
        "replicas": "int"
      }
    },
    "status": {
      "lastUpdateTime": "string",
      "observedGeneration": "int",
      "state": "string"
    }
  }
}

Property Values

ActiveDirectoryConnectorDNSDetails

Name Description Value
domainName DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. string
nameserverIPAddresses List of Active Directory DNS server IP addresses. string[] (required)
preferK8sDnsForPtrLookups Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. bool
replicas Replica count for DNS proxy service. Default value is 1. int

ActiveDirectoryConnectorDomainDetails

Name Description Value
domainControllers null ActiveDirectoryDomainControllers
netbiosDomainName NETBIOS name of the Active Directory domain. string
ouDistinguishedName The distinguished name of the Active Directory Organizational Unit. string
realm Name (uppercase) of the Active Directory domain that this AD connector will be associated with. string (required)
serviceAccountProvisioning The service account provisioning mode for this Active Directory connector. 'automatic'
'manual'

ActiveDirectoryConnectorProperties

Name Description Value
domainServiceAccountLoginInformation Username and password for domain service account authentication. BasicLoginInformation
spec null ActiveDirectoryConnectorSpec (required)
status null ActiveDirectoryConnectorStatus

ActiveDirectoryConnectorSpec

Name Description Value
activeDirectory null ActiveDirectoryConnectorDomainDetails (required)
dns null ActiveDirectoryConnectorDNSDetails (required)

ActiveDirectoryConnectorStatus

Name Description Value
lastUpdateTime The time that the custom resource was last updated. string
observedGeneration The version of the replicaSet associated with the AD connector custom resource. int
state The state of the AD connector custom resource. string

ActiveDirectoryDomainController

Name Description Value
hostname Fully-qualified domain name of a domain controller in the AD domain. string (required)

ActiveDirectoryDomainControllers

Name Description Value
primaryDomainController Information about the Primary Domain Controller (PDC) in the AD domain. ActiveDirectoryDomainController
secondaryDomainControllers null ActiveDirectoryDomainController[]

BasicLoginInformation

Name Description Value
password Login password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
username Login username. string

Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors

Name Description Value
apiVersion The api version '2025-03-01-preview'
name The resource name string (required)
properties null ActiveDirectoryConnectorProperties (required)
type The resource type 'Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors'

Usage Examples

Terraform (AzAPI provider) resource definition

The dataControllers/activeDirectoryConnectors resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors@2025-03-01-preview"
  name = "string"
  body = {
    properties = {
      domainServiceAccountLoginInformation = {
        password = "string"
        username = "string"
      }
      spec = {
        activeDirectory = {
          domainControllers = {
            primaryDomainController = {
              hostname = "string"
            }
            secondaryDomainControllers = [
              {
                hostname = "string"
              }
            ]
          }
          netbiosDomainName = "string"
          ouDistinguishedName = "string"
          realm = "string"
          serviceAccountProvisioning = "string"
        }
        dns = {
          domainName = "string"
          nameserverIPAddresses = [
            "string"
          ]
          preferK8sDnsForPtrLookups = bool
          replicas = int
        }
      }
      status = {
        lastUpdateTime = "string"
        observedGeneration = int
        state = "string"
      }
    }
  }
}

Property Values

ActiveDirectoryConnectorDNSDetails

Name Description Value
domainName DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. string
nameserverIPAddresses List of Active Directory DNS server IP addresses. string[] (required)
preferK8sDnsForPtrLookups Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. bool
replicas Replica count for DNS proxy service. Default value is 1. int

ActiveDirectoryConnectorDomainDetails

Name Description Value
domainControllers null ActiveDirectoryDomainControllers
netbiosDomainName NETBIOS name of the Active Directory domain. string
ouDistinguishedName The distinguished name of the Active Directory Organizational Unit. string
realm Name (uppercase) of the Active Directory domain that this AD connector will be associated with. string (required)
serviceAccountProvisioning The service account provisioning mode for this Active Directory connector. 'automatic'
'manual'

ActiveDirectoryConnectorProperties

Name Description Value
domainServiceAccountLoginInformation Username and password for domain service account authentication. BasicLoginInformation
spec null ActiveDirectoryConnectorSpec (required)
status null ActiveDirectoryConnectorStatus

ActiveDirectoryConnectorSpec

Name Description Value
activeDirectory null ActiveDirectoryConnectorDomainDetails (required)
dns null ActiveDirectoryConnectorDNSDetails (required)

ActiveDirectoryConnectorStatus

Name Description Value
lastUpdateTime The time that the custom resource was last updated. string
observedGeneration The version of the replicaSet associated with the AD connector custom resource. int
state The state of the AD connector custom resource. string

ActiveDirectoryDomainController

Name Description Value
hostname Fully-qualified domain name of a domain controller in the AD domain. string (required)

ActiveDirectoryDomainControllers

Name Description Value
primaryDomainController Information about the Primary Domain Controller (PDC) in the AD domain. ActiveDirectoryDomainController
secondaryDomainControllers null ActiveDirectoryDomainController[]

BasicLoginInformation

Name Description Value
password Login password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
username Login username. string

Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: dataControllers
properties null ActiveDirectoryConnectorProperties (required)
type The resource type "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors@2025-03-01-preview"