Aracılığıyla paylaş


Catalogs - List Device Groups

Katalog için cihaz gruplarını listeleyin.

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 Parametreleri

Name İçinde Gerekli Tür Description
catalogName
path True

string

Kataloğun adı

Normal ifade deseni: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.

subscriptionId
path True

string

Hedef aboneliğin kimliği.

api-version
query True

string

Bu işlem için kullanılacak API sürümü.

$filter
query

string

Verilen ifadeyi kullanarak sonuç listesini filtreleme

$maxpagesize
query

integer

int32

Sayfa başına en fazla sonuç öğesi sayısı.

$skip
query

integer

int32

Atlana sonuç öğelerinin sayısı.

$top
query

integer

int32

Döndürülecek sonuç öğelerinin sayısı.

İstek Gövdesi

Name Tür Description
deviceGroupName

string

Cihaz Grubu adı.

Yanıtlar

Name Tür Description
200 OK

DeviceGroupListResult

Azure işlemi başarıyla tamamlandı.

Other Status Codes

ErrorResponse

Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

Catalogs_ListDeviceGroups

Örnek isteği

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"
}

Örnek yanıt

{
  "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"
    }
  ]
}

Tanımlar

Name Description
AllowCrashDumpCollection

Kilitlenme bilgi dökümü değerlerine izin verin.

createdByType

Kaynağı oluşturan kimliğin türü.

DeviceGroup

Ürün kaynağına ait bir cihaz grubu kaynağı.

DeviceGroupListResult

DeviceGroup liste işleminin yanıtı.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

ListDeviceGroupsRequest

Katalog için cihaz gruplarını listeleme eylemi isteği.

OSFeedType

İşletim sistemi akışı türü değerleri.

ProvisioningState

Kaynağın sağlama durumu.

RegionalDataBoundary

Bölgesel veri sınırı değerleri.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

UpdatePolicy

İlke değerlerini güncelleştirin.

AllowCrashDumpCollection

Kilitlenme bilgi dökümü değerlerine izin verin.

Name Tür Description
Disabled

string

Kilitlenme dökümü koleksiyonu devre dışı bırakıldı

Enabled

string

Kilitlenme dökümü koleksiyonu etkin

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceGroup

Ürün kaynağına ait bir cihaz grubu kaynağı.

Name Tür Description
id

string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Kaynağın adı

properties.allowCrashDumpsCollection

AllowCrashDumpCollection

Kullanıcının kilitlenme bilgi dökümü koleksiyonuna izin verdiğinden bağımsız olarak tanımlamak için bayrak.

properties.description

string

Cihaz grubunun açıklaması.

properties.hasDeployment

boolean

Cihaz grubu için dağıtım durumu.

properties.osFeedType

OSFeedType

Cihaz grubunun işletim sistemi akış türü.

properties.provisioningState

ProvisioningState

Son işlemin durumu.

properties.regionalDataBoundary

RegionalDataBoundary

Cihaz grubu için bölgesel veri sınırı.

properties.updatePolicy

UpdatePolicy

Cihaz grubunun ilkesini güncelleştirin.

systemData

systemData

createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.

type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

DeviceGroupListResult

DeviceGroup liste işleminin yanıtı.

Name Tür Description
nextLink

string

Öğelerin sonraki sayfasının bağlantısı

value

DeviceGroup[]

Bu sayfadaki DeviceGroup öğeleri

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi.

ErrorResponse

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

ListDeviceGroupsRequest

Katalog için cihaz gruplarını listeleme eylemi isteği.

Name Tür Description
deviceGroupName

string

Cihaz Grubu adı.

OSFeedType

İşletim sistemi akışı türü değerleri.

Name Tür Description
Retail

string

Perakende işletim sistemi akış türü.

RetailEval

string

Perakende değerlendirme işletim sistemi akış türü.

ProvisioningState

Kaynağın sağlama durumu.

Name Tür Description
Accepted

string

Kaynak oluşturma isteği kabul edildi

Canceled

string

Kaynak oluşturma işlemi iptal edildi.

Deleting

string

Kaynak siliniyor

Failed

string

Kaynak oluşturulamadı.

Provisioning

string

Kaynak sağlanıyor

Succeeded

string

Kaynak oluşturuldu.

Updating

string

Kaynak güncelleştiriliyor

RegionalDataBoundary

Bölgesel veri sınırı değerleri.

Name Tür Description
EU

string

AB veri sınırı

None

string

Veri sınırı yok

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.

UpdatePolicy

İlke değerlerini güncelleştirin.

Name Tür Description
No3rdPartyAppUpdates

string

Üçüncü taraf uygulama ilkesi için güncelleştirme yok.

UpdateAll

string

Tüm ilkeyi güncelleştirin.