Iot Hub Resource - Export Devices

Служба:

IoT Hub

Версия API:

2023-06-30

Экспортирует все удостоверения устройств из реестра удостоверений Центра Интернета вещей в контейнер больших двоичных объектов службы хранилища Azure. Дополнительные сведения см. на странице 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

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей Центр Интернета вещей.
resourceName	path	True	string	Имя Центра Интернета вещей.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Текст запроса

Имя	Обязательно	Тип	Описание
excludeKeys	True	boolean	Значение, указывающее, следует ли исключать ключи во время экспорта.
exportBlobContainerUri	True	string	URI контейнера больших двоичных объектов экспорта.
authenticationType		AuthenticationType	Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.
configurationsBlobName		string	Имя большого двоичного объекта, который будет создан в предоставленном контейнере выходных BLOB-объектов. Этот BLOB-объект будет содержать экспортированные конфигурации для Центра Интернета вещей.
exportBlobName		string	Имя большого двоичного объекта, который будет создан в предоставленном контейнере выходных BLOB-объектов. Этот BLOB-объект будет содержать экспортированные сведения реестра устройств для Центр Интернета вещей.
identity		ManagedIdentity	Свойства управляемого удостоверения конечной точки хранилища для устройств экспорта.
includeConfigurations		boolean	Значение, указывающее, следует ли экспортировать конфигурации.

Ответы

Имя	Тип	Описание
200 OK	JobResponse	ОК
Other Status Codes	ErrorDetails	DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
}

Определения

Имя	Описание
AuthenticationType	Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.
ErrorDetails	Сведения об ошибке.
ExportDevicesRequest	Используйте для предоставления параметров при запросе экспорта всех устройств в Центре Интернета вещей.
JobResponse	Свойства объекта Job Response.
JobStatus	Состояние задания.
JobType	Тип задания.
ManagedIdentity	Свойства управляемого удостоверения.

AuthenticationType

Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.

Имя	Тип	Описание
identityBased	string
keyBased	string

ErrorDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	string	Сведения об ошибке.
httpStatusCode	string	Код состояния HTTP.
message	string	Сообщение об ошибке.

ExportDevicesRequest

Используйте для предоставления параметров при запросе экспорта всех устройств в Центре Интернета вещей.

Имя	Тип	Описание
authenticationType	AuthenticationType	Указывает тип проверки подлинности, используемый для подключения к учетной записи хранения.
configurationsBlobName	string	Имя большого двоичного объекта, который будет создан в предоставленном контейнере выходных BLOB-объектов. Этот BLOB-объект будет содержать экспортированные конфигурации для Центра Интернета вещей.
excludeKeys	boolean	Значение, указывающее, следует ли исключать ключи во время экспорта.
exportBlobContainerUri	string	URI контейнера больших двоичных объектов экспорта.
exportBlobName	string	Имя большого двоичного объекта, который будет создан в предоставленном контейнере выходных BLOB-объектов. Этот BLOB-объект будет содержать экспортированные сведения реестра устройств для Центр Интернета вещей.
identity	ManagedIdentity	Свойства управляемого удостоверения конечной точки хранилища для устройств экспорта.
includeConfigurations	boolean	Значение, указывающее, следует ли экспортировать конфигурации.

JobResponse

Свойства объекта Job Response.

Имя	Тип	Описание
endTimeUtc	string	Время остановки обработки задания.
failureReason	string	Если status == failed, эта строка содержит причину сбоя.
jobId	string	Идентификатор задания.
parentJobId	string	Идентификатор родительского задания, если таковой есть.
startTimeUtc	string	Время начала задания.
status	JobStatus	Состояние задания.
statusMessage	string	Сообщение о состоянии задания.
type	JobType	Тип задания.

JobStatus

Состояние задания.

Имя	Тип	Описание
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

Тип задания.

Имя	Тип	Описание
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

ManagedIdentity

Свойства управляемого удостоверения.

Имя	Тип	Описание
userAssignedIdentity	string	Удостоверение, назначаемое пользователем.