image
重要
これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。
ディスク上の Azure Sphere イメージを管理します。
操作 | 説明 |
---|---|
add | 新しいイメージをアップロードします。 |
download | イメージをダウンロードします。 |
show | 指定されたイメージ に関する情報を表示します。 |
add
Azure Sphere テナントに新しいイメージをアップロードします。
必須のパラメーター
パラメーター | 型 | 説明 |
---|---|---|
--画像 | String | アップロードするイメージへのパスを指定します。 |
省略可能なパラメーター
パラメーター | 型 | 説明 |
---|---|---|
-t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
--一時的 | Boolean | イメージ パッケージを一時的なものとしてマーク付けます。 このパラメーターは、製造プロセス中に使用するためのものです。 |
--force | Boolean | ベータ API を使用してイメージのアップロードを強制します。 |
-r、--regional-data-boundary | String | このイメージの地域データ境界。 使用できる値: EU 、None 。 既定値は None です。 値が指定されていない場合は、既定値が使用されます。 詳細については、「 クラッシュ ダンプの構成 - Pivacy に関する考慮事項」を参照してください。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
パラメーター | 説明 |
---|---|
--debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
-h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
--only-show-errors | エラーのみを表示し、警告を抑制します。 |
-o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
--query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
--verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere image add --image C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage --temporary
Uploading image from file 'C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage':
--> Image ID: d788fdd1-28eb-4477-9818-a4734289f2f1
--> Component ID: 99d419ef-296d-43b0-ade1-809efe3a7aba
--> Component name: 'QuickStart-AzureSphereBlink1'
Retaining temporary state for uploaded image.
Successfully uploaded image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1' and name 'QuickStart-AzureSphereBlink1' to component with ID '99d419ef-296d-43b0-ade1-809efe3a7aba'.
download
Azure Sphere テナントから既存のイメージをダウンロードします。
必須のパラメーター
パラメーター | 型 | 説明 |
---|---|---|
-i、--image | String | ダウンロードするイメージの ID を指定します。 azsphere image add コマンドを実行して、イメージ ID を取得します。 |
--行き先 | String | イメージの保存先となるパスとファイル名を指定します。 ファイル パスには、絶対パスまたは相対パスを指定できます。 |
省略可能なパラメーター
パラメーター | 型 | 説明 |
---|---|---|
-t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
パラメーター | 説明 |
---|---|
--debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
-h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
--only-show-errors | エラーのみを表示し、警告を抑制します。 |
-o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
--query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
--verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere image download --image d788fdd1-28eb-4477-9818-a4734289f2f1 --destination AzureSphereBlink1.image
Getting the image with ID 'd788fdd1-28eb-4477-9818-a4734289f2f1'.
---------
Result
=========
Succeeded
---------
show
Azure Sphere テナントの既存のイメージの詳細を表示します。
必須のパラメーター
パラメーター | 型 | 説明 |
---|---|---|
-i、--image | GUID | 詳細を取得するイメージの ID を指定します。 azsphere image add コマンドを実行して、イメージ ID を取得します。 |
省略可能なパラメーター
パラメーター | 型 | 説明 |
---|---|---|
-t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
パラメーター | 説明 |
---|---|
--debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
-h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
--only-show-errors | エラーのみを表示し、警告を抑制します。 |
-o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
--query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
--verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
azsphere image show --image d788fdd1-28eb-4477-9818-a4734289f2f1
------------------------------------ ------------------------------------ ---------------------------- ------------- ------------ ---------------------
ImageId ComponentId Name SigningStatus ImageType RegionalDataBoundary
========================================================================================================================================================
d788fdd1-28eb-4477-9818-a4734289f2f1 99d419ef-296d-43b0-ade1-809efe3a7aba QuickStart-AzureSphereBlink1 Succeeded Applications None
------------------------------------ ------------------------------------ ---------------------------- ------------- ------------ ---------------------