通过

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

az cdn custom-domain

管理 Azure CDN 自定义域，为终结点提供自定义主机名。

命令

名称 说明 类型 Status
az cdn custom-domain create

在终结点中创建新的自定义域。

 Core GA
az cdn custom-domain delete

删除终结点中的现有自定义域。

 Core GA
az cdn custom-domain disable-https

禁用自定义域的 https 传递。

 Core GA
az cdn custom-domain enable-https

为自定义域启用 HTTPS。 可以使用“az cdn custom-domain list”获取自定义域的资源名称。

 Core GA
az cdn custom-domain list

列出终结点中的所有现有自定义域。

 Core GA
az cdn custom-domain show

获取终结点中的现有自定义域。

 Core GA
az cdn custom-domain update

更新终结点中的新自定义域。

 Core GA
az cdn custom-domain wait

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

 Core GA

az cdn custom-domain create

编辑

在终结点中创建新的自定义域。

az cdn custom-domain create --custom-domain-name --name
                            --endpoint-name
                            --profile-name
                            --resource-group
                            [--hostname]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

示例

在终结点和配置文件中使用资源名称 customdomain1 创建自定义域。

az cdn custom-domain create -g group --endpoint-name endpoint --profile-name profile -n customdomain1 --hostname www.example.com

必需参数

--custom-domain-name --name -n

终结点中自定义域的名称。

--endpoint-name

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

--profile-name

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

--resource-group -g

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

可选参数

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

--hostname

自定义域的主机名。 必须是域名。

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

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--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 cdn custom-domain delete

编辑

删除终结点中的现有自定义域。

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

示例

删除 CDN 的自定义域。

az cdn custom-domain delete -g group --endpoint-name endpoint --profile-name profile -n customdomain1

可选参数

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

--custom-domain-name --name -n

终结点中自定义域的名称。

属性 值
参数组: Resource Id 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

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

属性 值
参数组: 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 cdn custom-domain disable-https

编辑

禁用自定义域的 https 传递。

az cdn custom-domain disable-https --endpoint-name
                                   --name
                                   --profile-name
                                   --resource-group

必需参数

--endpoint-name

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

--name -n

自定义域的资源名称。

--profile-name

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

--resource-group -g

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

全局参数
--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 cdn custom-domain enable-https

编辑

为自定义域启用 HTTPS。 可以使用“az cdn custom-domain list”获取自定义域的资源名称。

az cdn custom-domain enable-https --endpoint-name
                                  --name
                                  --profile-name
                                  --resource-group
                                  [--min-tls-version {1.0, 1.2, none}]
                                  [--user-cert-group-name]
                                  [--user-cert-protocol-type {ip, sni}]
                                  [--user-cert-secret-name]
                                  [--user-cert-secret-version]
                                  [--user-cert-subscription-id]
                                  [--user-cert-vault-name]

示例

使用 CDN 管理的证书为具有资源名称 customdomain1 的自定义域启用 HTTPS

az cdn custom-domain enable-https -g group --profile-name profile --endpoint-name endpoint -n customdomain1

使用 CDN 管理的证书为具有资源名称 customdomain1 的自定义域启用 HTTPS，并将最低 TLS 版本设置为 1.2

az cdn custom-domain enable-https -g group --profile-name profile --endpoint-name endpoint -n customdomain1 --min-tls-version 1.2

必需参数

--endpoint-name

父终结点的名称。

--name -n

自定义域的资源名称。

--profile-name

父配置文件的名称。

--resource-group -g

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

可选参数

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

--min-tls-version

自定义域所需的最低 TLS 版本。

属性 值
接受的值: 1.0, 1.2, none
--user-cert-group-name

KeyVault 证书的资源组。

属性 值
参数组: Bring Your Own Certificate Arguments
--user-cert-protocol-type

证书的协议类型。

属性 值
参数组: Bring Your Own Certificate Arguments
接受的值: ip, sni
--user-cert-secret-name

KeyVault 证书的机密名称。

属性 值
参数组: Bring Your Own Certificate Arguments
--user-cert-secret-version

KeyVault 证书的机密版本（如果未指定），则始终使用“最新”版本，并且部署的证书将在更新版本的证书可用时自动轮换到最新版本。

属性 值
参数组: Bring Your Own Certificate Arguments
--user-cert-subscription-id

KeyVault 证书的订阅 ID。

属性 值
参数组: Bring Your Own Certificate Arguments
--user-cert-vault-name

KeyVault 证书的保管库名称。

属性 值
参数组: Bring Your Own Certificate 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 cdn custom-domain list

编辑

列出终结点中的所有现有自定义域。

az cdn custom-domain list --endpoint-name
                          --profile-name
                          --resource-group
                          [--max-items]
                          [--next-token]

必需参数

--endpoint-name

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

--profile-name

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

--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 cdn custom-domain show

编辑

获取终结点中的现有自定义域。

az cdn custom-domain show [--custom-domain-name --name]
                          [--endpoint-name]
                          [--ids]
                          [--profile-name]
                          [--resource-group]
                          [--subscription]

示例

获取具有资源名称 customdomain1 的自定义域的详细信息。

az cdn custom-domain show -g group --endpoint-name endpoint --profile-name profile -n customdomain1

可选参数

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

--custom-domain-name --name -n

终结点中自定义域的名称。

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

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

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

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

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

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

属性 值
参数组: 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 cdn custom-domain update

编辑

更新终结点中的新自定义域。

az cdn custom-domain update [--add]
                            [--custom-domain-name --name]
                            [--endpoint-name]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--hostname]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--profile-name]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--subscription]

可选参数

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

--add

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

属性 值
参数组: Generic Update Arguments
--custom-domain-name --name -n

终结点中自定义域的名称。

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

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

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

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

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

自定义域的主机名。 必须是域名。

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

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

属性 值
参数组: 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
全局参数
--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 cdn custom-domain wait

编辑

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

az cdn custom-domain wait [--created]
                          [--custom]
                          [--custom-domain-name --name]
                          [--deleted]
                          [--endpoint-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
--custom-domain-name --name -n

终结点中自定义域的名称。

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

等到删除为止。

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

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

属性 值
参数组: 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

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

属性 值
参数组: 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