Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az postgres flexible-server ad-admin

Manage server Active Directory administrators.

Commands

Name Description Type Status
az postgres flexible-server ad-admin create

Create an Active Directory administrator.

 Core GA
az postgres flexible-server ad-admin delete

Delete an Active Directory administrator.

 Core GA
az postgres flexible-server ad-admin list

List all Active Directory administrators.

 Core GA
az postgres flexible-server ad-admin show

Get an Active Directory administrator.

 Core GA
az postgres flexible-server ad-admin wait

Wait for an Active Directory administrator to satisfy certain conditions.

 Core GA

az postgres flexible-server ad-admin create

Create an Active Directory administrator.

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

Examples

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

az postgres flexible-server ad-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 Azure AD administrator user or group.

--object-id -i

The unique ID of the Azure AD 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 Azure AD administrator.

Property Value
Default value: User
Accepted values: Group, ServicePrincipal, Unknown, User

az postgres flexible-server ad-admin delete

Delete an Active Directory administrator.

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

Examples

Delete Active Directory administrator with ID '00000000-0000-0000-0000-000000000000'.

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

Required Parameters

--object-id -i

The unique ID of the Azure AD 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

az postgres flexible-server ad-admin list

List all Active Directory administrators.

az postgres flexible-server ad-admin list --resource-group
 --server-name

Examples

List Active Directory administrators.

az postgres flexible-server ad-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.

az postgres flexible-server ad-admin show

Get an Active Directory administrator.

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

Examples

Get Active Directory administrator with ID '00000000-0000-0000-0000-000000000000'.

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

Required Parameters

--object-id -i

The unique ID of the Azure AD 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.

az postgres flexible-server ad-admin wait

Wait for an Active Directory administrator to satisfy certain conditions.

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

Examples

Wait until an Active Directory administrator exists.

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

Wait for an Active Directory administrator to be deleted.

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

Required Parameters

--object-id -i

The unique ID of the Azure AD 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

Feedback

Was this page helpful?