通过

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

az afd origin-group

管理指定配置文件下的源组。

命令

名称 说明 类型 Status
az afd origin-group create

在指定的配置文件中创建新的源组。

 Core GA
az afd origin-group delete

删除配置文件中的现有源组。

 Core GA
az afd origin-group list

列出配置文件中的所有现有源组。

 Core GA
az afd origin-group show

获取配置文件中的现有源组。

 Core GA
az afd origin-group update

更新指定配置文件中的新源组。

 Core GA
az afd origin-group wait

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

 Core GA

az afd origin-group create

在指定的配置文件中创建新的源组。

az afd origin-group create --name --origin-group-name
                           --profile-name
                           --resource-group
                           [--additional-latency-in-milliseconds]
                           [--authentication]
                           [--enable-health-probe {0, 1, f, false, n, no, t, true, y, yes}]
                           [--health-probe-settings]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--probe-interval-in-seconds]
                           [--probe-path]
                           [--probe-protocol {Http, Https, NotSet}]
                           [--probe-request-type {GET, HEAD, NotSet}]
                           [--sample-size]
                           [--session-affinity-state {Disabled, Enabled}]
                           [--successful-samples-required]
                           [--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes]

示例

在指定的配置文件中创建新的源组。

az afd origin-group create --resource-group RG --profile-name profile1 --origin-group-name origingroup1 --sample-size 3 --successful-samples-required 3 --additional-latency-in-milliseconds 1000 --health-probe-settings "{probe-path:/path2,probe-request-type:NotSet,probe-protocol:NotSet,probe-interval-in-seconds:10}" --traffic-restoration-time-to-healed-or-new-endpoints-in-minutes 5

必需参数

--name --origin-group-name -n

终结点中唯一的源组的名称。

--profile-name

在资源组中唯一的 Azure Front Door 标准版或 Azure Front Door Premium 的名称。

--resource-group -g

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

可选参数

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

--additional-latency-in-milliseconds

探测的额外延迟（以毫秒为单位）会下降到最低延迟存储桶中。

属性 值
参数组: LoadBalancingSettings Arguments
--authentication

源组中源的身份验证设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--enable-health-probe

指示是否对源组启用探测。

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

用于确定源运行状况的源的运行状况探测设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--probe-interval-in-seconds

运行状况探测之间的秒数。默认值为 240sec。

属性 值
参数组: HealthProbeSettings Arguments
--probe-path

相对于用于确定源运行状况的源的路径。

属性 值
参数组: HealthProbeSettings Arguments
--probe-protocol

用于运行状况探测的协议。

属性 值
参数组: HealthProbeSettings Arguments
接受的值: Http, Https, NotSet
--probe-request-type

发出的运行状况探测请求的类型。

属性 值
参数组: HealthProbeSettings Arguments
接受的值: GET, HEAD, NotSet
--sample-size

负载均衡决策要考虑的样本数。

属性 值
参数组: LoadBalancingSettings Arguments
--session-affinity-state

是否允许在此主机上进行会话关联。 有效选项为“Enabled”或“Disabled”。

属性 值
参数组: Properties Arguments
接受的值: Disabled, Enabled
--successful-samples-required

采样期间必须成功的样本数。

属性 值
参数组: LoadBalancingSettings Arguments
--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes

当运行不正常的终结点或添加新终结点时，将流量逐渐转移到终结点的时间（以分钟为单位）。 默认值为 10 分钟。 目前不支持此属性。

属性 值
参数组: Properties 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 origin-group delete

删除配置文件中的现有源组。

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

示例

删除配置文件中的现有源组。

az afd origin-group delete -g group --origin-group-name og1 --profile-name profile

可选参数

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

--ids

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

属性 值
参数组: Resource Id Arguments
--name --origin-group-name -n

在配置文件中唯一的源组的名称。

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

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

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

在资源组中唯一的 Azure Front Door 标准版或 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 origin-group list

列出配置文件中的所有现有源组。

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

必需参数

--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 origin-group show

获取配置文件中的现有源组。

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

示例

获取配置文件中的现有源组。

az afd origin-group show --resource-group RG --profile-name profile1 --origin-group-name origingroup1

可选参数

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

--ids

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

属性 值
参数组: Resource Id Arguments
--name --origin-group-name -n

终结点中唯一的源组的名称。

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

在资源组中唯一的 Azure Front Door 标准版或 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 origin-group update

更新指定配置文件中的新源组。

az afd origin-group update [--add]
                           [--additional-latency-in-milliseconds]
                           [--authentication]
                           [--enable-health-probe {0, 1, f, false, n, no, t, true, y, yes}]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--health-probe-settings]
                           [--ids]
                           [--name --origin-group-name]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--probe-interval-in-seconds]
                           [--probe-path]
                           [--probe-protocol {Http, Https, NotSet}]
                           [--probe-request-type {GET, HEAD, NotSet}]
                           [--profile-name]
                           [--remove]
                           [--resource-group]
                           [--sample-size]
                           [--session-affinity-state {Disabled, Enabled}]
                           [--set]
                           [--subscription]
                           [--successful-samples-required]
                           [--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes]

示例

更新指定配置文件中的新源组。

az afd origin-group update -g group --origin-group-name og1 --profile-name profile --probe-request-type HEAD --probe-protocol Https --probe-interval-in-seconds 120 --probe-path /test1/azure.txt

可选参数

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

--add

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

属性 值
参数组: Generic Update Arguments
--additional-latency-in-milliseconds

探测的额外延迟（以毫秒为单位）会下降到最低延迟存储桶中。

属性 值
参数组: LoadBalancingSettings Arguments
--authentication

源组中源的身份验证设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--enable-health-probe

指示是否对源组启用探测。

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

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

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

用于确定源运行状况的源的运行状况探测设置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--ids

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

属性 值
参数组: Resource Id Arguments
--name --origin-group-name -n

终结点中唯一的源组的名称。

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

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--probe-interval-in-seconds

运行状况探测之间的秒数。默认值为 240sec。

属性 值
参数组: HealthProbeSettings Arguments
--probe-path

相对于用于确定源运行状况的源的路径。

属性 值
参数组: HealthProbeSettings Arguments
--probe-protocol

用于运行状况探测的协议。

属性 值
参数组: HealthProbeSettings Arguments
接受的值: Http, Https, NotSet
--probe-request-type

发出的运行状况探测请求的类型。

属性 值
参数组: HealthProbeSettings Arguments
接受的值: GET, HEAD, NotSet
--profile-name

在资源组中唯一的 Azure Front Door 标准版或 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
--sample-size

负载均衡决策要考虑的样本数。

属性 值
参数组: LoadBalancingSettings Arguments
--session-affinity-state

是否允许在此主机上进行会话关联。 有效选项为“Enabled”或“Disabled”。

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

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

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

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

属性 值
参数组: Resource Id Arguments
--successful-samples-required

采样期间必须成功的样本数。

属性 值
参数组: LoadBalancingSettings Arguments
--traffic-restoration-time-to-healed-or-new-endpoints-in-minutes

当运行不正常的终结点或添加新终结点时，将流量逐渐转移到终结点的时间（以分钟为单位）。 默认值为 10 分钟。 目前不支持此属性。

属性 值
参数组: Properties 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 origin-group wait

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

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

等待资源存在。

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

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

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

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

属性 值
参数组: Wait Condition Arguments
默认值: 30
--name --origin-group-name -n

终结点中唯一的源组的名称。

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

在资源组中唯一的 Azure Front Door 标准版或 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