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

Successfully retrieved a specified Azure Active Directory administrator.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of Azure Active Directory administrators.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, administratorName, subscriptionId		Gets a Azure Active Directory administrator.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of Azure Active Directory administrators in a server.
create_or_update	insert	resourceGroupName, serverName, administratorName, subscriptionId		Creates or updates an existing Azure Active Directory administrator.
delete	delete	resourceGroupName, serverName, administratorName, subscriptionId		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
administratorName	string	The name of server active directory administrator.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a Azure Active Directory administrator.

SELECT
properties
FROM azure.sql.server_azure_ad_administrators
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND administratorName = '{{ administratorName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

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

SELECT
properties
FROM azure.sql.server_azure_ad_administrators
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an existing Azure Active Directory administrator.

INSERT INTO azure.sql.server_azure_ad_administrators (
data__properties,
resourceGroupName,
serverName,
administratorName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ administratorName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_azure_ad_administrators
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_azure_ad_administrators resource.
    - name: serverName
      value: string
      description: Required parameter for the server_azure_ad_administrators resource.
    - name: administratorName
      value: string
      description: Required parameter for the server_azure_ad_administrators resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the server_azure_ad_administrators resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes the Azure Active Directory administrator with the given name.

DELETE FROM azure.sql.server_azure_ad_administrators
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND administratorName = '{{ administratorName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;