Share via

az postgres flexible-server microsoft-entra-admin

Manage server Microsoft Entra administrators.

Commands

Name Description Type Status
az postgres flexible-server microsoft-entra-admin create

Create a Microsoft Entra administrator.

 Core GA
az postgres flexible-server microsoft-entra-admin delete

Delete a Microsoft Entra administrator.

 Core GA
az postgres flexible-server microsoft-entra-admin list

List all Microsoft Entra administrators.

 Core GA
az postgres flexible-server microsoft-entra-admin show

Get a Microsoft Entra administrator.

 Core GA
az postgres flexible-server microsoft-entra-admin wait

Wait for a Microsoft Entra administrator to satisfy certain conditions.

 Core GA

az postgres flexible-server microsoft-entra-admin create

Create a Microsoft Entra administrator.

az postgres flexible-server microsoft-entra-admin create --display-name
                                                         --object-id
                                                         --resource-group
                                                         --server-name
                                                         [--no-wait]
                                                         [--type {Group, ServicePrincipal, Unknown, User}]

Examples

Create Microsoft Entra administrator with user 'john@contoso.com', administrator ID '00000000-0000-0000-0000-000000000000' and type User.

az postgres flexible-server microsoft-entra-admin create -g testgroup -s testsvr -u john@contoso.com -i 00000000-0000-0000-0000-000000000000 -t User

Required Parameters

--display-name -u

Display name of the Microsoft Entra administrator user or group.

--object-id -i

The unique ID of the Microsoft Entra administrator.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--type -t

Type of the Microsoft Entra administrator.

Property Value
Default value: User
Accepted values: Group, ServicePrincipal, Unknown, User
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az postgres flexible-server microsoft-entra-admin delete

Delete a Microsoft Entra administrator.

az postgres flexible-server microsoft-entra-admin delete --object-id
                                                         --resource-group
                                                         --server-name
                                                         [--no-wait]
                                                         [--yes]

Examples

Delete Microsoft Entra administrator with ID '00000000-0000-0000-0000-000000000000'.

az postgres flexible-server microsoft-entra-admin delete -g testgroup -s testsvr -i 00000000-0000-0000-0000-000000000000

Required Parameters

--object-id -i

The unique ID of the Microsoft Entra administrator.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az postgres flexible-server microsoft-entra-admin list

List all Microsoft Entra administrators.

az postgres flexible-server microsoft-entra-admin list --resource-group
                                                       --server-name

Examples

List Microsoft Entra administrators.

az postgres flexible-server microsoft-entra-admin list -g testgroup -s testsvr

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az postgres flexible-server microsoft-entra-admin show

Get a Microsoft Entra administrator.

az postgres flexible-server microsoft-entra-admin show --object-id
                                                       --resource-group
                                                       --server-name

Examples

Get Microsoft Entra administrator with ID '00000000-0000-0000-0000-000000000000'.

az postgres flexible-server microsoft-entra-admin show -g testgroup -s testsvr -i 00000000-0000-0000-0000-000000000000

Required Parameters

--object-id -i

The unique ID of the Microsoft Entra administrator.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az postgres flexible-server microsoft-entra-admin wait

Wait for a Microsoft Entra administrator to satisfy certain conditions.

az postgres flexible-server microsoft-entra-admin wait --object-id
                                                       --resource-group
                                                       --server-name
                                                       [--created]
                                                       [--custom]
                                                       [--deleted]
                                                       [--exists]
                                                       [--interval]
                                                       [--timeout]
                                                       [--updated]

Examples

Wait until a Microsoft Entra administrator exists.

az postgres flexible-server microsoft-entra-admin wait -g testgroup -s testsvr -i 00000000-0000-0000-0000-000000000000 --exists

Wait for a Microsoft Entra administrator to be deleted.

az postgres flexible-server microsoft-entra-admin wait -g testgroup -s testsvr -i 00000000-0000-0000-0000-000000000000 --deleted

Required Parameters

--object-id -i

The unique ID of the Microsoft Entra administrator.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False