az keyvault private-endpoint-connection
Manage vault private endpoint connections.
Commands
az keyvault private-endpoint-connection approve |
Approve a private endpoint connection request for a Key Vault. |
az keyvault private-endpoint-connection delete |
Delete the specified private endpoint connection associated with a Key Vault. |
az keyvault private-endpoint-connection reject |
Reject a private endpoint connection request for a Key Vault. |
az keyvault private-endpoint-connection show |
Show details of a private endpoint connection associated with a Key Vault. |
az keyvault private-endpoint-connection wait |
Place the CLI in a waiting state until a condition of the private endpoint connection is met. |
az keyvault private-endpoint-connection approve
Approve a private endpoint connection request for a Key Vault.
az keyvault private-endpoint-connection approve [--description]
[--id]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--vault-name]
Examples
Approve a private endpoint connection request for a Key Vault by ID.
az keyvault private-endpoint-connection approve --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"
Approve a private endpoint connection request for a Key Vault by ID.
id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection approve --id $id
Approve a private endpoint connection request for a Key Vault using vault name and connection name.
az keyvault private-endpoint-connection approve -g myrg --vault-name mykv --name myconnection
Approve a private endpoint connection request for a Key Vault using vault name and connection name.
name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection approve -g myrg --vault-name mykv --name $name
Optional Parameters
Comments for the approve operation.
The ID of the private endpoint connection associated with the Key Vault. If specified --vault-name and --name/-n, this should be omitted.
The name of the private endpoint connection associated with the Key Vault. Required if --id is not specified.
Do not wait for the long-running operation to finish.
Proceed only if Key Vault belongs to the specified resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Name of the Key Vault. Required if --id is not specified.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az keyvault private-endpoint-connection delete
Delete the specified private endpoint connection associated with a Key Vault.
az keyvault private-endpoint-connection delete [--id]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--vault-name]
Examples
Delete a private endpoint connection request for a Key Vault by ID.
az keyvault private-endpoint-connection delete --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"
Delete a private endpoint connection request for a Key Vault by ID.
id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection delete --id $id
Delete a private endpoint connection request for a Key Vault using account name and connection name.
az keyvault private-endpoint-connection delete -g myrg --vault-name mykv --name myconnection
Delete a private endpoint connection request for a Key Vault using account name and connection name.
name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection delete -g myrg --vault-name mykv --name $name
Optional Parameters
The ID of the private endpoint connection associated with the Key Vault. If specified --vault-name and --name/-n, this should be omitted.
The name of the private endpoint connection associated with the Key Vault. Required if --id is not specified.
Do not wait for the long-running operation to finish.
Proceed only if Key Vault belongs to the specified resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Name of the Key Vault. Required if --id is not specified.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az keyvault private-endpoint-connection reject
Reject a private endpoint connection request for a Key Vault.
az keyvault private-endpoint-connection reject [--description]
[--id]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--vault-name]
Examples
Reject a private endpoint connection request for a Key Vault by ID.
az keyvault private-endpoint-connection reject --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"
Reject a private endpoint connection request for a Key Vault by ID.
id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection reject --id $id
Reject a private endpoint connection request for a Key Vault using vault name and connection name.
az keyvault private-endpoint-connection reject -g myrg --vault-name mykv --name myconnection
Reject a private endpoint connection request for a Key Vault using vault name and connection name.
name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection reject -g myrg --vault-name mystorageaccount --name $name
Optional Parameters
Comments for the reject operation.
The ID of the private endpoint connection associated with the Key Vault. If specified --vault-name and --name/-n, this should be omitted.
The name of the private endpoint connection associated with the Key Vault. Required if --id is not specified.
Do not wait for the long-running operation to finish.
Proceed only if Key Vault belongs to the specified resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Name of the Key Vault. Required if --id is not specified.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az keyvault private-endpoint-connection show
Show details of a private endpoint connection associated with a Key Vault.
az keyvault private-endpoint-connection show [--id]
[--name]
[--query-examples]
[--resource-group]
[--subscription]
[--vault-name]
Examples
Show details of a private endpoint connection request for a Key Vault by ID.
az keyvault private-endpoint-connection show --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"
Show details of a private endpoint connection request for a Key Vault by ID.
id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection show --id $id
Show details of a private endpoint connection request for a Key Vault using vault name and connection name.
az keyvault private-endpoint-connection show -g myrg --vault-name mykv --name myconnection
Show details of a private endpoint connection request for a Key Vault using vault name and connection name.
name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection show -g myrg --vault-name mykv --name $name
Optional Parameters
The ID of the private endpoint connection associated with the Key Vault. If specified --vault-name and --name/-n, this should be omitted.
The name of the private endpoint connection associated with the Key Vault. Required if --id is not specified.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Proceed only if Key Vault belongs to the specified resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Name of the Key Vault. Required if --id is not specified.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az keyvault private-endpoint-connection wait
Place the CLI in a waiting state until a condition of the private endpoint connection is met.
az keyvault private-endpoint-connection wait [--created]
[--custom]
[--deleted]
[--exists]
[--id]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--vault-name]
Examples
Pause CLI until the private endpoint connection is approved/rejected by ID.
az keyvault private-endpoint-connection wait --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000" --created
Pause CLI until the private endpoint connection is approved/rejected using vault name and connection name.
az keyvault private-endpoint-connection wait -g myrg --vault-name mykv --name myconnection --created
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
The ID of the private endpoint connection associated with the Key Vault. If specified --vault-name and --name/-n, this should be omitted.
Polling interval in seconds.
The name of the private endpoint connection associated with the Key Vault. Required if --id is not specified.
Proceed only if Key Vault belongs to the specified resource group.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Name of the Key Vault. Required if --id is not specified.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.