az afd endpoint

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enabled-state

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--name-reuse-scope

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse

--no-wait

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

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

Property	Value
Parameter group:	Endpoint Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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.

Property	Value
Parameter group:	Contents Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--domains

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

Property	Value
Parameter group:	Contents Arguments

--endpoint-name

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--enabled-state

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--endpoint-name --name -n

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

Property	Value
Parameter group:	Resource Id Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

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

Property	Value
Parameter group:	Endpoint Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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 --name]
                     [--exists]
                     [--ids]
                     [--interval]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]
                     [--timeout]
                     [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--endpoint-name --name -n

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

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False