次の方法で共有


Catalogs - List Device Groups

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups?api-version=2024-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups?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

返す結果アイテムの数。

要求本文

名前 説明
deviceGroupName

string

デバイス グループ名。

応答

名前 説明
200 OK

DeviceGroupListResult

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_ListDeviceGroups

要求のサンプル

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

{
  "deviceGroupName": "MyDeviceGroup1"
}

応答のサンプル

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1",
      "name": "MyDeviceGroup1",
      "type": "microsoft.azureSphere/catalogs/products/devicegroups"
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2",
      "name": "MyDeviceGroup2",
      "type": "microsoft.azureSphere/catalogs/products/devicegroups"
    }
  ]
}

定義

名前 説明
AllowCrashDumpCollection

クラッシュ ダンプの値を許可します。

createdByType

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

DeviceGroup

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

DeviceGroupListResult

DeviceGroup リスト操作の応答。

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ListDeviceGroupsRequest

カタログのデバイス グループを一覧表示するアクションの要求。

OSFeedType

OS フィードの種類の値。

ProvisioningState

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

RegionalDataBoundary

地域データ境界値。

systemData

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

UpdatePolicy

ポリシー値を更新します。

AllowCrashDumpCollection

クラッシュ ダンプの値を許可します。

名前 説明
Disabled

string

クラッシュ ダンプ コレクションが無効になっている

Enabled

string

クラッシュ ダンプ コレクションが有効

createdByType

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

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceGroup

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

名前 説明
id

string

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

name

string

リソースの名前

properties.allowCrashDumpsCollection

AllowCrashDumpCollection

ユーザーがクラッシュ ダンプ収集を許可するかどうかを定義するフラグ。

properties.description

string

デバイス グループの説明。

properties.hasDeployment

boolean

デバイス グループの展開状態。

properties.osFeedType

OSFeedType

デバイス グループのオペレーティング システム フィードの種類。

properties.provisioningState

ProvisioningState

最後の操作の状態。

properties.regionalDataBoundary

RegionalDataBoundary

デバイス グループの地域データ境界。

properties.updatePolicy

UpdatePolicy

デバイス グループのポリシーを更新します。

systemData

systemData

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

type

string

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

DeviceGroupListResult

DeviceGroup リスト操作の応答。

名前 説明
nextLink

string

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

value

DeviceGroup[]

このページの DeviceGroup 項目

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

ListDeviceGroupsRequest

カタログのデバイス グループを一覧表示するアクションの要求。

名前 説明
deviceGroupName

string

デバイス グループ名。

OSFeedType

OS フィードの種類の値。

名前 説明
Retail

string

Retail OS フィードの種類。

RetailEval

string

小売評価 OS フィードの種類。

ProvisioningState

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

名前 説明
Accepted

string

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

Canceled

string

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

Deleting

string

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

Failed

string

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

Provisioning

string

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

Succeeded

string

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

Updating

string

リソースが更新中です

RegionalDataBoundary

地域データ境界値。

名前 説明
EU

string

EU データ境界

None

string

データ境界なし

systemData

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

名前 説明
createdAt

string

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

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

UpdatePolicy

ポリシー値を更新します。

名前 説明
No3rdPartyAppUpdates

string

サード パーティ製アプリ ポリシーの更新プログラムはありません。

UpdateAll

string

すべてのポリシーを更新します。