az afd endpoint

Manage AFD endpoints within the specified profile.

An endpoint is a logical grouping of domains and their associated configurations.

Commands

az afd endpoint create

Creates an endpoint within the specified profile.

az afd endpoint delete

Delete an endpoint within the specified profile.

az afd endpoint list

List all the endpoints within the specified profile.

az afd endpoint purge

Removes cached contents from Azure Front Door.

az afd endpoint show

Show details of an endpoint within the specified profile.

az afd endpoint update

Update an endpoint within the specified profile.

az afd endpoint create

Creates an endpoint within the specified profile.

Azure Front Door will generate a deterministic DNS domain based on the customer input endpoint name in the form of -.z01.azurefd.net, the deterministic DNS domain could be reused within the tenant, subscription, or resource group depends on the --name-reuse-scope option. Customer will get the same DNS domain in the reuse scope if the endpoint get deleted and recreated.

az afd endpoint create --endpoint-name
                       --profile-name
                       --resource-group
                       [--enabled-state {Disabled, Enabled}]
                       [--name-reuse-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                       [--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 of the endpoint under the profile which is unique globally.

--profile-name

Name of the 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

--enabled-state

Whether to enable this endpoint.

accepted values: Disabled, Enabled
default value: Enabled
--name-reuse-scope

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

accepted values: NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse
default value: TenantReuse
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az afd endpoint delete

Delete an endpoint within the specified profile.

az afd endpoint delete [--endpoint-name]
                       [--ids]
                       [--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 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 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.

--yes -y

Do not prompt for confirmation.

default value: False

az afd endpoint list

List all the endpoints within the specified profile.

az afd endpoint list --profile-name
                     --resource-group

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

az afd endpoint purge

Removes cached contents from Azure Front Door.

az afd endpoint purge --content-paths
                      [--domains]
                      [--endpoint-name]
                      [--ids]
                      [--no-wait]
                      [--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 wildcard directory.

Optional Parameters

--domains

List of domains.

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

default value: False
--profile-name

Name of the 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.

az afd endpoint show

Show details of an endpoint within the specified 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 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 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.

az afd endpoint update

Update an endpoint within the specified profile.

az afd endpoint update [--enabled-state {Disabled, Enabled}]
                       [--endpoint-name]
                       [--ids]
                       [--profile-name]
                       [--resource-group]
                       [--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

--enabled-state

Whether to enable this endpoint.

accepted values: Disabled, Enabled
--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.

--profile-name

Name of the 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.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.