Dela via


Catalogs - List Devices

Visar en lista över enheter för katalogen.

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-parametrar

Name I Obligatorisk Typ Description
catalogName
path True

string

Namn på katalog

Reguljärt uttrycksmönster: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

$filter
query

string

Filtrera resultatlistan med det angivna uttrycket

$maxpagesize
query

integer

int32

Det maximala antalet resultatobjekt per sida.

$skip
query

integer

int32

Antalet resultatobjekt som ska hoppa över.

$top
query

integer

int32

Antalet resultatobjekt som ska returneras.

Svar

Name Typ Description
200 OK

DeviceListResult

Azure-åtgärden har slutförts.

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Catalogs_ListDevices

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.

Device

En enhetsresurs som tillhör en enhetsgruppsresurs.

DeviceListResult

Svaret från en åtgärd för enhetslistan.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ProvisioningState

Etableringstillstånd för resursen.

systemData

Metadata som rör skapande och senaste ändring av resursen.

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

Device

En enhetsresurs som tillhör en enhetsgruppsresurs.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.chipSku

string

Chipets SKU

properties.deviceId

string

Enhets-ID

properties.lastAvailableOsVersion

string

Os-version som är tillgänglig för installation när uppdateringen begärs

properties.lastInstalledOsVersion

string

OS-version som körs på enheten när uppdateringen begärs

properties.lastOsUpdateUtc

string

Tid när uppdateringen begärdes och den nya versionen av operativsystemet är tillgänglig

properties.lastUpdateRequestUtc

string

Tid då uppdateringen senast begärdes

properties.provisioningState

ProvisioningState

Status för den senaste åtgärden.

systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy-information.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

DeviceListResult

Svaret från en åtgärd för enhetslistan.

Name Typ Description
nextLink

string

Länken till nästa sida med objekt

value

Device[]

Enhetsobjekten på den här sidan

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ProvisioningState

Etableringstillstånd för resursen.

Name Typ Description
Accepted

string

Begäran om resursskapande har accepterats

Canceled

string

Resursskapandet avbröts.

Deleting

string

Resursen tas bort

Failed

string

Det gick inte att skapa resursen.

Provisioning

string

Resursen etableras

Succeeded

string

Resursen har skapats.

Updating

string

Resursen uppdateras

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.