Iot Hub Resource - Export Devices

Servizio:

IoT Hub

Versione API:

2023-06-30

Esporta tutte le identità del dispositivo nel registro delle identità dell'hub IoT in un contenitore BLOB di Archiviazione di Azure. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices?api-version=2023-06-30

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene l'hub IoT.
resourceName	path	True	string	Nome dell'hub IoT.
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
excludeKeys	True	boolean	Valore che indica se le chiavi devono essere escluse durante l'esportazione.
exportBlobContainerUri	True	string	URI del contenitore BLOB di esportazione.
authenticationType		AuthenticationType	Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione.
configurationsBlobName		string	Nome del BLOB che verrà creato nel contenitore BLOB di output specificato. Questo BLOB conterrà le configurazioni esportate per l'hub Iot.
exportBlobName		string	Nome del BLOB che verrà creato nel contenitore BLOB di output specificato. Questo BLOB conterrà le informazioni del Registro di sistema dei dispositivi esportate per il hub IoT.
identity		ManagedIdentity	Proprietà dell'identità gestita dell'endpoint di archiviazione per i dispositivi di esportazione.
includeConfigurations		boolean	Valore che indica se le configurazioni devono essere esportate.

Risposte

Nome	Tipo	Descrizione
200 OK	JobResponse	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

IotHubResource_ExportDevices

Esempio di richiesta

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/exportDevices?api-version=2023-06-30

{
  "exportBlobContainerUri": "testBlob",
  "excludeKeys": true
}

Java

import com.azure.resourcemanager.iothub.models.ExportDevicesRequest;

/** Samples for IotHubResource ExportDevices. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_exportdevices.json
     */
    /**
     * Sample code: IotHubResource_ExportDevices.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceExportDevices(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager
            .iotHubResources()
            .exportDevicesWithResponse(
                "myResourceGroup",
                "testHub",
                new ExportDevicesRequest().withExportBlobContainerUri("testBlob").withExcludeKeys(true),
                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.iothub import IotHubClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_exportdevices.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 = IotHubClient(
        credential=DefaultAzureCredential(),
        subscription_id="91d12660-3dec-467a-be2a-213b5544ddc0",
    )

    response = client.iot_hub_resource.export_devices(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
        export_devices_parameters={"excludeKeys": True, "exportBlobContainerUri": "testBlob"},
    )
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_exportdevices.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 armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_exportdevices.json
func ExampleResourceClient_ExportDevices() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewResourceClient().ExportDevices(ctx, "myResourceGroup", "testHub", armiothub.ExportDevicesRequest{
		ExcludeKeys:            to.Ptr(true),
		ExportBlobContainerURI: to.Ptr("testBlob"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.JobResponse = armiothub.JobResponse{
	// 	Type: to.Ptr(armiothub.JobTypeUnknown),
	// 	EndTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2017-06-15T19:20:58.000Z"); return t}()),
	// 	JobID: to.Ptr("test"),
	// 	StartTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2017-06-15T19:20:58.000Z"); return t}()),
	// 	Status: to.Ptr(armiothub.JobStatusUnknown),
	// }
}

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 { IotHubClient } = require("@azure/arm-iothub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
 *
 * @summary Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_exportdevices.json
 */
async function iotHubResourceExportDevices() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const exportDevicesParameters = {
    excludeKeys: true,
    exportBlobContainerUri: "testBlob",
  };
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.exportDevices(
    resourceGroupName,
    resourceName,
    exportDevicesParameters
  );
  console.log(result);
}

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.IotHub.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.IotHub;

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_exportdevices.json
// this example is just showing the usage of "IotHubResource_ExportDevices" 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 IotHubDescriptionResource created on azure
// for more information of creating IotHubDescriptionResource, please refer to the document of IotHubDescriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
string resourceName = "testHub";
ResourceIdentifier iotHubDescriptionResourceId = IotHubDescriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName);
IotHubDescriptionResource iotHubDescription = client.GetIotHubDescriptionResource(iotHubDescriptionResourceId);

// invoke the operation
ExportDevicesContent content = new ExportDevicesContent(new Uri("testBlob"), true);
IotHubJobInfo result = await iotHubDescription.ExportDevicesAsync(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:

200

{
  "jobId": "test",
  "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
  "type": "unknown",
  "status": "unknown"
}

Definizioni

Nome	Descrizione
AuthenticationType	Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione.
ErrorDetails	Dettagli errore.
ExportDevicesRequest	Usare per specificare i parametri quando si richiede un'esportazione di tutti i dispositivi nell'hub IoT.
JobResponse	Proprietà dell'oggetto Job Response.
JobStatus	Stato del processo.
JobType	Tipo del processo.
ManagedIdentity	Proprietà dell'identità gestita.

AuthenticationType

Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione.

Nome	Tipo	Descrizione
identityBased	string
keyBased	string

ErrorDetails

Dettagli errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	string	Dettagli dell'errore.
httpStatusCode	string	Codice di stato HTTP.
message	string	Messaggio di errore.

ExportDevicesRequest

Usare per specificare i parametri quando si richiede un'esportazione di tutti i dispositivi nell'hub IoT.

Nome	Tipo	Descrizione
authenticationType	AuthenticationType	Specifica il tipo di autenticazione utilizzato per la connessione all'account di archiviazione.
configurationsBlobName	string	Nome del BLOB che verrà creato nel contenitore BLOB di output specificato. Questo BLOB conterrà le configurazioni esportate per l'hub Iot.
excludeKeys	boolean	Valore che indica se le chiavi devono essere escluse durante l'esportazione.
exportBlobContainerUri	string	URI del contenitore BLOB di esportazione.
exportBlobName	string	Nome del BLOB che verrà creato nel contenitore BLOB di output specificato. Questo BLOB conterrà le informazioni del Registro di sistema dei dispositivi esportate per il hub IoT.
identity	ManagedIdentity	Proprietà dell'identità gestita dell'endpoint di archiviazione per i dispositivi di esportazione.
includeConfigurations	boolean	Valore che indica se le configurazioni devono essere esportate.

JobResponse

Proprietà dell'oggetto Job Response.

Nome	Tipo	Descrizione
endTimeUtc	string	Ora in cui il processo ha interrotto l'elaborazione.
failureReason	string	Se status == non è riuscito, questa stringa contenente il motivo dell'errore.
jobId	string	Identificatore di processo.
parentJobId	string	Identificatore del processo padre, se presente.
startTimeUtc	string	Ora di inizio del processo.
status	JobStatus	Stato del processo.
statusMessage	string	Messaggio di stato per il processo.
type	JobType	Tipo del processo.

JobStatus

Stato del processo.

Nome	Tipo	Descrizione
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

Tipo del processo.

Nome	Tipo	Descrizione
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

ManagedIdentity

Proprietà dell'identità gestita.

Nome	Tipo	Descrizione
userAssignedIdentity	string	Identità assegnata dall'utente.