az databox job

Note

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

データ ボックス ジョブを管理します。

コマンド

名前	説明	型	Status
az databox job cancel	CancelJob。	拡張	GA
az databox job create	指定したパラメーターを使用して新しいジョブを作成します。	拡張	GA
az databox job delete	ジョブを削除します。	拡張	GA
az databox job list	サブスクリプションで使用可能なすべてのジョブを一覧表示します。	拡張	GA
az databox job list-credential	このメソッドは、ジョブに関連する暗号化されていないシークレットを取得します。	拡張	GA
az databox job mark-devices-shipped	特定のジョブのデバイスを出荷済みとしてマークする要求。	拡張	GA
az databox job show	指定したジョブに関する情報を取得します。	拡張	GA
az databox job update	既存のジョブのプロパティを更新します。	拡張	GA

az databox job cancel

CancelJob。

az databox job cancel --reason
                      [--ids]
                      [--job-name]
                      [--resource-group]
                      [--subscription]
                      [--yes]

例

ジョブの取り消し

az databox job cancel -g rg --job-name name --reason reason

必須のパラメーター

--reason

取り消しの理由。

省略可能のパラメーター

--ids

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

--job-name --name -n

指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用してください。

--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 databox job create

指定したパラメーターを使用して新しいジョブを作成します。

az databox job create --job-name
                      --resource-group
                      --sku {DataBox, DataBoxCustomerDisk, DataBoxDisk, DataBoxHeavy}
                      --transfer-type {ExportFromAzure, ImportToAzure}
                      [--city]
                      [--company-name]
                      [--contact-name]
                      [--country]
                      [--data-box-customer-disk]
                      [--email-list]
                      [--expected-data-size]
                      [--identity]
                      [--kek-identity]
                      [--kek-type {CustomerManaged, MicrosoftManaged}]
                      [--kek-url]
                      [--kek-vault-resource-id]
                      [--location]
                      [--mobile]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--phone]
                      [--postal-code]
                      [--resource-group-for-managed-disk]
                      [--staging-storage-account]
                      [--state-or-province]
                      [--storage-account]
                      [--street-address1]
                      [--street-address2]
                      [--street-address3]
                      [--tags]
                      [--transfer-all-blobs {0, 1, f, false, n, no, t, true, y, yes}]
                      [--transfer-all-files {0, 1, f, false, n, no, t, true, y, yes}]
                      [--transfer-configuration-type {TransferAll, TransferUsingFilter}]
                      [--transfer-filter-details]

例

ジョブを作成する

az databox job create -g rg -n job-name --sku databox --contact-name 'test' --phone 14258828080 --email-list testing@microsoft.com --street-address1 "1 MICROSOFT WAY" --city Redmond --state-or-province WA --country US --postal-code 98052 --company-name Microsoft --storage-account account-id --staging-storage-account account-id --resource-group-for-managed-disk rg --transfer-type ImportToAzure --kek-type MicrosoftManaged

必須のパラメーター

--job-name --name -n

指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用してください。

--resource-group -g

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

--sku

SKU 名。

承認された値: DataBox, DataBoxCustomerDisk, DataBoxDisk, DataBoxHeavy

--transfer-type

データ転送の種類。

承認された値: ExportFromAzure, ImportToAzure

省略可能のパラメーター

--city

市区町間の名前。

--company-name

会社の名前。

--contact-name

ユーザーの連絡先名。

--country

国の名前。

--data-box-customer-disk

顧客ディスク ジョブの詳細。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--email-list

ジョブの進行状況について通知する電子メール ID の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--expected-data-size

このジョブで転送する必要があるデータの予想サイズ (テラバイト単位)。

--identity

リソースの Msi ID 短縮構文、json ファイル、yaml ファイルをサポートします。 詳細を表示するには、"??" を試してください。

--kek-identity

キー暗号化に使用されるマネージド ID プロパティ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--kek-type

キーの暗号化に使用される暗号化キーの種類。

承認された値: CustomerManaged, MicrosoftManaged

既定値: MicrosoftManaged

--kek-url

キー暗号化キー。 これは、カスタマー マネージド KekType の場合に必要です。

--kek-vault-resource-id

Kek コンテナーのリソース ID。これは、カスタマー マネージド KekType の場合に必要です。

--location -l

リソースの場所。 これは、サポートおよび登録されている Azure リージョンの 1 つ (米国西部、米国東部、東南アジアなど) になります。 リソースのリージョンは一度作成した後は変更できませんが、更新時に同じリージョンが指定されている場合、要求は成功します。 指定しない場合は、リソース グループの場所が使用されます。

--mobile

連絡先の携帯電話番号。

--no-wait

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

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

--phone

連絡先の番号を電話します。

--postal-code

郵便番号。

--resource-group-for-managed-disk

コンピューティング ディスクのリソース グループ ID。

--staging-storage-account

ステージング用の vhd のコピーに使用できるストレージ アカウントのリソース ID。

--state-or-province

都道府県の名前。

--storage-account

宛先ストレージ アカウントのスペース区切りの一覧。 ストレージ アカウントの名前またはリソース ID を指定できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--street-address1

番地 1 行目。

--street-address2

番地 2 行目。

--street-address3

番地 3 行目。

--tags

リソースを記述するキー値ペアの一覧。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--transfer-all-blobs

すべての Azure BLOB を転送する必要があるかどうかを示す場合。

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

既定値: False

--transfer-all-files

すべての Azure ファイルを転送する必要があるかどうかを示す場合。

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

既定値: False

--transfer-configuration-type

転送の構成の種類。

承認された値: TransferAll, TransferUsingFilter

--transfer-filter-details

フィルターの種類とフィルター処理する詳細のマップへのパス。 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 databox job delete

ジョブを削除します。

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

例

ジョブを削除する

az databox job delete -n job-name -g rg

省略可能のパラメーター

--ids

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

--job-name --name -n

指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用してください。

--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 databox job list

サブスクリプションで使用可能なすべてのジョブを一覧表示します。

az databox job list [--resource-group]

例

リソース グループ別にジョブを一覧表示する

az databox job list -g 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 databox job list-credential

このメソッドは、ジョブに関連する暗号化されていないシークレットを取得します。

az databox job list-credential [--ids]
                               [--job-name]
                               [--resource-group]
                               [--subscription]

例

資格情報を一覧表示する

az databox job list-credential -g rg -n job-name

省略可能のパラメーター

--ids

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

--job-name --name -n

指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用してください。

--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 databox job mark-devices-shipped

特定のジョブのデバイスを出荷済みとしてマークする要求。

az databox job mark-devices-shipped --deliver-package-details
                                    [--ids]
                                    [--job-name]
                                    [--resource-group]
                                    [--subscription]

例

出荷されたデバイスをマークする

az databox job mark-devices-shipped -g rg -n job-name

必須のパラメーター

--deliver-package-details

配信パッケージの詳細 短い構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

省略可能のパラメーター

--ids

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

--job-name --name -n

指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用してください。

--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 databox job show

指定したジョブに関する情報を取得します。

az databox job show [--ids]
                    [--job-name]
                    [--resource-group]
                    [--subscription]

例

ジョブの表示

az databox job show -g rg -n job-name

省略可能のパラメーター

--ids

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

--job-name --name -n

指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用してください。

--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 databox job update

既存のジョブのプロパティを更新します。

az databox job update [--city]
                      [--company-name]
                      [--contact-name]
                      [--country]
                      [--email-list]
                      [--ids]
                      [--job-name]
                      [--kek-identity]
                      [--kek-type {CustomerManaged, MicrosoftManaged}]
                      [--kek-url]
                      [--kek-vault-resource-id]
                      [--mobile]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--phone]
                      [--postal-code]
                      [--resource-group]
                      [--state-or-province]
                      [--street-address1]
                      [--street-address2]
                      [--street-address3]
                      [--subscription]

例

ジョブを更新する

az databox job update -g rg -n job-name --contact-name 'name --email-list email --phone phone-number

省略可能のパラメーター

--city

市区町間の名前。

--company-name

会社の名前。

--contact-name

ユーザーの連絡先名。

--country

国の名前。

--email-list

ジョブの進行状況について通知する電子メール ID の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--ids

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

--job-name --name -n

指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用してください。

--kek-identity

キー暗号化に使用されるマネージド ID プロパティ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--kek-type

キーの暗号化に使用される暗号化キーの種類。

承認された値: CustomerManaged, MicrosoftManaged

--kek-url

キー暗号化キー。 これは、カスタマー マネージド KekType の場合に必要です。

--kek-vault-resource-id

Kek コンテナーのリソース ID。これは、カスタマー マネージド KekType の場合に必要です。

--mobile

連絡先の携帯電話番号。

--no-wait

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

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

--phone

連絡先の番号を電話します。

--postal-code

郵便番号。

--resource-group -g

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

--state-or-province

都道府県の名前。

--street-address1

番地 1 行目。

--street-address2

番地 2 行目。

--street-address3

番地 3 行目。

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