Share via

az afd endpoint

  • Reference

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

Commands

Name Description Type Status
az afd endpoint create

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

 Core GA
az afd endpoint delete

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

 Core GA
az afd endpoint list

List existing AzureFrontDoor endpoints.

 Core GA
az afd endpoint purge

Removes a content from AzureFrontDoor.

 Core GA
az afd endpoint show

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

 Core GA
az afd endpoint update

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

 Core GA
az afd endpoint wait

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

 Core GA

az afd endpoint create

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

az afd endpoint create --endpoint-name
                       --profile-name
                       --resource-group
                       [--enabled-state {Disabled, Enabled}]
                       [--name-reuse-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--tags]

Examples

Creates an enabled endpoint

az afd endpoint create -g group --endpoint-name endpoint1 --profile-name profile --enabled-state Enabled

Required Parameters

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

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

--enabled-state

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'.

Accepted values: Disabled, Enabled
--name-reuse-scope

Indicates the endpoint name reuse scope. The default value is TenantReuse.

Accepted values: NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse
--no-wait

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

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

Resource tags. 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 endpoint delete

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

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

Examples

Delete an endpoint named endpoint1.

az afd endpoint delete -g group --profile-name profile --endpoint-name endpoint1

Optional Parameters

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

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

--no-wait

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

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

--subscription

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

--yes -y

Do not prompt for confirmation.

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.

az afd endpoint list

List existing AzureFrontDoor endpoints.

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

Examples

List all the endpoints within the specified profile.

az afd endpoint list -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 endpoint purge

Removes a content from AzureFrontDoor.

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

Examples

Remove all cached contents under directory "/script" for domain www.contoso.com

az afd endpoint purge -g group --profile-name profile --domains www.contoso.com --content-paths '/scripts/*'

Required Parameters

--content-paths

The path to the content to be purged. Can describe a file path or a wild card directory. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--domains

List of domains. Example: "www.contoso.com, www.contoso1.com" Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--endpoint-name

Name of the endpoint under the profile which is unique globally.

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

--no-wait

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

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

--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 endpoint show

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

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

Examples

show details of the endpoint named endpoint1.

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

Optional Parameters

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

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

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

--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 endpoint update

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

az afd endpoint update [--add]
                       [--enabled-state {Disabled, Enabled}]
                       [--endpoint-name]
                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                       [--ids]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--profile-name]
                       [--remove]
                       [--resource-group]
                       [--set]
                       [--subscription]
                       [--tags]

Examples

Update an endpoint's state to disabled.

az afd endpoint update -g group --endpoint-name endpoint1 --profile-name profile --enabled-state Disabled

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

--enabled-state

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'.

Accepted values: Disabled, Enabled
--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

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

--no-wait

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

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

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

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

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 endpoint wait

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

az afd endpoint wait [--created]
                     [--custom]
                     [--deleted]
                     [--endpoint-name]
                     [--exists]
                     [--ids]
                     [--interval]
                     [--profile-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
--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

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

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