Iot Dps Resource - Get Operation Result

  • Reference
Service:
IoT Hub Device Provisioning Service
API Version:
2022-12-12

Gets the status of a long running operation, such as create, update or delete a provisioning service.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}?asyncinfo={asyncinfo}&api-version=2022-12-12

URI Parameters

Name In Required Type Description
operationId
 path True

string

Operation id corresponding to long running operation. Use this to poll for the status.
provisioningServiceName
 path True

string

Name of provisioning service that the operation is running on.
resourceGroupName
 path True

string

Resource group identifier.
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

The version of the API.
asyncinfo
 query True

string

Async header used to poll on the status of the operation, obtained while creating the long running operation.

Responses

Name Type Description
200 OK

AsyncOperationResult

The status of the long running operation.
Other Status Codes

ErrorDetails

Default error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DPSGetOperationResult

Sample request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/operationresults/MTY5OTNmZDctODI5Yy00N2E2LTkxNDQtMDU1NGIyYzY1ZjRl?asyncinfo=1508265712453&api-version=2022-12-12

Sample response

Status code:
200 
{
  "status": "Succeeded"
}

Definitions

Name Description
AsyncOperationResult

Result of a long running operation.
ErrorDetails

Error details.
ErrorMessage

Error response containing message and code.

AsyncOperationResult

Result of a long running operation.

Name Type Description
error

ErrorMessage

Error message containing code, description and details
status

string

current status of a long running operation.

ErrorDetails

Error details.

Name Type Description
code

integer

The error code.
details

string

The error details.
httpStatusCode

string

The HTTP status code.
message

string

The error message.

ErrorMessage

Error response containing message and code.

Name Type Description
code

string

standard error code
details

string

detailed summary of error
message

string

standard error description