Iot Hub Resource - Import Devices
Importe, actualice o elimine identidades de dispositivo en el registro de identidades de IoT Hub desde un blob. Para obtener más información, consulte: 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
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nombre del grupo de recursos que contiene el centro de IoT. |
resource
|
path | True |
string |
Nombre del centro de IoT. |
subscription
|
path | True |
string |
Identificador de la suscripción. |
api-version
|
query | True |
string |
La versión de la API. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
inputBlobContainerUri | True |
string |
Identificador URI del contenedor de blobs de entrada. |
outputBlobContainerUri | True |
string |
URI del contenedor de blobs de salida. |
authenticationType |
Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento. |
||
configurationsBlobName |
string |
Nombre del blob que se va a usar al importar configuraciones desde el contenedor de blobs de entrada proporcionado. |
|
identity |
Propiedades de identidad administrada del punto de conexión de almacenamiento para importar dispositivos. |
||
includeConfigurations |
boolean |
Valor que indica si se deben importar configuraciones. |
|
inputBlobName |
string |
Nombre del blob que se va a usar al importar desde el contenedor de blobs de entrada proporcionado. |
|
outputBlobName |
string |
Nombre del blob que se va a usar para almacenar el estado del trabajo de importación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar |
|
Other Status Codes |
DefaultErrorResponse |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
IotHubResource_ImportDevices
Solicitud de ejemplo
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"
}
Respuesta de muestra
{
"jobId": "test",
"startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
"endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT",
"type": "unknown",
"status": "unknown"
}
Definiciones
Nombre | Description |
---|---|
Authentication |
Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento. |
Error |
Detalles del error. |
Import |
Use para proporcionar parámetros al solicitar una importación de todos los dispositivos del centro. |
Job |
Propiedades del objeto Job Response. |
Job |
El estado del trabajo. |
Job |
Tipo del trabajo. |
Managed |
Propiedades de la identidad administrada. |
AuthenticationType
Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento.
Nombre | Tipo | Description |
---|---|---|
identityBased |
string |
|
keyBased |
string |
ErrorDetails
Detalles del error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
details |
string |
Los detalles del error. |
httpStatusCode |
string |
El código de estado HTTP. |
message |
string |
El mensaje de error. |
ImportDevicesRequest
Use para proporcionar parámetros al solicitar una importación de todos los dispositivos del centro.
Nombre | Tipo | Description |
---|---|---|
authenticationType |
Especifica el tipo de autenticación que se usa para conectarse a la cuenta de almacenamiento. |
|
configurationsBlobName |
string |
Nombre del blob que se va a usar al importar configuraciones desde el contenedor de blobs de entrada proporcionado. |
identity |
Propiedades de identidad administrada del punto de conexión de almacenamiento para importar dispositivos. |
|
includeConfigurations |
boolean |
Valor que indica si se deben importar configuraciones. |
inputBlobContainerUri |
string |
Identificador URI del contenedor de blobs de entrada. |
inputBlobName |
string |
Nombre del blob que se va a usar al importar desde el contenedor de blobs de entrada proporcionado. |
outputBlobContainerUri |
string |
URI del contenedor de blobs de salida. |
outputBlobName |
string |
Nombre del blob que se va a usar para almacenar el estado del trabajo de importación. |
JobResponse
Propiedades del objeto Job Response.
Nombre | Tipo | Description |
---|---|---|
endTimeUtc |
string |
Hora en que el trabajo detuvo el procesamiento. |
failureReason |
string |
Si el estado == no se pudo realizar, esta cadena contiene el motivo del error. |
jobId |
string |
Identificador de trabajo. |
parentJobId |
string |
Identificador de trabajo del trabajo primario, si existe. |
startTimeUtc |
string |
Hora de inicio del trabajo. |
status |
El estado del trabajo. |
|
statusMessage |
string |
Mensaje de estado del trabajo. |
type |
Tipo del trabajo. |
JobStatus
El estado del trabajo.
Nombre | Tipo | Description |
---|---|---|
cancelled |
string |
|
completed |
string |
|
enqueued |
string |
|
failed |
string |
|
running |
string |
|
unknown |
string |
JobType
Tipo del trabajo.
Nombre | Tipo | Description |
---|---|---|
backup |
string |
|
export |
string |
|
factoryResetDevice |
string |
|
firmwareUpdate |
string |
|
import |
string |
|
readDeviceProperties |
string |
|
rebootDevice |
string |
|
unknown |
string |
|
updateDeviceConfiguration |
string |
|
writeDeviceProperties |
string |
ManagedIdentity
Propiedades de la identidad administrada.
Nombre | Tipo | Description |
---|---|---|
userAssignedIdentity |
string |
Identidad asignada por el usuario. |