Aracılığıyla paylaş


Catalogs - List Devices

Katalog için cihazları listeler.

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 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ı.

Yanıtlar

Name Tür Description
200 OK

DeviceListResult

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_ListDevices

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Name Description
createdByType

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

Device

Cihaz grubu kaynağına ait bir cihaz kaynağı.

DeviceListResult

Cihaz listesi işleminin yanıtı.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Hata yanıtı

ProvisioningState

Kaynağın sağlama durumu.

systemData

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

createdByType

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

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

Device

Cihaz grubu kaynağına ait bir cihaz 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.chipSku

string

Yonganın SKU'su

properties.deviceId

string

Cihaz Kimliği

properties.lastAvailableOsVersion

string

Güncelleştirme istendiğinde yükleme için kullanılabilen işletim sistemi sürümü

properties.lastInstalledOsVersion

string

Güncelleştirme istendiğinde cihazda çalışan işletim sistemi sürümü

properties.lastOsUpdateUtc

string

Güncelleştirmenin istenip yeni işletim sistemi sürümünün kullanılabilir olduğu zaman

properties.lastUpdateRequestUtc

string

Güncelleştirmenin en son istenildiği zaman

properties.provisioningState

ProvisioningState

Son işlemin durumu.

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"

DeviceListResult

Cihaz listesi işleminin yanıtı.

Name Tür Description
nextLink

string

Öğelerin sonraki sayfasına bağlantı

value

Device[]

Bu sayfadaki Cihaz öğ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.

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

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ğı en son değiştiren kimlik.

lastModifiedByType

createdByType

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