administrators_microsoft_entra

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

Overview

Name	administrators_microsoft_entra
Type	Resource
Id	azure.postgresql_flexible_servers.administrators_microsoft_entra

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.
objectId	string	Object identifier of the Microsoft Entra principal.
principalName	string	Name of the Microsoft Entra principal.
principalType	string	Type of Microsoft Entra principal to which the server administrator is associated. Known values are: "Unknown", "User", "Group", and "ServicePrincipal". (Unknown, User, Group, ServicePrincipal)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Identifier of the tenant in which the Microsoft Entra principal exists.
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.
objectId	string	Object identifier of the Microsoft Entra principal.
principalName	string	Name of the Microsoft Entra principal.
principalType	string	Type of Microsoft Entra principal to which the server administrator is associated. Known values are: "Unknown", "User", "Group", and "ServicePrincipal". (Unknown, User, Group, ServicePrincipal)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tenantId	string	Identifier of the tenant in which the Microsoft Entra principal exists.
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, object_id, subscription_id		Gets information about a server administrator associated to a Microsoft Entra principal.
list_by_server	select	resource_group_name, server_name, subscription_id		List all server administrators associated to a Microsoft Entra principal.
create_or_update	insert	resource_group_name, server_name, object_id, subscription_id		Creates a new server administrator associated to a Microsoft Entra principal.
create_or_update	replace	resource_group_name, server_name, object_id, subscription_id		Creates a new server administrator associated to a Microsoft Entra principal.
delete	delete	resource_group_name, server_name, object_id, subscription_id		Deletes an existing server administrator associated to a Microsoft Entra principal.

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
object_id	string	Object identifier of the Microsoft Entra principal. 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 information about a server administrator associated to a Microsoft Entra principal.

SELECT
id,
name,
objectId,
principalName,
principalType,
systemData,
tenantId,
type
FROM azure.postgresql_flexible_servers.administrators_microsoft_entra
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND object_id = '{{ object_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

List all server administrators associated to a Microsoft Entra principal.

SELECT
id,
name,
objectId,
principalName,
principalType,
systemData,
tenantId,
type
FROM azure.postgresql_flexible_servers.administrators_microsoft_entra
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 a new server administrator associated to a Microsoft Entra principal.

INSERT INTO azure.postgresql_flexible_servers.administrators_microsoft_entra (
properties,
resource_group_name,
server_name,
object_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ object_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: administrators_microsoft_entra
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the administrators_microsoft_entra resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the administrators_microsoft_entra resource.
  - name: object_id
    value: "{{ object_id }}"
    description: Required parameter for the administrators_microsoft_entra resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the administrators_microsoft_entra resource.
  - name: properties
    description: |
      Properties of the server administrator associated to a Microsoft Entra principal.
    value:
      principalType: "{{ principalType }}"
      principalName: "{{ principalName }}"
      tenantId: "{{ tenantId }}"

REPLACE examples

create_or_update

Creates a new server administrator associated to a Microsoft Entra principal.

REPLACE azure.postgresql_flexible_servers.administrators_microsoft_entra
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND object_id = '{{ object_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing server administrator associated to a Microsoft Entra principal.

DELETE FROM azure.postgresql_flexible_servers.administrators_microsoft_entra
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND object_id = '{{ object_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;