Deployments - List By Device Group

Služba:

Azure Sphere

Verze rozhraní API:

2024-04-01

Vypsat prostředky nasazení podle deviceGroup .default a .unassigned jsou hodnoty definované systémem a nelze je použít pro název skupiny produktů nebo zařízení.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
catalogName	path	True	string pattern: ^[A-Za-z0-9_-]{1,50}$	Název katalogu
deviceGroupName	path	True	string pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$	Název skupiny zařízení
productName	path	True	string pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$	Název produktu.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	Filtrování seznamu výsledků pomocí daného výrazu
$maxpagesize	query		integer (int32)	Maximální počet výsledků položek na stránku.
$skip	query		integer (int32)	Počet položek výsledků, které se mají přeskočit.
$top	query		integer (int32)	Počet výsledných položek, které se mají vrátit.

Odpovědi

Name	Typ	Description
200 OK	DeploymentListResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Deployments_ListByDeviceGroup

Ukázkový požadavek

HTTP

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

Java

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

from azure.mgmt.sphere import AzureSphereMgmtClient

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


# x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.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/GetDeployments.json
func ExampleDeploymentsClient_NewListByDeviceGroupPager() {
	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.NewDeploymentsClient().NewListByDeviceGroupPager("MyResourceGroup1", "MyCatalog1", "MyProduct1", "myDeviceGroup1", &armsphere.DeploymentsClientListByDeviceGroupOptions{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.DeploymentListResult = armsphere.DeploymentListResult{
		// 	Value: []*armsphere.Deployment{
		// 		{
		// 			Name: to.Ptr("MyDeployment1"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1"),
		// 			Properties: &armsphere.DeploymentProperties{
		// 				DeployedImages: []*armsphere.Image{
		// 					{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1"),
		// 						Properties: &armsphere.ImageProperties{
		// 							Description: to.Ptr("description"),
		// 							ComponentID: to.Ptr("componentId"),
		// 							Image: to.Ptr("dGVzdGltYWdl"),
		// 							ImageType: to.Ptr(armsphere.ImageType("ImageType")),
		// 							ProvisioningState: to.Ptr(armsphere.ProvisioningStateSucceeded),
		// 							RegionalDataBoundary: to.Ptr(armsphere.RegionalDataBoundaryNone),
		// 							URI: to.Ptr("imageUri"),
		// 						},
		// 				}},
		// 				DeploymentDateUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-30T21:51:39.269Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

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 Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
 *
 * @summary List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
 * x-ms-original-file: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json
 */
async function deploymentsListByDeviceGroup() {
  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 deviceGroupName = "myDeviceGroup1";
  const credential = new DefaultAzureCredential();
  const client = new AzureSphereManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.deployments.listByDeviceGroup(
    resourceGroupName,
    catalogName,
    productName,
    deviceGroupName,
  )) {
    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;

// Generated from example definition: specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json
// this example is just showing the usage of "Deployments_ListByDeviceGroup" 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 SphereDeviceGroupResource created on azure
// for more information of creating SphereDeviceGroupResource, please refer to the document of SphereDeviceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "MyResourceGroup1";
string catalogName = "MyCatalog1";
string productName = "MyProduct1";
string deviceGroupName = "myDeviceGroup1";
ResourceIdentifier sphereDeviceGroupResourceId = SphereDeviceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName);
SphereDeviceGroupResource sphereDeviceGroup = client.GetSphereDeviceGroupResource(sphereDeviceGroupResourceId);

// get the collection of this SphereDeploymentResource
SphereDeploymentCollection collection = sphereDeviceGroup.GetSphereDeployments();

// invoke the operation and iterate over the result
await foreach (SphereDeploymentResource 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
    SphereDeploymentData 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

Ukázková odpověď

Stavový kód:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1",
      "name": "MyDeployment1",
      "properties": {
        "deployedImages": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1",
            "properties": {
              "image": "dGVzdGltYWdl",
              "regionalDataBoundary": "None",
              "uri": "imageUri",
              "description": "description",
              "componentId": "componentId",
              "imageType": "ImageType",
              "provisioningState": "Succeeded"
            }
          }
        ],
        "deploymentDateUtc": "2022-09-30T21:51:39.2698729Z"
      }
    }
  ]
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
Deployment	Prostředek nasazení patřící k prostředku skupiny zařízení.
DeploymentListResult	Odpověď operace seznamu nasazení.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Image	Prostředek image, který patří k prostředku katalogu.
ImageType	Hodnoty typu obrázku.
ProvisioningState	Stav zřizování prostředku
RegionalDataBoundary	Místní hodnoty hranic dat.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

Deployment

Objekt

Prostředek nasazení patřící k prostředku skupiny zařízení.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.deployedImages	Image[]	Nasazené image
properties.deploymentDateUtc	string (date-time)	Datum nasazení (UTC)
properties.deploymentId	string	ID nasazení
properties.provisioningState	ProvisioningState	Stav poslední operace.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

DeploymentListResult

Objekt

Odpověď operace seznamu nasazení.

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	Deployment[]	Položky nasazení na této stránce

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Image

Objekt

Prostředek image, který patří k prostředku katalogu.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.componentId	string	ID součásti image.
properties.description	string	Popis obrázku.
properties.image	string	Obrázek jako řetězec kódování UTF-8 s kódováním base 64 při vytvoření image Toto pole obsahuje identifikátor URI obrázku při čtení obrázků.
properties.imageId	string	ID obrázku
properties.imageName	string	Název obrázku
properties.imageType	ImageType	Typ image.
properties.provisioningState	ProvisioningState	Stav poslední operace.
properties.regionalDataBoundary	RegionalDataBoundary	Hranice místních dat pro obrázek
properties.uri	string	Umístění obrázku
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ImageType

Výčet

Hodnoty typu obrázku.

Hodnota	Description
InvalidImageType	Neplatný obrázek
OneBl	Jeden typ obrázku Bl
PlutonRuntime	Typ obrázku Image Type
WifiFirmware	Typ image firmwaru Wi-Fi
SecurityMonitor	Typ image monitorování zabezpečení
NormalWorldLoader	Typ obrázku zavaděče normálního světa
NormalWorldDtb	Typ obrázku Normální svět dtb
NormalWorldKernel	Typ obrázku normálního světa jádra
RootFs	Typ image kořenové služby FS
Services	Typ image služeb
Applications	Typ image aplikací
FwConfig	Typ konfigurační image FW
BootManifest	Typ image spouštěcího manifestu
Nwfs	Typ image Nwfs
TrustedKeystore	Typ image důvěryhodného úložiště klíčů
Policy	Typ image zásad
CustomerBoardConfig	Typ image konfigurace panelu zákazníka
UpdateCertStore	Aktualizace typu image úložiště certifikátů
BaseSystemUpdateManifest	Typ image manifestu aktualizace základního systému
FirmwareUpdateManifest	Typ image manifestu aktualizace firmwaru
CustomerUpdateManifest	Typ image manifestu aktualizace zákazníka
RecoveryManifest	Typ image manifestu obnovení
ManifestSet	typ image sady manifestů
Other	Jiný typ obrázku

ProvisioningState

Výčet

Stav zřizování prostředku

Hodnota	Description
Succeeded	Prostředek byl vytvořen.
Failed	Vytvoření prostředku se nezdařilo.
Canceled	Vytvoření prostředku bylo zrušeno.
Provisioning	Prostředek se zřizuje.
Updating	Prostředek se aktualizuje.
Deleting	Prostředek se odstraňuje.
Accepted	Žádost o vytvoření prostředku byla přijata.

RegionalDataBoundary

Výčet

Místní hodnoty hranic dat.

Hodnota	Description
None	Žádná hranice dat
EU	Hranice dat EU

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.