Skip to content

Commit

Permalink
Merge pull request Azure#112 from ZengTaoxu/vnet-gateway02
Browse files Browse the repository at this point in the history
Add command model for `az network vnet-gateway packet-capture/vpn-client`
  • Loading branch information
necusjz authored Feb 9, 2023
2 parents 977e606 + 7dac97c commit 271f213
Show file tree
Hide file tree
Showing 29 changed files with 1,313 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/packet-capture/_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway packet-capture start_

Start packet capture on a virtual network gateway.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vc3RhcnRwYWNrZXRjYXB0dXJl/2022-01-01.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/startpacketcapture 2022-01-01 -->

#### examples

- Start packet capture on a virtual network gateway.
```bash
network vnet-gateway packet-capture start -g MyResourceGroup -n MyVnetGateway
```
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/packet-capture/_stop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway packet-capture stop_

Stop packet capture on a virtual network gateway.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vc3RvcHBhY2tldGNhcHR1cmU=/2022-01-01.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/stoppacketcapture 2022-01-01 -->

#### examples

- Stop packet capture on a virtual network gateway.
```bash
network vnet-gateway packet-capture stop -g MyResourceGroup -n MyVnetGateway --sas-url https://myStorageAct.blob.azure.com/artifacts?st=2019-04-10T22%3A12Z&se=2019-04-11T09%3A12Z&sp=rl&sv=2018-03-28&sr=c&sig=0000000000
```
11 changes: 11 additions & 0 deletions Commands/network/vnet-gateway/packet-capture/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _network vnet-gateway packet-capture_

Manage packet capture on a virtual network gateway.

## Commands

- [start](/Commands/network/vnet-gateway/packet-capture/_start.md)
: Start packet capture on a virtual network gateway.

- [stop](/Commands/network/vnet-gateway/packet-capture/_stop.md)
: Stop packet capture on a virtual network gateway.
6 changes: 6 additions & 0 deletions Commands/network/vnet-gateway/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,18 @@ To learn more about Azure Virtual Network Gateways, visit https://docs.microsoft
- [nat-rule](/Commands/network/vnet-gateway/nat-rule/readme.md)
: Manage nat rule in a virtual network gateway.

- [packet-capture](/Commands/network/vnet-gateway/packet-capture/readme.md)
: Manage packet capture on a virtual network gateway.

- [revoked-cert](/Commands/network/vnet-gateway/revoked-cert/readme.md)
: Manage revoked certificates in a virtual network gateway. Prevent machines using this certificate from accessing Azure through this gateway.

- [root-cert](/Commands/network/vnet-gateway/root-cert/readme.md)
: Manage root certificates of a virtual network gateway.

- [vpn-client](/Commands/network/vnet-gateway/vpn-client/readme.md)
: Download a VPN client configuration required to connect to Azure via point-to-site.

## Commands

- [create](/Commands/network/vnet-gateway/_create.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _network vnet-gateway vpn-client generate-vpn-profile_

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2VuZXJhdGV2cG5wcm9maWxl/2022-01-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/generatevpnprofile 2022-01-01 -->
26 changes: 26 additions & 0 deletions Commands/network/vnet-gateway/vpn-client/_generate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# [Command] _network vnet-gateway vpn-client generate_

Generate VPN client configuration.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2VuZXJhdGV2cG5jbGllbnRwYWNrYWdl/2022-01-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/generatevpnclientpackage 2022-01-01 -->

#### examples

- Create the VPN client configuration for RADIUS with EAP-MSCHAV2 authentication.
```bash
network vnet-gateway vpn-client generate -g MyResourceGroup -n MyVnetGateway --authentication-method EAPMSCHAPv2
```

- Create the VPN client configuration for AMD64 architecture.
```bash
network vnet-gateway vpn-client generate -g MyResourceGroup -n MyVnetGateway --processor-architecture Amd64
```

- Generate VPN client configuration.
```bash
network vnet-gateway vpn-client generate --name MyVnetGateway --processor-architecture Amd64 --resource-group MyResourceGroup --subscription MySubscription
```
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/vpn-client/_show-health.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway vpn-client show-health_

Get the VPN client connection health detail per P2S client connection of the virtual network gateway.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0dnBuY2xpZW50Y29ubmVjdGlvbmhlYWx0aA==/2022-01-01.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getvpnclientconnectionhealth 2022-01-01 -->

#### examples

- Get the VPN client connection health detail per P2S client connection of the virtual network gateway.
```bash
network vnet-gateway vpn-client show-health -g MyResourceGroup -n MyVnetGateway
```
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/vpn-client/_show-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway vpn-client show-url_

Retrieve a pre-generated VPN client configuration.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0dnBucHJvZmlsZXBhY2thZ2V1cmw=/2022-01-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getvpnprofilepackageurl 2022-01-01 -->

#### examples

- Get the pre-generated point-to-site VPN client of the virtual network gateway.
```bash
network vnet-gateway vpn-client show-url -g MyResourceGroup -n MyVnetGateway
```
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/vpn-client/ipsec-policy/_set.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway vpn-client ipsec-policy set_

Set the VPN client connection ipsec policy per P2S client connection of the virtual network gateway.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vc2V0dnBuY2xpZW50aXBzZWNwYXJhbWV0ZXJz/2022-01-01.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/setvpnclientipsecparameters 2022-01-01 -->

#### examples

- Set the VPN client connection ipsec policy per P2S client connection of the virtual network gateway.
```bash
network vnet-gateway vpn-client ipsec-policy set -g MyResourceGroup -n MyVnetGateway --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
```
16 changes: 16 additions & 0 deletions Commands/network/vnet-gateway/vpn-client/ipsec-policy/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network vnet-gateway vpn-client ipsec-policy show_

Get the VPN client connection ipsec policy per P2S client connection of the virtual network gateway.

## Versions

### [2022-01-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3ZpcnR1YWxuZXR3b3JrZ2F0ZXdheXMve30vZ2V0dnBuY2xpZW50aXBzZWNwYXJhbWV0ZXJz/2022-01-01.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualnetworkgateways/{}/getvpnclientipsecparameters 2022-01-01 -->

#### examples

- Get the VPN client connection ipsec policy per P2S client connection of the virtual network gateway.
```bash
network vnet-gateway vpn-client ipsec-policy show -g MyResourceGroup -n MyVnetGateway
```
11 changes: 11 additions & 0 deletions Commands/network/vnet-gateway/vpn-client/ipsec-policy/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _network vnet-gateway vpn-client ipsec-policy_

Manage the VPN client connection ipsec-policy for P2S client connection of the virtual network gateway.

## Commands

- [set](/Commands/network/vnet-gateway/vpn-client/ipsec-policy/_set.md)
: Set the VPN client connection ipsec policy per P2S client connection of the virtual network gateway.

- [show](/Commands/network/vnet-gateway/vpn-client/ipsec-policy/_show.md)
: Get the VPN client connection ipsec policy per P2S client connection of the virtual network gateway.
22 changes: 22 additions & 0 deletions Commands/network/vnet-gateway/vpn-client/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# [Group] _network vnet-gateway vpn-client_

Download a VPN client configuration required to connect to Azure via point-to-site.

## Subgroups

- [ipsec-policy](/Commands/network/vnet-gateway/vpn-client/ipsec-policy/readme.md)
: Manage the VPN client connection ipsec-policy for P2S client connection of the virtual network gateway.

## Commands

- [generate](/Commands/network/vnet-gateway/vpn-client/_generate.md)
: Generate VPN client configuration.

- [generate-vpn-profile](/Commands/network/vnet-gateway/vpn-client/_generate-vpn-profile.md)
: Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

- [show-health](/Commands/network/vnet-gateway/vpn-client/_show-health.md)
: Get the VPN client connection health detail per P2S client connection of the virtual network gateway.

- [show-url](/Commands/network/vnet-gateway/vpn-client/_show-url.md)
: Retrieve a pre-generated VPN client configuration.
Loading

0 comments on commit 271f213

Please sign in to comment.