Products - Generate Default Device Groups

Hizmet:

Azure Sphere

API Sürümü:

2024-04-01

Ürün için varsayılan cihaz gruplarını oluşturur. '.default' ve '.unassigned' sistem tanımlı değerlerdir ve ürün adı için kullanılamaz.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
catalogName	path	True	string pattern: ^[A-Za-z0-9_-]{1,50}$	Kataloğun adı
productName	path	True	string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$	Ürünün adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	DeviceGroupListResult	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Products_GenerateDefaultDeviceGroups

Örnek isteği

HTTP

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

Java

/**
 * Samples for Products GenerateDefaultDeviceGroups.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/
     * PostGenerateDefaultDeviceGroups.json
     */
    /**
     * Sample code: Products_GenerateDefaultDeviceGroups.
     * 
     * @param manager Entry point to AzureSphereManager.
     */
    public static void
        productsGenerateDefaultDeviceGroups(com.azure.resourcemanager.sphere.AzureSphereManager manager) {
        manager.products().generateDefaultDeviceGroups("MyResourceGroup1", "MyCatalog1", "MyProduct1",
            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 post_generate_default_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.products.generate_default_device_groups(
        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/PostGenerateDefaultDeviceGroups.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/PostGenerateDefaultDeviceGroups.json
func ExampleProductsClient_NewGenerateDefaultDeviceGroupsPager() {
	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.NewProductsClient().NewGenerateDefaultDeviceGroupsPager("MyResourceGroup1", "MyCatalog1", "MyProduct1", 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"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1"),
		// 			Properties: &armsphere.DeviceGroupProperties{
		// 				Description: to.Ptr("Device group description 1"),
		// 				AllowCrashDumpsCollection: to.Ptr(armsphere.AllowCrashDumpCollectionEnabled),
		// 				OSFeedType: to.Ptr(armsphere.OSFeedTypeRetail),
		// 				UpdatePolicy: to.Ptr(armsphere.UpdatePolicyUpdateAll),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("MyDeviceGroup2"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup2"),
		// 			Properties: &armsphere.DeviceGroupProperties{
		// 				Description: to.Ptr("Device group description 2"),
		// 				AllowCrashDumpsCollection: to.Ptr(armsphere.AllowCrashDumpCollectionEnabled),
		// 				OSFeedType: to.Ptr(armsphere.OSFeedTypeRetail),
		// 				UpdatePolicy: to.Ptr(armsphere.UpdatePolicyUpdateAll),
		// 			},
		// 	}},
		// }
	}
}

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 Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
 *
 * @summary Generates default device groups for the 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/PostGenerateDefaultDeviceGroups.json
 */
async function productsGenerateDefaultDeviceGroups() {
  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.products.listGenerateDefaultDeviceGroups(
    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/PostGenerateDefaultDeviceGroups.json
// this example is just showing the usage of "Products_GenerateDefaultDeviceGroups" 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);

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

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1",
      "name": "MyDeviceGroup1",
      "properties": {
        "description": "Device group description 1",
        "osFeedType": "Retail",
        "updatePolicy": "UpdateAll",
        "allowCrashDumpsCollection": "Enabled"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup2",
      "name": "MyDeviceGroup2",
      "properties": {
        "description": "Device group description 2",
        "osFeedType": "Retail",
        "updatePolicy": "UpdateAll",
        "allowCrashDumpsCollection": "Enabled"
      }
    }
  ]
}

Tanımlar

Name	Description
AllowCrashDumpCollection	Kilitlenme bilgi dökümü değerlerine izin verin.
createdByType	Kaynağı oluşturan kimliğin türü.
DeviceGroup	Ürün kaynağına ait bir cihaz grubu kaynağı.
DeviceGroupListResult	DeviceGroup liste işleminin yanıtı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
OSFeedType	İşletim sistemi akışı türü değerleri.
ProvisioningState	Kaynağın sağlama durumu.
RegionalDataBoundary	Bölgesel veri sınırı değerleri.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UpdatePolicy	İlke değerlerini güncelleştirin.

AllowCrashDumpCollection

Listeleme

Kilitlenme bilgi dökümü değerlerine izin verin.

Değer	Description
Enabled	Kilitlenme dökümü koleksiyonu etkin
Disabled	Kilitlenme dökümü koleksiyonu devre dışı bırakıldı

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

DeviceGroup

Object

Ürün kaynağına ait bir cihaz grubu kaynağı.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.allowCrashDumpsCollection	AllowCrashDumpCollection	Kullanıcının kilitlenme bilgi dökümü koleksiyonuna izin kullanıp vermediğini tanımlamak için bayrak.
properties.description	string	Cihaz grubunun açıklaması.
properties.hasDeployment	boolean	Cihaz grubu için dağıtım durumu.
properties.osFeedType	OSFeedType	Cihaz grubunun işletim sistemi akış türü.
properties.provisioningState	ProvisioningState	Son işlemin durumu.
properties.regionalDataBoundary	RegionalDataBoundary	Cihaz grubu için bölgesel veri sınırı.
properties.updatePolicy	UpdatePolicy	Cihaz grubunun ilkesini güncelleştirin.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

DeviceGroupListResult

Object

DeviceGroup liste işleminin yanıtı.

Name	Tür	Description
nextLink	string (uri)	Öğelerin sonraki sayfasına bağlantı
value	DeviceGroup[]	Bu sayfadaki DeviceGroup öğeleri

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

OSFeedType

Listeleme

İşletim sistemi akışı türü değerleri.

Değer	Description
Retail	Perakende işletim sistemi akış türü.
RetailEval	Perakende değerlendirme işletim sistemi akışı türü.

ProvisioningState

Listeleme

Kaynağın sağlama durumu.

Değer	Description
Succeeded	Kaynak oluşturuldu.
Failed	Kaynak oluşturulamadı.
Canceled	Kaynak oluşturma işlemi iptal edildi.
Provisioning	Kaynak sağlanıyor
Updating	Kaynak güncelleştiriliyor
Deleting	Kaynak siliniyor
Accepted	Kaynak oluşturma isteği kabul edildi

RegionalDataBoundary

Listeleme

Bölgesel veri sınırı değerleri.

Değer	Description
None	Veri sınırı yok
EU	AB veri sınırı

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

UpdatePolicy

Listeleme

İlke değerlerini güncelleştirin.

Değer	Description
UpdateAll	Tüm ilkeyi güncelleştirin.
No3rdPartyAppUpdates	Üçüncü taraf uygulama ilkesi için güncelleştirme yok.