az cosmosdb private-endpoint-connection

  • Reference

Manage Azure Cosmos DB private endpoint connections.

Commands

Name Description Type Status
az cosmosdb private-endpoint-connection approve

Approve the specified private endpoint connection associated with Azure Cosmos DB.

 Core GA
az cosmosdb private-endpoint-connection delete

Delete the specified private endpoint connection associated with Azure Cosmos DB.

 Core GA
az cosmosdb private-endpoint-connection reject

Reject the specified private endpoint connection associated with Azure Cosmos DB.

 Core GA
az cosmosdb private-endpoint-connection show

Show details of a private endpoint connection associated with Azure Cosmos DB.

 Core GA

az cosmosdb private-endpoint-connection approve

Edit

Approve the specified private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection approve [--account-name]
                                                [--description]
                                                [--id]
                                                [--ids]
                                                [--name]
                                                [--resource-group]
                                                [--subscription]

Examples

Approve the specified private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection approve --account-name MyAccount --name MyPrivateEndpoint --resource-group MyResourceGroup --description "Approved"

Optional Parameters

--account-name -a

Name of the Cosmos DB database account. Required if --connection-id is not specified.

--description

Comments for the approve operation.

--id

The ID of the private endpoint connection associated with Azure Cosmos DB. If specified --account-name --resource-group/-g 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.

--name -n

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

--resource-group -g

The resource group name of specified Cosmos DB account. Required if --connection-id is not specified.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az cosmosdb private-endpoint-connection delete

Edit

Delete the specified private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection delete [--account-name]
                                               [--id]
                                               [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]

Examples

Delete the specified private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection delete --account-name MyAccount --name MyPrivateEndpoint --resource-group MyResourceGroup

Optional Parameters

--account-name -a

Name of the Cosmos DB database account. Required if --connection-id is not specified.

--id

The ID of the private endpoint connection associated with Azure Cosmos DB. If specified --account-name --resource-group/-g 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.

--name -n

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

--resource-group -g

The resource group name of specified Cosmos DB account. Required if --connection-id is not specified.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az cosmosdb private-endpoint-connection reject

Edit

Reject the specified private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection reject [--account-name]
                                               [--description]
                                               [--id]
                                               [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]

Examples

Reject the specified private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection reject --account-name MyAccount --name MyPrivateEndpoint --resource-group MyResourceGroup --description "Rejected"

Optional Parameters

--account-name -a

Name of the Cosmos DB database account. Required if --connection-id is not specified.

--description

Comments for the reject operation.

--id

The ID of the private endpoint connection associated with Azure Cosmos DB. If specified --account-name --resource-group/-g 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.

--name -n

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

--resource-group -g

The resource group name of specified Cosmos DB account. Required if --connection-id is not specified.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az cosmosdb private-endpoint-connection show

Edit

Show details of a private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection show [--account-name]
                                             [--id]
                                             [--ids]
                                             [--name]
                                             [--resource-group]
                                             [--subscription]

Examples

Show details of a private endpoint connection associated with Azure Cosmos DB.

az cosmosdb private-endpoint-connection show --account-name MyAccount --name MyPrivateEndpoint --resource-group MyResourceGroup

Optional Parameters

--account-name -a

Name of the Cosmos DB database account. Required if --connection-id is not specified.

--id

The ID of the private endpoint connection associated with Azure Cosmos DB. If specified --account-name --resource-group/-g 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.

--name -n

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

--resource-group -g

The resource group name of specified Cosmos DB account. Required if --connection-id is not specified.

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.