Condividi tramite


Catalogs - List Device Groups

Elencare i gruppi di dispositivi per il catalogo.

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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
catalogName
path True

string

Nome del catalogo

Criterio di espressione regolare: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

$filter
query

string

Filtrare l'elenco dei risultati usando l'espressione specificata

$maxpagesize
query

integer

int32

Numero massimo di elementi dei risultati per pagina.

$skip
query

integer

int32

Numero di elementi dei risultati da ignorare.

$top
query

integer

int32

Numero di elementi dei risultati da restituire.

Corpo della richiesta

Nome Tipo Descrizione
deviceGroupName

string

Nome gruppo di dispositivi.

Risposte

Nome Tipo Descrizione
200 OK

DeviceGroupListResult

Operazione di Azure completata.

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Catalogs_ListDeviceGroups

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
AllowCrashDumpCollection

Consenti i valori dei dump di arresto anomalo del sistema.

createdByType

Tipo di identità che ha creato la risorsa.

DeviceGroup

Una risorsa del gruppo di dispositivi appartenente a una risorsa del prodotto.

DeviceGroupListResult

Risposta di un'operazione di elenco DeviceGroup.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

ListDeviceGroupsRequest

Richiesta dell'azione per elencare i gruppi di dispositivi per un catalogo.

OSFeedType

Valori del tipo di feed del sistema operativo.

ProvisioningState

Stato di provisioning della risorsa.

RegionalDataBoundary

Valori limite dati a livello di area.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

UpdatePolicy

Aggiornare i valori dei criteri.

AllowCrashDumpCollection

Consenti i valori dei dump di arresto anomalo del sistema.

Nome Tipo Descrizione
Disabled

string

Raccolta di dump di arresto anomalo disabilitata

Enabled

string

Raccolta di dump di arresto anomalo del sistema abilitata

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceGroup

Una risorsa del gruppo di dispositivi appartenente a una risorsa del prodotto.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.allowCrashDumpsCollection

AllowCrashDumpCollection

Contrassegno da definire se l'utente consente la raccolta di dump di arresto anomalo del sistema.

properties.description

string

Descrizione del gruppo di dispositivi.

properties.hasDeployment

boolean

Stato della distribuzione per il gruppo di dispositivi.

properties.osFeedType

OSFeedType

Tipo di feed del sistema operativo del gruppo di dispositivi.

properties.provisioningState

ProvisioningState

Stato dell'ultima operazione.

properties.regionalDataBoundary

RegionalDataBoundary

Limite dei dati a livello di area per il gruppo di dispositivi.

properties.updatePolicy

UpdatePolicy

Aggiornare i criteri del gruppo di dispositivi.

systemData

systemData

Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DeviceGroupListResult

Risposta di un'operazione di elenco DeviceGroup.

Nome Tipo Descrizione
nextLink

string

Collegamento alla pagina successiva di elementi

value

DeviceGroup[]

Elementi DeviceGroup in questa pagina

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ListDeviceGroupsRequest

Richiesta dell'azione per elencare i gruppi di dispositivi per un catalogo.

Nome Tipo Descrizione
deviceGroupName

string

Nome gruppo di dispositivi.

OSFeedType

Valori del tipo di feed del sistema operativo.

Nome Tipo Descrizione
Retail

string

Tipo di feed del sistema operativo retail.

RetailEval

string

Tipo di feed del sistema operativo di valutazione al dettaglio.

ProvisioningState

Stato di provisioning della risorsa.

Nome Tipo Descrizione
Accepted

string

La richiesta di creazione della risorsa è stata accettata

Canceled

string

La creazione della risorsa è stata annullata.

Deleting

string

La risorsa viene eliminata

Failed

string

Creazione della risorsa non riuscita.

Provisioning

string

Provisioning della risorsa

Succeeded

string

La risorsa è stata creata.

Updating

string

La risorsa viene aggiornata

RegionalDataBoundary

Valori limite dati a livello di area.

Nome Tipo Descrizione
EU

string

Limite dati UE

None

string

Nessun limite di dati

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.

UpdatePolicy

Aggiornare i valori dei criteri.

Nome Tipo Descrizione
No3rdPartyAppUpdates

string

Nessun aggiornamento per i criteri delle app di terze parti.

UpdateAll

string

Aggiornare tutti i criteri.