通过

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

az ad ds

  • 实验
  • 参考

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的广告扩展的一部分。 该扩展将在首次运行 az ad ds 命令时自动安装。 详细了解扩展。

此命令组是试验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

使用 Azure Active Directory 管理域服务。

命令

名称 说明 类型 Status
az ad ds create

使用指定的参数创建新的域服务。

 扩展 实验
az ad ds delete

删除域服务操作将删除现有的域服务。

 扩展 实验
az ad ds list

列出资源组或订阅中的域服务。

 扩展 实验
az ad ds show

获取指定的域服务。

 扩展 实验
az ad ds update

更新域服务的现有部署属性。

 扩展 实验
az ad ds wait

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

 扩展 实验

az ad ds create

实验

命令组“ad ds”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

使用指定的参数创建新的域服务。

az ad ds create --domain
                --name
                --replica-sets
                --resource-group
                [--domain-config-type {FullySynced, ResourceTrusting}]
                [--external-access {Disabled, Enabled}]
                [--filtered-sync {Disabled, Enabled}]
                [--ldaps {Disabled, Enabled}]
                [--no-wait]
                [--notify-dc-admins {Disabled, Enabled}]
                [--notify-global-admins {Disabled, Enabled}]
                [--notify-others]
                [--ntlm-v1 {Disabled, Enabled}]
                [--pfx-cert]
                [--pfx-cert-pwd]
                [--resource-forest {Disabled, Enabled}]
                [--settings]
                [--sku {Enterprise, Premium, Standard}]
                [--sync-kerberos-pwd {Disabled, Enabled}]
                [--sync-ntlm-pwd {Disabled, Enabled}]
                [--sync-on-prem-pwd {Disabled, Enabled}]
                [--tags]
                [--tls-v1 {Disabled, Enabled}]

示例

创建域服务

az ad ds create --domain "TestDS.com" --replica-sets location="West US" subnet-id="<subnetId>" --name "TestDS.com" --resource-group "rg"

创建具有指定设置的域服务（仅可读性换行符）

az ad ds create --domain "TestDS.com" --replica-sets location="West US" subnet-id="<subnetId>" --name "TestDS.com" --resource-group "rg"
--ntlm-v1 "Enabled" --sync-ntlm-pwd "Enabled" --tls-v1 "Disabled" --filtered-sync "Enabled" --external-access "Enabled"
--ldaps "Enabled" --pfx-cert "cert or path to cert" --pfx-cert-pwd "<pfxCertificatePassword>"
--notify-others "a@gmail.com" "b@gmail.com" --notify-dc-admins "Enabled" --notify-global-admins "Enabled"

必需参数

--domain

用户希望将域服务部署到的 Azure 域的名称。

--name -n

域服务的名称。

--replica-sets

ReplicaSet 列表。

用法：--replica-sets location=XX subnet-id=XX

location：虚拟网络位置子网 ID：将部署域服务的子网的 ID。

可以使用多个 --replica-sets 参数指定多个操作。

--resource-group -g

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

可选参数

--domain-config-type

域配置类型。

接受的值: FullySynced, ResourceTrusting
--external-access

用于确定是否启用或禁用通过 Internet 进行安全 LDAP 访问的标志。

接受的值: Disabled, Enabled
--filtered-sync

启用或禁用标志以启用基于组的筛选同步。

接受的值: Disabled, Enabled
--ldaps

用于确定是否启用或禁用安全 LDAP 的标志。

接受的值: Disabled, Enabled
--no-wait

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

默认值: False
--notify-dc-admins

应通知域控制器管理员。

接受的值: Disabled, Enabled
--notify-global-admins

应通知全局管理员。

接受的值: Disabled, Enabled
--notify-others

其他收件人的列表。

--ntlm-v1

用于确定 NtlmV1 是启用或禁用的标志。

接受的值: Disabled, Enabled
--pfx-cert

配置安全 LDAP 所需的证书。 此处传递的参数应该是证书 pfx 文件的文件路径或证书 pfx 文件的 base64encoded 表示形式。

--pfx-cert-pwd

用于解密提供的安全 LDAP 证书 pfx 文件的密码。

--resource-forest

资源林。

接受的值: Disabled, Enabled
--settings

资源林的设置列表。 这可以是 JSON 格式的字符串，也可以是包含 JSON 对象的文件的位置。

资源林的设置 JSON 对象的格式：[ { “trusted_domain_fqdn”： “XX”， “trust_direction”： “XX”， “friendly_name”： “XX”， “remote_dns_ips”： “XX”， “trust_password”： “XX” }， ...n ].

--sku

Sku 类型。

接受的值: Enterprise, Premium, Standard
--sync-kerberos-pwd

用于确定是否启用或禁用 SyncKerberosPasswords 的标志。

接受的值: Disabled, Enabled
--sync-ntlm-pwd

用于确定是否启用或禁用 SyncNtlmPasswords 的标志。

接受的值: Disabled, Enabled
--sync-on-prem-pwd

用于确定是否启用或禁用 SyncOnPremPasswords 的标志。

接受的值: Disabled, Enabled
--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--tls-v1

用于确定 TlsV1 是启用或禁用的标志。

接受的值: Disabled, Enabled
全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az ad ds delete

实验

命令组“ad ds”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

删除域服务操作将删除现有的域服务。

az ad ds delete [--ids]
                [--name]
                [--no-wait]
                [--resource-group]
                [--subscription]
                [--yes]

示例

删除域服务

az ad ds delete --name "TestDomainService.com" --resource-group "TestResourceGroup"

可选参数

--ids

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

--name -n

域服务的名称。

--no-wait

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

默认值: False
--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

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

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az ad ds list

实验

命令组“ad ds”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

列出资源组或订阅中的域服务。

az ad ds list [--resource-group]

示例

按组列出域服务

az ad ds list --resource-group "TestResourceGroup"

按子列出域服务

az ad ds list

可选参数

--resource-group -g

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az ad ds show

实验

命令组“ad ds”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

获取指定的域服务。

az ad ds show [--ids]
              [--name]
              [--resource-group]
              [--subscription]

示例

获取域服务

az ad ds show --name "TestDomainService.com" --resource-group "TestResourceGroup"

可选参数

--ids

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

--name -n

域服务的名称。

--resource-group -g

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

--subscription

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

全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az ad ds update

实验

命令组“ad ds”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

更新域服务的现有部署属性。

az ad ds update [--domain-config-type {FullySynced, ResourceTrusting}]
                [--external-access {Disabled, Enabled}]
                [--filtered-sync {Disabled, Enabled}]
                [--ids]
                [--ldaps {Disabled, Enabled}]
                [--name]
                [--no-wait]
                [--notify-dc-admins {Disabled, Enabled}]
                [--notify-global-admins {Disabled, Enabled}]
                [--notify-others]
                [--ntlm-v1 {Disabled, Enabled}]
                [--pfx-cert]
                [--pfx-cert-pwd]
                [--replica-sets]
                [--resource-forest {Disabled, Enabled}]
                [--resource-group]
                [--settings]
                [--sku {Enterprise, Premium, Standard}]
                [--subscription]
                [--sync-kerberos-pwd {Disabled, Enabled}]
                [--sync-ntlm-pwd {Disabled, Enabled}]
                [--sync-on-prem-pwd {Disabled, Enabled}]
                [--tags]
                [--tls-v1 {Disabled, Enabled}]

示例

更新 sku

az ad ds update --name "TestDS.com" --resource-group "rg" --sku "Enterprise"

更新域安全设置

az ad ds update --name "TestDS.com" --resource-group "rg" --ntlm-v1 "Enabled" --tls-v1 "Disabled"

更新 ldaps 设置

az ad ds update --name "TestDS.com" --resource-group "rg" --external-access "Enabled" --ldaps "Enabled" --pfx-cert "MIIDPDCCAiSg..." --pfx-cert-pwd "<pfxCertificatePassword>"

更新通知设置

az ad ds update --name "TestDS.com" --resource-group "rg" --notify-dc-admins "Enabled" --notify-global-admins "Disabled"

可选参数

--domain-config-type

域配置类型。

接受的值: FullySynced, ResourceTrusting
--external-access

用于确定是否启用或禁用通过 Internet 进行安全 LDAP 访问的标志。

接受的值: Disabled, Enabled
--filtered-sync

启用或禁用标志以启用基于组的筛选同步。

接受的值: Disabled, Enabled
--ids

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

--ldaps

用于确定是否启用或禁用安全 LDAP 的标志。

接受的值: Disabled, Enabled
--name -n

域服务的名称。

--no-wait

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

默认值: False
--notify-dc-admins

应通知域控制器管理员。

接受的值: Disabled, Enabled
--notify-global-admins

应通知全局管理员。

接受的值: Disabled, Enabled
--notify-others

其他收件人的列表。

--ntlm-v1

用于确定 NtlmV1 是启用或禁用的标志。

接受的值: Disabled, Enabled
--pfx-cert

配置安全 LDAP 所需的证书。 此处传递的参数应该是证书 pfx 文件的文件路径或证书 pfx 文件的 base64encoded 表示形式。

--pfx-cert-pwd

用于解密提供的安全 LDAP 证书 pfx 文件的密码。

--replica-sets

ReplicaSet 列表。

用法：--replica-sets location=XX subnet-id=XX

location：虚拟网络位置子网 ID：将部署域服务的子网的 ID。

可以使用多个 --replica-sets 参数指定多个操作。

--resource-forest

资源林。

接受的值: Disabled, Enabled
--resource-group -g

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

--settings

资源林的设置列表。 这可以是 JSON 格式的字符串，也可以是包含 JSON 对象的文件的位置。

资源林的设置 JSON 对象的格式：[ { “trusted_domain_fqdn”： “XX”， “trust_direction”： “XX”， “friendly_name”： “XX”， “remote_dns_ips”： “XX”， “trust_password”： “XX” }， ...n ].

--sku

Sku 类型。

接受的值: Enterprise, Premium, Standard
--subscription

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

--sync-kerberos-pwd

用于确定是否启用或禁用 SyncKerberosPasswords 的标志。

接受的值: Disabled, Enabled
--sync-ntlm-pwd

用于确定是否启用或禁用 SyncNtlmPasswords 的标志。

接受的值: Disabled, Enabled
--sync-on-prem-pwd

用于确定是否启用或禁用 SyncOnPremPasswords 的标志。

接受的值: Disabled, Enabled
--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--tls-v1

用于确定 TlsV1 是启用或禁用的标志。

接受的值: Disabled, Enabled
全局参数
--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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

az ad ds wait

实验

命令组“ad ds”是实验性的，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

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

az ad ds wait [--created]
              [--custom]
              [--deleted]
              [--exists]
              [--ids]
              [--interval]
              [--name]
              [--resource-group]
              [--subscription]
              [--timeout]
              [--updated]

示例

暂停执行下一行 CLI 脚本，直到广告 ds 成功创建。

az ad ds wait --name "TestDomainService.com" --resource-group "TestResourceGroup" --created

暂停执行下一行 CLI 脚本，直到广告 ds 成功更新。

az ad ds wait --name "TestDomainService.com" --resource-group "TestResourceGroup" --updated

暂停执行下一行 CLI 脚本，直到成功删除 ad ds。

az ad ds wait --name "TestDomainService.com" --resource-group "TestResourceGroup" --deleted

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

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

--interval

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

默认值: 30
--name -n

域服务的名称。

--resource-group -g

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

--subscription

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

--timeout

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

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

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

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

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

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

--subscription

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

--verbose

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