Skip to content

Commit

Permalink
Merge pull request Azure#21 from ZengTaoxu/traffic-manager
Browse files Browse the repository at this point in the history
Add command models for `az network traffic-manager` and `az network routeserver`
  • Loading branch information
necusjz authored Sep 13, 2022
2 parents a242939 + 650de0b commit 059396f
Show file tree
Hide file tree
Showing 54 changed files with 19,715 additions and 201 deletions.
6 changes: 6 additions & 0 deletions Commands/network/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,18 @@ Manage Azure Network resources.
- [route-table](/Commands/network/route-table/readme.md)
: Manage route tables.

- [routeserver](/Commands/network/routeserver/readme.md)
: Manage the route server.

- [security-partner-provider](/Commands/network/security-partner-provider/readme.md)
: Manage Azure security partner provider.

- [service-endpoint](/Commands/network/service-endpoint/readme.md)
: Manage policies related to service endpoints.

- [traffic-manager](/Commands/network/traffic-manager/readme.md)
: Manage the routing of incoming traffic.

- [vhub](/Commands/network/vhub/readme.md)
: Manage virtual hubs.

Expand Down
16 changes: 16 additions & 0 deletions Commands/network/routeserver/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver create_

Create a route server.

## Versions

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

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

#### examples

- Create a route server.
```bash
network routeserver create --resource-group myresourcegroup --name myrouteserver --hosted-subnet my_subnet_id --public-ip-address my_public_ip
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver delete_

Delete a route server under a resource group.

## Versions

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

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

#### examples

- Delete a route server.
```bash
network routeserver delete -g MyResourceGroup -n MyRouteServer -y
```
17 changes: 17 additions & 0 deletions Commands/network/routeserver/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Command] _network routeserver list_

List all route servers under a subscription or a resource group.

## Versions

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

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

#### examples

- List a route server.
```bash
network routeserver list -g MyResourceGroup
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver show_

Show a route server.

## Versions

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

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

#### examples

- Show a route server.
```bash
network routeserver show -g MyResourceGroup -n MyRouteServer
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver update_

Update a route server.

## Versions

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

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

#### examples

- Update a route server.
```bash
network routeserver update --name myrouteserver --resource-group myresourcegroup --tags super_secure no_80 no_22
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/peering/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver peering create_

Create a route server peering.

## Versions

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

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

#### examples

- Create a route server peering.
```bash
network routeserver peering create -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer --peer-asn 11000 --peer-ip 10.0.0.120
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/peering/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver peering delete_

Delete a route server peering.

## Versions

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

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

#### examples

- Delete a route server peering.
```bash
network routeserver peering delete -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer -y
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/peering/_list-advertised-routes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver peering list-advertised-routes_

List all routes the route server bgp connection is advertising to the specified peer.

## Versions

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

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualhubs/{}/bgpconnections/{}/advertisedroutes 2022-01-01 -->

#### examples

- List.
```bash
network routeserver peering list-advertised-routes -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/peering/_list-learned-routes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver peering list-learned-routes_

List all routes the route server bgp connection has learned.

## Versions

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

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/virtualhubs/{}/bgpconnections/{}/learnedroutes 2022-01-01 -->

#### examples

- List.
```bash
network routeserver peering list-learned-routes -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/peering/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver peering list_

List all route server peerings under a resource group.

## Versions

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

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

#### examples

- List a route server peering.
```bash
network routeserver peering list -g MyResourceGroup --routeserver MyRouteServer
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/peering/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver peering show_

Show a route server peering.

## Versions

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

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

#### examples

- Show a route server peering.
```bash
network routeserver peering show -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer
```
16 changes: 16 additions & 0 deletions Commands/network/routeserver/peering/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network routeserver peering update_

Update a route server peering.

## Versions

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

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

#### examples

- Update a route server peering.
```bash
network routeserver peering update -g MyResourceGroup --routeserver MyRouteServer -n MyRouteServerPeer --peer-ip 10.0.0.0
```
26 changes: 26 additions & 0 deletions Commands/network/routeserver/peering/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# [Group] _network routeserver peering_

Manage the route server peering.

## Commands

- [create](/Commands/network/routeserver/peering/_create.md)
: Create a route server peering.

- [delete](/Commands/network/routeserver/peering/_delete.md)
: Delete a route server peering.

- [list](/Commands/network/routeserver/peering/_list.md)
: List all route server peerings under a resource group.

- [list-advertised-routes](/Commands/network/routeserver/peering/_list-advertised-routes.md)
: List all routes the route server bgp connection is advertising to the specified peer.

- [list-learned-routes](/Commands/network/routeserver/peering/_list-learned-routes.md)
: List all routes the route server bgp connection has learned.

- [show](/Commands/network/routeserver/peering/_show.md)
: Show a route server peering.

- [update](/Commands/network/routeserver/peering/_update.md)
: Update a route server peering.
25 changes: 25 additions & 0 deletions Commands/network/routeserver/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# [Group] _network routeserver_

Manage the route server.

## Subgroups

- [peering](/Commands/network/routeserver/peering/readme.md)
: Manage the route server peering.

## Commands

- [create](/Commands/network/routeserver/_create.md)
: Create a route server.

- [delete](/Commands/network/routeserver/_delete.md)
: Delete a route server under a resource group.

- [list](/Commands/network/routeserver/_list.md)
: List all route servers under a subscription or a resource group.

- [show](/Commands/network/routeserver/_show.md)
: Show a route server.

- [update](/Commands/network/routeserver/_update.md)
: Update a route server.
21 changes: 21 additions & 0 deletions Commands/network/traffic-manager/endpoint/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _network traffic-manager endpoint create_

Create a traffic manager endpoint.

## Versions

### [2018-08-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3RyYWZmaWNtYW5hZ2VycHJvZmlsZXMve30ve30ve30=/2018-08-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/trafficmanagerprofiles/{}/{}/{} 2018-08-01 -->

#### examples

- Create an endpoint for a performance profile to point to an Azure Web App endpoint.
```bash
network traffic-manager endpoint create -g MyResourceGroup --profile-name MyTmProfile -n MyEndpoint --type azureEndpoints --target-resource-id $MyWebApp1Id --endpoint-status enabled
```

- Create an endpoint.
```bash
network traffic-manager endpoint create -n MyTmEndpoint --profile-name MyTmProfile -g MyResourceGroup --type azureEndpoints --target-resource-id $MyWebApp1Id --subnets [{first:10.0.0.0}] --custom-headers [{name:test,value:best}]
```
21 changes: 21 additions & 0 deletions Commands/network/traffic-manager/endpoint/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _network traffic-manager endpoint delete_

Delete a traffic manager endpoint.

## Versions

### [2018-08-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3RyYWZmaWNtYW5hZ2VycHJvZmlsZXMve30ve30ve30=/2018-08-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/trafficmanagerprofiles/{}/{}/{} 2018-08-01 -->

#### examples

- Delete a traffic manager endpoint.
```bash
network traffic-manager endpoint delete -g MyResourceGroup --profile-name MyTmProfile -n MyEndpoint --type azureEndpoints
```

- Delete a traffic manager endpoint. (autogenerated)
```bash
network traffic-manager endpoint delete --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --subscription MySubscription --type azureEndpoints
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network traffic-manager endpoint show-geographic-hierarchy_

Get the default geographic hierarchy used by the geographic traffic routing method.

## Versions

### [2018-08-01](/Resources/mgmt-plane/L3Byb3ZpZGVycy9taWNyb3NvZnQubmV0d29yay90cmFmZmljbWFuYWdlcmdlb2dyYXBoaWNoaWVyYXJjaGllcy9kZWZhdWx0/2018-08-01.xml) **Stable**

<!-- mgmt-plane /providers/microsoft.network/trafficmanagergeographichierarchies/default 2018-08-01 -->

#### examples

- Get the default geographic hierarchy used by the geographic traffic routing method.
```bash
network traffic-manager endpoint show-geographic-hierarchy
```
16 changes: 16 additions & 0 deletions Commands/network/traffic-manager/endpoint/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _network traffic-manager endpoint show_

Get the details of a traffic manager endpoint.

## Versions

### [2018-08-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3RyYWZmaWNtYW5hZ2VycHJvZmlsZXMve30ve30ve30=/2018-08-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/trafficmanagerprofiles/{}/{}/{} 2018-08-01 -->

#### examples

- Get the details of a traffic manager endpoint.
```bash
network traffic-manager endpoint show -g MyResourceGroup --profile-name MyTmProfile -n MyEndpoint --type azureEndpoints
```
32 changes: 32 additions & 0 deletions Commands/network/traffic-manager/endpoint/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# [Command] _network traffic-manager endpoint update_

Update a traffic manager endpoint.

## Versions

### [2018-08-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5uZXR3b3JrL3RyYWZmaWNtYW5hZ2VycHJvZmlsZXMve30ve30ve30=/2018-08-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.network/trafficmanagerprofiles/{}/{}/{} 2018-08-01 -->

#### examples

- Update a traffic manager endpoint to change its weight.
```bash
network traffic-manager endpoint update -g MyResourceGroup --profile-name MyTmProfile -n MyEndpoint --weight 20 --type azureEndpoints
```

- Update a traffic manager endpoint. (autogenerated)
```bash
network traffic-manager endpoint update --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --target webserver.mysite.com --type azureEndpoints
```

- Update a traffic manager endpoint. (autogenerated)
```bash
network traffic-manager endpoint update --endpoint-status Enabled --name MyEndpoint --profile-name MyTmProfile --resource-group MyResourceGroup --type azureEndpoints
```

- Update a traffic manager endpoint.
```bash
network traffic-manager endpoint update -n MyTmEndpoint --type azureEndpoints --profile-name MyTmProfile -g MyResourceGroup --subnets [{first:10.0.0.0,scope:24}]
network traffic-manager endpoint update -n MyTmEndpoint --type azureEndpoints --profile-name MyTmProfile -g MyResourceGroup --subnets [{first:10.0.0.0,last:11.0.0.0}]
```
Loading

0 comments on commit 059396f

Please sign in to comment.