azure_ad_administrators

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

Overview

Name	azure_ad_administrators
Type	Resource
Id	azure.mysql.azure_ad_administrators

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of an administrator.

list_by_server

Name	Datatype	Description
properties	object	The properties of an administrator.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, administratorName		Gets information about an azure ad administrator.
list_by_server	select	subscriptionId, resourceGroupName, serverName		List all the AAD administrators in a given server.
create_or_update	insert	subscriptionId, resourceGroupName, serverName, administratorName		Creates or updates an existing Azure Active Directory administrator.
delete	delete	subscriptionId, resourceGroupName, serverName, administratorName		Deletes an Azure AD Administrator.

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 the Azure AD Administrator.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serverName	string	The name of the server.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about an azure ad administrator.

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

list_by_server

List all the AAD administrators in a given server.

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

INSERT examples

create_or_update

Creates or updates an existing Azure Active Directory administrator.

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

Manifest

# Description fields are for documentation purposes
- name: azure_ad_administrators
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the azure_ad_administrators resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the azure_ad_administrators resource.
    - name: serverName
      value: string
      description: Required parameter for the azure_ad_administrators resource.
    - name: administratorName
      value: string
      description: Required parameter for the azure_ad_administrators resource.
    - name: properties
      value: object
      description: |
        The properties of an administrator.

DELETE examples

delete

Deletes an Azure AD Administrator.

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