azure_ad_administrators

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

Overview

Name	azure_ad_administrators
Type	Resource
Id	azure.mysql.azure_ad_administrators

Fields

vw_azure_ad_administrators

Name	Datatype	Description
administratorName	text	field from the properties object
administrator_type	text	field from the properties object
identity_resource_id	text	field from the properties object
login	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
sid	text	field from the properties object
subscriptionId	text	field from the properties object
tenant_id	text	field from the properties object

azure_ad_administrators

Name	Datatype	Description
properties	object	The properties of an administrator.

Methods

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

SELECT examples

List all the AAD administrators in a given server.

vw_azure_ad_administrators

SELECT
administratorName,
administrator_type,
identity_resource_id,
login,
resourceGroupName,
serverName,
sid,
subscriptionId,
tenant_id
FROM azure.mysql.vw_azure_ad_administrators
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

azure_ad_administrators

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

INSERT example

Use the following StackQL query and manifest file to create a new azure_ad_administrators resource.

All Properties

/*+ create */
INSERT INTO azure.mysql.azure_ad_administrators (
administratorName,
resourceGroupName,
serverName,
subscriptionId,
properties
)
SELECT 
'{{ administratorName }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: administratorType
          value: string
        - name: login
          value: string
        - name: sid
          value: string
        - name: tenantId
          value: string
        - name: identityResourceId
          value: string

DELETE example

Deletes the specified azure_ad_administrators resource.

/*+ delete */
DELETE FROM azure.mysql.azure_ad_administrators
WHERE administratorName = '{{ administratorName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';