Products - Generate Default Device Groups

Service:

Azure Sphere

API-versie:

2024-04-01

Hiermee worden standaardapparaatgroepen voor het product gegenereerd. '.default' en '.unassigned' zijn door het systeem gedefinieerde waarden en kunnen niet worden gebruikt voor productnaam.

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

URI-parameters

Name	In	Vereist	Type	Description
catalogName	path	True	string pattern: ^[A-Za-z0-9_-]{1,50}$	Naam van catalogus
productName	path	True	string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$	Naam van product.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	DeviceGroupListResult	De Azure-bewerking is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Products_GenerateDefaultDeviceGroups

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
AllowCrashDumpCollection	Crashdumpwaarden toestaan.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DeviceGroup	Een apparaatgroepresource die hoort bij een productresource.
DeviceGroupListResult	Het antwoord van een apparaatgroeplijstbewerking.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
OSFeedType	Waarden van het type besturingssysteemfeed.
ProvisioningState	Inrichtingsstatus van de resource.
RegionalDataBoundary	Regionale gegevensgrenswaarden.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UpdatePolicy	Beleidswaarden bijwerken.

AllowCrashDumpCollection

Inventarisatie

Crashdumpwaarden toestaan.

Waarde	Description
Enabled	Crashdumpverzameling ingeschakeld
Disabled	Crashdumpverzameling uitgeschakeld

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DeviceGroup

Object

Een apparaatgroepresource die hoort bij een productresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.allowCrashDumpsCollection	AllowCrashDumpCollection	Vlag om te definiëren of de gebruiker crashdumpverzameling toestaat.
properties.description	string	Beschrijving van de apparaatgroep.
properties.hasDeployment	boolean	Implementatiestatus voor de apparaatgroep.
properties.osFeedType	OSFeedType	Type besturingssysteemfeed van de apparaatgroep.
properties.provisioningState	ProvisioningState	De status van de laatste bewerking.
properties.regionalDataBoundary	RegionalDataBoundary	Regionale gegevensgrens voor de apparaatgroep.
properties.updatePolicy	UpdatePolicy	Beleid van de apparaatgroep bijwerken.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

DeviceGroupListResult

Object

Het antwoord van een apparaatgroeplijstbewerking.

Name	Type	Description
nextLink	string (uri)	De koppeling naar de volgende pagina met items
value	DeviceGroup[]	De DeviceGroup-items op deze pagina

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

OSFeedType

Inventarisatie

Waarden van het type besturingssysteemfeed.

Waarde	Description
Retail	Feedtype retail-besturingssysteem.
RetailEval	Feedtype retailevaluatie van besturingssysteem.

ProvisioningState

Inventarisatie

Inrichtingsstatus van de resource.

Waarde	Description
Succeeded	De resource is gemaakt.
Failed	Het maken van resources is mislukt.
Canceled	Het maken van resources is geannuleerd.
Provisioning	De resource wordt ingericht
Updating	De resource wordt bijgewerkt
Deleting	De resource wordt verwijderd
Accepted	De aanvraag voor het maken van resources is geaccepteerd

RegionalDataBoundary

Inventarisatie

Regionale gegevensgrenswaarden.

Waarde	Description
None	Geen gegevensgrens
EU	Eu-gegevensgrens

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UpdatePolicy

Inventarisatie

Beleidswaarden bijwerken.

Waarde	Description
UpdateAll	Werk alle beleidsregels bij.
No3rdPartyAppUpdates	Er is geen update voor app-beleid van derden.