server_azure_ad_administrators

Creates, updates, deletes, gets or lists a server_azure_ad_administrators resource.

Overview

Name	server_azure_ad_administrators
Type	Resource
Id	azure.sql.server_azure_ad_administrators

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.
administratorType	string	Type of the sever administrator. "ActiveDirectory" (ActiveDirectory)
azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication enabled.
login	string	Login name of the server administrator. Required.
sid	string	SID (object ID) of the server administrator. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Tenant ID of the administrator.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

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.
administratorType	string	Type of the sever administrator. "ActiveDirectory" (ActiveDirectory)
azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication enabled.
login	string	Login name of the server administrator. Required.
sid	string	SID (object ID) of the server administrator. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Tenant ID of the administrator.
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, server_name, administrator_name, subscription_id		Gets a Azure Active Directory administrator.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of Azure Active Directory administrators in a server.
create_or_update	insert	resource_group_name, server_name, administrator_name, subscription_id		Creates or updates an existing Azure Active Directory administrator.
create_or_update	replace	resource_group_name, server_name, administrator_name, subscription_id		Creates or updates an existing Azure Active Directory administrator.
delete	delete	resource_group_name, server_name, administrator_name, subscription_id		Deletes the Azure Active Directory administrator with the given name.

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
administrator_name	string	The name of server active directory administrator. "ActiveDirectory" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a Azure Active Directory administrator.

SELECT
id,
name,
administratorType,
azureADOnlyAuthentication,
login,
sid,
systemData,
tenantId,
type
FROM azure.sql.server_azure_ad_administrators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND administrator_name = '{{ administrator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Gets a list of Azure Active Directory administrators in a server.

SELECT
id,
name,
administratorType,
azureADOnlyAuthentication,
login,
sid,
systemData,
tenantId,
type
FROM azure.sql.server_azure_ad_administrators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an existing Azure Active Directory administrator.

INSERT INTO azure.sql.server_azure_ad_administrators (
properties,
resource_group_name,
server_name,
administrator_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ administrator_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_azure_ad_administrators
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_azure_ad_administrators resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the server_azure_ad_administrators resource.
  - name: administrator_name
    value: "{{ administrator_name }}"
    description: Required parameter for the server_azure_ad_administrators resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_azure_ad_administrators resource.
  - name: properties
    description: |
      Resource properties.
    value:
      administratorType: "{{ administratorType }}"
      login: "{{ login }}"
      sid: "{{ sid }}"
      tenantId: "{{ tenantId }}"
      azureADOnlyAuthentication: {{ azureADOnlyAuthentication }}

REPLACE examples

create_or_update

Creates or updates an existing Azure Active Directory administrator.

REPLACE azure.sql.server_azure_ad_administrators
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND administrator_name = '{{ administrator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the Azure Active Directory administrator with the given name.

DELETE FROM azure.sql.server_azure_ad_administrators
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND administrator_name = '{{ administrator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;