Iot Hub Resource - Export Devices

Service:

IoT Hub

API Version:

2023-06-30

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.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the IoT hub.
resourceName	path	True	string	The name of the IoT hub.
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The version of the API.

Request Body

Name	Required	Type	Description
excludeKeys	True	boolean	The value indicating whether keys should be excluded during export.
exportBlobContainerUri	True	string	The export blob container URI.
authenticationType		AuthenticationType	Specifies authentication type being used for connecting to the storage account.
configurationsBlobName		string	The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.
exportBlobName		string	The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.
identity		ManagedIdentity	Managed identity properties of storage endpoint for export devices.
includeConfigurations		boolean	The value indicating whether configurations should be exported.

Responses

Name	Type	Description
200 OK	JobResponse	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

IotHubResource_ExportDevices

Sample request

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

Sample response

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

Definitions

Name	Description
AuthenticationType	Specifies authentication type being used for connecting to the storage account.
ErrorDetails	Error details.
ExportDevicesRequest	Use to provide parameters when requesting an export of all devices in the IoT hub.
JobResponse	The properties of the Job Response object.
JobStatus	The status of the job.
JobType	The type of the job.
ManagedIdentity	The properties of the Managed identity.

AuthenticationType

Specifies authentication type being used for connecting to the storage account.

Name	Type	Description
identityBased	string
keyBased	string

ErrorDetails

Error details.

Name	Type	Description
code	string	The error code.
details	string	The error details.
httpStatusCode	string	The HTTP status code.
message	string	The error message.

ExportDevicesRequest

Use to provide parameters when requesting an export of all devices in the IoT hub.

Name	Type	Description
authenticationType	AuthenticationType	Specifies authentication type being used for connecting to the storage account.
configurationsBlobName	string	The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.
excludeKeys	boolean	The value indicating whether keys should be excluded during export.
exportBlobContainerUri	string	The export blob container URI.
exportBlobName	string	The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.
identity	ManagedIdentity	Managed identity properties of storage endpoint for export devices.
includeConfigurations	boolean	The value indicating whether configurations should be exported.

JobResponse

The properties of the Job Response object.

Name	Type	Description
endTimeUtc	string	The time the job stopped processing.
failureReason	string	If status == failed, this string containing the reason for the failure.
jobId	string	The job identifier.
parentJobId	string	The job identifier of the parent job, if any.
startTimeUtc	string	The start time of the job.
status	JobStatus	The status of the job.
statusMessage	string	The status message for the job.
type	JobType	The type of the job.

JobStatus

The status of the job.

Name	Type	Description
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

The type of the job.

Name	Type	Description
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

ManagedIdentity

The properties of the Managed identity.

Name	Type	Description
userAssignedIdentity	string	The user assigned identity.