Iot Hub Resource - Export Devices

Servicio:

IoT Hub

Versión de la API:

2023-06-30

Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, vea: 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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el centro de IoT.
resourceName	path	True	string	Nombre del centro de IoT.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	Versión de la API.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
excludeKeys	True	boolean	Valor que indica si las claves deben excluirse durante la exportación.
exportBlobContainerUri	True	string	Identificador URI del contenedor de blobs de exportación.
authenticationType		AuthenticationType	Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.
configurationsBlobName		string	Nombre del blob que se creará en el contenedor de blobs de salida proporcionado. Este blob contendrá las configuraciones exportadas para Iot Hub.
exportBlobName		string	Nombre del blob que se creará en el contenedor de blobs de salida proporcionado. Este blob contendrá la información del Registro de dispositivos exportado para IoT Hub.
identity		ManagedIdentity	Propiedades de identidad administrada del punto de conexión de almacenamiento para dispositivos de exportación.
includeConfigurations		boolean	Valor que indica si se deben exportar configuraciones.

Respuestas

Nombre	Tipo	Description
200 OK	JobResponse	De acuerdo
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

IotHubResource_ExportDevices

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
AuthenticationType	Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.
ErrorDetails	Detalles del error.
ExportDevicesRequest	Use para proporcionar parámetros al solicitar una exportación de todos los dispositivos del centro de IoT.
JobResponse	Propiedades del objeto Job Response.
JobStatus	Estado del trabajo.
JobType	Tipo del trabajo.
ManagedIdentity	Propiedades de la identidad administrada.

AuthenticationType

Enumeración

Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.

Valor	Description
identityBased
keyBased

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
details	string	Detalles del error.
httpStatusCode	string	Código de estado HTTP.
message	string	Mensaje de error.

ExportDevicesRequest

Object

Use para proporcionar parámetros al solicitar una exportación de todos los dispositivos del centro de IoT.

Nombre	Tipo	Description
authenticationType	AuthenticationType	Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.
configurationsBlobName	string	Nombre del blob que se creará en el contenedor de blobs de salida proporcionado. Este blob contendrá las configuraciones exportadas para Iot Hub.
excludeKeys	boolean	Valor que indica si las claves deben excluirse durante la exportación.
exportBlobContainerUri	string	Identificador URI del contenedor de blobs de exportación.
exportBlobName	string	Nombre del blob que se creará en el contenedor de blobs de salida proporcionado. Este blob contendrá la información del Registro de dispositivos exportado para IoT Hub.
identity	ManagedIdentity	Propiedades de identidad administrada del punto de conexión de almacenamiento para dispositivos de exportación.
includeConfigurations	boolean	Valor que indica si se deben exportar configuraciones.

JobResponse

Object

Propiedades del objeto Job Response.

Nombre	Tipo	Description
endTimeUtc	string (date-time-rfc1123)	Hora en que el trabajo detuvo el procesamiento.
failureReason	string	Si el estado == no se pudo realizar, esta cadena contiene el motivo del error.
jobId	string	Identificador del trabajo.
parentJobId	string	Identificador de trabajo del trabajo primario, si existe.
startTimeUtc	string (date-time-rfc1123)	Hora de inicio del trabajo.
status	JobStatus	Estado del trabajo.
statusMessage	string	Mensaje de estado del trabajo.
type	JobType	Tipo del trabajo.

JobStatus

Enumeración

Estado del trabajo.

Valor	Description
cancelled
completed
enqueued
failed
running
unknown

JobType

Enumeración

Tipo del trabajo.

Valor	Description
backup
export
factoryResetDevice
firmwareUpdate
import
readDeviceProperties
rebootDevice
unknown
updateDeviceConfiguration
writeDeviceProperties

ManagedIdentity

Object

Propiedades de la identidad administrada.

Nombre	Tipo	Description
userAssignedIdentity	string	Identidad asignada por el usuario.