Device Groups - List By Product

Szolgáltatás:

Azure Sphere

API-verzió:

2024-04-01

DeviceGroup-erőforrások listázása termék szerint. A ".default" és a ".unassigned" rendszer által definiált értékek, és nem használhatók a terméknévhez.

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

Opcionális paraméterekkel:

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-paraméterek

Name	In	Kötelező	Típus	Description
catalogName	path	True	string pattern: ^[A-Za-z0-9_-]{1,50}$	Katalógus neve
productName	path	True	string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$	A termék neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.
$filter	query		string	Az eredménylista szűrése a megadott kifejezéssel
$maxpagesize	query		integer (int32)	Az eredményelemek maximális száma oldalanként.
$skip	query		integer (int32)	A kihagyandó eredményelemek száma.
$top	query		integer (int32)	A visszaadni kívánt eredményelemek száma.

Válaszok

Name	Típus	Description
200 OK	DeviceGroupListResult	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

DeviceGroups_ListByProduct

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
AllowCrashDumpCollection	Összeomlási memóriaképek értékeinek engedélyezése.
createdByType	Az erőforrást létrehozó identitás típusa.
DeviceGroup	Egy termékerőforráshoz tartozó eszközcsoport-erőforrás.
DeviceGroupListResult	A DeviceGroup listaművelet válasza.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
OSFeedType	Operációsrendszer-hírcsatornatípus értékei.
ProvisioningState	Az erőforrás kiépítési állapota.
RegionalDataBoundary	Regionális adathatárértékek.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UpdatePolicy	Szabályzatértékek frissítése.

AllowCrashDumpCollection

Enumerálás

Összeomlási memóriaképek értékeinek engedélyezése.

Érték	Description
Disabled	Az összeomlási memóriakép-gyűjtemény le van tiltva
Enabled	Az összeomlási memóriakép-gyűjtemény engedélyezve van

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

DeviceGroup

Objektum

Egy termékerőforráshoz tartozó eszközcsoport-erőforrás.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.allowCrashDumpsCollection	AllowCrashDumpCollection	Jelző, amely meghatározza, hogy a felhasználó engedélyezi-e az összeomlási memóriaképek gyűjtését.
properties.description	string	Az eszközcsoport leírása.
properties.hasDeployment	boolean	Az eszközcsoport üzembe helyezési állapota.
properties.osFeedType	OSFeedType	Az eszközcsoport operációsrendszer-hírcsatornájának típusa.
properties.provisioningState	ProvisioningState	Az utolsó művelet állapota.
properties.regionalDataBoundary	RegionalDataBoundary	Az eszközcsoport regionális adathatára.
properties.updatePolicy	UpdatePolicy	Az eszközcsoport frissítési szabályzata.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

DeviceGroupListResult

Objektum

A DeviceGroup listaművelet válasza.

Name	Típus	Description
nextLink	string (uri)	Az elemek következő oldalára mutató hivatkozás
value	DeviceGroup[]	A lapon található DeviceGroup-elemek

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

OSFeedType

Enumerálás

Operációsrendszer-hírcsatornatípus értékei.

Érték	Description
Retail	Kiskereskedelmi operációsrendszer-hírcsatorna típusa.
RetailEval	Kiskereskedelmi kiértékelési operációsrendszer-hírcsatorna típusa.

ProvisioningState

Enumerálás

Az erőforrás kiépítési állapota.

Érték	Description
Accepted	Az erőforrás-létrehozási kérelem elfogadva
Canceled	Az erőforrás létrehozása megszakadt.
Deleting	Az erőforrás törlése folyamatban van
Failed	Az erőforrás létrehozása nem sikerült.
Provisioning	Az erőforrás kiépítése folyamatban van
Succeeded	Az erőforrás létrejött.
Updating	Az erőforrás frissítése folyamatban van

RegionalDataBoundary

Enumerálás

Regionális adathatárértékek.

Érték	Description
EU	AZ EU adathatára
None	Nincs adathatár

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UpdatePolicy

Enumerálás

Szabályzatértékek frissítése.

Érték	Description
No3rdPartyAppUpdates	Nincs frissítés harmadik féltől származó alkalmazásszabályzathoz.
UpdateAll	Frissítse az összes szabályzatot.