Iot Hub Resource - List Jobs

Referencia

Service:: IoT Hub

API Version:: 2018-04-01

Obtenga una lista de todos los trabajos de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs?api-version=2018-04-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el centro de IoT.
resourceName	path	True	string	Nombre del centro de IoT.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	JobResponseListResult	Se trata de una operación sincrónica. La respuesta contiene una matriz serializada por JSON de todos los trabajos del centro de IoT.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

IotHubResource_ListJobs

Sample Request

HTTP

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/jobs?api-version=2018-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "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
ErrorDetails	Detalles del error.
JobResponse	Propiedades del objeto Job Response.
JobResponseListResult	Matriz serializada por JSON de objetos JobResponse con un vínculo siguiente.
JobStatus	El estado del trabajo.
JobType	Tipo del trabajo.

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.

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	JobStatus	El estado del trabajo.
statusMessage	string	Mensaje de estado del trabajo.
type	JobType	Tipo del trabajo.

JobResponseListResult

Matriz serializada por JSON de objetos JobResponse con un vínculo siguiente.

Nombre	Tipo	Description
nextLink	string	Vínculo siguiente.
value	JobResponse[]	Matriz de objetos JobResponse.

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