Share via

az afd profile

  • Reference

Manage AFD profiles.

Commands

Name Description Type Status
az afd profile create

Create a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.

 Core GA
az afd profile delete

Delete an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.

 Core GA
az afd profile list

List all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.

 Core GA
az afd profile log-scrubbing

Defines rules that scrub sensitive fields in the Azure Front Door profile logs.

 Core GA
az afd profile log-scrubbing show

Defines rules that scrub sensitive fields in the Azure Front Door profile logs.

 Core GA
az afd profile show

Get an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.

 Core GA
az afd profile update

Update a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.

 Core GA
az afd profile usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

 Core GA
az afd profile wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az afd profile create

Create a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.

az afd profile create --name
                      --resource-group
                      [--identity]
                      [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                      [--log-scrubbing]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--origin-response-timeout-seconds]
                      [--sku {Custom_Verizon, Premium_AzureFrontDoor, Premium_Verizon, StandardPlus_955BandWidth_ChinaCdn, StandardPlus_AvgBandWidth_ChinaCdn, StandardPlus_ChinaCdn, Standard_955BandWidth_ChinaCdn, Standard_Akamai, Standard_AvgBandWidth_ChinaCdn, Standard_AzureFrontDoor, Standard_ChinaCdn, Standard_Microsoft, Standard_Verizon}]
                      [--tags]
                      [--user-assigned-identities]

Examples

Create an AFD profile using Standard SKU.

az afd profile create -g group --profile-name profile --sku Standard_AzureFrontDoor

Required Parameters

--name --profile-name -n

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

--resource-group -g

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

Optional Parameters

--identity

Managed service identity (system assigned and/or user assigned identities). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--identity-type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Accepted values: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--log-scrubbing

Defines rules that scrub sensitive fields in the Azure Front Door profile logs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--origin-response-timeout-seconds

Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.

--sku

Name of the pricing tier.

Accepted values: Custom_Verizon, Premium_AzureFrontDoor, Premium_Verizon, StandardPlus_955BandWidth_ChinaCdn, StandardPlus_AvgBandWidth_ChinaCdn, StandardPlus_ChinaCdn, Standard_955BandWidth_ChinaCdn, Standard_Akamai, Standard_AvgBandWidth_ChinaCdn, Standard_AzureFrontDoor, Standard_ChinaCdn, Standard_Microsoft, Standard_Verizon
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-assigned-identities

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{{identityName}}. The dictionary values can be empty objects ({{}}) in requests. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd profile delete

Delete an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.

az afd profile delete [--ids]
                      [--name]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--resource-group]
                      [--subscription]

Examples

Delete an AFD profile.

az profile delete -g group --profile-name profile

Optional Parameters

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

--name --profile-name -n

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd profile list

List all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.

az afd profile list [--max-items]
                    [--next-token]
                    [--resource-group]

Examples

List AFD profiles in a resource group.

az afd profile list -g group

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd profile show

Get an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.

az afd profile show [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

Examples

Show details of an AFD profile.

az afd profile show -g group --profile-name profile

Optional Parameters

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

--name --profile-name -n

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd profile update

Update a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.

az afd profile update [--add]
                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                      [--identity]
                      [--identity-type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                      [--ids]
                      [--log-scrubbing]
                      [--name]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--origin-response-timeout-seconds]
                      [--remove]
                      [--resource-group]
                      [--set]
                      [--subscription]
                      [--tags]
                      [--user-assigned-identities]

Examples

Update an AFD profile with tags.

az afd profile update --profile-name profile --resource-group MyResourceGroup --tags tag1=value1

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity

Managed service identity (system assigned and/or user assigned identities). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--identity-type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Accepted values: None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned
--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.

--log-scrubbing

Defines rules that scrub sensitive fields in the Azure Front Door profile logs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name --profile-name -n

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--origin-response-timeout-seconds

Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-assigned-identities

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroupName}}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{{identityName}}. The dictionary values can be empty objects ({{}}) in requests. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd profile usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

az afd profile usage --profile-name
                     --resource-group
                     [--max-items]
                     [--next-token]

Examples

List resource usage within the specific AFD profile.

az afd profile usage -g group --profile-name profile

Required Parameters

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az afd profile wait

Place the CLI in a waiting state until a condition is met.

az afd profile wait [--created]
                    [--custom]
                    [--deleted]
                    [--exists]
                    [--ids]
                    [--interval]
                    [--name]
                    [--resource-group]
                    [--subscription]
                    [--timeout]
                    [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

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

--interval

Polling interval in seconds.

Default value: 30
--name --profile-name -n

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.