az synapse workspace

リファレンス

Synapse ワークスペースを管理します。

コマンド

名前	説明	型	Status
az synapse workspace activate	ワークスペースをアクティブ化し、ワークスペースが最初にプロビジョニングされ、二重暗号化が有効になっているときに、その状態を保留中から成功状態に変更します。	コア	GA
az synapse workspace check-name	Synapse ワークスペース名が使用可能かどうかを確認します。	コア	GA
az synapse workspace create	Synapse ワークスペースを作成します。	コア	GA
az synapse workspace delete	Synapse ワークスペースを削除します。	コア	GA
az synapse workspace firewall-rule	ワークスペースのファイアウォール規則を管理します。	コア	GA
az synapse workspace firewall-rule create	ファイアウォール規則を作成します。	コア	GA
az synapse workspace firewall-rule delete	ファイアウォール規則を削除します。	コア	GA
az synapse workspace firewall-rule list	すべてのファイアウォール規則を一覧表示します。	コア	GA
az synapse workspace firewall-rule show	ファイアウォール規則を取得します。	コア	GA
az synapse workspace firewall-rule update	ファイアウォール規則を更新します。	コア	GA
az synapse workspace firewall-rule wait	ファイアウォール規則の条件が満たされるまで、CLI を待機状態にします。	コア	GA
az synapse workspace key	ワークスペースのキーを管理します。	コア	GA
az synapse workspace key create	ワークスペースのキーを作成します。	コア	GA
az synapse workspace key delete	ワークスペースのキーを削除します。アクティブな状態のキーは削除できません。	コア	GA
az synapse workspace key list	指定したワークスペースの下にキーを一覧表示します。	コア	GA
az synapse workspace key show	ワークスペースのキーを名前で表示します。	コア	GA
az synapse workspace key wait	ワークスペースキーの条件が満たされるまで、CLI を待機状態にします。	コア	GA
az synapse workspace list	すべての Synapse ワークスペースを一覧表示します。	コア	GA
az synapse workspace managed-identity	ワークスペースのマネージド ID を管理します。	コア	GA
az synapse workspace managed-identity grant-sql-access	マネージド ID へのワークスペースの sql アクセス権を付与します。	コア	GA
az synapse workspace managed-identity revoke-sql-access	マネージド ID へのワークスペースの sql アクセスを取り消します。	コア	GA
az synapse workspace managed-identity show-sql-access	ワークスペースの SQL アクセス状態をマネージド ID に表示します。	コア	GA
az synapse workspace managed-identity wait	マネージド ID への sql アクセス状態の条件が満たされるまで、CLI を待機状態にします。	コア	GA
az synapse workspace show	Synapse ワークスペースを取得します。	コア	GA
az synapse workspace update	Synapse ワークスペースを更新します。	コア	GA
az synapse workspace wait	ワークスペースの条件が満たされるまで、CLI を待機状態にします。	コア	GA

az synapse workspace activate

編集

ワークスペースをアクティブ化し、ワークスペースが最初にプロビジョニングされ、二重暗号化が有効になっているときに、その状態を保留中から成功状態に変更します。

Azure Synapse Analytics ワークスペースを作成するときに、ワークスペースに二重暗号化を提供するカスタマーマネージドキーを使用して、ワークスペース内のすべての保存データを暗号化することを選択できます。消去保護を有効にしてキーコンテナーを作成し、キーコンテナーへのアクセスポリシーを指定するなど、暗号化環境を最初に設定する必要がある場合があります。次に、このコマンドレットを使用して、カスタマーマネージドキーを使用して二重暗号化が有効になっている新しい Azure Synapse Analytics ワークスペースをアクティブ化します。

az synapse workspace activate --key-identifier
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]
                              [--workspace-name]

例

ワークスペースをアクティブ化します。

az synapse workspace activate --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}

必須のパラメーター

--key-identifier

ワークスペース暗号化キーの Key Vault URL。は、https://{keyvaultname}.vault.azure.net/keys/{keyname} の形式にする必要があります。

省略可能のパラメーター

--ids

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

--name -n

ワークスペースのカスタマーマネージドキーの表示名。既存のすべてのキーは、/"az synapse workspace key list/" コマンドレットを使用して見つけることができます。

--no-wait

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

既定値: False

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--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 workspace check-name

編集

Synapse ワークスペース名が使用可能かどうかを確認します。

az synapse workspace check-name --name

例

Synapse ワークスペース名が使用可能かどうかを確認します。

az synapse workspace check-name --name testsynapseworkspace

必須のパラメーター

--name -n

チェックする名前。

グローバルパラメーター

--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 workspace create

編集

Synapse ワークスペースを作成します。

az synapse workspace create --file-system
                            --name
                            --resource-group
                            --sql-admin-login-password
                            --sql-admin-login-user
                            --storage-account
                            [--account-name]
                            [--allowed-tenant-ids]
                            [--cmk]
                            [--collaboration-branch]
                            [--enable-managed-virtual-network {false, true}]
                            [--host-name]
                            [--key-name]
                            [--last-commit-id]
                            [--location]
                            [--managed-rg-name]
                            [--no-wait]
                            [--prevent-data-exfiltration {false, true}]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--root-folder]
                            [--tags]
                            [--tenant-id]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

例

Synapse ワークスペースを作成する

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

ストレージリソース ID を使用して Synapse ワークスペースを作成する

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

カスタマーマネージドキーを使用して Synapse ワークスペースを作成する

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname} --key-name testcmk \
  --use-sami-in-encrypt True

Azure devops に接続する Synapse ワークスペースを作成する

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --repository-type AzureDevOpsGit --account-name testuser --project-name testprj \
  --repository-name testrepo --collaboration-branch main --last-commit-id 000000

マネージドリソースグループを使用して Synapse ワークスペースを作成する

az synapse workspace create --name testworkspace --resource-group rg \
  --managed-rg-name managedrg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

ユーザー割り当てマネージド ID を使用して Synapse ワークスペースを作成する

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

必須のパラメーター

--file-system

Data Lake ストレージアカウントのファイルシステム。

--name -n

ワークスペース名。

--resource-group -g

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

--sql-admin-login-password -p

SQL 管理者のログインパスワード。

--sql-admin-login-user -u

SQL 管理者ログインユーザー名。

--storage-account

Data Lake ストレージアカウント名またはリソース ID。

省略可能のパラメーター

--account-name

リポジトリまたは Azure devops 組織名に使用される GitHub アカウント名。

--allowed-tenant-ids

送信データトラフィックが許可された承認済みの Azure AD テナント。現在のユーザーの Azure AD テナントは、既定で含まれます。 (PowerShell の場合は '' ) を使用して、許可されているすべてのテナント ID を無効にします。

--cmk --key-identifier

ワークスペース内のすべての保存データを暗号化するために使用されるカスタマーマネージドキー。キー識別子は、https://{keyvaultname}.vault.azure.net/keys/{keyname} の形式にする必要があります。

--collaboration-branch

他のユーザーと共同作業を行い、公開元となるブランチ名。

--enable-managed-virtual-network --enable-managed-vnet

このフラグは、マネージド仮想ネットワークを有効にするかどうかを示します。

承認された値: false, true

--host-name

github Enterprise Server を使用する場合は、GitHub Enterprise Cloud でこのオプションを使用しないように、サーバー URL を https://github.mydomain.com.Do 指定します。

--key-name

ワークスペースのカスタマーマネージドキーの表示名。既存のすべてのキーは、"az synapse workspace key list" コマンドレットを使用して見つけることができます。

既定値: default

--last-commit-id

最後のコミット ID。

--location -l

場所。値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--managed-rg-name

ワークスペースマネージドリソースグループ。リソースグループ名は、ユーザー subscriptionId 内のリソースグループを一意に識別します。

--no-wait

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

既定値: False

--prevent-data-exfiltration --prevent-exfiltration

このフラグは、データ流出を有効にするかどうかを示します。

承認された値: false, true

--project-name

接続先のプロジェクト名。

--repository-name

接続先のリポジトリの名前。

--repository-type

リポジトリ構成の種類。

承認された値: AzureDevOpsGit, GitHub

--root-folder

Azure synapse JSON リソースの場所へのフォルダーの名前がインポートされます。既定値は /です。

既定値: /

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--tenant-id

Azure devops の接続に使用されるテナント ID。

--uami-id

ワークスペースのユーザー割り当てマネージド ID の一覧。

--uami-id-in-encrypt

ワークスペース暗号化で使用されるユーザー割り当て ID リソース ID。

--use-sami-in-encrypt

ワークスペース暗号化でシステム割り当て ID を使用するかどうか。 uami を使用する場合は、True を設定してください。そうでない場合は 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 workspace delete

編集

Synapse ワークスペースを削除します。

az synapse workspace delete [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]
                            [--yes]

例

Synapse ワークスペースを削除します。

az synapse workspace delete --name testsynapseworkspace --resource-group rg

省略可能のパラメーター

--ids

--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 synapse workspace list

編集

すべての Synapse ワークスペースを一覧表示します。

az synapse workspace list [--resource-group]

例

サブスクリプションのすべての Synapse ワークスペースを一覧表示する

az synapse workspace list

特定のリソースグループのすべての Synapse ワークスペースを一覧表示する

az synapse workspace list --resource-group rg

省略可能のパラメーター

--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 synapse workspace show

編集

Synapse ワークスペースを取得します。

az synapse workspace show [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]

例

Synapse ワークスペースを取得します。

az synapse workspace show --name testsynapseworkspace --resource-group rg

省略可能のパラメーター

--ids

--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 synapse workspace update

編集

Synapse ワークスペースを更新します。

az synapse workspace update [--account-name]
                            [--allowed-tenant-ids]
                            [--collaboration-branch]
                            [--host-name]
                            [--ids]
                            [--key-name]
                            [--last-commit-id]
                            [--name]
                            [--no-wait]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--resource-group]
                            [--root-folder]
                            [--sql-admin-login-password]
                            [--subscription]
                            [--tags]
                            [--tenant-id]
                            [--uami-action {Add, Remove, Set}]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

例

Synapse ワークスペースを更新する

az synapse workspace update --name fromcli4 --resource-group rg \
  --tags key1=value1

Synapse ワークスペースを更新し、ユーザー割り当てマネージド ID を追加する

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Add --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Synapse ワークスペースの更新、ユーザー割り当てマネージド ID の削除

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Remove --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Synapse ワークスペースの更新、ユーザー割り当てマネージド ID の書き換え

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Set --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Synapse ワークスペースを更新し、ワークスペース暗号化 uami を設定する

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-id-in-encrypt "{your-encrytion-uami-resourceid}" --use-sami-in-encrypt False

省略可能のパラメーター

--account-name

リポジトリまたは Azure devops 組織名に使用される GitHub アカウント名。

--allowed-tenant-ids

--collaboration-branch

他のユーザーと共同作業を行い、公開元となるブランチ名。

--host-name

--ids

--key-name

--last-commit-id

最後のコミット ID。

--name -n

ワークスペース名。

--no-wait

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

既定値: False

--project-name

接続先のプロジェクト名。

--repository-name

接続先のリポジトリの名前。

--repository-type

リポジトリ構成の種類。

承認された値: AzureDevOpsGit, GitHub

--resource-group -g

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

--root-folder

Azure synapse JSON リソースの場所へのフォルダーの名前がインポートされます。既定値は /です。

--sql-admin-login-password -p

SQL 管理者のログインパスワード。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--tenant-id

Azure devops の接続に使用されるテナント ID。

--uami-action

ワークスペースのユーザー割り当てマネージド ID を追加/削除/設定する場合は、アクションを指定する必要があります。サポートされるアクションは、追加、削除、Set.Add は、ワークスペースのユーザー割り当てマネージド ID を追加することを意味し、削除はユーザー割り当てマネージド ID をワークスペースから削除することを意味します。Set は、ユーザー割り当てマネージド ID を同時に追加および削除する場合に使用できます。現在の ID は、指定された ID によってカバーされます。

承認された値: Add, Remove, Set

--uami-id

ワークスペースのユーザー割り当てマネージド ID の一覧。

--uami-id-in-encrypt

ワークスペース暗号化で使用されるユーザー割り当て ID リソース ID。

--use-sami-in-encrypt

グローバルパラメーター

--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 workspace wait

編集

ワークスペースの条件が満たされるまで、CLI を待機状態にします。

az synapse workspace 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 を使います。

次の方法で共有

az synapse workspace

コマンド

az synapse workspace activate

例

必須のパラメーター

省略可能のパラメーター

az synapse workspace check-name

例

必須のパラメーター

az synapse workspace create

例

必須のパラメーター

省略可能のパラメーター

az synapse workspace delete

例

省略可能のパラメーター

az synapse workspace list

例

省略可能のパラメーター

az synapse workspace show

例

省略可能のパラメーター

az synapse workspace update

例

省略可能のパラメーター

az synapse workspace wait

必須のパラメーター

省略可能のパラメーター

その他のリソース