administrators

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

Overview

Name	administrators
Type	Resource
Id	azure.postgresql.administrators

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Properties of the active directory administrator.

list_by_server

Name	Datatype	Description
properties	object	Properties of the active directory administrator.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, objectId		Gets information about a server.
list_by_server	select	subscriptionId, resourceGroupName, serverName		List all the AAD administrators for a given server.
create	insert	subscriptionId, resourceGroupName, serverName, objectId		Creates a new server.
delete	delete	subscriptionId, resourceGroupName, serverName, objectId		Deletes an Active Directory Administrator associated with the server.

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
objectId	string	Guid of the objectId for the 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 a server.

SELECT
properties
FROM azure.postgresql.administrators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND objectId = '{{ objectId }}' -- required
;

list_by_server

List all the AAD administrators for a given server.

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

INSERT examples

create

Creates a new server.

INSERT INTO azure.postgresql.administrators (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
objectId
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ objectId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: administrators
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the administrators resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the administrators resource.
    - name: serverName
      value: string
      description: Required parameter for the administrators resource.
    - name: objectId
      value: string
      description: Required parameter for the administrators resource.
    - name: properties
      value: object
      description: |
        Properties of the active directory administrator.

DELETE examples

delete

Deletes an Active Directory Administrator associated with the server.

DELETE FROM azure.postgresql.administrators
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND objectId = '{{ objectId }}' --required
;