Catalogs - List Device Groups

Usługa:

Azure Sphere

Wersja interfejsu API:

2024-04-01

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

Z parametrami opcjonalnymi:

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 pattern: ^[A-Za-z0-9_-]{1,50}$	Nazwa wykazu
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	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 wyników 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 protokołu 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

HTTP

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

Java

import com.azure.resourcemanager.sphere.models.ListDeviceGroupsRequest;

/**
 * Samples for Catalogs ListDeviceGroups.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/
     * PostListDeviceGroupsCatalog.json
     */
    /**
     * Sample code: Catalogs_ListDeviceGroups.
     * 
     * @param manager Entry point to AzureSphereManager.
     */
    public static void catalogsListDeviceGroups(com.azure.resourcemanager.sphere.AzureSphereManager manager) {
        manager.catalogs().listDeviceGroups("MyResourceGroup1", "MyCatalog1",
            new ListDeviceGroupsRequest().withDeviceGroupName("MyDeviceGroup1"), null, null, null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.sphere import AzureSphereMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sphere
# USAGE
    python post_list_device_groups_catalog.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureSphereMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.catalogs.list_device_groups(
        resource_group_name="MyResourceGroup1",
        catalog_name="MyCatalog1",
        list_device_groups_request={"deviceGroupName": "MyDeviceGroup1"},
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsphere_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sphere/armsphere"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/09c37754dac91874ff689ed1e60effb4268c8669/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json
func ExampleCatalogsClient_NewListDeviceGroupsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsphere.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCatalogsClient().NewListDeviceGroupsPager("MyResourceGroup1", "MyCatalog1", armsphere.ListDeviceGroupsRequest{
		DeviceGroupName: to.Ptr("MyDeviceGroup1"),
	}, &armsphere.CatalogsClientListDeviceGroupsOptions{Filter: nil,
		Top:         nil,
		Skip:        nil,
		Maxpagesize: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DeviceGroupListResult = armsphere.DeviceGroupListResult{
		// 	Value: []*armsphere.DeviceGroup{
		// 		{
		// 			Name: to.Ptr("MyDeviceGroup1"),
		// 			Type: to.Ptr("microsoft.azureSphere/catalogs/products/devicegroups"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1"),
		// 		},
		// 		{
		// 			Name: to.Ptr("MyDeviceGroup2"),
		// 			Type: to.Ptr("microsoft.azureSphere/catalogs/products/devicegroups"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureSphereManagementClient } = require("@azure/arm-sphere");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List the device groups for the catalog.
 *
 * @summary List the device groups for the catalog.
 * x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json
 */
async function catalogsListDeviceGroups() {
  const subscriptionId =
    process.env["SPHERE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["SPHERE_RESOURCE_GROUP"] || "MyResourceGroup1";
  const catalogName = "MyCatalog1";
  const listDeviceGroupsRequest = {
    deviceGroupName: "MyDeviceGroup1",
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureSphereManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.catalogs.listDeviceGroups(
    resourceGroupName,
    catalogName,
    listDeviceGroupsRequest,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sphere.Models;
using Azure.ResourceManager.Sphere;

// Generated from example definition: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json
// this example is just showing the usage of "Catalogs_ListDeviceGroups" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SphereCatalogResource created on azure
// for more information of creating SphereCatalogResource, please refer to the document of SphereCatalogResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "MyResourceGroup1";
string catalogName = "MyCatalog1";
ResourceIdentifier sphereCatalogResourceId = SphereCatalogResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, catalogName);
SphereCatalogResource sphereCatalog = client.GetSphereCatalogResource(sphereCatalogResourceId);

// invoke the operation and iterate over the result
ListSphereDeviceGroupsContent content = new ListSphereDeviceGroupsContent
{
    DeviceGroupName = "MyDeviceGroup1",
};
await foreach (SphereDeviceGroupResource item in sphereCatalog.GetDeviceGroupsAsync(content))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SphereDeviceGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:

200

{
  "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, aby wyświetlić listę 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

Wyliczanie

Zezwalaj na wartości zrzutów awaryjnych.

Wartość	Opis
Enabled	Włączono zbieranie zrzutów awaryjnych
Disabled	Kolekcja zrzutów awaryjnych jest wyłączona

createdByType

Wyliczanie

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

Wartość	Opis
User
Application
ManagedIdentity
Key

DeviceGroup

Objekt

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

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /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 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

Objekt

Odpowiedź operacji listy DeviceGroup.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	DeviceGroup[]	Elementy DeviceGroup na tej stronie

ErrorAdditionalInfo

Objekt

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

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ListDeviceGroupsRequest

Objekt

Żądanie akcji, aby wyświetlić listę grup urządzeń dla wykazu.

Nazwa	Typ	Opis
deviceGroupName	string	Nazwa grupy urządzeń.

OSFeedType

Wyliczanie

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

Wartość	Opis
Retail	Typ kanału informacyjnego systemu operacyjnego handlu detalicznego.
RetailEval	Typ kanału informacyjnego systemu operacyjnego oceny handlu detalicznego.

ProvisioningState

Wyliczanie

Stan aprowizacji zasobu.

Wartość	Opis
Succeeded	Zasób został utworzony.
Failed	Tworzenie zasobu nie powiodło się.
Canceled	Tworzenie zasobów zostało anulowane.
Provisioning	Zasób jest aprowizowany
Updating	Zasób jest aktualizowany
Deleting	Zasób jest usuwany
Accepted	Żądanie utworzenia zasobu zostało zaakceptowane

RegionalDataBoundary

Wyliczanie

Regionalne wartości granic danych.

Wartość	Opis
None	Brak granicy danych
EU	Granica danych UE

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (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 (date-time)	Znacznik czasu 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

Wyliczanie

Aktualizuj wartości zasad.

Wartość	Opis
UpdateAll	Zaktualizuj wszystkie zasady.
No3rdPartyAppUpdates	Brak aktualizacji zasad aplikacji innych firm.