Share via

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

Edit

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 102400000

Required Parameters

--dh-group

The DH Group used in initial SA.

Property Value
Parameter group: IKE Phase 1 Arguments
Accepted values: DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, None
--gateway-name

Virtual network gateway name.

--ike-encryption

The IKE encryption algorithm.

Property Value
Parameter group: IKE Phase 2 Arguments
Accepted values: AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES256
--ike-integrity

The IKE integrity algorithm.

Property Value
Parameter group: IKE Phase 2 Arguments
Accepted values: GCMAES128, GCMAES256, MD5, SHA1, SHA256, SHA384
--ipsec-encryption

The IPSec encryption algorithm.

Property Value
Parameter group: IKE Phase 1 Arguments
Accepted values: AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, None
--ipsec-integrity

The IPSec integrity algorithm.

Property Value
Parameter group: IKE Phase 1 Arguments
Accepted values: GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, SHA256
--pfs-group

The Pfs Group used for new child SA.

Property Value
Parameter group: IKE Phase 2 Arguments
Accepted values: ECP256, ECP384, None, PFS1, PFS14, PFS2, PFS2048, PFS24, PFSMM
--resource-group -g

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

--sa-lifetime

The lifetime in seconds for P2S client.

Property Value
Parameter group: Security Association Arguments
--sa-max-size

The payload size in KB for P2S client.

Property Value
Parameter group: Security Association Arguments

Optional Parameters

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

--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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.

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

Property Value
Default value: False

az network vnet-gateway ipsec-policy clear

Edit

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 MyConnection

Required Parameters

--gateway-name

Virtual network gateway name.

--resource-group -g

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

Optional Parameters

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

--no-wait

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

Property Value
Default value: False
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.

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

Property Value
Default value: False

az network vnet-gateway ipsec-policy list

Edit

List IPSec policies associated with a virtual network gateway.

az network vnet-gateway ipsec-policy list --gateway-name
                                          --resource-group

Examples

List the IPsec policies set on a gateway.

az network vnet-gateway ipsec-policy list -g MyResourceGroup --gateway-name MyConnection

Required Parameters

--gateway-name

Virtual network gateway name.

--resource-group -g

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

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.

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

Property Value
Default value: False

az network vnet-gateway ipsec-policy wait

Edit

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

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

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--gateway-name

Virtual network gateway name.

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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
--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
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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