active_directory_configs

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

Overview

Name	active_directory_configs
Type	Resource
Id	azure.netapp.active_directory_configs

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.
activeDirectoryStatus	string	Status of the Active Directory. Known values are: "Created", "InUse", "Deleted", "Error", and "Updating". (Created, InUse, Deleted, Error, Updating)
administrators	array	Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier.
backupOperators	array	Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier.
dns	array	An array of DNS server IP addresses(IPv4 only) for the Active Directory.
domain	string	Name of the Active Directory domain. Required.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
organizationalUnit	string	The Organizational Unit (OU) within the Windows Active Directory.
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
secretPassword	object	Access password from Azure KeyVault Secrets to connect Active Directory. Required.
securityOperators	array	Domain Users in the Active directory to be given SecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier.
site	string	The Active Directory site the service will limit Domain Controller discovery to. Required.
smbServerName	string	NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes.
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".
userName	string	A domain user account with permission to create machine accounts.

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.
activeDirectoryStatus	string	Status of the Active Directory. Known values are: "Created", "InUse", "Deleted", "Error", and "Updating". (Created, InUse, Deleted, Error, Updating)
administrators	array	Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier.
backupOperators	array	Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier.
dns	array	An array of DNS server IP addresses(IPv4 only) for the Active Directory.
domain	string	Name of the Active Directory domain. Required.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
organizationalUnit	string	The Organizational Unit (OU) within the Windows Active Directory.
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
secretPassword	object	Access password from Azure KeyVault Secrets to connect Active Directory. Required.
securityOperators	array	Domain Users in the Active directory to be given SecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier.
site	string	The Active Directory site the service will limit Domain Controller discovery to. Required.
smbServerName	string	NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes.
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".
userName	string	A domain user account with permission to create machine accounts.

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.
activeDirectoryStatus	string	Status of the Active Directory. Known values are: "Created", "InUse", "Deleted", "Error", and "Updating". (Created, InUse, Deleted, Error, Updating)
administrators	array	Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier.
backupOperators	array	Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier.
dns	array	An array of DNS server IP addresses(IPv4 only) for the Active Directory.
domain	string	Name of the Active Directory domain. Required.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
organizationalUnit	string	The Organizational Unit (OU) within the Windows Active Directory.
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
secretPassword	object	Access password from Azure KeyVault Secrets to connect Active Directory. Required.
securityOperators	array	Domain Users in the Active directory to be given SecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier.
site	string	The Active Directory site the service will limit Domain Controller discovery to. Required.
smbServerName	string	NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes.
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".
userName	string	A domain user account with permission to create machine accounts.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, active_directory_config_name, subscription_id		Get the details of the specified active directory configuration.
list_by_resource_group	select	resource_group_name, subscription_id		List all active directory configurations within the resource group.
list_by_subscription	select	subscription_id		List all active directory configurations within the subscription.
create_or_update	insert	resource_group_name, active_directory_config_name, subscription_id, location		Create or update the specified active directory configuration.
update	update	resource_group_name, active_directory_config_name, subscription_id		Patch the specified active directory configuration.
create_or_update	replace	resource_group_name, active_directory_config_name, subscription_id, location		Create or update the specified active directory configuration.
delete	delete	resource_group_name, active_directory_config_name, subscription_id		Delete the specified Active Directory configuration.

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_config_name	string	The name of the ActiveDirectoryConfig. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the details of the specified active directory configuration.

SELECT
id,
name,
activeDirectoryStatus,
administrators,
backupOperators,
dns,
domain,
etag,
identity,
location,
organizationalUnit,
provisioningState,
secretPassword,
securityOperators,
site,
smbServerName,
systemData,
tags,
type,
userName
FROM azure.netapp.active_directory_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND active_directory_config_name = '{{ active_directory_config_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all active directory configurations within the resource group.

SELECT
id,
name,
activeDirectoryStatus,
administrators,
backupOperators,
dns,
domain,
etag,
identity,
location,
organizationalUnit,
provisioningState,
secretPassword,
securityOperators,
site,
smbServerName,
systemData,
tags,
type,
userName
FROM azure.netapp.active_directory_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all active directory configurations within the subscription.

SELECT
id,
name,
activeDirectoryStatus,
administrators,
backupOperators,
dns,
domain,
etag,
identity,
location,
organizationalUnit,
provisioningState,
secretPassword,
securityOperators,
site,
smbServerName,
systemData,
tags,
type,
userName
FROM azure.netapp.active_directory_configs
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the specified active directory configuration.

INSERT INTO azure.netapp.active_directory_configs (
tags,
location,
properties,
identity,
resource_group_name,
active_directory_config_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ active_directory_config_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: active_directory_configs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the active_directory_configs resource.
  - name: active_directory_config_name
    value: "{{ active_directory_config_name }}"
    description: Required parameter for the active_directory_configs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the active_directory_configs resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      userName: "{{ userName }}"
      dns:
        - "{{ dns }}"
      smbServerName: "{{ smbServerName }}"
      organizationalUnit: "{{ organizationalUnit }}"
      site: "{{ site }}"
      backupOperators:
        - "{{ backupOperators }}"
      administrators:
        - "{{ administrators }}"
      securityOperators:
        - "{{ securityOperators }}"
      activeDirectoryStatus: "{{ activeDirectoryStatus }}"
      provisioningState: "{{ provisioningState }}"
      domain: "{{ domain }}"
      secretPassword:
        keyVaultProperties:
          keyVaultUri: "{{ keyVaultUri }}"
          secretName: "{{ secretName }}"
        identity:
          principalId: "{{ principalId }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Patch the specified active directory configuration.

UPDATE azure.netapp.active_directory_configs
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND active_directory_config_name = '{{ active_directory_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update the specified active directory configuration.

REPLACE azure.netapp.active_directory_configs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND active_directory_config_name = '{{ active_directory_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the specified Active Directory configuration.

DELETE FROM azure.netapp.active_directory_configs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND active_directory_config_name = '{{ active_directory_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;