Udostępnij za pośrednictwem


Catalogs - List Device Groups

Wyświetl listę grup urządzeń dla wykazu.

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}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
catalogName
path True

string

Nazwa wykazu

Wzorzec wyrażenia regularnego: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

$filter
query

string

Filtrowanie listy wyników przy użyciu podanego wyrażenia

$maxpagesize
query

integer

int32

Maksymalna liczba elementów wyników na stronę.

$skip
query

integer

int32

Liczba elementów wyników do pominięcia.

$top
query

integer

int32

Liczba elementów wyniku do zwrócenia.

Treść żądania

Nazwa Typ Opis
deviceGroupName

string

Nazwa grupy urządzeń.

Odpowiedzi

Nazwa Typ Opis
200 OK

DeviceGroupListResult

Operacja platformy Azure została ukończona pomyślnie.

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Catalogs_ListDeviceGroups

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AllowCrashDumpCollection

Zezwalaj na wartości zrzutów awaryjnych.

createdByType

Typ tożsamości, która utworzyła zasób.

DeviceGroup

Zasób grupy urządzeń należący do zasobu produktu.

DeviceGroupListResult

Odpowiedź operacji listy DeviceGroup.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

ListDeviceGroupsRequest

Żądanie akcji w celu wyświetlenia listy grup urządzeń dla wykazu.

OSFeedType

Wartości typu źródła danych systemu operacyjnego.

ProvisioningState

Stan aprowizacji zasobu.

RegionalDataBoundary

Regionalne wartości granic danych.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

UpdatePolicy

Aktualizuj wartości zasad.

AllowCrashDumpCollection

Zezwalaj na wartości zrzutów awaryjnych.

Nazwa Typ Opis
Disabled

string

Wyłączono zbieranie zrzutów awaryjnych

Enabled

string

Włączono zbieranie zrzutów awaryjnych

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceGroup

Zasób grupy urządzeń należący do zasobu produktu.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.allowCrashDumpsCollection

AllowCrashDumpCollection

Flaga określająca, czy użytkownik zezwala na zbieranie zrzutów awaryjnych.

properties.description

string

Opis grupy urządzeń.

properties.hasDeployment

boolean

Stan wdrożenia dla grupy urządzeń.

properties.osFeedType

OSFeedType

Typ kanału informacyjnego systemu operacyjnego grupy urządzeń.

properties.provisioningState

ProvisioningState

Stan ostatniej operacji.

properties.regionalDataBoundary

RegionalDataBoundary

Regionalna granica danych dla grupy urządzeń.

properties.updatePolicy

UpdatePolicy

Zaktualizuj zasady grupy urządzeń.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

DeviceGroupListResult

Odpowiedź operacji listy DeviceGroup.

Nazwa Typ Opis
nextLink

string

Link do następnej strony elementów

value

DeviceGroup[]

Elementy DeviceGroup na tej stronie

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt error.

ListDeviceGroupsRequest

Żądanie akcji w celu wyświetlenia listy grup urządzeń dla wykazu.

Nazwa Typ Opis
deviceGroupName

string

Nazwa grupy urządzeń.

OSFeedType

Wartości typu źródła danych systemu operacyjnego.

Nazwa Typ Opis
Retail

string

Typ kanału informacyjnego systemu operacyjnego handlu detalicznego.

RetailEval

string

Typ kanału informacyjnego systemu operacyjnego oceny handlu detalicznego.

ProvisioningState

Stan aprowizacji zasobu.

Nazwa Typ Opis
Accepted

string

Żądanie utworzenia zasobu zostało zaakceptowane

Canceled

string

Tworzenie zasobów zostało anulowane.

Deleting

string

Zasób jest usuwany

Failed

string

Tworzenie zasobu nie powiodło się.

Provisioning

string

Zasób jest aprowizowany

Succeeded

string

Zasób został utworzony.

Updating

string

Zasób jest aktualizowany

RegionalDataBoundary

Regionalne wartości granic danych.

Nazwa Typ Opis
EU

string

Granica danych UE

None

string

Brak granicy danych

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UpdatePolicy

Aktualizuj wartości zasad.

Nazwa Typ Opis
No3rdPartyAppUpdates

string

Brak aktualizacji zasad aplikacji innych firm.

UpdateAll

string

Zaktualizuj wszystkie zasady.