az adp workspace

Note

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

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

コマンド

名前 説明 Status
az adp workspace create

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

拡張 GA
az adp workspace delete

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

拡張 GA
az adp workspace list

サブスクリプション ID でワークスペース リソースを一覧表示します。

拡張 GA
az adp workspace show

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

拡張 GA
az adp workspace update

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

拡張 GA
az adp workspace wait

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

拡張 GA

az adp workspace create

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

az adp workspace create --name
                        --resource-group
                        [--data-location]
                        [--direct-read-access {Disabled, Enabled}]
                        [--domain-name-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                        [--encryption]
                        [--identity]
                        [--location]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--source-resource-id]
                        [--storage-account-count]
                        [--storage-sku]
                        [--tags]

LRS SKU を使用して 3 つのストレージ アカウントを持つワークスペースを作成する

az adp workspaces create --name sample-ws --subscription sample-subscription --resource-group sample-rg --location westus3 --storage-account-count 3 --storage-sku name=Standard_LRS

暗号化を使用してワークスペースを作成する

az adp workspace create --name sample-ws --resource-group sample-rg --location westus3 --encryption key-encryption-key-url=https://contosovault.vault.azure.net/keys/contosokek user-assigned-identity-resource-id=/subscriptions/<subscriptionid>/resourceGroups/<resourcegroup>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId

必須のパラメーター

--name --workspace-name -n

ワークスペース名。

--resource-group -g

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

省略可能のパラメーター

--data-location

ワークスペースのデータの場所。 指定しない場合は、既定でリソースの場所が指定されます。

--direct-read-access

Azure RBAC に従ってワークスペースの基になる Azure リソースへの直接データ プレーン読み取りアクセスを有効にします (したがって、自律開発プラットフォームの承認システムをバイパスします)。

承認された値: Disabled, Enabled
--domain-name-scope

FQDN ラベル生成のスコープ。 指定しない場合は、既定で TenantReuse が使用されます。

承認された値: NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse
--encryption

暗号化の構成。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--identity

このリソースに割り当てられているマネージド サービス ID。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--source-resource-id

このワークスペースのデータを生成したソース リソースの ARM ID。

--storage-account-count

ワークスペースごとにプロビジョニングされたストレージ アカウントの量。 指定しない場合、既定値は 5 です。

--storage-sku

Storage SKU。 指定しない場合は、既定でStandard_ZRS。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--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 adp workspace delete

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

az adp workspace delete [--ids]
                        [--name]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--subscription]
                        [--yes]

ワークスペースの削除

az adp workspace delete --subscription sample-subscription --resource-group sample-rg --name sample-ws

省略可能のパラメーター

--ids

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

--name --workspace-name -n

ワークスペース名。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--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 adp workspace list

サブスクリプション ID でワークスペース リソースを一覧表示します。

az adp workspace list [--resource-group]

リソース グループ内のワークスペースを一覧表示する

az adp workspace list --subscription sample-subscription --resource-group sample-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 adp workspace show

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

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

リソース グループにワークスペースを表示する

az adp workspace show --subscription sample-subscription --resource-group sample-rg --name sample-ws

省略可能のパラメーター

--ids

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

--name --workspace-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 adp workspace update

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

az adp workspace update [--add]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--identity]
                        [--ids]
                        [--name]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]
                        [--tags]

ワークスペースを 3 つのストレージ アカウントに更新する

az adp workspace update --subscription sample-rg --resource-group sample-rg --workspace-name sample-ws --set properties.StorageAccountCount=3

省略可能のパラメーター

--add

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

--force-string

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--identity

このリソースに割り当てられているマネージド サービス ID。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--ids

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

--name --workspace-name -n

ワークスペース名。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--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 adp workspace wait

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

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

省略可能のパラメーター

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