APIHub
Back to Explore

AdvisorManagementClient

The AdvisorManagementClient API enables you to trigger generation of Azure Advisor recommendations, retrieve cached recommendation data and details, manage Advisor configuration settings, access metadata and operation listings, and create, read, update, or delete recommendation suppressions (snoozed or dismissed states).

Cloud
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

77ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations

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.

  • subscriptionId (path, required) — The Azure subscription ID.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.Advisor/metadata

Gets the list of metadata entities.

  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.Advisor/metadata/{name}

Gets the metadata entity.

  • name (path, required) — Name of metadata entity.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/providers/Microsoft.Advisor/operations

Lists all the available Advisor REST API operations.

  • api-version (query, required) — The version of the API to be used with the client request.
GET

/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations

Retrieve Azure Advisor configurations.

  • api-version (query, required) — The version of the API to be used with the client request.
  • subscriptionId (path, required) — The Azure subscription ID.
PUT

/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations

Create/Overwrite Azure Advisor configuration.

  • api-version (query, required) — The version of the API to be used with the client request.
  • subscriptionId (path, required) — The Azure subscription ID.
GET

/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}

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.

  • subscriptionId (path, required) — The Azure subscription ID.
  • operationId (path, required) — The operation ID, which can be found from the Location field in the generate recommendation response header.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

  • subscriptionId (path, required) — The Azure subscription ID.
  • api-version (query, required) — The version of the API to be used with the client request.
  • $filter (query) — The filter to apply to the recommendations.
  • $top (query, limit) — The number of recommendations per page if a paged version of this API is being used.
  • $skipToken (query) — The page-continuation token to use with a paged version of this API.
GET

/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions

Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.

  • subscriptionId (path, required) — The Azure subscription ID.
  • api-version (query, required) — The version of the API to be used with the client request.
  • $top (query, limit) — The number of suppressions per page if a paged version of this API is being used.
  • $skipToken (query) — The page-continuation token to use with a paged version of this API.
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations

Retrieve Azure Advisor configurations.

  • api-version (query, required) — The version of the API to be used with the client request.
  • subscriptionId (path, required) — The Azure subscription ID.
  • resourceGroup (path, required) — The name of the Azure resource group.
PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations

Create/Overwrite Azure Advisor configuration.

  • api-version (query, required) — The version of the API to be used with the client request.
  • subscriptionId (path, required) — The Azure subscription ID.
  • resourceGroup (path, required) — The name of the Azure resource group.
GET

/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}

Obtains details of a cached recommendation.

  • resourceUri (path, required) — The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
  • recommendationId (path, required) — The recommendation ID.
  • api-version (query, required) — The version of the API to be used with the client request.
DELETE

/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}

Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.

  • resourceUri (path, required) — The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
  • recommendationId (path, required) — The recommendation ID.
  • name (path, required) — The name of the suppression.
  • api-version (query, required) — The version of the API to be used with the client request.
GET

/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}

Obtains the details of a suppression.

  • resourceUri (path, required) — The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
  • recommendationId (path, required) — The recommendation ID.
  • name (path, required) — The name of the suppression.
  • api-version (query, required) — The version of the API to be used with the client request.
PUT

/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}

Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.

  • resourceUri (path, required) — The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
  • recommendationId (path, required) — The recommendation ID.
  • name (path, required) — The name of the suppression.
  • api-version (query, required) — The version of the API to be used with the client request.

15 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations"

management.azure.com · HTTPS only