Recommendations - Generate

  • Reference
Service:
Advisor
API Version:
2023-01-01

Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.

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

URI Parameters

Name In Required Type Description
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 has been accepted.

Headers

  • Location: string
  • Retry-After: string
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

GenerateRecommendations

Sample Request

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

Sample Response

Status code:
202 
Location: https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Microsoft.Advisor/generateRecommendations/recGUID?api-version=2023-01-01
Retry-After: 60

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.