Iot Hub Resource - Export Devices

Referensi

Layanan:: IoT Hub

Versi API:: 2023-06-30

Mengekspor semua identitas perangkat di registri identitas hub IoT ke kontainer blob Azure Storage. Untuk mengetahui informasi selengkapnya, lihat: 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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi hub IoT.
resourceName	path	True	string	Nama hub IoT.
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
excludeKeys	True	boolean	Nilai yang menunjukkan apakah kunci harus dikecualikan selama ekspor.
exportBlobContainerUri	True	string	URI kontainer blob ekspor.
authenticationType		AuthenticationType	Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.
configurationsBlobName		string	Nama blob yang akan dibuat dalam kontainer blob output yang disediakan. Blob ini akan berisi konfigurasi yang diekspor untuk Iot Hub.
exportBlobName		string	Nama blob yang akan dibuat dalam kontainer blob output yang disediakan. Blob ini akan berisi informasi registri perangkat yang diekspor untuk IoT Hub.
identity		ManagedIdentity	Properti identitas terkelola dari titik akhir penyimpanan untuk perangkat ekspor.
includeConfigurations		boolean	Nilai yang menunjukkan apakah konfigurasi harus diekspor.

Respons

Nama	Jenis	Deskripsi
200 OK	JobResponse	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

IotHubResource_ExportDevices

Permintaan sampel

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

Respon sampel

Kode status:: 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"
}

Definisi

Nama	Deskripsi
AuthenticationType	Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.
ErrorDetails	Detail kesalahan.
ExportDevicesRequest	Gunakan untuk menyediakan parameter saat meminta ekspor semua perangkat di hub IoT.
JobResponse	Properti objek Respons Pekerjaan.
JobStatus	Status pekerjaan.
JobType	Jenis pekerjaan.
ManagedIdentity	Properti identitas Terkelola.

AuthenticationType

Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.

Nama	Jenis	Deskripsi
identityBased	string
keyBased	string

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	string	Detail kesalahan.
httpStatusCode	string	Kode status HTTP.
message	string	Pesan kesalahan.

ExportDevicesRequest

Gunakan untuk menyediakan parameter saat meminta ekspor semua perangkat di hub IoT.

Nama	Jenis	Deskripsi
authenticationType	AuthenticationType	Menentukan jenis autentikasi yang digunakan untuk menyambungkan ke akun penyimpanan.
configurationsBlobName	string	Nama blob yang akan dibuat dalam kontainer blob output yang disediakan. Blob ini akan berisi konfigurasi yang diekspor untuk Iot Hub.
excludeKeys	boolean	Nilai yang menunjukkan apakah kunci harus dikecualikan selama ekspor.
exportBlobContainerUri	string	URI kontainer blob ekspor.
exportBlobName	string	Nama blob yang akan dibuat dalam kontainer blob output yang disediakan. Blob ini akan berisi informasi registri perangkat yang diekspor untuk IoT Hub.
identity	ManagedIdentity	Properti identitas terkelola dari titik akhir penyimpanan untuk perangkat ekspor.
includeConfigurations	boolean	Nilai yang menunjukkan apakah konfigurasi harus diekspor.

JobResponse

Properti objek Respons Pekerjaan.

Nama	Jenis	Deskripsi
endTimeUtc	string	Waktu pekerjaan berhenti diproses.
failureReason	string	Jika status == gagal, string ini berisi alasan kegagalan.
jobId	string	Pengidentifikasi pekerjaan.
parentJobId	string	Pengidentifikasi pekerjaan pekerjaan induk, jika ada.
startTimeUtc	string	Waktu mulai pekerjaan.
status	JobStatus	Status pekerjaan.
statusMessage	string	Pesan status untuk pekerjaan tersebut.
type	JobType	Jenis pekerjaan.

JobStatus

Status pekerjaan.

Nama	Jenis	Deskripsi
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

Jenis pekerjaan.

Nama	Jenis	Deskripsi
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

ManagedIdentity

Properti identitas Terkelola.

Nama	Jenis	Deskripsi
userAssignedIdentity	string	Identitas yang ditetapkan pengguna.