az network vnet-gateway ipsec-policy
Manage virtual network gateway IPSec policies.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network vnet-gateway ipsec-policy add |
Add a virtual network gateway IPSec policy. |
Core | GA |
| az network vnet-gateway ipsec-policy clear |
Delete all IPsec policies on a virtual network gateway. |
Core | GA |
| az network vnet-gateway ipsec-policy list |
List IPSec policies associated with a virtual network gateway. |
Core | GA |
| az network vnet-gateway ipsec-policy wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network vnet-gateway ipsec-policy add
Add a virtual network gateway IPSec policy.
az network vnet-gateway ipsec-policy add --dh-group {DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, None}
--gateway-name
--ike-encryption {AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES256}
--ike-integrity {GCMAES128, GCMAES256, MD5, SHA1, SHA256, SHA384}
--ipsec-encryption {AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, None}
--ipsec-integrity {GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, SHA256}
--pfs-group {ECP256, ECP384, None, PFS1, PFS14, PFS2, PFS2048, PFS24, PFSMM}
--resource-group
--sa-lifetime
--sa-max-size
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Add specified IPsec policies to a gateway instead of relying on defaults.
az network vnet-gateway ipsec-policy add -g MyResourceGroup --gateway-name MyGateway --dh-group DHGroup14 --ike-encryption AES256 --ike-integrity SHA384 --ipsec-encryption DES3 --ipsec-integrity GCMAES256 --pfs-group PFS2048 --sa-lifetime 27000 --sa-max-size 102400000Required Parameters
The DH Group used in initial SA.
Virtual network gateway name.
The IKE encryption algorithm.
The IKE integrity algorithm.
The IPSec encryption algorithm.
The IPSec integrity algorithm.
The Pfs Group used for new child SA.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The lifetime in seconds for P2S client.
The payload size in KB for P2S client.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet-gateway ipsec-policy clear
Delete all IPsec policies on a virtual network gateway.
az network vnet-gateway ipsec-policy clear --gateway-name
--resource-group
[--no-wait]Examples
Remove all previously specified IPsec policies from a gateway.
az network vnet-gateway ipsec-policy clear -g MyResourceGroup --gateway-name MyConnectionRequired Parameters
Virtual network gateway name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet-gateway ipsec-policy list
List IPSec policies associated with a virtual network gateway.
az network vnet-gateway ipsec-policy list --gateway-name
--resource-groupExamples
List the IPsec policies set on a gateway.
az network vnet-gateway ipsec-policy list -g MyResourceGroup --gateway-name MyConnectionRequired Parameters
Virtual network gateway name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet-gateway ipsec-policy wait
Place the CLI in a waiting state until a condition is met.
az network vnet-gateway ipsec-policy wait [--created]
[--custom]
[--deleted]
[--exists]
[--gateway-name]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]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.
Virtual network gateway name.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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'.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
