az network vnet-gateway root-cert

  • Reference

Manage root certificates of a virtual network gateway.

Commands

Name Description Type Status
az network vnet-gateway root-cert create

Upload a root certificate.

 Core GA
az network vnet-gateway root-cert delete

Delete a root certificate.

 Core GA
az network vnet-gateway root-cert wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az network vnet-gateway root-cert create

Edit

Upload a root certificate.

az network vnet-gateway root-cert create --gateway-name
                                         --name
                                         --public-cert-data
                                         --resource-group
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Add a Root Certificate to the list of certs allowed to connect to this Gateway.

az network vnet-gateway root-cert create -g MyResourceGroup -n MyRootCertificate --gateway-name MyVnetGateway --public-cert-data MyCertificateData

Required Parameters

--gateway-name

Virtual network gateway name.

--name -n

Root certificate name.

--public-cert-data

Base64 contents of the root certificate file or file path.

--resource-group -g

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

Optional Parameters

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 network vnet-gateway root-cert delete

Edit

Delete a root certificate.

az network vnet-gateway root-cert delete --gateway-name
                                         --name
                                         --resource-group
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Remove a certificate from the list of Root Certificates whose children are allowed to access this Gateway.

az network vnet-gateway root-cert delete -g MyResourceGroup -n MyRootCertificate --gateway-name MyVnetGateway

Delete a root certificate.

az network vnet-gateway root-cert delete --gateway-name MyVnetGateway --name MyRootCertificate --resource-group MyResourceGroup --subscription MySubscription

Required Parameters

--gateway-name

Virtual network gateway name.

--name -n

Root certificate name.

--resource-group -g

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

Optional Parameters

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 network vnet-gateway root-cert wait

Edit

Place the CLI in a waiting state until a condition is met.

az network vnet-gateway root-cert wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--gateway-name]
                                       [--ids]
                                       [--interval]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--gateway-name

Virtual network gateway name.

--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.

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
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.