Share via

az postgres flexible-server private-endpoint-connection

Manage PostgreSQL flexible server private endpoint connections.

Commands

Name Description Type Status
az postgres flexible-server private-endpoint-connection approve

Approve the specified private endpoint connection associated with a PostgreSQL flexible server.

 Core GA
az postgres flexible-server private-endpoint-connection delete

Delete the specified private endpoint connection associated with a PostgreSQL flexible server.

 Core GA
az postgres flexible-server private-endpoint-connection list

List all private endpoint connections associated with a PostgreSQL flexible server.

 Core GA
az postgres flexible-server private-endpoint-connection reject

Reject the specified private endpoint connection associated with a PostgreSQL flexible server.

 Core GA
az postgres flexible-server private-endpoint-connection show

Show details of a private endpoint connection associated with a PostgreSQL flexible server.

 Core GA

az postgres flexible-server private-endpoint-connection approve

Approve the specified private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection approve --description
                                                                [--id]
                                                                [--ids]
                                                                [--name]
                                                                [--resource-group]
                                                                [--server-name]
                                                                [--subscription]

Examples

Approve a private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection approve -g testgroup -s testsvr         -n pec-connection.40e3d3a8-7d8f-41eb-8462-1cd05bc3e33b         --description "Approve connection"

Required Parameters

--description

Comments for approve operation.

Optional Parameters

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

--id

The ID of the private endpoint connection associated with the Server. If specified --server-name/-s and --name/-n, this should be omitted.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the private endpoint connection associated with the Server. Required if --id is not specified.

--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server-name -s

Name of the Server. Required if --id is not specified.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False

az postgres flexible-server private-endpoint-connection delete

Delete the specified private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection delete [--id]
                                                               [--ids]
                                                               [--name]
                                                               [--resource-group]
                                                               [--server-name]
                                                               [--subscription]

Examples

Delete a private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection delete -g testgroup -s testsvr         --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testgroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testsvr/privateEndpointConnections/pec-connection.40e3d3a8-7d8f-41eb-8462-1cd05bc3e33b

Optional Parameters

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

--id

The ID of the private endpoint connection associated with the Server. If specified --server-name/-s and --name/-n, this should be omitted.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the private endpoint connection associated with the Server. Required if --id is not specified.

--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server-name -s

Name of the Server. Required if --id is not specified.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False

az postgres flexible-server private-endpoint-connection list

List all private endpoint connections associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection list [--ids]
                                                             [--resource-group]
                                                             [--server-name]
                                                             [--subscription]

Examples

List all private endpoint connections associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection list -g testgroup -s testsvr

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False

az postgres flexible-server private-endpoint-connection reject

Reject the specified private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection reject --description
                                                               [--id]
                                                               [--ids]
                                                               [--name]
                                                               [--resource-group]
                                                               [--server-name]
                                                               [--subscription]

Examples

Reject a private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection reject -g testgroup -s testsvr         -n pec-connection.40e3d3a8-7d8f-41eb-8462-1cd05bc3e33b         --description "Reject connection"

Required Parameters

--description

Comments for reject operation.

Optional Parameters

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

--id

The ID of the private endpoint connection associated with the Server. If specified --server-name/-s and --name/-n, this should be omitted.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the private endpoint connection associated with the Server. Required if --id is not specified.

--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server-name -s

Name of the Server. Required if --id is not specified.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False

az postgres flexible-server private-endpoint-connection show

Show details of a private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection show [--id]
                                                             [--ids]
                                                             [--name]
                                                             [--resource-group]
                                                             [--server-name]
                                                             [--subscription]

Examples

Show details of a private endpoint connection associated with a PostgreSQL flexible server.

az postgres flexible-server private-endpoint-connection show -g testgroup -s testsvr -n pec-connection.40e3d3a8-7d8f-41eb-8462-1cd05bc3e33b

Optional Parameters

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

--id

The ID of the private endpoint connection associated with the Server. If specified --server-name/-s and --name/-n, this should be omitted.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the private endpoint connection associated with the Server. Required if --id is not specified.

--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server-name -s

Name of the Server. Required if --id is not specified.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False