Device Groups - List By Product

Dienst:

Azure Sphere

API-Version:

2024-04-01

DeviceGroup-Ressourcen nach Produkt auflisten. '.default' und '.unassigned' sind systemdefinierte Werte und können nicht für den Produktnamen verwendet werden.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups?api-version=2024-04-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups?api-version=2024-04-01&$filter={$filter}&$top={$top}&$skip={$skip}&$maxpagesize={$maxpagesize}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
catalogName	path	True	string pattern: ^[A-Za-z0-9_-]{1,50}$	Name des Katalogs
productName	path	True	string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$	Name des Produkts.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	Filtern der Ergebnisliste mithilfe des angegebenen Ausdrucks
$maxpagesize	query		integer (int32)	Die maximale Anzahl von Ergebniselementen pro Seite.
$skip	query		integer (int32)	Die Anzahl der zu überspringenden Ergebniselemente.
$top	query		integer (int32)	Die Anzahl der zurückzugebenden Ergebniselemente.

Antworten

Name	Typ	Beschreibung
200 OK	DeviceGroupListResult	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

DeviceGroups_ListByProduct

Beispielanforderung

HTTP

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

Java

/**
 * Samples for DeviceGroups ListByProduct.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json
     */
    /**
     * Sample code: DeviceGroups_ListByProduct.
     * 
     * @param manager Entry point to AzureSphereManager.
     */
    public static void deviceGroupsListByProduct(com.azure.resourcemanager.sphere.AzureSphereManager manager) {
        manager.deviceGroups().listByProduct("MyResourceGroup1", "MyCatalog1", "MyProduct1", 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 azure.identity import DefaultAzureCredential

from azure.mgmt.sphere import AzureSphereMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sphere
# USAGE
    python get_device_groups.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.device_groups.list_by_product(
        resource_group_name="MyResourceGroup1",
        catalog_name="MyCatalog1",
        product_name="MyProduct1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.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/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/GetDeviceGroups.json
func ExampleDeviceGroupsClient_NewListByProductPager() {
	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.NewDeviceGroupsClient().NewListByProductPager("MyResourceGroup1", "MyCatalog1", "MyProduct1", &armsphere.DeviceGroupsClientListByProductOptions{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 DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
 *
 * @summary List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
 * x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json
 */
async function deviceGroupsListByProduct() {
  const subscriptionId =
    process.env["SPHERE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["SPHERE_RESOURCE_GROUP"] || "MyResourceGroup1";
  const catalogName = "MyCatalog1";
  const productName = "MyProduct1";
  const credential = new DefaultAzureCredential();
  const client = new AzureSphereManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.deviceGroups.listByProduct(
    resourceGroupName,
    catalogName,
    productName,
  )) {
    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/GetDeviceGroups.json
// this example is just showing the usage of "DeviceGroups_ListByProduct" 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 SphereProductResource created on azure
// for more information of creating SphereProductResource, please refer to the document of SphereProductResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "MyResourceGroup1";
string catalogName = "MyCatalog1";
string productName = "MyProduct1";
ResourceIdentifier sphereProductResourceId = SphereProductResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, catalogName, productName);
SphereProductResource sphereProduct = client.GetSphereProductResource(sphereProductResourceId);

// get the collection of this SphereDeviceGroupResource
SphereDeviceGroupCollection collection = sphereProduct.GetSphereDeviceGroups();

// invoke the operation and iterate over the result
await foreach (SphereDeviceGroupResource item in collection.GetAllAsync())
{
    // 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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AllowCrashDumpCollection	Absturzabbilder zulassen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DeviceGroup	Eine Gerätegruppenressource, die zu einer Produktressource gehört.
DeviceGroupListResult	Die Antwort eines DeviceGroup-Listenvorgangs.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
OSFeedType	Werte des Betriebssystemfeedtyps.
ProvisioningState	Bereitstellungsstatus der Ressource.
RegionalDataBoundary	Regionale Datenbegrenzungswerte.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UpdatePolicy	Aktualisieren von Richtlinienwerten.

AllowCrashDumpCollection

Enumeration

Absturzabbilder zulassen.

Wert	Beschreibung
Enabled	Absturzabbildsammlung aktiviert
Disabled	Absturzabbildsammlung deaktiviert

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DeviceGroup

Objekt

Eine Gerätegruppenressource, die zu einer Produktressource gehört.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.allowCrashDumpsCollection	AllowCrashDumpCollection	Flag zum Definieren, ob der Benutzer absturzabbildsammlung zulässt.
properties.description	string	Beschreibung der Gerätegruppe.
properties.hasDeployment	boolean	Bereitstellungsstatus für die Gerätegruppe.
properties.osFeedType	OSFeedType	Betriebssystemfeedtyp der Gerätegruppe.
properties.provisioningState	ProvisioningState	Der Status des letzten Vorgangs.
properties.regionalDataBoundary	RegionalDataBoundary	Regionale Datengrenze für die Gerätegruppe.
properties.updatePolicy	UpdatePolicy	Aktualisieren sie die Richtlinie der Gerätegruppe.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DeviceGroupListResult

Objekt

Die Antwort eines DeviceGroup-Listenvorgangs.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	DeviceGroup[]	Die DeviceGroup-Elemente auf dieser Seite

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

OSFeedType

Enumeration

Werte des Betriebssystemfeedtyps.

Wert	Beschreibung
Retail	Feedtyp des Einzelhandelsbetriebssystems.
RetailEval	BS-Feedtyp für Einzelhandelsauswertung.

ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Succeeded	Ressource wurde erstellt.
Failed	Fehler bei der Ressourcenerstellung.
Canceled	Die Ressourcenerstellung wurde abgebrochen.
Provisioning	Die Ressource wird bereitgestellt.
Updating	Die Ressource wird aktualisiert.
Deleting	Die Ressource wird gelöscht.
Accepted	Die Anforderung zum Erstellen der Ressource wurde akzeptiert.

RegionalDataBoundary

Enumeration

Regionale Datenbegrenzungswerte.

Wert	Beschreibung
None	Keine Datenbegrenzung
EU	EU-Datengrenze

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UpdatePolicy

Enumeration

Aktualisieren von Richtlinienwerten.

Wert	Beschreibung
UpdateAll	Alle Richtlinien aktualisieren.
No3rdPartyAppUpdates	Keine Aktualisierung der App-Richtlinie von Drittanbietern.