Iot Hub Resource - Export Devices

Reference

Služba:: IoT Hub

Verze rozhraní API:: 2023-06-30

Exportuje všechny identity zařízení v registru identit služby IoT Hub do kontejneru objektů blob služby Azure Storage. Další informace najdete v tématu: 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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje centrum IoT.
resourceName	path	True	string	Název ioT Hubu.
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API.

Text požadavku

Name	Vyžadováno	Typ	Description
excludeKeys	True	boolean	Hodnota označující, jestli se mají klíče během exportu vyloučit.
exportBlobContainerUri	True	string	Identifikátor URI kontejneru objektů blob exportu.
authenticationType		AuthenticationType	Určuje typ ověřování, který se používá pro připojení k účtu úložiště.
configurationsBlobName		string	Název objektu blob, který se vytvoří v zadaném výstupním kontejneru objektů blob. Tento objekt blob bude obsahovat exportované konfigurace pro Iot Hub.
exportBlobName		string	Název objektu blob, který se vytvoří v zadaném výstupním kontejneru objektů blob. Tento objekt blob bude obsahovat informace o exportu registru zařízení pro IoT Hub.
identity		ManagedIdentity	Vlastnosti spravované identity koncového bodu úložiště pro export zařízení
includeConfigurations		boolean	Hodnota označující, jestli se mají exportovat konfigurace.

Odpovědi

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

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

IotHubResource_ExportDevices

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
AuthenticationType	Určuje typ ověřování, který se používá pro připojení k účtu úložiště.
ErrorDetails	Podrobnosti o chybě
ExportDevicesRequest	Slouží k zadání parametrů při vyžádání exportu všech zařízení v centru IoT.
JobResponse	Vlastnosti objektu Job Response.
JobStatus	Stav úlohy.
JobType	Typ úlohy.
ManagedIdentity	Vlastnosti spravované identity.

AuthenticationType

Výčet

Určuje typ ověřování, který se používá pro připojení k účtu úložiště.

Hodnota	Description
identityBased
keyBased

ErrorDetails

Objekt

Podrobnosti o chybě

Name	Typ	Description
code	string	Kód chyby.
details	string	Podrobnosti o chybě.
httpStatusCode	string	Stavový kód HTTP.
message	string	Chybová zpráva.

ExportDevicesRequest

Objekt

Slouží k zadání parametrů při vyžádání exportu všech zařízení v centru IoT.

Name	Typ	Description
authenticationType	AuthenticationType	Určuje typ ověřování, který se používá pro připojení k účtu úložiště.
configurationsBlobName	string	Název objektu blob, který se vytvoří v zadaném výstupním kontejneru objektů blob. Tento objekt blob bude obsahovat exportované konfigurace pro Iot Hub.
excludeKeys	boolean	Hodnota označující, jestli se mají klíče během exportu vyloučit.
exportBlobContainerUri	string	Identifikátor URI kontejneru objektů blob exportu.
exportBlobName	string	Název objektu blob, který se vytvoří v zadaném výstupním kontejneru objektů blob. Tento objekt blob bude obsahovat informace o exportu registru zařízení pro IoT Hub.
identity	ManagedIdentity	Vlastnosti spravované identity koncového bodu úložiště pro export zařízení
includeConfigurations	boolean	Hodnota označující, jestli se mají exportovat konfigurace.

JobResponse

Objekt

Vlastnosti objektu Job Response.

Name	Typ	Description
endTimeUtc	string (date-time-rfc1123)	Čas, kdy úloha přestala zpracovávat.
failureReason	string	Pokud stav == selhal, tento řetězec obsahující důvod selhání.
jobId	string	Identifikátor úlohy.
parentJobId	string	Identifikátor úlohy nadřazené úlohy( pokud existuje).
startTimeUtc	string (date-time-rfc1123)	Čas zahájení úlohy.
status	JobStatus	Stav úlohy.
statusMessage	string	Stavová zpráva pro úlohu.
type	JobType	Typ úlohy.

JobStatus

Výčet

Stav úlohy.

Hodnota	Description
cancelled
completed
enqueued
failed
running
unknown

JobType

Výčet

Typ úlohy.

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

ManagedIdentity

Objekt

Vlastnosti spravované identity.

Name	Typ	Description
userAssignedIdentity	string	Identita přiřazená uživatelem.