device、devdevice, dev

Azure Sphere デバイスを管理します。Manages Azure Sphere devices.

OperationOperation 説明Description
capabilitycapcapability, cap デバイスの機能を管理しますManages device capabilities
claimclaim Azure Sphere テナントにまだ要求されていないデバイスを要求しますClaims a previously unclaimed device to the Azure Sphere tenant
imageimgimage, img デバイスのイメージを管理しますManages images for a device
link-feedlink-feed デバイスをフィードにリンクしますLinks a device to a feed
manufacturing-statemfgmanufacturing-state, mfg 接続されているデバイスの製造状態を管理しますManages the manufacturing state of the attached device
prep-debugprep-debug ローカル デバッグのためのデバイスを設定しますSets up a device for local debugging
prep-fieldprep-field デバッグを無効にし、無線 (OTA) で更新プログラムを受信するようにデバイスを設定しますSets up a device to disable debugging and receive over-the-air (OTA) updates
recoverrecover 特殊な回復モードを使用して、新しいファームウェアをデバイスに読み込みますUses special recovery mode to load new firmware onto the device
restartrestart 接続されたデバイスを再起動しますRestarts the attached device
show-attachedshow-attached 接続されているデバイスから取得したそのデバイスに関する詳細を表示しますDisplays details about the attached device from the device itself
show-ota-configshow-ota-config デバイスの OTA 更新プログラムの構成に関する詳細を表示しますDisplays details about the OTA update configuration of the device
show-ota-statusshow-ota-status 最新の OTA 更新プログラムの状態を表示しますDisplays the status of the most recent OTA update
sideloadslsideload, sl 接続されたデバイスにアプリケーションを読み込むか、アプリケーションの状態を変更しますLoads an application onto the attached device or changes the status of the application
update-device-groupupdate-device-group デバイスをデバイス グループに移動しますMoves a device into a device group
update-skuupdate-sku デバイスの製品 SKU を設定しますSets the product SKU for a device
wifiwifi デバイスの Wi-Fi 構成を管理しますManages the Wi-Fi configuration for the device

capability、capcapability, cap

デバイスの機能を管理します。Manages device capabilities.

現在、唯一の機能は appdevelopment です。この機能を使用すると、SDK 署名済みイメージ パッケージをデバイスにサイドローディングし、デバイスからイメージ パッケージを開始、停止、デバッグ、または削除することができます。Currently, the only capability is appdevelopment, which enables you to sideload SDK-signed image packages to the device and to start, stop, debug, or delete any image package from the device.

OperationOperation 説明Description
downloaddownload Azure Sphere Security Service からデバイスの機能構成をダウンロードしますDownloads a device capability configuration from the Azure Sphere Security Service
show-attachedshow-attached 接続されているデバイスの機能構成を表示しますDisplays the capability configuration for the attached device
updateupdate 接続されているデバイスにデバイスの機能構成を適用しますApplies a device capability configuration to the attached device

capability downloadcapability download

Azure Sphere Security Service からデバイス機能をダウンロードし、デバイスに適用します。Downloads a device capability from the Azure Sphere Security Service and applies it to a device.

appdevelopment 機能を使用すると、SDK 署名済みアプリケーションをサイドローディングし、デバイス上の任意のアプリケーションを起動、停止、デバッグ、または削除することができます。The appdevelopment capability lets you sideload SDK-signed applications and start, stop, debug, or delete any application on the device. appdevelopment 機能を使用しない場合、OTA で配置されたアプリケーションに対して実行できる操作は読み込みのみであり、開始、停止、デバッグ、および削除は禁止されます。Without the appdevelopment capability, only OTA-deployed applications can be loaded and start, stop, debug, and delete are prohibited.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-t、--type capability-type-t, --type capability-type 機能の種類を指定します (appdevelopment または none)。Specifies the type of capability, either appdevelopment or none. none を使用して appdevelopment の機能を削除します。Use none to remove the appdevelopment capability.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--deviceid id-i, --deviceid id 機能構成を取得するデバイスの ID を指定します。Specifies the ID of the device for which to get the capability configuration. デバイス ID を指定する場合は、--output も使用する必要があります。If you specify a device ID, you must also use --output. 省略すると、接続されているデバイスの機能を取得します。If omitted, gets a capability for the attached device.
-o、--output path-o, --output path 機能構成を保存するパスとファイル名を指定します。Specifies the path and filename at which to save the capability configuration. 現在のディレクトリであっても、パスを指定してください。Include a path, even for the current directory. --deviceid パラメーターを使用する場合は必須です。Required with the --deviceid parameter.
-p、--apply-p, --apply 接続されているデバイスにデバイスの機能構成を適用します。Applies the device capability configuration to the attached device. --deviceid または --output と同時に使用しないでください。Do not use with --deviceid or --output.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device capability download --type appdevelopment --output ./appdevcap

Downloading device capability configuration for device ID 'ABCDEF82513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully downloaded device capability configuration.
Successfully wrote device capability configuration file './appdevcap'.
Command completed successfully in 00:00:07.7393213.

capability show-attachedcapability show-attached

接続されているデバイスの機能構成を表示しますDisplays the capability configuration for the attached device

グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device capability show-attached
Device Capabilities:
        Enable App development
Command completed successfully in 00:00:00.8746160.

capability updatecapability update

接続されているデバイスにデバイスの機能構成を適用します。Applies a device capability configuration to the attached device.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-f、--filepath path-f, --filepath path 適用するデバイス機能ファイルのパスと名前を指定します。Specifies the path and name of the device capability file to apply.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device capability update --filepath appdevcap

Applying device capability configuration to device.
Successfully applied device capability configuration to device.
The device is rebooting.
Command completed successfully in 00:00:07.7393213.

要求claim

現在の Azure Sphere テナントに対してまだ要求されていないデバイスを要求します。Claims a previously unclaimed device for the current Azure Sphere tenant.

重要

デバイスを要求する前に、正しい Azure Sphere テナントにサインインしていることを確認してください。Before you claim the device, ensure that you are signed in to the correct Azure Sphere tenant. デバイスは、1 回のみ要求できます。A device can be claimed only once. 要求後にデバイスを別のテナントに移動することはできません。Once claimed, a device cannot be moved to a different tenant.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--deviceid GUID-i, --deviceid GUID 要求するデバイスの ID を指定します。Specifies the ID of the device to claim. 省略すると、azsphere から接続されているデバイスに要求されます。If omitted, azsphere claims the attached device.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device claim

Claiming device.
Claiming attached device ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' into tenant ID 'd343c263-4aa3-4558-adbb-d3fc34631800'.
Successfully claimed device ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' into tenant 'Microsoft' with ID 'd343c263-4aa3-4558-adbb-d3fc34631800'.
Command completed successfully in 00:00:05.5459143.

image、imgimage, img

接続されているデバイスにインストールされている、またはターゲットが設定されているイメージに関する情報を返します。Returns information about the images that are installed on or targeted to the attached device.

OperationOperation 説明Description
list-installedlist-installed 接続されているデバイスに現在インストールされているイメージに関する詳細を表示しますProvides details about the images that are currently installed on the attached device
list-targetedlist-targeted 接続されているデバイスにターゲットが設定されているイメージに関する詳細を表示します。Provides details about the images that are targeted to the attached device.

image list-installedimage list-installed

接続されているデバイスにインストールされているイメージを一覧表示します。Lists the images that are installed on the attached device. 情報の一覧には、コンポーネント ID とイメージ ID が含まれます。The list of information includes the component and image IDs.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-f、--full-f, --full デバイスにインストールされているカスタマー ソフトウェア イメージとシステム ソフトウェア イメージの両方を一覧表示します。Lists both customer and system software images that are installed on the device. 既定では、お客様のアプリケーション イメージ、デバッガー、およびボード構成イメージを一覧表示します。By default, lists only customer application images, debuggers, and board configuration images.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device image list-installed
Installed images:
 --> gdbserver
   --> Image type:   Application
   --> Component ID: 8548b129-b16f-4f84-8dbe-d2c847862e78
   --> Image ID:     43d2707f-0bc7-4956-92c1-4a3d0ad91a74
 --> Mt3620Blink4
   --> Image type:   Application
   --> Component ID: 970d2ff1-86b4-4e50-9e80-e5af2845f465
   --> Image ID:     e53ce989-0ecf-493d-8056-fc0683a566d3
Command completed successfully in 00:00:01.6189314.

image list-targetedimage list-targeted

Azure Sphere Security Service にアップロードされており、次にデバイスが更新されたときにインストールされるイメージを一覧表示します。Lists the images that have been uploaded to the Azure Sphere Security Service and will be installed the next time the device is updated.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--deviceid GUID-i, --deviceid GUID ターゲットのイメージを一覧表示するデバイスの ID を指定します。Specifies the ID of the device for which to list targeted images. 既定では、接続されているデバイスのイメージを一覧表示します。By default, lists images for the attached device.
-f、--full-f, --full デバイスにインストールされるカスタマー ソフトウェア イメージとシステム ソフトウェア イメージの両方を一覧表示します。Lists both customer and system software images that will be installed on the device. 既定では、カスタマー アプリケーション イメージのみを一覧表示します。By default, lists only customer application images.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device image list-targeted

Successfully retrieved the current image set for device with ID 'ABCDEF82513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC5ABCDEF' from your Azure Sphere tenant:
 --> ID:   [6e9cdc9d-c9ca-4080-9f95-b77599b4095a]
 --> Name: 'ImageSet-Mt3620Blink1-2018.07.19-18.15.42'
Images to be installed:
 --> [ID: 116c0bc5-be17-47f9-88af-8f3410fe7efa]
Command completed successfully in 00:00:04.2733444.

デバイスをフィードにリンクし、必要に応じて新しいイメージをフィードに追加します。Links a device to a feed and optionally adds a new image to the feed.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-c、--componentid GUID-c, --componentid GUID フィードが配信する既存のコンポーネントの ID を指定します。Specifies the ID of an existing component that the feed will deliver. --newfeedname を使用する場合、--componentid または --imagepath が必要です。Either --componentid or --imagepath is required with --newfeedname. 複数のコンポーネントをフィードに追加できます。このフラグを複数回使用して複数のコンポーネントを指定するか、1 回使用し、複数のコンポーネント ID をスペースを挿入せずにコンマで区切って指定します。You may add multiple components to the feed by either using this flag multiple times to specify multiple components, or once and separate the component IDs with commas and no intervening spaces.
-d、--dependentfeedid GUID-d, --dependentfeedid GUID 新しいフィードが依存するシステム ソフトウェア フィードの ID を指定します。Specifies the ID of the system software feed that the new feed depends on. --newfeedname を使用する場合は必須です。Required with --newfeedname.
-f --feedid GUID-f --feedid GUID 指定したデバイスのデバイス グループにリンクする既存のフィードの ID を指定します。Specifies the ID of an existing feed to link to the device group for the specified device. 省略した場合は、新しいフィードを作成し、省略可能な --newfeedname パラメーターで名前を割り当てます。If omitted, creates a new feed and assigns it the name in the optional --newfeedname parameter. このコンポーネントのフィードが既にある場合は、それを使用して、重複するフィードでテナントが混乱しないようにします。If you already have a feed for this component, use it to avoid cluttering your tenant with redundant feeds. --feedid または --newfeedname が必要です。Either --feedid or --newfeedname is required.
-i、--deviceid GUID-i, --deviceid GUID フィードをリンクするデバイスの ID を指定します。Specifies the ID of the device to which to link the feed. 省略した場合は、接続されているデバイスにフィードをリンクします。If omitted, links the feed to the attached device.
-p、--imagepath path-p, --imagepath path フィードにアップロードするイメージ パッケージへのパスを指定し、イメージ パッケージのコンポーネント ID をフィードのコンポーネント ID と照合して検証します。Specifies the path to an image package to upload to the feed and validates the component ID of the image package against the component ID for the feed. 省略した場合、新しいフィードは作成されますが、初期イメージ セットは割り当てられません。If omitted, creates a new feed but does not assign an initial image set. --newfeedname を使用する場合、--imagepath または --componentid が必要です。Either --imagepath or --componentid is required with --newfeedname. 複数のイメージ パスをフィードに追加できます。このフラグを複数回使用して複数のイメージ パスを指定するか、1 回使用し、複数のイメージ パスをスペースを挿入せずにコンマで区切って指定します。You may add multiple image paths to the feed by either using this flag multiple times to specify multiple image paths or using it once and separating the image paths with commas and no intervening spaces.
-n、--newfeedname string-n, --newfeedname string フィードの名前を指定します。Specifies a name for the feed. --dependentfeedid が必要です。Requires --dependentfeedid. フィード名は Azure Sphere テナント内で一意である必要があります。Feed names must be unique within an Azure Sphere tenant. --newfeedname または --feedid が必要です。Either --newfeedname or --feedid is required.
-s、--newimagesetname string-s, --newimagesetname string 作成される新しいイメージ セットの名前を指定します。Specifies the name for the new image set to create. 省略した場合、コンポーネント名とタイム スタンプに基づいてイメージ セット名が生成されます。If omitted, generates an image set name based on the component name and a time stamp. --imagepath が必要です。Requires --imagepath.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Examples

この例では、新しいフィードを作成し、配信するフィードのイメージ パッケージを提供します。This example creates a new feed and supplies an image package for the feed to deliver.

azsphere device link-feed --dependentfeedid 3369f0e1-dedf-49ec-a602-2aa98669fd61 --imagepath "C:\Users\User\Documents\Visual Studio 2017\Projects\Mt3620Blink5\Mt3620Blink5\bin\ARM\Debug\Mt3620Blink5.imagepackage" --newfeedname Model100AppFeedOTA --newimagesetname Model100Appv1.0

Getting the details for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Uploading image from file 'C:\Users\User\Documents\Visual Studio 2017\Projects\Mt3620Blink5\Mt3620Blink5\bin\ARM\Debug\Mt3620Blink5.imagepackage':
 --> Image ID:       'b66f1398-4ad6-4f12-be84-8ad607676ec3'
 --> Component ID:   '8fb105a3-35d0-423a-9427-a21852623965'
 --> Component name: 'Mt3620Blink5'
Create a new feed with name 'Model100AppFeedOTA'.
Adding feed with ID '8e2d3b19-bb01-4e36-b974-5b2f8df502e9' to device group with ID 'c0346077-eb9e-4dbc-85ad-03313867be69'.
Creating new image set with name 'Model100Appv1.0' for image with ID 'b66f1398-4ad6-4f12-be84-8ad607676ec3'.
Adding image set with ID '70207e9a-d080-42d7-899e-fb02822fbc32' to feed with ID '8e2d3b19-bb01-4e36-b974-5b2f8df502e9'.
Successfully linked device 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' to feed with ID '8e2d3b19-bb01-4e36-b974-5b2f8df502e9'.
Command completed successfully in 00:00:25.5193828.

次の例では、既存のコンポーネントの新しいフィードを作成します。The next example creates a new feed for an existing component. フィードは Retail Azure Sphere OS フィードに依存し、BlinkLink という名前が付けられています。The feed depends on the Retail Azure Sphere OS feed and is named BlinkLink. フィードは、接続されているデバイスと同じデバイス グループ内のデバイスにサービスを提供します。The feed services the devices in the same device group as the attached device.

azsphere device link-feed --componentid 16995a70-377f-4bd2-b29d-1b0fffcbe287 -n BlinkLink --dependentfeedid 3369f0e1-dedf-49ec-a602-2aa98669fd61

Getting the details for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Create a new feed with name 'BlinkLink'.
Adding feed with ID '6daf66aa-5a3e-41f9-9659-6c30a2f7673f' to device group with ID 'd80bf785-acae-497c-a62c-21a6ce65b81f'.
Successfully linked device 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' to feed with ID '6daf66aa-5a3e-41f9-9659-6c30a2f7673f'.
Command completed successfully in 00:00:07.1315217.

manufacturing-state、mfgmanufacturing-state, mfg

接続されているデバイスの製造状態を管理します。Manages the manufacturing state of the attached device.

OperationOperation 説明Description
showshow 接続されているデバイスの製造状態を表示しますDisplays the manufacturing state of the attached device
updateupdate 接続されているデバイスの製造状態がまだ AllComplete ではない場合は更新します。Updates the manufacturing state of the attached device if it is not already AllComplete.

注意事項

製造状態の変更は永続的であり、元に戻すことはできません。Manufacturing state changes are permanent and irreversible.

manufacturing-state showmanufacturing-state show

接続されているデバイスの製造状態を表示します。Displays the manufacturing state of the attached device.

グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device manufacturing-state show
Manufacturing State: Blank
Command completed successfully in 00:00:00.9005143.

manufacturing-state updatemanufacturing-state update

接続されているデバイスの製造状態がまだ AllComplete ではない場合は更新します。Updates the manufacturing state of the attached device if the state is not already AllComplete.

このコマンドは、製造プロセス中に使用するものです。This command is intended for use during the manufacturing process.

注意事項

製造状態の変更は永続的であり、元に戻すことはできません。Manufacturing state changes are permanent and irreversible.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-s、--state SettableManufacturingStates-s, --state SettableManufacturingStates デバイスに設定する製造状態を指定します。Specifies the manufacturing state to set for the device. 現在設定できる唯一の状態は AllComplete です。Currently the only settable state is AllComplete.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device manufacturing-state update --state AllComplete
Manufacturing State: AllComplete
Command completed successfully in 00:00:00.9005143.

prep-debugprep-debug

接続されているデバイスをローカル デバッグ用に設定し、無線のアプリケーション更新を無効にします。Sets up the attached device for local debugging and disables over-the-air application updates.

prep-debug の具体的な機能を次に示します。Specifically, prep-debug:

  • 接続されているデバイスの appdevelopment 機能をダウンロードして適用しますDownloads and applies the appdevelopment capability for the attached device
  • 無線のアプリケーション更新を有効にしないデバイス グループにデバイスを割り当てますAssigns the device to a device group that does not enable over-the-air application updates
  • デバイスを再起動しますReboots the device

コマンドからエラーが報告された場合、デバイスの要求が提案されている可能性があります。If the command reports an error, it may suggest that you claim the device. まず、意図した Azure Sphere テナントにログインしていることを確認するために azsphere tenant show-selected を使用してから、必要に応じて azsphere login を使用して別のテナントにログインします。First, use azsphere tenant show-selected to ensure that you are logged in to the intended Azure Sphere tenant, and then azsphere login to log into a different tenant if necessary. デバイスを要求するには、azsphere device claim を使用します。To claim the device, use azsphere device claim. デバイスを既に要求しているにもかかわらずエラーが表示される場合は、デバイスを要求したテナントにログインしていることを確認してください。If you see the error but have already claimed the device, make sure that you are logged in to the tenant in which you claimed the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-d、--devicegroupid GUID-d, --devicegroupid GUID 無線のアプリケーション更新を適用しないデバイス グループの ID を指定します。Specifies the ID of a device group that does not apply over-the-air application updates. 省略した場合は、デバイスを既定グループに割り当てます。If omitted, assigns the device to a default group.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device prep-debug

Getting device capability configuration for application development.
Downloading device capability configuration for device ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully downloaded device capability configuration.
Successfully wrote device capability configuration file 'C:\Users\Administrator\AppData\Local\Temp\tmpD15E.tmp'.
Setting device group ID '63bbe6ea-14be-4d1a-a6e7-03591d882b42' for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully disabled over-the-air updates.
Enabling application development capability on attached device.
Applying device capability configuration to device.
Successfully applied device capability configuration to device.
The device is rebooting.
Application development capability enabled.
Successfully set up device 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' for application development, and disabled over-the-air updates.
Command completed successfully in 00:00:07.7393213.

prep-fieldprep-field

アプリケーション開発を無効にする、既存のアプリケーションを削除する、無線のアプリケーション更新を有効にすることで、接続されているデバイスをフィールドでの使用のために準備をします。Readies the attached device for field use by disabling application development, deleting any existing applications, and enabling over-the-air application updates.

これは、デバイスを PC に接続する必要があります。また、接続されているデバイス上でのみ動作します。It requires a device to be attached to the PC and operates only on the attached device.

prep-field が実行する具体的なタスクは、製品 SKU とデバイス グループがこのデバイス用に既に割り当てられているかどうかによって変わります。The specific tasks that prep-field performs depend on the whether a product SKU and device group have already been assigned for this device. SKU 名またはデバイス グループ名に適切なパラメーターが指定されていて、製品 SKU またはデバイス グループがまだ存在しない場合、コマンドによってそれが作成され、デバイスに割り当てられます。If the product SKU or the device group does not already exist, the command creates it and assigns it to the device, provided that a SKU name or a device group name is supplied with the appropriate parameter.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-r、--devicegroupid GUID-r, --devicegroupid GUID デバイスを割り当てるデバイス グループの ID を指定します。Specifies the ID of the device group to which to assign the device. 省略した場合は、アプリケーションの更新が有効な既定のグループにデバイスを割り当てます。If omitted, assigns the device to a default group that enables application updates. --newdevicegroupname と同時に使用することはできません。Cannot be used with --newdevicegroupname.
-g、--newdevicegroupname string-g, --newdevicegroupname string 無線のアプリケーション更新を許可する新しいデバイス グループを作成します。Creates a new device group that allows over-the-air application updates. デバイス グループ名は Azure Sphere テナント内で一意である必要があります。Device group names must be unique within an Azure Sphere tenant. --devicegroupid と同時に使用することはできません。Cannot be used with --devicegroupid.
-n、--newskuname string-n, --newskuname string 新しい製品 SKU を作成し、デバイスに割り当てます。Creates a new product SKU and assigns it to the device. SKU 名は Azure Sphere テナント内で一意である必要があります。SKU names must be unique within an Azure Sphere tenant. --skuid と同時に使用することはできません。Cannot be used with --skuid.
-d、--skudescription string-d, --skudescription string 新しい SKU のわかりやすい説明を指定します。Provides a friendly description of the new SKU. --newskuname が必要です。Requires --newskuname.
-s、--skuid GUID-s, --skuid GUID デバイスに適用する既存の製品 SKU の ID を指定します。Specifies the ID of an existing product SKU to apply to the device. --newskuname と同時に使用することはできません。Cannot be used with --newskuname.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Examples

例 1.Example 1. デバイスの製品 SKU とデバイス グループを作成するCreate a product SKU and device group for device

この例では、新しい製品 SKU と新しいデバイス グループを作成し、接続されているデバイスに両方を割り当てます。This example creates a new product SKU and a new device group, and assigns both to the attached device.

azsphere device prep-field --newdevicegroupname AppUpdateGroup --newskuname TestSKU

出力が示すように、このコマンドでデバイスから既存のアプリケーションが削除され、appdevelopment 機能が削除され、AppUpdateGroup という名前のデバイス グループが作成され、TestSKU という名前の製品 SKU が作成され、接続されているデバイスにデバイス グループと製品 SKU の両方が割り当てられます。As the output shows, the command deletes the existing application from the device, removes the appdevelopment capability, creates a device group named AppUpdateGroup, creates a product SKU named TestSKU, and assigns both the device group and the product SKU to the attached device. 新しいデバイス グループは、アプリケーション更新プログラムの OTA 読み込みに対して有効です。The new device group is enabled for OTA loading of application updates.

Removing applications from device.
Component '54acba7c-7719-461a-89db-49c807e0fa4d' deleted.
Locking device.
Downloading device capability configuration for device ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully downloaded device capability configuration.
Applying device capability configuration to device.
Successfully applied device capability configuration to device.
The device is rebooting.
Successfully locked device.
Creating a new device group with name 'AppUpdateGroup'.
Setting device group ID 'bbc91f02-1de4-43a3-bcf2-f6f0994ac723' for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Creating a new SKU with name 'TestSKU'.
Setting product SKU to '5d88f658-be0c-4814-8319-473f21f4f88f' for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully set up device 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' for OTA loading.
Command completed successfully in 00:00:18.0072081.

例 2.Example 2. 既存の製品 SKU とデバイス グループをデバイスに割り当てるAssign existing product SKU and device group to device

この例では、既存の製品 SKU とデバイス グループを接続されているデバイスに割り当てます。This example assigns an existing product SKU and device group to the attached device.

azsphere device prep-field --skuid 2bc8c605-6f8f-4802-ba69-c57d63e9c6dd --devicegroupid d80bf785-acae-497c-a62c-21a6ce65b81f

Getting the details of device group with ID ''.
Removing applications from device.
No app present.
Successfully removed applications from device.
Locking device.
Downloading device capability configuration for device ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully downloaded device capability configuration.
Applying device capability configuration to device.
Successfully applied device capability configuration to device.
The device is rebooting.
Successfully locked device.
Setting device group ID 'd80bf785-acae-497c-a62c-21a6ce65b81f' for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Setting product SKU to '2bc8c605-6f8f-4802-ba69-c57d63e9c6dd' for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully set up device 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' for OTA loading.
Command completed successfully in 00:00:12.0638169.

例 3.Example 3. 別のデバイス グループにデバイスを割り当てるAssign device to different device group

この例は前の例と似ていますが、デバイスの既存の製品 SKU は保持されます。This example is similar to the preceding example, but retains the existing product SKU for the device. この例の prep-field 操作では、デバイスが属するデバイス グループが変更され、appDevelopment 機能は削除されます。Here the prep-field operation changes the device group to which the device belongs and removes the appDevelopment capability. このコマンドは、OTA のアプリケーション更新が有効ではない開発環境から、有効な運用環境に移行する場合に便利です。This command is useful for moving a device from a development environment that does not enable OTA application updates to a production environment that does.

azsphere device prep-field --devicegroupid 655d7b12-07ad-4e8a-b104-c0ec494b8489

Getting the product SKU for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Getting the details of device group with ID ''.
Removing applications from device.
Component '54acba7c-7719-461a-89db-49c807e0fa4d' deleted.
Successfully removed applications from device.
Locking device.
Downloading device capability configuration for device ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully downloaded device capability configuration.
Applying device capability configuration to device.
Successfully applied device capability configuration to device.
The device is rebooting.
Successfully locked device.
Setting device group ID '655d7b12-07ad-4e8a-b104-c0ec494b8489' for device with ID 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED'.
Successfully set up device 'ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' for OTA loading.
Command completed successfully in 00:00:11.1988981.

recoverrecover

デバイス上のシステム ソフトウェアを置き換えます。Replaces the system software on the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-b、--bootloader filename-b, --bootloader filename 使用する復旧ブートローダーのファイル名を指定します。Specifies the filename of the recovery bootloader to use. 既定では、コマンドは --images フラグで指定された folder から recovery-loader.bin を使用します。By default, the command uses recovery-loader.bin from the folder named with the --images flag.
-c、--capability filename-c, --capability filename デバイスに適用するデバイス機能イメージのファイル名を指定します。Specifies the filename of the device capability image to apply to the device. Microsoft のみが使用します。For Microsoft use only.
-i、--images folder-i, --images folder デバイスに書き込むイメージ パッケージを含むフォルダーへのパスを指定します。Specifies the path to a folder that contains the image packages to write to the device. このフラグを使用して代替パスを指定しない限り、復旧では SDK 内のイメージが既定で使用されます。By default, recovery uses the images in the SDK unless an alternate path is provided with this flag.
-m、--manifest filename-m, --manifest filename 復旧イメージ マニフェスト ファイルのパスを指定します。Specifies the path to the recovery image manifest file. 既定では、このコマンドは --images フラグで指定された folder の recovery.imagemanifest ファイルを使用します。By default, the command uses the recovery.imagemanifest file from the folder specified with the --images flag.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device recover -i .\recovery`

restartrestart

接続されたデバイスを再起動します。Restarts the attached device.

グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device restart
Restarting device.
Device restarted successfully.
Command completed successfully in 00:00:10.2668755.

show-attachedshow-attached

接続されているデバイスから取得したそのデバイスに関する情報を表示します。Displays information about the attached device from the device itself. これらの詳細は、Azure Sphere Security Service がデバイス用に保存しているものとは異なります。These details differ from those that the Azure Sphere Security Service stores for the device.

グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device show-attached
Device ID: ABCDE082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED
Command completed successfully in 00:00:07.7393213.

show-ota-configshow-ota-config

Azure Sphere Security Service がデバイス用に保存している情報を表示します。Displays information that the Azure Sphere Security Service stores for a device. これらの詳細は、デバイス自体に格納されている詳細とは異なります。These details differ from those that the device itself stores.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--deviceid GUID-i, --deviceid GUID デバイスの ID を指定します。Specifies the ID of the device. 既定では、接続されているデバイスに関する情報が表示されます。By default, shows information about the attached device.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device show-ota-config
Retrieved the over-the-air update configuration for device with ID 'ABCDEF864D649176A4C5F26FE01EAD92F01BA0C50A20E9F6E441F7C5B66DF193E775524D70C7176AF2592F94729C9936FE4ABDDA9B45B8B76123682509ABCDEF':
 --> Device group: 'System Software' with ID '63bbe6ea-14be-4d1a-a6e7-03591d882b42'
 --> SKU: '9d606c43-1fad-4990-b207-554a025e0869' of type 'Chip'
 --> SKU: '946410a0-0057-4b11-af68-d56a684f6681' of type 'Product'
Command completed successfully in 00:00:03.0219123.

show-ota-statusshow-ota-status

デバイスの最新の OTA 更新プログラムの状態を表示しますDisplays the status of the most recent OTA update for the device.

このコマンドを使用して、デバイスが動作している Azure Sphere OS のバージョン、または現在の OTA 更新プログラムが完了しているかどうかを調べます。Use this command to find out which version of the Azure Sphere OS your device is running or whether the current OTA update has completed.

グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device show-ota-status
The Azure Sphere Security Service is targeting this device with OS version <versionNumber>
Your device has the expected version of the Azure Sphere OS: <versionNumber>.
Command completed successfully in 00:00:03.8184016.

この例では、<versionNumber> は現在のオペレーティング システムのバージョンを表す変更可能な値です。In this example, <versionNumber> represents the current operating system version and is a changeable value.

sideload、slsideload, sl

デバイス上のアプリケーションを管理します。Manages the application on the device.

サイドローディングされるオプションの多くは、appdevelopment 機能が必要です。これは prep-debug を使用して取得できます。Many of the sideload options require the appdevelopment capability, which can be acquired by using prep-debug. SDK 署名済みアプリケーションをサイドローディングする場合、SDK 署名済みアプリケーションまたは製品署名済みアプリケーションを開始、停止、デバッグ、または削除する場合、デバイスは appdevelopment 機能を持っている必要があります。To sideload an SDK-signed application, or to start, stop, debug, or delete an SDK-signed application or a production-signed application, the device must have the appdevelopment capability.

OperationOperation 説明Description
deletedelete デバイスから現在のアプリケーションを削除します。Deletes the current application from the device.
deploydeploy アプリケーションをデバイスに読み込みます。Loads an application onto the device.
show-quotashow-quota デバイス上の現在のアプリケーションによって使用されているストレージの量を表示します。Displays the amount of storage used by the current application on the device.
show-statusshow-status デバイス上の現在のアプリケーションの状態を返します。Returns the status of the current application on the device.
startstart デバイスに読み込まれているアプリケーションを開始します。Starts the application that is loaded on the device.
stopstop デバイス上で実行されているアプリケーションを停止します。Stops the application that is running on the device.

sideload deletesideload delete

デバイスからアプリケーションを削除します。Deletes applications from the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--componentid GUID-i, --componentid GUID 削除するコンポーネントの ID を指定します。Specifies the ID of the component to delete. 省略した場合、すべてのアプリケーションを削除します。If omitted, deletes all applications.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device sideload delete
Component '54acba7c-7719-461a-89db-49c807e0fa4d' deleted.

sideload deploysideload deploy

接続されているデバイスにアプリケーションを読み込み、アプリケーションを開始します。Loads an application onto the attached device and starts the application.

既にデバイス上にあるアプリケーションによって使用されているリソースをアプリケーション マニフェストが要求している場合、このコマンドは失敗します。This command fails if the application manifest requests a resource that is being used by an application that is already on the device. この場合は、azsphere device sideload delete を使用して既存のアプリケーションを削除し、サイドローディングを再試行します。In this case, use azsphere device sideload delete to delete the existing application and then try sideloading again.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-p、--imagepackage path-p, --imagepackage path デバイスに読み込むイメージ パッケージのパスとファイル名を指定します。Specifies the path and filename of the image package to load on the device. デバイスに appdevelopment 機能がない場合、サイドロードの展開は失敗します。Sideload deployment will fail if the device does not have the appdevelopment capability.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-m、--manualstart-m, --manualstart 読み込み後にアプリケーションを開始しません。Does not start the application after loading it.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device sideload deploy --imagepackage "C:\Users\Test\Documents\Visual Studio 2017\Projects\Mt3620Blink6\Mt3620Blink6\bin\ARM\Debug\Mt3620Blink6.imagepackage"
Deploying 'C:\Users\Test\Documents\Visual Studio 2017\Projects\Mt3620Blink6\Mt3620Blink6\bin\ARM\Debug\Mt3620Blink6.imagepackage' to the attached device.
Image package 'C:\Users\Test\Documents\Visual Studio 2017\Projects\Mt3620Blink6\Mt3620Blink6\bin\ARM\Debug\Mt3620Blink6.imagepackage' has been deployed to the attached device.
Command completed successfully in 00:00:03.0567304.

sideload show-quotasideload show-quota

接続されたデバイス上の変更可能ストレージの割り当て済み使用量を表示します。Displays the amount of mutable storage allocated and in use on the attached device.

アプリケーション マニフェストで変更可能ストレージのクォータを設定すると、Azure Sphere OS によってファイルのセクターが割り当てられるときにクォータが適用されます。You set the mutable storage quota in the application manifest, and the Azure Sphere OS enforces quotas when it allocates sectors for the file. このため、MutableStorage 値を小さくすると、ストレージの使用量は変わりませんが、報告される割り当て済みの値は変わります。As a result, if you decrease the MutableStorage value, the amount of storage in use will not change, but the allocated value reported will be different. たとえば、アプリケーションによって既に 16 KB が使用されている場合、MutableStorage 値を 8 に変更すると、8 KB のうち 16 KB がアプリケーションで使用されていることがコマンドによって報告されます。For example, if the application has already used 16 KB and you change the MutableStorage value to 8, the command reports that the application uses 16 KB of 8 KB allocated. データはデバイスに残ります。The data remains on the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--componentid GUID-i, --componentid GUID ストレージ情報を返すコンポーネントの ID を指定します。Specifies the ID of the component for which to return storage information. 省略した場合は、すべてのアプリケーションの情報を表示します。If omitted, displays information for all applications.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

C:\>azsphere device sideload show-quota

8548b129-b16f-4f84-8dbe-d2c847862e78: No mutable storage allocated.
Command completed successfully in 00:00:02.3003524.

C:\> azsphere.exe device sideload deploy -p Mt3620Blink1_Mutable.imagepackage
Deploying 'Mt3620Blink1_Mutable.imagepackage' to the attached device.
Image package 'Mt3620Blink1_Mutable.imagepackage' has been deployed to the attached device.
Command completed successfully in 00:00:04.8939438.

C:\>azsphere device sideload show-quota
8548b129-b16f-4f84-8dbe-d2c847862e78: No mutable storage allocated.
ee8abc15-41f3-491d-a4c7-4af49948e159: 0KB out of 16KB of mutable storage used.
Command completed successfully in 00:00:02.0410841.

sideload show-statussideload show-status

デバイス上のアプリケーションの現在の状態を表示します。Displays the current status of the applications on the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--componentid GUID-i, --componentid GUID 状態を表示するコンポーネントの ID を指定します。Specifies the ID of the component for which to display status. 省略した場合は、すべてのコンポーネントの状態を表示します。If omitted, shows status of all components.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device sideload show-status
54acba7c-7719-461a-89db-49c807e0fa4d: App state: running

Command completed successfully in 00:00:01.1103343.

sideload startsideload start

デバイス上のアプリケーションを開始します。Starts applications on the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--componentid GUID-i, --componentid GUID 開始するコンポーネントの ID を指定します。Specifies the ID of the component to start. 省略した場合、すべてのアプリケーションを開始します。If omitted, starts all applications.
-d、--debug-d, --debug デバッグのためにアプリケーションを開始します。Starts the application for debugging. --componentid が必要です。Requires --componentid.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device sideload start
54acba7c-7719-461a-89db-49c807e0fa4d: App state: running

Command completed successfully in 00:00:01.1183407.

sideload stopsideload stop

デバイス上のアプリケーションを開始します。Stops the applications on the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--componentid GUID-i, --componentid GUID 停止するコンポーネントの ID を指定します。Specifies the ID of the component to stop. 省略した場合、すべてのアプリケーションが停止します。If omitted, stops all applications.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device sideload stop
54acba7c-7719-461a-89db-49c807e0fa4d: App state: stopped

Command completed successfully in 00:00:01.1210256.

update-device-groupupdate-device-group

Azure Sphere テナント内の別のデバイス グループにデバイスを移動します。Moves the device into a different device group in your Azure Sphere tenant.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-d、--devicegroupid GUID-d, --devicegroupid GUID デバイスを移動する先のデバイス グループの ID を指定します。Specifies the ID of the device group to which to move the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--deviceid GUID-i, --deviceid GUID 移動するデバイスの ID を指定します。Specifies the ID of the device to move. 既定では、接続されているデバイスを移動します。By default, moves the attached device.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device update-device-group --devicegroupid 63bbe6ea-14be-4d1a-a6e7-03591d882b42
Successfully moved device '94B27082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' to device group '63bbe6ea-14be-4d1a-a6e7-03591d882b42' in your Azure Sphere tenant.

Command completed successfully in 00:00:02.7316538.

update-skuupdate-sku

デバイスの製品 SKU を設定します。Sets the product SKU for a device.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-s、--skuid GUID-s, --skuid GUID デバイスに割り当てる SKU の ID を指定します。Specifies the ID of the SKU to assign to the device.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-i、--deviceid GUID-i, --deviceid GUID デバイスの ID を指定します。Specifies the ID of the device. 既定では、接続されているデバイスに SKU を割り当てます。By default, assigns the SKU to the attached device.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device update-sku --skuid 319725fd-1591-4a92-be9a-2f8cf90707f1
Successfully set SKU '319725fd-1591-4a92-be9a-2f8cf90707f1' for device ID '94B27082513B529C45098884F882B2CA6D832587CAAE1A90B1CEC4A376EA2F22A96C4E7E1FC4D2AFF5633B68DB68FF4420A5588B420851EE4F3F1A7DC51399ED' in your Azure Sphere tenant.
Command completed successfully in 00:00:02.5983519.

wifiwifi

接続されているデバイスのワイヤレス構成を変更します。Changes the wireless configuration for the attached device.

ワイヤレス ネットワーク上のデバイスを使用するには、ネットワークに関する情報を追加し、デバイス上のネットワークを有効にする必要があります。To use the device on a wireless network, you must add information about the network and enable the network on the device. SSID には ASCII 以外の文字を入力できますが、azsphere は正しく表示されません。Although you can input non-ASCII characters in SSIDs, azsphere does not display them properly.

アプリケーションに WifiConfig API が使用されている場合、アプリケーションの app_manifest.json ファイルに WifiConfig 機能も含める必要があります。If your application uses the WifiConfig API, you must also include the WifiConfig capability in the application's app_manifest.json file.

OperationOperation 説明Description
addadd ワイヤレス ネットワークの詳細をデバイスに追加します。Adds the details of a wireless network to the device.
deletedelete ワイヤレス ネットワークの詳細をデバイスから削除します。Removes the details of a wireless network from the device.
disabledisable デバイスのワイヤレス ネットワークを無効にします。Disables a wireless network on the device.
enableenable デバイスのワイヤレス ネットワークを有効にします。Enables a wireless network on the device.
listlist デバイスの現在の Wi-Fi 構成を一覧表示します。Lists the current Wi-Fi configuration for the device.
scanscan 使用できるネットワークをスキャンします。Scans for available networks.
show-statusshow-status ワイヤレス インターフェイスの状態を表示します。Displays the status of the wireless interface.

wifi addwifi add

デバイスへの Wi-Fi 接続に関する情報を追加します。Adds information about a Wi-Fi connection to the device.

デバイスは複数の Wi-Fi 接続を持つことができます。A device can have multiple Wi-Fi connections.

SSID には ASCII 以外の文字を入力できますが、azsphere は正しく表示されません。Although you can input non-ASCII characters in SSIDs, azsphere does not display them properly.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-s、--ssid string-s, --ssid string ネットワークの SSID を指定します。Specifies the SSID of the network. ネットワーク SSID では大文字と小文字が区別されます。Network SSIDs are case-sensitive.

省略可能なパラメーターOptional parameters

パラメーターParameter 説明Description
-k、--key string-k, --key string 新しいネットワークの WPA/WPA2 キーを指定します。Specifies the WPA/WPA2 key for the new network. この SSID をオープン ネットワークとして追加するには、省略します。Omit to add this SSID as an open network. キーにアンパサンド (&) を含める場合は、引用符でキーを囲みます。If your key contains an ampersand (&), enclose the key in quotation marks.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device wifi add -s MyNetwork -k myKey123

Add network succeeded:
ID : 2
SSID : MyNetwork
Configuration state : enabled
Connection state : unknown
Security state : psk

Command completed successfully in 00:00:01.7039497.

ネットワーク SSID またはキーにスペースまたはアンパサンドが埋め込まれている場合は、SSID またはキーを引用符で囲みます。If the network SSID or key has embedded spaces or an ampersand, enclose the SSID or key in quotation marks. SSID またはキーに引用符を含める場合は、引用符をエスケープするためにバックスラッシュを使用します。If the SSID or key includes a quotation mark, use a backslash to escape the quotation mark. 値の一部であれば、バックスラッシュをエスケープする必要ありません。Backslashes do not require escape if they are part of a value. 例: For example:

azsphere device wifi add -s "New SSID" -k "key \"value\" with quotes"

wifi deletewifi delete

デバイスからワイヤレス ネットワークに関する情報を削除します。Deletes information about a wireless network from the device.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-i、--id integer-i, --id integer 削除するネットワークの ID を指定します。Specifies the ID of the network to delete.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device wifi delete --id 1
Successfully removed network.
Command completed successfully in 00:00:01.0055424.

wifi disablewifi disable

接続されているデバイスのワイヤレス ネットワークを無効にします。Disables a wireless network on the attached device.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-i、--id integer-i, --id integer 無効にするネットワークの ID を指定します。Specifies the ID of the network to disable.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device wifi disable --id 2
Successfully disabled network:
ID                  : 2
SSID                : NETGEAR21-5G
Configuration state : disabled
Connection state    : disconnected
Security state      : psk
Command completed successfully in 00:00:01.4166658.

wifi enablewifi enable

接続されているデバイスのワイヤレス ネットワークを有効にします。Enables a wireless network on the attached device.

あるネットワークから別のネットワークに変更する場合で、両方のネットワークが範囲内にある場合は、新しいネットワークを有効にする前に現在接続されているネットワークを無効にします。To change from one network to another if both are within range, disable the currently connected network before you enable the new network.

必須のパラメーターRequired parameters

パラメーターParameter 説明Description
-i、--id integer-i, --id integer 有効にするネットワークの ID を指定します。Specifies the ID of the network to enable.
グローバル パラメーターGlobal parameters

パラメーターParameter 説明Description
-v、--verbose-v, --verbose 詳細な出力を提供しますProvides verbose output
-?、--help-?, --help コマンドについてのヘルプを表示しますDisplays help on the command

Example

azsphere device wifi enable --id 2
Successfully enabled network:
ID                  : 2
SSID                : NETGEAR21-5G
Configuration state : enabled
Connection state    : connected
Security state      : psk
Command completed successfully in 00:00:01.4063645.

wifi listwifi list

デバイス上のすべての Wi-Fi 接続に関する情報を表示します。Displays information about all the Wi-Fi connections on the device.

Example

azsphere device wifi list
Network list:

ID                  : 0
SSID                : NETGEAR21
Configuration state : enabled
Connection state    : connected
Security state      : psk
ID                  : 1

SSID                : A_WiFi_SSID
Configuration state : enabled
Connection state    : disconnected
Security state      : open
ID                  : 2

SSID                : NETGEAR21-5G
Configuration state : enabled
Connection state    : disconnected
Security state      : psk
Command completed successfully in 00:00:00.7698180.

wifi scanwifi scan

デバイスの範囲内のワイヤレス ネットワークをスキャンします。Scans for wireless networks within range of the device. このコマンドにより最大 64 のワイヤレス ネットワークが返されますが、表示されるワイヤレス ネットワークの数は、環境要因 (範囲内にあるアクセス ポイントの密度など) によって制限される場合があります。The command will return up to 64 wireless network, but the number of wireless networks displayed may be limited by environmental factors such as the density of access points in range.

Example

azsphere device wifi scan

Scan results:
SSID : NETGEAR21
Security state : psk
BSSID : 44:94:fc:36:c8:65
Signal level : -66
Frequency : 2442

SSID : CenturyLink9303
Security state : psk
BSSID : 58:8b:f3:09:ae:d2
Signal level : -75
Frequency : 2412

SSID : NETGEAR21-5G
Security state : psk
BSSID : 44:94:fc:36:c8:64
Signal level : -86
Frequency : 5765

SSID : belkin.c32
Security state : psk
BSSID : 08:86:3b:0b:cc:32
Signal level : -86
Frequency : 2462
Command completed successfully in 00:00:07.4163320.

wifi show-statuswifi show-status

デバイス上の現在の Wi-Fi 接続に関する情報を表示します。Displays information about the current Wi-Fi connection on the device.

Example

azsphere dev wifi show-status
SSID                : NETGEAR23
Configuration state : enabled
Connection state    : connected
Security state      : psk
Frequency           : 2417
Mode                : station
Key management      : WPA2-PSK
WPA State           : COMPLETED
IP Address          : 192.168.1.9
MAC Address         : be:98:26:be:0d:e0

Command completed successfully in 00:00:01.7341825.