次の方法で共有


Catalogs - List Devices

カタログのデバイスを一覧表示します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices?api-version=2024-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices?api-version=2024-04-01&$filter={$filter}&$top={$top}&$skip={$skip}&$maxpagesize={$maxpagesize}

URI パラメーター

名前 / 必須 説明
catalogName
path True

string

カタログの名前

正規表現パターン: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

$filter
query

string

指定された式を使用して結果一覧をフィルター処理する

$maxpagesize
query

integer

int32

1 ページあたりの結果アイテムの最大数。

$skip
query

integer

int32

スキップする結果項目の数。

$top
query

integer

int32

返す結果項目の数。

応答

名前 説明
200 OK

DeviceListResult

Azure 操作は正常に完了しました。

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Catalogs_ListDevices

要求のサンプル

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/listDevices?api-version=2024-04-01

応答のサンプル

{
  "value": [
    {
      "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "properties": {}
    },
    {
      "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "properties": {}
    }
  ]
}

定義

名前 説明
createdByType

リソースを作成した ID の種類。

Device

デバイス グループ リソースに属するデバイス リソース。

DeviceListResult

デバイス リスト操作の応答。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ProvisioningState

リソースのプロビジョニング状態。

systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

Device

デバイス グループ リソースに属するデバイス リソース。

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

リソースの名前

properties.chipSku

string

チップの SKU

properties.deviceId

string

Device ID

properties.lastAvailableOsVersion

string

更新要求時にインストール可能な OS バージョン

properties.lastInstalledOsVersion

string

更新が要求されたときにデバイスで実行されている OS バージョン

properties.lastOsUpdateUtc

string

更新が要求され、新しい OS バージョンが利用可能な時刻

properties.lastUpdateRequestUtc

string

更新が最後に要求された時刻

properties.provisioningState

ProvisioningState

最後の操作の状態。

systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

DeviceListResult

デバイス リスト操作の応答。

名前 説明
nextLink

string

アイテムの次のページへのリンク

value

Device[]

このページの [デバイス] 項目

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

ProvisioningState

リソースのプロビジョニング状態。

名前 説明
Accepted

string

リソース作成要求が受け入れられた

Canceled

string

リソースの作成が取り消されました。

Deleting

string

リソースが削除されています

Failed

string

リソースの作成に失敗しました。

Provisioning

string

リソースのプロビジョニング中

Succeeded

string

リソースが作成されました。

Updating

string

リソースが更新中です

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。