Iot Hub Resource - Import Devices

Dienst:

IoT Hub

API-Version:

2023-06-30

Importieren, Aktualisieren oder Löschen von Geräteidentitäten in der IoT Hub-Identitätsregistrierung aus einem Blob. Weitere Informationen finden Sie unter 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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die den IoT Hub enthält.
resourceName	path	True	string	Der Name des IoT-Hubs.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
inputBlobContainerUri	True	string	Der Eingabeblobcontainer-URI.
outputBlobContainerUri	True	string	Der Ausgabeblobcontainer-URI.
authenticationType		AuthenticationType	Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.
configurationsBlobName		string	Der Blobname, der beim Importieren von Konfigurationen aus dem bereitgestellten Eingabeblobcontainer verwendet werden soll.
identity		ManagedIdentity	Eigenschaften der verwalteten Identität des Speicherendpunkts für Importgeräte.
includeConfigurations		boolean	Der Wert, der angibt, ob Konfigurationen importiert werden sollen.
inputBlobName		string	Der Blobname, der beim Importieren aus dem bereitgestellten Eingabeblobcontainer verwendet werden soll.
outputBlobName		string	Der Blobname, der zum Speichern der status des Importauftrags verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	JobResponse	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_ImportDevices

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AuthenticationType	Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.
ErrorDetails	Fehlerdetails.
ImportDevicesRequest	Verwenden Sie , um Parameter bereitzustellen, wenn Sie einen Import aller Geräte im Hub anfordern.
JobResponse	Die Eigenschaften des Auftragsantwortobjekts.
JobStatus	Der Status des Auftrags.
JobType	Der Typ des Auftrags.
ManagedIdentity	Die Eigenschaften der verwalteten Identität.

AuthenticationType

Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.

Name	Typ	Beschreibung
identityBased	string
keyBased	string

ErrorDetails

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

ImportDevicesRequest

Verwenden Sie , um Parameter bereitzustellen, wenn Sie einen Import aller Geräte im Hub anfordern.

Name	Typ	Beschreibung
authenticationType	AuthenticationType	Gibt den Authentifizierungstyp an, der zum Herstellen einer Verbindung mit dem Speicherkonto verwendet wird.
configurationsBlobName	string	Der Blobname, der beim Importieren von Konfigurationen aus dem bereitgestellten Eingabeblobcontainer verwendet werden soll.
identity	ManagedIdentity	Eigenschaften der verwalteten Identität des Speicherendpunkts für Importgeräte.
includeConfigurations	boolean	Der Wert, der angibt, ob Konfigurationen importiert werden sollen.
inputBlobContainerUri	string	Der Eingabeblobcontainer-URI.
inputBlobName	string	Der Blobname, der beim Importieren aus dem bereitgestellten Eingabeblobcontainer verwendet werden soll.
outputBlobContainerUri	string	Der Ausgabeblobcontainer-URI.
outputBlobName	string	Der Blobname, der zum Speichern der status des Importauftrags verwendet werden soll.

JobResponse

Die Eigenschaften des Auftragsantwortobjekts.

Name	Typ	Beschreibung
endTimeUtc	string	Die Zeit, zu der die Verarbeitung des Auftrags beendet wurde.
failureReason	string	Wenn status == fehlgeschlagen ist, enthält diese Zeichenfolge den Grund für den Fehler.
jobId	string	Der Auftragsbezeichner.
parentJobId	string	Der Auftragsbezeichner des übergeordneten Auftrags, falls vorhanden.
startTimeUtc	string	Die Startzeit des Auftrags.
status	JobStatus	Der Status des Auftrags.
statusMessage	string	Die status Meldung für den Auftrag.
type	JobType	Der Typ des Auftrags.

JobStatus

Der Status des Auftrags.

Name	Typ	Beschreibung
cancelled	string
completed	string
enqueued	string
failed	string
running	string
unknown	string

JobType

Der Typ des Auftrags.

Name	Typ	Beschreibung
backup	string
export	string
factoryResetDevice	string
firmwareUpdate	string
import	string
readDeviceProperties	string
rebootDevice	string
unknown	string
updateDeviceConfiguration	string
writeDeviceProperties	string

ManagedIdentity

Die Eigenschaften der verwalteten Identität.

Name	Typ	Beschreibung
userAssignedIdentity	string	Die vom Benutzer zugewiesene Identität.