Recommendations - Get Generate Status

Service:

Advisor

API Version:

2023-01-01

Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}?api-version=2023-01-01

URI Parameters

Name	In	Required	Type	Description
operationId	path	True	string uuid	The operation ID, which can be found from the Location field in the generate recommendation response header.
subscriptionId	path	True	string	The Azure subscription ID.
api-version	query	True	string	The version of the API to be used with the client request.

Responses

Name	Type	Description
202 Accepted		Accepted. Recommendation generation is in progress.
204 No Content		NoContent. Recommendation generation has been completed.
Other Status Codes	ArmErrorResponse	Error response describing why the operation failed.

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

GetGenerateStatus

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/generateRecommendations/123e4567-e89b-12d3-a456-426614174000?api-version=2023-01-01

Sample Response

Status code:

202

Status code:

204

Definitions

Name	Description
ArmErrorResponse
ARMErrorResponseBody	ARM error response body.

ArmErrorResponse

Name	Type	Description
error	ARMErrorResponseBody	ARM error response body.

ARMErrorResponseBody

ARM error response body.

Name	Type	Description
code	string	Gets or sets the string that can be used to programmatically identify the error.
message	string	Gets or sets the string that describes the error in detail and provides debugging information.