Iot Hub Resource - Import Devices

Odwołanie

Usługa:: IoT Hub

Wersja interfejsu API:: 2023-06-30

Importowanie, aktualizowanie lub usuwanie tożsamości urządzeń w rejestrze tożsamości usługi IoT Hub z obiektu blob. Aby uzyskać więcej informacji, zobacz 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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów, która zawiera centrum IoT.
resourceName	path	True	string	Nazwa centrum IoT.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Treść żądania

Nazwa	Wymagane	Typ	Opis
inputBlobContainerUri	True	string	Identyfikator URI wejściowego kontenera obiektów blob.
outputBlobContainerUri	True	string	Wyjściowy identyfikator URI kontenera obiektów blob.
authenticationType		AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.
configurationsBlobName		string	Nazwa obiektu blob do użycia podczas importowania konfiguracji z dostarczonego wejściowego kontenera obiektów blob.
identity		ManagedIdentity	Właściwości tożsamości zarządzanej punktu końcowego magazynu dla urządzeń importowanych.
includeConfigurations		boolean	Wartość wskazująca, czy konfiguracje powinny być importowane.
inputBlobName		string	Nazwa obiektu blob do użycia podczas importowania z dostarczonego wejściowego kontenera obiektów blob.
outputBlobName		string	Nazwa obiektu blob do użycia do przechowywania stanu zadania importu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	JobResponse	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

IotHubResource_ImportDevices

Przykładowe żądanie

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

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

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

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

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

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_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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.
ErrorDetails	Szczegóły błędu.
ImportDevicesRequest	Użyj polecenia , aby podać parametry podczas żądania zaimportowania wszystkich urządzeń w centrum.
JobResponse	Właściwości obiektu Odpowiedź zadania.
JobStatus	Stan zadania.
JobType	Typ zadania.
ManagedIdentity	Właściwości tożsamości zarządzanej.

AuthenticationType

Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.

Nazwa	Typ	Opis
identityBased	string
keyBased	string

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod stanu HTTP.
message	string	Komunikat o błędzie.

ImportDevicesRequest

Użyj polecenia , aby podać parametry podczas żądania zaimportowania wszystkich urządzeń w centrum.

Nazwa	Typ	Opis
authenticationType	AuthenticationType	Określa typ uwierzytelniania używany do nawiązywania połączenia z kontem magazynu.
configurationsBlobName	string	Nazwa obiektu blob do użycia podczas importowania konfiguracji z dostarczonego wejściowego kontenera obiektów blob.
identity	ManagedIdentity	Właściwości tożsamości zarządzanej punktu końcowego magazynu dla urządzeń importowanych.
includeConfigurations	boolean	Wartość wskazująca, czy konfiguracje powinny być importowane.
inputBlobContainerUri	string	Identyfikator URI wejściowego kontenera obiektów blob.
inputBlobName	string	Nazwa obiektu blob do użycia podczas importowania z dostarczonego wejściowego kontenera obiektów blob.
outputBlobContainerUri	string	Wyjściowy identyfikator URI kontenera obiektów blob.
outputBlobName	string	Nazwa obiektu blob do użycia do przechowywania stanu zadania importu.

JobResponse

Właściwości obiektu Odpowiedź zadania.

Nazwa	Typ	Opis
endTimeUtc	string	Czas zatrzymania przetwarzania zadania.
failureReason	string	Jeśli stan == nie powiodło się, ten ciąg zawierający przyczynę błędu.
jobId	string	Identyfikator zadania.
parentJobId	string	Identyfikator zadania nadrzędnego, jeśli istnieje.
startTimeUtc	string	Godzina rozpoczęcia zadania.
status	JobStatus	Stan zadania.
statusMessage	string	Komunikat o stanie zadania.
type	JobType	Typ zadania.

JobStatus

Stan zadania.

Nazwa	Typ	Opis
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

Typ zadania.

Nazwa	Typ	Opis
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

ManagedIdentity

Właściwości tożsamości zarządzanej.

Nazwa	Typ	Opis
userAssignedIdentity	string	Tożsamość przypisana przez użytkownika.