Iot Hub Resource - Get Job

Odwołanie

Usługa:: IoT Hub

Wersja interfejsu API:: 2023-06-30

Uzyskaj szczegółowe informacje o zadaniu z centrum IoT. Aby uzyskać więcej informacji, zobacz 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/{jobId}?api-version=2023-06-30

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
jobId	path	True	string	Identyfikator zadania.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej centrum IoT.
resourceName	path	True	string	Nazwa centrum IoT.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	JobResponse	Jest to operacja synchroniczna. Odpowiedź zawiera serializowany opis zadania w centrum IoT w formacie JSON.
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_GetJob

Przykładowe żądanie

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


/**
 * Samples for IotHubResource GetJob.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getjob.json
     */
    /**
     * Sample code: IotHubResource_GetJob.
     * 
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceGetJob(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().getJobWithResponse("myResourceGroup", "testHub", "test",
            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_getjob.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.get_job(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
        job_id="test",
    )
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getjob.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/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_getjob.json
func ExampleResourceClient_GetJob() {
	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().GetJob(ctx, "myResourceGroup", "testHub", "test", 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 Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
 *
 * @summary Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getjob.json
 */
async function iotHubResourceGetJob() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const jobId = "test";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.iotHubResource.getJob(resourceGroupName, resourceName, jobId);
  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_getjob.json
// this example is just showing the usage of "IotHubResource_GetJob" 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
string jobId = "test";
IotHubJobInfo result = await iotHubDescription.GetJobAsync(jobId);

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
ErrorDetails	Szczegóły błędu.
JobResponse	Właściwości obiektu Odpowiedź zadania.
JobStatus	Stan zadania.
JobType	Typ zadania.

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.

JobResponse

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

Nazwa	Typ	Opis
endTimeUtc	string	Czas zatrzymania przetwarzania zadania.
failureReason	string	Jeśli stan == nie powiódł się, ten ciąg zawierający przyczynę niepowodzenia.
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