Iot Hub Resource - Export Devices

서비스:

IoT Hub

API 버전:

2023-06-30

IoT Hub ID 레지스트리의 모든 디바이스 ID를 Azure Storage Blob 컨테이너로 내보냅니다. 자세한 내용은 다음을 참조하세요. 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 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	IoT Hub를 포함하는 리소스 그룹의 이름입니다.
resourceName	path	True	string	IoT Hub의 이름입니다.
subscriptionId	path	True	string	구독 식별자입니다.
api-version	query	True	string	API의 버전입니다.

요청 본문

Name	필수	형식	Description
excludeKeys	True	boolean	내보내는 동안 키를 제외해야 하는지 여부를 나타내는 값입니다.
exportBlobContainerUri	True	string	Blob 컨테이너 URI 내보내기입니다.
authenticationType		AuthenticationType	스토리지 계정에 연결하는 데 사용되는 인증 유형을 지정합니다.
configurationsBlobName		string	제공된 출력 Blob 컨테이너에서 만들 Blob의 이름입니다. 이 Blob에는 IoT Hub에 대한 내보낸 구성이 포함됩니다.
exportBlobName		string	제공된 출력 Blob 컨테이너에서 만들 Blob의 이름입니다. 이 Blob에는 IoT Hub에 대한 내보낸 디바이스 레지스트리 정보가 포함됩니다.
identity		ManagedIdentity	내보내기 디바이스에 대한 스토리지 엔드포인트의 관리 ID 속성입니다.
includeConfigurations		boolean	구성을 내보낼지 여부를 나타내는 값입니다.

응답

Name	형식	Description
200 OK	JobResponse	그래
Other Status Codes	ErrorDetails	DefaultErrorResponse

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

IotHubResource_ExportDevices

샘플 요청

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

샘플 응답

상태 코드:

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

정의

Name	Description
AuthenticationType	스토리지 계정에 연결하는 데 사용되는 인증 유형을 지정합니다.
ErrorDetails	오류 세부 정보입니다.
ExportDevicesRequest	IoT Hub에서 모든 디바이스의 내보내기를 요청할 때 매개 변수를 제공하는 데 사용합니다.
JobResponse	작업 응답 개체의 속성입니다.
JobStatus	작업의 상태입니다.
JobType	작업의 형식입니다.
ManagedIdentity	관리 ID의 속성입니다.

AuthenticationType

열거형

스토리지 계정에 연결하는 데 사용되는 인증 유형을 지정합니다.

값	Description
identityBased
keyBased

ErrorDetails

Object

오류 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	string	오류 세부 정보입니다.
httpStatusCode	string	HTTP 상태 코드입니다.
message	string	오류 메시지입니다.

ExportDevicesRequest

Object

IoT Hub에서 모든 디바이스의 내보내기를 요청할 때 매개 변수를 제공하는 데 사용합니다.

Name	형식	Description
authenticationType	AuthenticationType	스토리지 계정에 연결하는 데 사용되는 인증 유형을 지정합니다.
configurationsBlobName	string	제공된 출력 Blob 컨테이너에서 만들 Blob의 이름입니다. 이 Blob에는 IoT Hub에 대한 내보낸 구성이 포함됩니다.
excludeKeys	boolean	내보내는 동안 키를 제외해야 하는지 여부를 나타내는 값입니다.
exportBlobContainerUri	string	Blob 컨테이너 URI 내보내기입니다.
exportBlobName	string	제공된 출력 Blob 컨테이너에서 만들 Blob의 이름입니다. 이 Blob에는 IoT Hub에 대한 내보낸 디바이스 레지스트리 정보가 포함됩니다.
identity	ManagedIdentity	내보내기 디바이스에 대한 스토리지 엔드포인트의 관리 ID 속성입니다.
includeConfigurations	boolean	구성을 내보낼지 여부를 나타내는 값입니다.

JobResponse

Object

작업 응답 개체의 속성입니다.

Name	형식	Description
endTimeUtc	string (date-time-rfc1123)	작업이 처리를 중지한 시간입니다.
failureReason	string	status ==가 실패하면 실패 이유를 포함하는 이 문자열입니다.
jobId	string	작업 식별자입니다.
parentJobId	string	부모 작업의 작업 식별자(있는 경우)입니다.
startTimeUtc	string (date-time-rfc1123)	작업의 시작 시간입니다.
status	JobStatus	작업의 상태입니다.
statusMessage	string	작업에 대한 상태 메시지입니다.
type	JobType	작업의 형식입니다.

JobStatus

열거형

작업의 상태입니다.

값	Description
cancelled
completed
enqueued
failed
running
unknown

JobType

열거형

작업의 형식입니다.

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

ManagedIdentity

Object

관리 ID의 속성입니다.

Name	형식	Description
userAssignedIdentity	string	사용자 할당 ID입니다.