Iot Hub Resource - Import Devices

服務:

IoT Hub

API 版本:

2023-06-30

從 Blob 匯入、更新或刪除 IoT 中樞身分識別登錄中的裝置身分識別。 如需詳細資訊，請參閱：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}/importDevices?api-version=2023-06-30

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含IoT中樞的資源組名。
resourceName	path	True	string	IoT 中樞的名稱。
subscriptionId	path	True	string	訂用帳戶識別碼。
api-version	query	True	string	API 的版本。

要求本文

名稱	必要	類型	Description
inputBlobContainerUri	True	string	輸入 Blob 容器 URI。
outputBlobContainerUri	True	string	輸出 Blob 容器 URI。
authenticationType		AuthenticationType	指定用於連線到記憶體帳戶的驗證類型。
configurationsBlobName		string	從提供的輸入 Blob 容器匯入組態時要使用的 Blob 名稱。
identity		ManagedIdentity	用於匯入裝置之記憶體端點的受控識別屬性。
includeConfigurations		boolean	值，指出是否應該匯入組態。
inputBlobName		string	從提供的輸入 Blob 容器匯入時要使用的 Blob 名稱。
outputBlobName		string	用來儲存匯入作業狀態的 Blob 名稱。

回應

名稱	類型	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

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

IotHubResource_ImportDevices

範例要求

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/importDevices?api-version=2023-06-30

{
  "inputBlobContainerUri": "testBlob",
  "outputBlobContainerUri": "testBlob"
}

Java

import com.azure.resourcemanager.iothub.models.ImportDevicesRequest;

/** Samples for IotHubResource ImportDevices. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_importdevices.json
     */
    /**
     * Sample code: IotHubResource_ImportDevices.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceImportDevices(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager
            .iotHubResources()
            .importDevicesWithResponse(
                "myResourceGroup",
                "testHub",
                new ImportDevicesRequest().withInputBlobContainerUri("testBlob").withOutputBlobContainerUri("testBlob"),
                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_importdevices.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.import_devices(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
        import_devices_parameters={"inputBlobContainerUri": "testBlob", "outputBlobContainerUri": "testBlob"},
    )
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_importdevices.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_importdevices.json
func ExampleResourceClient_ImportDevices() {
	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().ImportDevices(ctx, "myResourceGroup", "testHub", armiothub.ImportDevicesRequest{
		InputBlobContainerURI:  to.Ptr("testBlob"),
		OutputBlobContainerURI: 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 Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
 *
 * @summary Import, update, or delete device identities in the IoT hub identity registry from a blob. 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_importdevices.json
 */
async function iotHubResourceImportDevices() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const importDevicesParameters = {
    inputBlobContainerUri: "testBlob",
    outputBlobContainerUri: "testBlob",
  };
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.importDevices(
    resourceGroupName,
    resourceName,
    importDevicesParameters
  );
  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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.IotHub;
using Azure.ResourceManager.IotHub.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_importdevices.json
// this example is just showing the usage of "IotHubResource_ImportDevices" 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
IotHubImportDevicesContent content = new IotHubImportDevicesContent(new Uri("testBlob"), new Uri("testBlob"));
IotHubJobInfo result = await iotHubDescription.ImportDevicesAsync(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"
}

定義

名稱	Description
AuthenticationType	指定用於連線到記憶體帳戶的驗證類型。
ErrorDetails	錯誤詳細數據。
ImportDevicesRequest	在要求匯入中樞中的所有裝置時，使用 提供參數。
JobResponse	Job Response 對象的屬性。
JobStatus	工作的狀態。
JobType	作業的類型。
ManagedIdentity	受控識別的屬性。

AuthenticationType

指定用於連線到記憶體帳戶的驗證類型。

名稱	類型	Description
identityBased	string
keyBased	string

ErrorDetails

錯誤詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	string	錯誤詳細資料。
httpStatusCode	string	HTTP 狀態碼。
message	string	錯誤訊息。

ImportDevicesRequest

在要求匯入中樞中的所有裝置時，使用 提供參數。

名稱	類型	Description
authenticationType	AuthenticationType	指定用於連線到記憶體帳戶的驗證類型。
configurationsBlobName	string	從提供的輸入 Blob 容器匯入組態時要使用的 Blob 名稱。
identity	ManagedIdentity	用於匯入裝置之記憶體端點的受控識別屬性。
includeConfigurations	boolean	值，指出是否應該匯入組態。
inputBlobContainerUri	string	輸入 Blob 容器 URI。
inputBlobName	string	從提供的輸入 Blob 容器匯入時要使用的 Blob 名稱。
outputBlobContainerUri	string	輸出 Blob 容器 URI。
outputBlobName	string	用來儲存匯入作業狀態的 Blob 名稱。

JobResponse

Job Response 對象的屬性。

名稱	類型	Description
endTimeUtc	string	作業停止處理的時間。
failureReason	string	如果 status == 失敗，則此字串包含失敗的原因。
jobId	string	作業識別碼。
parentJobId	string	父作業的作業標識碼，如果有的話。
startTimeUtc	string	工作的開始時間。
status	JobStatus	工作的狀態。
statusMessage	string	作業的狀態消息。
type	JobType	作業的類型。

JobStatus

工作的狀態。

名稱	類型	Description
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

作業的類型。

名稱	類型	Description
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

ManagedIdentity

受控識別的屬性。

名稱	類型	Description
userAssignedIdentity	string	使用者指派的身分識別。