Skip to content

Commit

Permalink
Merge pull request #375 from Ptnan7/main
Browse files Browse the repository at this point in the history
Export az afd api with aaz
  • Loading branch information
necusjz authored Dec 22, 2023
2 parents 870d247 + 50b2aa6 commit 684df20
Show file tree
Hide file tree
Showing 141 changed files with 20,124 additions and 0 deletions.
21 changes: 21 additions & 0 deletions Commands/afd/custom-domain/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _afd custom-domain create_

Create a new domain within the specified profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vY3VzdG9tZG9tYWlucy97fQ==/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/customdomains/{} 2023-05-01 -->

#### examples

- Create a custom domain that uses AFD managed certificate for SSL/TLS encryption.
```bash
afd custom-domain create -g group --custom-domain-name customDomain --profile-name profile --host-name www.contoso.com --minimum-tls-version TLS12 --certificate-type ManagedCertificate
```

- Create a custom domain that uses your own certificate for SSL/TLS encryption, the certificate is stored in Azure Key Vault and referenced by an AFD secret.
```bash
afd custom-domain create -g group --custom-domain-name customDomain --profile-name profile --host-name www.contoso.com --minimum-tls-version TLS12 --certificate-type CustomerCertificate --secret secretName
```
16 changes: 16 additions & 0 deletions Commands/afd/custom-domain/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd custom-domain delete_

Delete an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vY3VzdG9tZG9tYWlucy97fQ==/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/customdomains/{} 2023-05-01 -->

#### examples

- Delete a custom domain.
```bash
afd custom-domain delete -g group --profile-name profile --custom-domain-name customDomainName
```
16 changes: 16 additions & 0 deletions Commands/afd/custom-domain/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd custom-domain list_

List existing AzureFrontDoor domains.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vY3VzdG9tZG9tYWlucw==/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/customdomains 2023-05-01 -->

#### examples

- List all the custom domains within the specified profile.
```bash
afd custom-domain list -g group --profile-name profile
```
16 changes: 16 additions & 0 deletions Commands/afd/custom-domain/_regenerate-validation-token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd custom-domain regenerate-validation-token_

Updates the domain validation token.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vY3VzdG9tZG9tYWlucy97fS9yZWZyZXNodmFsaWRhdGlvbnRva2Vu/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/customdomains/{}/refreshvalidationtoken 2023-05-01 -->

#### examples

- Regenerate the domain validation token.
```bash
afd custom-domain regenerate-validation-token -g MyResourceGroup --profile-name MyProfle --custom-domain-name MyCustomDomain
```
16 changes: 16 additions & 0 deletions Commands/afd/custom-domain/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd custom-domain show_

Get an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vY3VzdG9tZG9tYWlucy97fQ==/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/customdomains/{} 2023-05-01 -->

#### examples

- show details of the custom domain within the specified profile.
```bash
afd custom-domain show -g group --profile-name profile --custom-domain-name customDomainName
```
21 changes: 21 additions & 0 deletions Commands/afd/custom-domain/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _afd custom-domain update_

Update a new domain within the specified profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vY3VzdG9tZG9tYWlucy97fQ==/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/customdomains/{} 2023-05-01 -->

#### examples

- Update the custom domain's supported minimum TLS version.
```bash
afd custom-domain update -g group --custom-domain-name customDomain --profile-name profile --minimum-tls-version TLS12
```

- Update the custom domain's certificate type to AFD managed certificate.
```bash
afd custom-domain update -g group --custom-domain-name customDomain --profile-name profile --certificate-type ManagedCertificate
```
23 changes: 23 additions & 0 deletions Commands/afd/custom-domain/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# [Group] _afd custom-domain_

Manage custom domains within the specified profile.

## Commands

- [create](/Commands/afd/custom-domain/_create.md)
: Create a new domain within the specified profile.

- [delete](/Commands/afd/custom-domain/_delete.md)
: Delete an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

- [list](/Commands/afd/custom-domain/_list.md)
: List existing AzureFrontDoor domains.

- [regenerate-validation-token](/Commands/afd/custom-domain/_regenerate-validation-token.md)
: Updates the domain validation token.

- [show](/Commands/afd/custom-domain/_show.md)
: Get an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

- [update](/Commands/afd/custom-domain/_update.md)
: Update a new domain within the specified profile.
16 changes: 16 additions & 0 deletions Commands/afd/endpoint/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd endpoint create_

Create a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vYWZkZW5kcG9pbnRzL3t9/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{} 2023-05-01 -->

#### examples

- Creates an enabled endpoint
```bash
afd endpoint create -g group --endpoint-name endpoint1 --profile-name profile --enabled-state Enabled
```
16 changes: 16 additions & 0 deletions Commands/afd/endpoint/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd endpoint delete_

Delete an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vYWZkZW5kcG9pbnRzL3t9/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{} 2023-05-01 -->

#### examples

- Delete an endpoint named endpoint1.
```bash
afd endpoint delete -g group --profile-name profile --endpoint-name endpoint1
```
16 changes: 16 additions & 0 deletions Commands/afd/endpoint/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd endpoint list_

List existing AzureFrontDoor endpoints.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vYWZkZW5kcG9pbnRz/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints 2023-05-01 -->

#### examples

- List all the endpoints within the specified profile.
```bash
afd endpoint list -g group --profile-name profile
```
16 changes: 16 additions & 0 deletions Commands/afd/endpoint/_purge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd endpoint purge_

Removes a content from AzureFrontDoor.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vYWZkZW5kcG9pbnRzL3t9L3B1cmdl/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{}/purge 2023-05-01 -->

#### examples

- Remove all cached contents under directory "/script" for domain www.contoso.com
```bash
afd endpoint purge -g group --profile-name profile --domains www.contoso.com --content-paths '/scripts/*'
```
16 changes: 16 additions & 0 deletions Commands/afd/endpoint/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd endpoint show_

Get an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vYWZkZW5kcG9pbnRzL3t9/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{} 2023-05-01 -->

#### examples

- show details of the endpoint named endpoint1.
```bash
afd endpoint show -g group --profile-name profile --endpoint-name endpoint1
```
16 changes: 16 additions & 0 deletions Commands/afd/endpoint/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd endpoint update_

Update a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vYWZkZW5kcG9pbnRzL3t9/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{} 2023-05-01 -->

#### examples

- Update an endpoint's state to disabled.
```bash
afd endpoint update -g group --endpoint-name endpoint1 --profile-name profile --enabled-state Disabled
```
23 changes: 23 additions & 0 deletions Commands/afd/endpoint/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# [Group] _afd endpoint_

Manage AFD endpoints within the specified profile. An endpoint is a logical grouping of domains and their associated configurations.

## Commands

- [create](/Commands/afd/endpoint/_create.md)
: Create a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

- [delete](/Commands/afd/endpoint/_delete.md)
: Delete an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

- [list](/Commands/afd/endpoint/_list.md)
: List existing AzureFrontDoor endpoints.

- [purge](/Commands/afd/endpoint/_purge.md)
: Removes a content from AzureFrontDoor.

- [show](/Commands/afd/endpoint/_show.md)
: Get an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

- [update](/Commands/afd/endpoint/_update.md)
: Update a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
9 changes: 9 additions & 0 deletions Commands/afd/log-analytic/location/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _afd log-analytic location list_

Get all available location names for AFD log analytics report.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vZ2V0bG9nYW5hbHl0aWNzbG9jYXRpb25z/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/getloganalyticslocations 2023-05-01 -->
8 changes: 8 additions & 0 deletions Commands/afd/log-analytic/location/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _afd log-analytic location_

Manage available location names for AFD log analysis.

## Commands

- [list](/Commands/afd/log-analytic/location/_list.md)
: Get all available location names for AFD log analytics report.
9 changes: 9 additions & 0 deletions Commands/afd/log-analytic/metric/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _afd log-analytic metric list_

Get log report for AFD profile

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vZ2V0bG9nYW5hbHl0aWNzbWV0cmljcw==/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/getloganalyticsmetrics 2023-05-01 -->
8 changes: 8 additions & 0 deletions Commands/afd/log-analytic/metric/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _afd log-analytic metric_

Manage metric statistics for AFD profile.

## Commands

- [list](/Commands/afd/log-analytic/metric/_list.md)
: Get log report for AFD profile
9 changes: 9 additions & 0 deletions Commands/afd/log-analytic/ranking/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _afd log-analytic ranking list_

Get log analytics ranking report for AFD profile

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vZ2V0bG9nYW5hbHl0aWNzcmFua2luZ3M=/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/getloganalyticsrankings 2023-05-01 -->
8 changes: 8 additions & 0 deletions Commands/afd/log-analytic/ranking/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _afd log-analytic ranking_

Manage ranking statistics for AFD profile.

## Commands

- [list](/Commands/afd/log-analytic/ranking/_list.md)
: Get log analytics ranking report for AFD profile
17 changes: 17 additions & 0 deletions Commands/afd/log-analytic/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Group] _afd log-analytic_

Manage afd log analytic results.

## Subgroups

- [location](/Commands/afd/log-analytic/location/readme.md)
: Manage available location names for AFD log analysis.

- [metric](/Commands/afd/log-analytic/metric/readme.md)
: Manage metric statistics for AFD profile.

- [ranking](/Commands/afd/log-analytic/ranking/readme.md)
: Manage ranking statistics for AFD profile.

- [resource](/Commands/afd/log-analytic/resource/readme.md)
: Manage endpoints and custom domains available for AFD log analysis.
9 changes: 9 additions & 0 deletions Commands/afd/log-analytic/resource/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _afd log-analytic resource list_

Get all endpoints and custom domains available for AFD log report

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vZ2V0bG9nYW5hbHl0aWNzcmVzb3VyY2Vz/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/getloganalyticsresources 2023-05-01 -->
8 changes: 8 additions & 0 deletions Commands/afd/log-analytic/resource/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _afd log-analytic resource_

Manage endpoints and custom domains available for AFD log analysis.

## Commands

- [list](/Commands/afd/log-analytic/resource/_list.md)
: Get all endpoints and custom domains available for AFD log report
16 changes: 16 additions & 0 deletions Commands/afd/origin-group/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd origin-group create_

Create a new origin group within the specified profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vb3JpZ2luZ3JvdXBzL3t9/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/origingroups/{} 2023-05-01 -->

#### examples

- Creates a new origin group within the specified profile.
```bash
afd origin-group create -g group --origin-group-name og1 --profile-name profile --probe-request-type GET --probe-protocol Http --probe-interval-in-seconds 120 --probe-path /test1/azure.txt --sample-size 4 --successful-samples-required 3 --additional-latency-in-milliseconds 50
```
16 changes: 16 additions & 0 deletions Commands/afd/origin-group/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _afd origin-group delete_

Delete an existing origin group within a profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vb3JpZ2luZ3JvdXBzL3t9/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/origingroups/{} 2023-05-01 -->

#### examples

- Deletes an existing origin group within a profile.
```bash
afd origin-group delete -g group --origin-group-name og1 --profile-name profile
```
9 changes: 9 additions & 0 deletions Commands/afd/origin-group/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _afd origin-group list_

List all of the existing origin groups within a profile.

## Versions

### [2023-05-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jZG4vcHJvZmlsZXMve30vb3JpZ2luZ3JvdXBz/2023-05-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/origingroups 2023-05-01 -->
Loading

0 comments on commit 684df20

Please sign in to comment.