Microsoft.Advisor (stable:2017-03-31)

2025/09/12 • 9 new, 9 deleted methods

Recommendations_Generate (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL where the status of the asynchronous operation can be checked. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}
Recommendations_GetGenerateStatus (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID, which can be found from the Location field in the generate recommendation response header. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Recommendations_List (new)
Description :  Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendations. ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: The list of recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the recommendation. ,
Required: False ,
}
{
category:
{
Description: The category of the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
Security: No description available. ,
Performance: No description available. ,
Cost: No description available. ,
OperationalExcellence: No description available. ,
}
,
Required: False ,
}
enum ,
impact:
{
Description: The business impact of the recommendation. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
impactedField:
{
Description: The resource type identified by Advisor. ,
Required: False ,
}
string ,
impactedValue:
{
Description: The resource identified by Advisor. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The most recent time that Advisor checked the validity of the recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The recommendation metadata. ,
Required: False ,
}
object ,
recommendationTypeId:
{
Description: The recommendation-type GUID. ,
Required: False ,
}
string ,
risk:
{
Description: The potential risk of not implementing the recommendation. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: A summary of the recommendation. ,
Required: False ,
}
{
problem:
{
Description: The issue or opportunity identified by the recommendation. ,
Required: False ,
}
string ,
solution:
{
Description: The remediation action suggested by the recommendation. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
Operations_List (new)
Description :  Lists all the available Advisor REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/operations
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Advisor. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft Advisor. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Suppressions_Get (new)
Description :  Obtains the details of a suppression.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}
Suppressions_Create (new)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
suppressionContract:
{
Description: The snoozed or dismissed attribute; for example, the snooze duration. ,
Required: True ,
}
{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}
Suppressions_Delete (new)
Description :  Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Recommendations_Get (new)
Description :  Obtains details of a cached recommendation.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the recommendation. ,
Required: False ,
}
{
category:
{
Description: The category of the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
Security: No description available. ,
Performance: No description available. ,
Cost: No description available. ,
OperationalExcellence: No description available. ,
}
,
Required: False ,
}
enum ,
impact:
{
Description: The business impact of the recommendation. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
impactedField:
{
Description: The resource type identified by Advisor. ,
Required: False ,
}
string ,
impactedValue:
{
Description: The resource identified by Advisor. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The most recent time that Advisor checked the validity of the recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The recommendation metadata. ,
Required: False ,
}
object ,
recommendationTypeId:
{
Description: The recommendation-type GUID. ,
Required: False ,
}
string ,
risk:
{
Description: The potential risk of not implementing the recommendation. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: A summary of the recommendation. ,
Required: False ,
}
{
problem:
{
Description: The issue or opportunity identified by the recommendation. ,
Required: False ,
}
string ,
solution:
{
Description: The remediation action suggested by the recommendation. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Suppressions_List (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}
Recommendations_Generate (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL where the status of the asynchronous operation can be checked. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}
Recommendations_GetGenerateStatus (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID, which can be found from the Location field in the generate recommendation response header. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
Recommendations_List (removed)
Description :  Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendations. ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Description: The list of recommendations. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the recommendation. ,
Required: False ,
}
{
category:
{
Description: The category of the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
Security: No description available. ,
Performance: No description available. ,
Cost: No description available. ,
OperationalExcellence: No description available. ,
}
,
Required: False ,
}
enum ,
impact:
{
Description: The business impact of the recommendation. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
impactedField:
{
Description: The resource type identified by Advisor. ,
Required: False ,
}
string ,
impactedValue:
{
Description: The resource identified by Advisor. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The most recent time that Advisor checked the validity of the recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The recommendation metadata. ,
Required: False ,
}
object ,
recommendationTypeId:
{
Description: The recommendation-type GUID. ,
Required: False ,
}
string ,
risk:
{
Description: The potential risk of not implementing the recommendation. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: A summary of the recommendation. ,
Required: False ,
}
{
problem:
{
Description: The issue or opportunity identified by the recommendation. ,
Required: False ,
}
string ,
solution:
{
Description: The remediation action suggested by the recommendation. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
Operations_List (removed)
Description :  Lists all the available Advisor REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/operations
{
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Advisor. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft Advisor. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Suppressions_Get (removed)
Description :  Obtains the details of a suppression.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}
Suppressions_Create (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
suppressionContract:
{
Description: The snoozed or dismissed attribute; for example, the snooze duration. ,
Required: True ,
}
{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}
Suppressions_Delete (removed)
Description :  Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Recommendations_Get (removed)
Description :  Obtains details of a cached recommendation.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}
{
resourceUri:
{
Description: The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the recommendation. ,
Required: False ,
}
{
category:
{
Description: The category of the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
Security: No description available. ,
Performance: No description available. ,
Cost: No description available. ,
OperationalExcellence: No description available. ,
}
,
Required: False ,
}
enum ,
impact:
{
Description: The business impact of the recommendation. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
impactedField:
{
Description: The resource type identified by Advisor. ,
Required: False ,
}
string ,
impactedValue:
{
Description: The resource identified by Advisor. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: The most recent time that Advisor checked the validity of the recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The recommendation metadata. ,
Required: False ,
}
object ,
recommendationTypeId:
{
Description: The recommendation-type GUID. ,
Required: False ,
}
string ,
risk:
{
Description: The potential risk of not implementing the recommendation. ,
Enum:
{
Error: No description available. ,
Warning: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
shortDescription:
{
Description: A summary of the recommendation. ,
Required: False ,
}
{
problem:
{
Description: The issue or opportunity identified by the recommendation. ,
Required: False ,
}
string ,
solution:
{
Description: The remediation action suggested by the recommendation. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Suppressions_List (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the suppression. ,
Required: False ,
}
{
suppressionId:
{
Description: The GUID of the suppression. ,
Required: False ,
}
string ,
ttl:
{
Description: The duration for which the suppression is valid. ,
Required: False ,
}
string ,
}
,
}