通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az afd endpoint

管理指定配置文件中的 AFD 终结点。 终结点是域及其关联配置的逻辑分组。

命令

名称 说明 类型 Status
az afd endpoint create

在指定的订阅、资源组和配置文件下，使用指定的终结点名称创建新的 AzureFrontDoor 终结点。

 Core GA
az afd endpoint delete

删除具有指定订阅、资源组和配置文件下指定终结点名称的现有 AzureFrontDoor 终结点。

 Core GA
az afd endpoint list

列出现有的 AzureFrontDoor 终结点。

 Core GA
az afd endpoint purge

从 AzureFrontDoor 中删除内容。

 Core GA
az afd endpoint show

获取具有指定订阅、资源组和配置文件下指定终结点名称的现有 AzureFrontDoor 终结点。

 Core GA
az afd endpoint update

使用指定订阅、资源组和配置文件下的指定终结点名称更新新的 AzureFrontDoor 终结点。

 Core GA
az afd endpoint wait

将 CLI 置于等待状态，直到满足条件。

 Core GA

az afd endpoint create

在指定的订阅、资源组和配置文件下，使用指定的终结点名称创建新的 AzureFrontDoor 终结点。

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]

示例

创建已启用的终结点

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

必需参数

--endpoint-name --name -n

全局唯一的配置文件下的终结点的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--enabled-state

是否启用此规则的使用。 允许的值为“Enabled”或“Disabled”。

属性 值
参数组: Properties Arguments
接受的值: Disabled, Enabled
--name-reuse-scope

指示终结点名称重用范围。 默认值为 TenantReuse。

属性 值
参数组: Properties Arguments
接受的值: NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse
--no-wait

不等待长时间运行的操作完成。

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Endpoint Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az afd endpoint delete

删除具有指定订阅、资源组和配置文件下指定终结点名称的现有 AzureFrontDoor 终结点。

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]

示例

删除名为 endpoint1 的终结点。

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--endpoint-name --name -n

全局唯一的配置文件下的终结点的名称。

属性 值
参数组: Resource Id Arguments
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
参数组: Resource Id Arguments
--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az afd endpoint list

列出现有的 AzureFrontDoor 终结点。

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

示例

列出指定配置文件中的所有终结点。

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

必需参数

--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性 值
参数组: Pagination Arguments
--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性 值
参数组: Pagination Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az afd endpoint purge

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

示例

删除域 www.contoso.com 目录“/script”下的所有缓存内容

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

必需参数

--content-paths

要清除的内容的路径。 可以描述文件路径或通配符目录。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Contents Arguments

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--domains

域列表。 示例：“www.contoso.com, www.contoso1.com”支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Contents Arguments
--endpoint-name

全局唯一的配置文件下的终结点的名称。

属性 值
参数组: Resource Id Arguments
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
参数组: Resource Id Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az afd endpoint show

获取具有指定订阅、资源组和配置文件下指定终结点名称的现有 AzureFrontDoor 终结点。

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

示例

显示名为 endpoint1 的终结点的详细信息。

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--endpoint-name --name -n

全局唯一的配置文件下的终结点的名称。

属性 值
参数组: Resource Id Arguments
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
参数组: Resource Id Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az afd endpoint update

使用指定订阅、资源组和配置文件下的指定终结点名称更新新的 AzureFrontDoor 终结点。

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]

示例

将终结点的状态更新为已禁用。

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

属性 值
参数组: Generic Update Arguments
--enabled-state

是否启用此规则的使用。 允许的值为“Enabled”或“Disabled”。

属性 值
参数组: Properties Arguments
接受的值: Disabled, Enabled
--endpoint-name --name -n

全局唯一的配置文件下的终结点的名称。

属性 值
参数组: Resource Id Arguments
--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性 值
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性 值
参数组: Generic Update Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
参数组: Resource Id Arguments
--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

属性 值
参数组: Generic Update Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
参数组: Resource Id Arguments
--tags

资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Endpoint Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az afd endpoint wait

将 CLI 置于等待状态，直到满足条件。

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性 值
参数组: Wait Condition Arguments
默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性 值
参数组: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
参数组: Wait Condition Arguments
默认值: False
--endpoint-name --name -n

全局唯一的配置文件下的终结点的名称。

属性 值
参数组: Resource Id Arguments
--exists

等待资源存在。

属性 值
参数组: Wait Condition Arguments
默认值: False
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--interval

轮询间隔（以秒为单位）。

属性 值
参数组: Wait Condition Arguments
默认值: 30
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
参数组: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
参数组: Resource Id Arguments
--timeout

最大等待（以秒为单位）。

属性 值
参数组: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
参数组: Wait Condition Arguments
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False