次の方法で共有

az synapse sql ad-admin

  • リファレンス

SQL Active Directory 管理者を管理します。

コマンド

名前 説明 型 Status
az synapse sql ad-admin create

SQL Azure Active Directory 管理者を作成します。

 コア GA
az synapse sql ad-admin delete

SQL Azure Active Directory 管理者を削除します。

 コア GA
az synapse sql ad-admin show

SQL Azure Active Directory 管理者を取得します。

 コア GA
az synapse sql ad-admin update

SQL Azure Active Directory 管理者を更新します。

 コア GA
az synapse sql ad-admin wait

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

 コア GA

az synapse sql ad-admin create

編集

SQL Azure Active Directory 管理者を作成します。

az synapse sql ad-admin create --display-name
                               --object-id
                               --resource-group
                               --workspace-name
                               [--no-wait]

例

SQL Azure Active 管理者を作成します。

az synapse sql ad-admin create --workspace-name testsynapseworkspace --resource-group rg \
--display-name youraccount@yourdomain --object-id 00000000-0000-0000-0000-000000000000

必須のパラメーター

--display-name -u

Azure AD 管理者ユーザーまたはグループの表示名。

--object-id -i

Azure AD 管理者の一意の ID。

--resource-group -g

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

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: 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 synapse sql ad-admin delete

編集

SQL Azure Active Directory 管理者を削除します。

az synapse sql ad-admin delete --resource-group
                               --workspace-name
                               [--no-wait]
                               [--yes]

例

SQL Azure Active 管理者を削除します。

az synapse sql ad-admin delete --workspace-name testsynapseworkspace --resource-group rg

必須のパラメーター

--resource-group -g

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

--workspace-name

ワークスペース名。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--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 synapse sql ad-admin show

編集

SQL Azure Active Directory 管理者を取得します。

az synapse sql ad-admin show --resource-group
                             --workspace-name

例

SQL Azure Active 管理者を取得します。

az synapse sql ad-admin show --workspace-name testsynapseworkspace --resource-group rg

必須のパラメーター

--resource-group -g

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

--workspace-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 synapse sql ad-admin update

編集

SQL Azure Active Directory 管理者を更新します。

az synapse sql ad-admin update --resource-group
                               --workspace-name
                               [--add]
                               [--display-name]
                               [--force-string]
                               [--no-wait]
                               [--object-id]
                               [--remove]
                               [--set]

例

SQL Azure Active 管理者を更新します。

az synapse sql ad-admin update --workspace-name testsynapseworkspace --resource-group rg \
--display-name youraccount@yourdomain --object-id 00000000-0000-0000-0000-000000000000

必須のパラメーター

--resource-group -g

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

--workspace-name

ワークスペース名。

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

既定値: []
--display-name -u

Azure AD 管理者ユーザーまたはグループの表示名。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

既定値: False
--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--object-id -i

Azure AD 管理者の一意の ID。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

既定値: []
--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

既定値: []
グローバル パラメーター
--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 synapse sql ad-admin wait

編集

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

az synapse sql ad-admin wait --resource-group
                             --workspace-name
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--interval]
                             [--timeout]
                             [--updated]

必須のパラメーター

--resource-group -g

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

--workspace-name

ワークスペース名。

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--exists

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

既定値: False
--interval

ポーリング間隔 (秒単位)。

既定値: 30
--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 を使います。