az ad ds

  • 実験用
  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の ad 拡張機能の一部です。 az ad ds コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細をご覧ください。

このコマンド グループは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Active Directory を使用してドメイン サービスを管理します。

コマンド

名前 説明 型 状態
az ad ds create

指定したパラメーターを使用して新しいドメイン サービスを作成します。

 拡張子 実験用
az ad ds delete

ドメイン サービスの削除操作は、既存のドメイン サービスを削除します。

 拡張子 実験用
az ad ds list

リソース グループまたはサブスクリプション内のドメイン サービスを一覧表示します。

 拡張子 実験用
az ad ds show

指定したドメイン サービスを取得します。

 拡張子 実験用
az ad ds update

ドメイン サービスの既存の展開プロパティを更新します。

 拡張子 実験用
az ad ds wait

広告 ds の条件が満たされるまで、CLI を待機状態にします。

 拡張子 実験用

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"

指定した設定で Domain Service を作成する (読みやすさのみを目的とした改行)

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

ユーザーが Domain Services をデプロイする Azure ドメインの名前。

--name -n

ドメイン サービスの名前。

--replica-sets

ReplicaSet の一覧。

使用法: --replica-sets location=XX subnet-id=XX

location: Virtual Network location subnet-id: Domain Services がデプロイされるサブネットの ID。

複数の --replica-sets 引数を使用して、複数のアクションを指定できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--domain-config-type

ドメイン構成の種類。

指定可能な値: FullySynced, ResourceTrusting
--external-access

インターネット経由の Secure LDAP アクセスが有効か無効かを判断するフラグ。

指定可能な値: Disabled, Enabled
--filtered-sync

グループベースのフィルター処理された同期を有効にするには、フラグを有効または無効にします。

指定可能な値: Disabled, Enabled
--ldaps

Secure 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

Secure LDAP を構成するために必要な証明書。 ここで渡すパラメーターは、証明書 pfx ファイルへのファイル パス、または証明書 pfx ファイルの base64encoded 表現である必要があります。

--pfx-cert-pwd

指定された Secure 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

1 つまたは複数のリソース 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

1 つまたは複数のリソース 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

インターネット経由の Secure LDAP アクセスが有効か無効かを判断するフラグ。

指定可能な値: Disabled, Enabled
--filtered-sync

グループベースのフィルター処理された同期を有効にするには、フラグを有効または無効にします。

指定可能な値: Disabled, Enabled
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--ldaps

Secure 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

Secure LDAP を構成するために必要な証明書。 ここで渡すパラメーターは、証明書 pfx ファイルへのファイル パス、または証明書 pfx ファイルの base64encoded 表現である必要があります。

--pfx-cert-pwd

指定された Secure LDAP 証明書 pfx ファイルを復号化するためのパスワード。

--replica-sets

ReplicaSet の一覧。

使用法: --replica-sets location=XX subnet-id=XX

location: Virtual Network location subnet-id: Domain Services がデプロイされるサブネットの 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

広告 ds の条件が満たされるまで、CLI を待機状態にします。

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

例

広告 ds が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

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

広告 ds が正常に更新されるまで、CLI スクリプトの次の行の実行を一時停止します。

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

広告 ds が正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

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

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False
--exists

リソースが存在するまで待ちます。

規定値: False
--ids

1 つまたは複数のリソース 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 を使います。