Iot Hub Resource - Export Devices

Referentie

Service:: IoT Hub

API-versie:: 2023-06-30

Hiermee exporteert u alle apparaatidentiteiten in het IoT Hub-identiteitsregister naar een Azure Storage-blobcontainer. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities voor meer informatie.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de IoT-hub bevat.
resourceName	path	True	string	De naam van de IoT-hub.
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De versie van de API.

Aanvraagbody

Name	Vereist	Type	Description
excludeKeys	True	boolean	De waarde die aangeeft of sleutels moeten worden uitgesloten tijdens het exporteren.
exportBlobContainerUri	True	string	De URI van de export-blobcontainer.
authenticationType		AuthenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount.
configurationsBlobName		string	De naam van de blob die wordt gemaakt in de opgegeven uitvoer-blobcontainer. Deze blob bevat de geëxporteerde configuraties voor de IoT-hub.
exportBlobName		string	De naam van de blob die wordt gemaakt in de opgegeven uitvoer-blobcontainer. Deze blob bevat de geëxporteerde apparaatregistergegevens voor de IoT Hub.
identity		ManagedIdentity	Eigenschappen van beheerde identiteit van opslageindpunt voor exportapparaten.
includeConfigurations		boolean	De waarde die aangeeft of configuraties moeten worden geëxporteerd.

Antwoorden

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

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

IotHubResource_ExportDevices

Voorbeeldaanvraag

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
}


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

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

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

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

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

Voorbeeldrespons

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

Definities

Name	Description
AuthenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount.
ErrorDetails	Foutdetails.
ExportDevicesRequest	Gebruik om parameters op te geven bij het aanvragen van een export van alle apparaten in de IoT-hub.
JobResponse	De eigenschappen van het object Taakantwoord.
JobStatus	De status van de taak.
JobType	Het type taak.
ManagedIdentity	De eigenschappen van de beheerde identiteit.

AuthenticationType

Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount.

Name	Type	Description
identityBased	string
keyBased	string

ErrorDetails

Foutdetails.

Name	Type	Description
code	string	De foutcode.
details	string	De foutdetails.
httpStatusCode	string	De HTTP-statuscode.
message	string	Het foutbericht.

ExportDevicesRequest

Gebruik om parameters op te geven bij het aanvragen van een export van alle apparaten in de IoT-hub.

Name	Type	Description
authenticationType	AuthenticationType	Hiermee geeft u het verificatietype op dat wordt gebruikt om verbinding te maken met het opslagaccount.
configurationsBlobName	string	De naam van de blob die wordt gemaakt in de opgegeven uitvoer-blobcontainer. Deze blob bevat de geëxporteerde configuraties voor de IoT-hub.
excludeKeys	boolean	De waarde die aangeeft of sleutels moeten worden uitgesloten tijdens het exporteren.
exportBlobContainerUri	string	De URI van de export-blobcontainer.
exportBlobName	string	De naam van de blob die wordt gemaakt in de opgegeven uitvoer-blobcontainer. Deze blob bevat de geëxporteerde apparaatregistergegevens voor de IoT Hub.
identity	ManagedIdentity	Eigenschappen van beheerde identiteit van opslageindpunt voor exportapparaten.
includeConfigurations	boolean	De waarde die aangeeft of configuraties moeten worden geëxporteerd.

JobResponse

De eigenschappen van het object Taakantwoord.

Name	Type	Description
endTimeUtc	string	Het tijdstip waarop de taak is gestopt met verwerken.
failureReason	string	Als de status == mislukt is, bevat deze tekenreeks de reden voor de fout.
jobId	string	De taak-id.
parentJobId	string	De taak-id van de bovenliggende taak, indien van toepassing.
startTimeUtc	string	De begintijd van de taak.
status	JobStatus	De status van de taak.
statusMessage	string	Het statusbericht voor de taak.
type	JobType	Het type taak.

JobStatus

De status van de taak.

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

JobType

Het type taak.

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

ManagedIdentity

De eigenschappen van de beheerde identiteit.

Name	Type	Description
userAssignedIdentity	string	De door de gebruiker toegewezen identiteit.