Microsoft.Advisor (preview:2025-05-01)

2025/09/01 • 35 new, 35 deleted methods

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

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendations.
Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].
Example:
- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup' ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ResourceRecommendationBase items on this page ,
Required: True ,
}
[
{
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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Recommendations_Get (new)
Description :  Obtains details of a cached recommendation.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Recommendations_Patch (new)
Description :  Update the tracked properties of a Recommendation.
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
trackedProperties:
{
Description: The properties to update on the recommendation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
trackedProperties:
{
Description: The tracked properties of a Recommendation ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ 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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
RecommendationMetadata_List (new)
Description :  Gets the list of metadata entities.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MetadataEntity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The metadata entity properties. ,
Required: False ,
}
{
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
dependsOn:
{
Description: The list of keys on which this entity depends on. ,
Required: False ,
}
[
string ,
]
,
applicableScenarios:
{
Description: The list of scenarios applicable to this metadata entity. ,
Required: False ,
}
[
string ,
]
,
supportedValues:
{
Description: The list of supported values. ,
Required: False ,
}
[
{
id:
{
Description: The id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
RecommendationMetadata_Get (new)
Description :  Get a MetadataEntity
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/metadata/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Name of metadata entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The metadata entity properties. ,
Required: False ,
}
{
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
dependsOn:
{
Description: The list of keys on which this entity depends on. ,
Required: False ,
}
[
string ,
]
,
applicableScenarios:
{
Description: The list of scenarios applicable to this metadata entity. ,
Required: False ,
}
[
string ,
]
,
supportedValues:
{
Description: The list of supported values. ,
Required: False ,
}
[
{
id:
{
Description: The id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (404)

{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OperationEntity items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
AdvisorScores_List (new)
Description :  Gets the list of advisor scores.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/advisorScore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
properties:
{
Description: The Advisor score data. ,
Required: False ,
}
{
lastRefreshedScore:
{
Description: The details of latest available score. ,
Required: False ,
}
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
timeSeries:
{
Description: The historic Advisor score data. ,
Required: False ,
}
[
{
aggregationLevel:
{
Description: The aggregation level of the score. ,
Enum:
{
week: No description available. ,
day: No description available. ,
month: No description available. ,
}
,
Required: False ,
}
enum ,
scoreHistory:
{
Description: The past score data ,
Required: False ,
}
[
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
AdvisorScores_Get (new)
Description :  Gets the advisor score.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/advisorScore/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The scope of Advisor score entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor score data. ,
Required: False ,
}
{
lastRefreshedScore:
{
Description: The details of latest available score. ,
Required: False ,
}
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
timeSeries:
{
Description: The historic Advisor score data. ,
Required: False ,
}
[
{
aggregationLevel:
{
Description: The aggregation level of the score. ,
Enum:
{
week: No description available. ,
day: No description available. ,
month: No description available. ,
}
,
Required: False ,
}
enum ,
scoreHistory:
{
Description: The past score data ,
Required: False ,
}
[
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
AssessmentTypes_List (new)
Description :  Get list of Azure Advisor assessment types.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessmentTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessmentTypeResult items on this page ,
Required: True ,
}
[
{
id:
{
Description: Assessment Type Id ,
Required: False ,
}
string ,
title:
{
Description: Assessment Type Title ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale ,
Required: False ,
}
string ,
version:
{
Description: Assessment Type Version ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assessments_List (new)
Description :  Get list of Azure Advisor assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessmentResult items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assessments_Get (new)
Description :  Get a existing Azure Advisor assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
assessmentName:
{
Description: Advisor assessment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assessments_Put (new)
Description :  Create or Overwrite Azure Advisor assessment resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
assessmentName:
{
Description: Advisor assessment name. ,
Required: True ,
}
string ,
assessmentContract:
{
Description: The Azure Advisor assessment data structure. ,
Required: True ,
}
{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assessments_Delete (new)
Description :  Delete a existing Azure Advisor assessment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
assessmentName:
{
Description: Advisor assessment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_ListBySubscription (new)
Description :  Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ConfigData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Configurations_CreateInSubscription (new)
Description :  Create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: Advisor configuration name. Value must be 'default' ,
Required: True ,
}
string ,
configContract:
{
Description: The Azure Advisor configuration data structure. ,
Required: True ,
}
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
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 database so they can be retrieved later.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL where the status of the asynchronous operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Predict (new)
Description :  Predicts a recommendation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/predict
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
predictionRequest:
{
Description: The request body ,
Required: True ,
}
{
properties:
{
Description: Request properties for prediction recommendation. ,
Required: False ,
}
{
predictionType:
{
Description: Type of the prediction. ,
Enum:
{
PredictiveRightsizing: No description available. ,
}
,
Required: False ,
}
enum ,
extendedProperties:
{
Description: Extended properties are arguments specific for each prediction type. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the prediction. ,
Required: False ,
}
{
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
string ,
predictionType:
{
Description: Type of the prediction. ,
Enum:
{
PredictiveRightsizing: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
lastUpdated:
{
Description: The most recent time that Advisor checked the validity of the recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
shortDescription:
{
Description: A summary of the recommendation. ,
Required: False ,
}
{
problem:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendations.
Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].
Example:
- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup' ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ResourceRecommendationBase items on this page ,
Required: True ,
}
[
{
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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
resiliencyReviews_List (new)
Description :  Get list of Azure Advisor resiliency reviews.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip before starting to collect the result set. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply.
Filter can be applied to properties ['reviewStatus', 'reviewId'] with operators ['eq', 'and', 'or'].
Example:
- $filter=reviewStatus eq 'New' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resiliency reviews. ,
Required: True ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/resiliencyReviews". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewName:
{
Description: Review name. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
reviewStatus:
{
Description: Review status. ,
Enum:
{
New: New ,
InProgress: In Progress ,
Triaged: Triaged ,
Completed: Completed ,
}
,
Required: False ,
}
enum ,
recommendationsCount:
{
Description: Review recommendations count. ,
Format: int32 ,
Required: False ,
}
integer ,
publishedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
updatedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Advisor resiliency reviews, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
resiliencyReviews_Get (new)
Description :  Get existing Azure Advisor resiliency review by id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/resiliencyReviews". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewName:
{
Description: Review name. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
reviewStatus:
{
Description: Review status. ,
Enum:
{
New: New ,
InProgress: In Progress ,
Triaged: Triaged ,
Completed: Completed ,
}
,
Required: False ,
}
enum ,
recommendationsCount:
{
Description: Review recommendations count. ,
Format: int32 ,
Required: False ,
}
integer ,
publishedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
updatedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_List (new)
Description :  Get list of recommendations for an existing Azure Advisor Resiliency Review Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip before starting to collect the result set. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of triage recommendations. ,
Required: True ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendation/{recommendationId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/triageRecommendation". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewId:
{
Description: Review id. ,
Required: False ,
}
string ,
title:
{
Description: Recommendation label. ,
Required: False ,
}
string ,
priority:
{
Description: Recommendation priority. ,
Enum:
{
High: High ,
Medium: Medium ,
Low: Low ,
}
,
Required: False ,
}
enum ,
appliesToSubscriptions:
{
Description: List of subscription ids. ,
Required: False ,
}
[
string ,
]
,
recommendationStatus:
{
Description: Recommendation status. ,
Enum:
{
Approved: Approved ,
Rejected: Rejected ,
Pending: Pending ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
rejectReason:
{
Description: Recommendation rejection reason. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
description:
{
Description: Recommendation description. ,
Required: False ,
}
string ,
notes:
{
Description: Recommendation notes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of triage recommendations, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_Get (new)
Description :  Get an existing recommendation by id for an existing Azure Advisor Resiliency Review Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendation/{recommendationId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/triageRecommendation". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewId:
{
Description: Review id. ,
Required: False ,
}
string ,
title:
{
Description: Recommendation label. ,
Required: False ,
}
string ,
priority:
{
Description: Recommendation priority. ,
Enum:
{
High: High ,
Medium: Medium ,
Low: Low ,
}
,
Required: False ,
}
enum ,
appliesToSubscriptions:
{
Description: List of subscription ids. ,
Required: False ,
}
[
string ,
]
,
recommendationStatus:
{
Description: Recommendation status. ,
Enum:
{
Approved: Approved ,
Rejected: Rejected ,
Pending: Pending ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
rejectReason:
{
Description: Recommendation rejection reason. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
description:
{
Description: Recommendation description. ,
Required: False ,
}
string ,
notes:
{
Description: Recommendation notes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_ApproveTriageRecommendation (new)
Description :  Approve a triage recommendation for a given id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/approve
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageResources_List (new)
Description :  List all triage resources that belong to a review and recommendation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/providers/Microsoft.Advisor/triageResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of triage resources. ,
Required: True ,
}
[
{
properties:
{
Description: Triage resource properties. ,
Required: False ,
}
{
reviewId:
{
Description: Unique identifier for the review resource this triageResource belongs to. ,
Required: False ,
}
string ,
recommendationId:
{
Description: Unique identifier for the recommendation resource this triageResource belongs to. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Unique identifier for the subscription resource this triageResource belongs to. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Name of the resource group this triageResource belongs to. ,
Required: False ,
}
string ,
resourceType:
{
Description: Type of resource this triageResource corresponds to e.g. "Cosmos DB". ,
Required: False ,
}
string ,
resourceId:
{
Description: Full Azure resource id path of the resource this triageResource corresponds to. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the resource this triageResource corresponds to. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of triage resources, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageResources_Get (new)
Description :  Get a triage resource for a given review and recommendation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/providers/Microsoft.Advisor/triageResources/{recommendationResourceId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationResourceId:
{
Description: Existing recommendation triage resource associated with a triage recommendation. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Triage resource properties. ,
Required: False ,
}
{
reviewId:
{
Description: Unique identifier for the review resource this triageResource belongs to. ,
Required: False ,
}
string ,
recommendationId:
{
Description: Unique identifier for the recommendation resource this triageResource belongs to. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Unique identifier for the subscription resource this triageResource belongs to. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Name of the resource group this triageResource belongs to. ,
Required: False ,
}
string ,
resourceType:
{
Description: Type of resource this triageResource corresponds to e.g. "Cosmos DB". ,
Required: False ,
}
string ,
resourceId:
{
Description: Full Azure resource id path of the resource this triageResource corresponds to. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the resource this triageResource corresponds to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_RejectTriageRecommendation (new)
Description :  Reject an existing triage recommendation for a given id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/reject
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationRejectBody:
{
Description: JSON object that contains reason for rejecting triage recommendation. ,
Required: True ,
}
{
reasonForRejection:
{
Description: Reason for rejecting recommendation. ,
Enum:
{
NotARisk: Not A Risk ,
RiskAccepted: Risk Accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_ResetTriageRecommendation (new)
Description :  Reset an existing triage recommendation for a given id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/reset
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The number of suppressions per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SuppressionContract items on this page ,
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Workloads_List (new)
Description :  Get list of Workloads.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/workloads
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: [Placeholder] Discription for value property ,
Required: True ,
}
[
{
id:
{
Description: Workload Id ,
Required: False ,
}
string ,
name:
{
Description: Workload Name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Subscription Name ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: [Placeholder] Discription for nextLink property ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Configurations_ListByResourceGroup (new)
Description :  Retrieve Azure Advisor configurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ConfigData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Configurations_CreateInResourceGroup (new)
Description :  Create/Overwrite Azure Advisor configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: Advisor configuration name. Value must be 'default' ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
configContract:
{
Description: The Azure Advisor configuration data structure. ,
Required: True ,
}
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
RecommendationMetadata_Get (removed)
Description :  Get a MetadataEntity
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/metadata/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Name of metadata entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The metadata entity properties. ,
Required: False ,
}
{
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
dependsOn:
{
Description: The list of keys on which this entity depends on. ,
Required: False ,
}
[
string ,
]
,
applicableScenarios:
{
Description: The list of scenarios applicable to this metadata entity. ,
Required: False ,
}
[
string ,
]
,
supportedValues:
{
Description: The list of supported values. ,
Required: False ,
}
[
{
id:
{
Description: The id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (404)

{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
RecommendationMetadata_List (removed)
Description :  Gets the list of metadata entities.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MetadataEntity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The metadata entity properties. ,
Required: False ,
}
{
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
dependsOn:
{
Description: The list of keys on which this entity depends on. ,
Required: False ,
}
[
string ,
]
,
applicableScenarios:
{
Description: The list of scenarios applicable to this metadata entity. ,
Required: False ,
}
[
string ,
]
,
supportedValues:
{
Description: The list of supported values. ,
Required: False ,
}
[
{
id:
{
Description: The id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Configurations_ListBySubscription (removed)
Description :  Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ConfigData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Configurations_CreateInSubscription (removed)
Description :  Create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: Advisor configuration name. Value must be 'default' ,
Required: True ,
}
string ,
configContract:
{
Description: The Azure Advisor configuration data structure. ,
Required: True ,
}
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Configurations_ListByResourceGroup (removed)
Description :  Retrieve Azure Advisor configurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ConfigData items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Configurations_CreateInResourceGroup (removed)
Description :  Create/Overwrite Azure Advisor configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations/{configurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
configurationName:
{
Description: Advisor configuration name. Value must be 'default' ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The name of the Azure resource group. ,
Required: True ,
}
string ,
configContract:
{
Description: The Azure Advisor configuration data structure. ,
Required: True ,
}
{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor configuration data structure. ,
Required: False ,
}
{
exclude:
{
Description: Exclude the resource from Advisor evaluations. Valid values: False (default) or True. ,
Required: False ,
}
boolean ,
lowCpuThreshold:
{
Description: Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. ,
Enum:
{
5: No description available. ,
10: No description available. ,
15: No description available. ,
20: No description available. ,
}
,
Required: False ,
}
enum ,
duration:
{
Description: Minimum duration for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 7 (default), 14, 21, 30, 60 or 90. ,
Enum:
{
7: No description available. ,
14: No description available. ,
21: No description available. ,
30: No description available. ,
60: No description available. ,
90: No description available. ,
}
,
Required: False ,
}
enum ,
digests:
{
Description: Advisor digest configuration. Valid only for subscriptions ,
Required: False ,
}
[
{
name:
{
Description: Name of digest configuration. Value is case-insensitive and must be unique within a subscription. ,
Required: False ,
}
string ,
actionGroupResourceId:
{
Description: Action group resource id used by digest. ,
Required: False ,
}
string ,
frequency:
{
Description: Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
categories:
{
Description: Categories to send digest for. If categories are not provided, then digest will be sent for all categories. ,
Required: False ,
}
[
string ,
]
,
language:
{
Description: Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en). ,
Required: False ,
}
string ,
state:
{
Description: State of digest configuration. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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 database so they can be retrieved later.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL where the status of the asynchronous operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Recommendations_ListByTenant (removed)
Description :  Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendations.
Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].
Example:
- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup' ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ResourceRecommendationBase items on this page ,
Required: True ,
}
[
{
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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply to the recommendations.
Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].
Example:
- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup' ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ResourceRecommendationBase items on this page ,
Required: True ,
}
[
{
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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Advisor/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OperationEntity items on this page ,
Required: True ,
}
[
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Recommendations_Get (removed)
Description :  Obtains details of a cached recommendation.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Recommendations_Patch (removed)
Description :  Update the tracked properties of a Recommendation.
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
trackedProperties:
{
Description: The properties to update on the recommendation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
trackedProperties:
{
Description: The tracked properties of a Recommendation ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ 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 ,
control:
{
Description: The control type for the recommendation. ,
Enum:
{
HighAvailability: No description available. ,
BusinessContinuity: No description available. ,
DisasterRecovery: No description available. ,
Scalability: No description available. ,
MonitoringAndAlerting: No description available. ,
ServiceUpgradeAndRetirement: No description available. ,
Other: No description available. ,
PrioritizedRecommendations: No description available. ,
Personalized: 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 and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
suppressionIds:
{
Description: The list of snoozed and dismissed rules for the recommendation. ,
Required: False ,
}
[
string ,
]
,
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
resourceMetadata:
{
Description: Metadata of resource that was assessed ,
Required: False ,
}
{
resourceId:
{
Description: Azure resource Id of the assessed resource ,
Required: False ,
}
string ,
source:
{
Description: Source from which recommendation is generated ,
Required: False ,
}
string ,
action:
{
Description: The action to view resource. ,
Required: False ,
}
object ,
singular:
{
Description: The singular user friendly name of resource type. eg: virtual machine ,
Required: False ,
}
string ,
plural:
{
Description: The plural user friendly name of resource type. eg: virtual machines ,
Required: False ,
}
string ,
}
,
description:
{
Description: The detailed description of recommendation. ,
Required: False ,
}
string ,
label:
{
Description: The label of recommendation. ,
Required: False ,
}
string ,
learnMoreLink:
{
Description: The link to learn more about recommendation and generation logic. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: The potential benefit of implementing recommendation. ,
Required: False ,
}
string ,
actions:
{
Description: The list of recommended actions to implement recommendation. ,
Required: False ,
}
[
object ,
]
,
remediation:
{
Description: The automated way to apply recommendation. ,
Required: False ,
}
object ,
exposedMetadataProperties:
{
Description: The recommendation metadata properties exposed to customer to provide additional information. ,
Required: False ,
}
object ,
tracked:
{
Description: If the Recommendation has Tracking enabled. ,
Required: False ,
}
boolean ,
trackedProperties:
{
Description: The properties of a tracked recommendation. ,
Required: False ,
}
{
state:
{
Description: The state of the Recommendation ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Postponed: No description available. ,
Dismissed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
postponedTime:
{
Description: The time the Recommendation was postponed until. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The reason the state of the Recommendation was changed. ,
Enum:
{
ExcessiveInvestment: No description available. ,
TooComplex: No description available. ,
AlternativeSolution: No description available. ,
Incompatible: No description available. ,
Unclear: No description available. ,
RiskAccepted: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: The Priority of the Recommendation. ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
review:
{
Description: The Review that this Recommendation belongs to. ,
Required: False ,
}
{
id:
{
Description: The ARM Resource Id of the Review ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Review ,
Required: False ,
}
string ,
}
,
resourceWorkload:
{
Description: The Workload that this Resource belongs to. ,
Required: False ,
}
{
id:
{
Description: The Id of the Workload ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Workload ,
Required: False ,
}
string ,
}
,
sourceSystem:
{
Description: The Source System that this Recommendation originated from. ,
Required: False ,
}
string ,
notes:
{
Description: Additional notes for the Recommendation ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
recommendationId:
{
Description: The recommendation ID. ,
Required: True ,
}
string ,
name:
{
Description: The name of the suppression. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: The number of suppressions per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SuppressionContract items on this page ,
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 ,
expirationTimeStamp:
{
Description: Gets or sets the expiration time stamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Predict (removed)
Description :  Predicts a recommendation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/predict
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
predictionRequest:
{
Description: The request body ,
Required: True ,
}
{
properties:
{
Description: Request properties for prediction recommendation. ,
Required: False ,
}
{
predictionType:
{
Description: Type of the prediction. ,
Enum:
{
PredictiveRightsizing: No description available. ,
}
,
Required: False ,
}
enum ,
extendedProperties:
{
Description: Extended properties are arguments specific for each prediction type. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the prediction. ,
Required: False ,
}
{
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
string ,
predictionType:
{
Description: Type of the prediction. ,
Enum:
{
PredictiveRightsizing: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
lastUpdated:
{
Description: The most recent time that Advisor checked the validity of the recommendation. ,
Format: date-time ,
Required: False ,
}
string ,
shortDescription:
{
Description: A summary of the recommendation. ,
Required: False ,
}
{
problem:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
solution:
{
Description: The issue or opportunity identified by the recommendation and proposed solution. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
AdvisorScores_List (removed)
Description :  Gets the list of advisor scores.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/advisorScore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
properties:
{
Description: The Advisor score data. ,
Required: False ,
}
{
lastRefreshedScore:
{
Description: The details of latest available score. ,
Required: False ,
}
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
timeSeries:
{
Description: The historic Advisor score data. ,
Required: False ,
}
[
{
aggregationLevel:
{
Description: The aggregation level of the score. ,
Enum:
{
week: No description available. ,
day: No description available. ,
month: No description available. ,
}
,
Required: False ,
}
enum ,
scoreHistory:
{
Description: The past score data ,
Required: False ,
}
[
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
AdvisorScores_Get (removed)
Description :  Gets the advisor score.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/advisorScore/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The scope of Advisor score entity. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor score data. ,
Required: False ,
}
{
lastRefreshedScore:
{
Description: The details of latest available score. ,
Required: False ,
}
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
timeSeries:
{
Description: The historic Advisor score data. ,
Required: False ,
}
[
{
aggregationLevel:
{
Description: The aggregation level of the score. ,
Enum:
{
week: No description available. ,
day: No description available. ,
month: No description available. ,
}
,
Required: False ,
}
enum ,
scoreHistory:
{
Description: The past score data ,
Required: False ,
}
[
{
date:
{
Description: The date score was calculated. ,
Required: False ,
}
string ,
score:
{
Description: The percentage score. ,
Format: float ,
Required: False ,
}
number ,
consumptionUnits:
{
Description: The consumption units for the score. ,
Format: float ,
Required: False ,
}
number ,
impactedResourceCount:
{
Description: The number of impacted resources. ,
Format: float ,
Required: False ,
}
number ,
potentialScoreIncrease:
{
Description: The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented. ,
Format: float ,
Required: False ,
}
number ,
categoryCount:
{
Description: The count of impacted categories. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: ARM error response body. ,
Required: False ,
}
{
message:
{
Description: Gets or sets the string that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
code:
{
Description: Gets or sets the string that can be used to programmatically identify the error. ,
Required: False ,
}
string ,
}
,
}
Assessments_Delete (removed)
Description :  Delete a existing Azure Advisor assessment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
assessmentName:
{
Description: Advisor assessment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assessments_Get (removed)
Description :  Get a existing Azure Advisor assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
assessmentName:
{
Description: Advisor assessment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assessments_Put (removed)
Description :  Create or Overwrite Azure Advisor assessment resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments/{assessmentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
assessmentName:
{
Description: Advisor assessment name. ,
Required: True ,
}
string ,
assessmentContract:
{
Description: The Azure Advisor assessment data structure. ,
Required: True ,
}
{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assessments_List (removed)
Description :  Get list of Azure Advisor assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
$top:
{
Description: Limit the result to the specified number of rows. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The page-continuation token to use with a paged version of this API. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessmentResult items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Advisor assessment result properties structure. ,
Required: False ,
}
{
workloadId:
{
Description: Workload Id. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
assessmentId:
{
Description: Assessment Id. ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description. ,
Required: False ,
}
string ,
typeId:
{
Description: Assessment Type Id. ,
Required: False ,
}
string ,
type:
{
Description: Assessment Type. ,
Required: False ,
}
string ,
score:
{
Description: Assessment Score. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Assessment State. ,
Required: False ,
}
string ,
typeVersion:
{
Description: Assessment Type Version. ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssessmentTypes_List (removed)
Description :  Get list of Azure Advisor assessment types.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/assessmentTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssessmentTypeResult items on this page ,
Required: True ,
}
[
{
id:
{
Description: Assessment Type Id ,
Required: False ,
}
string ,
title:
{
Description: Assessment Type Title ,
Required: False ,
}
string ,
description:
{
Description: Assessment Type Description ,
Required: False ,
}
string ,
locale:
{
Description: Assessment Type Locale ,
Required: False ,
}
string ,
version:
{
Description: Assessment Type Version ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workloads_List (removed)
Description :  Get list of Workloads.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/workloads
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: [Placeholder] Discription for value property ,
Required: True ,
}
[
{
id:
{
Description: Workload Id ,
Required: False ,
}
string ,
name:
{
Description: Workload Name ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Subscription Name ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: [Placeholder] Discription for nextLink property ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
resiliencyReviews_List (removed)
Description :  Get list of Azure Advisor resiliency reviews.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip before starting to collect the result set. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply.
Filter can be applied to properties ['reviewStatus', 'reviewId'] with operators ['eq', 'and', 'or'].
Example:
- $filter=reviewStatus eq 'New' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resiliency reviews. ,
Required: True ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/resiliencyReviews". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewName:
{
Description: Review name. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
reviewStatus:
{
Description: Review status. ,
Enum:
{
New: New ,
InProgress: In Progress ,
Triaged: Triaged ,
Completed: Completed ,
}
,
Required: False ,
}
enum ,
recommendationsCount:
{
Description: Review recommendations count. ,
Format: int32 ,
Required: False ,
}
integer ,
publishedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
updatedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of Advisor resiliency reviews, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
resiliencyReviews_Get (removed)
Description :  Get existing Azure Advisor resiliency review by id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/resiliencyReviews". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewName:
{
Description: Review name. ,
Required: False ,
}
string ,
workloadName:
{
Description: Workload Name. ,
Required: False ,
}
string ,
reviewStatus:
{
Description: Review status. ,
Enum:
{
New: New ,
InProgress: In Progress ,
Triaged: Triaged ,
Completed: Completed ,
}
,
Required: False ,
}
enum ,
recommendationsCount:
{
Description: Review recommendations count. ,
Format: int32 ,
Required: False ,
}
integer ,
publishedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
updatedAt:
{
Description: Review last updated timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_List (removed)
Description :  Get list of recommendations for an existing Azure Advisor Resiliency Review Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: The number of items to skip before starting to collect the result set. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of triage recommendations. ,
Required: True ,
}
[
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendation/{recommendationId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/triageRecommendation". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewId:
{
Description: Review id. ,
Required: False ,
}
string ,
title:
{
Description: Recommendation label. ,
Required: False ,
}
string ,
priority:
{
Description: Recommendation priority. ,
Enum:
{
High: High ,
Medium: Medium ,
Low: Low ,
}
,
Required: False ,
}
enum ,
appliesToSubscriptions:
{
Description: List of subscription ids. ,
Required: False ,
}
[
string ,
]
,
recommendationStatus:
{
Description: Recommendation status. ,
Enum:
{
Approved: Approved ,
Rejected: Rejected ,
Pending: Pending ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
rejectReason:
{
Description: Recommendation rejection reason. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
description:
{
Description: Recommendation description. ,
Required: False ,
}
string ,
notes:
{
Description: Recommendation notes. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of triage recommendations, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_Get (removed)
Description :  Get an existing recommendation by id for an existing Azure Advisor Resiliency Review Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/ResiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendation/{recommendationId}". ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Resource name E.g. "{guid}". ,
Required: False ,
}
string ,
type:
{
Description: Resource type E.g. "Microsoft.Advisor/triageRecommendation". ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Advisor resiliency review properties. ,
Required: False ,
}
{
reviewId:
{
Description: Review id. ,
Required: False ,
}
string ,
title:
{
Description: Recommendation label. ,
Required: False ,
}
string ,
priority:
{
Description: Recommendation priority. ,
Enum:
{
High: High ,
Medium: Medium ,
Low: Low ,
}
,
Required: False ,
}
enum ,
appliesToSubscriptions:
{
Description: List of subscription ids. ,
Required: False ,
}
[
string ,
]
,
recommendationStatus:
{
Description: Recommendation status. ,
Enum:
{
Approved: Approved ,
Rejected: Rejected ,
Pending: Pending ,
}
,
Required: False ,
}
enum ,
updatedAt:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
rejectReason:
{
Description: Recommendation rejection reason. ,
Required: False ,
}
string ,
potentialBenefits:
{
Description: Recommendation potential benefit. ,
Required: False ,
}
string ,
description:
{
Description: Recommendation description. ,
Required: False ,
}
string ,
notes:
{
Description: Recommendation notes. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_ApproveTriageRecommendation (removed)
Description :  Approve a triage recommendation for a given id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/approve
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_RejectTriageRecommendation (removed)
Description :  Reject an existing triage recommendation for a given id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/reject
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationRejectBody:
{
Description: JSON object that contains reason for rejecting triage recommendation. ,
Required: True ,
}
{
reasonForRejection:
{
Description: Reason for rejecting recommendation. ,
Enum:
{
NotARisk: Not A Risk ,
RiskAccepted: Risk Accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageRecommendations_ResetTriageRecommendation (removed)
Description :  Reset an existing triage recommendation for a given id.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/reset
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageResources_Get (removed)
Description :  Get a triage resource for a given review and recommendation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/providers/Microsoft.Advisor/triageResources/{recommendationResourceId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationResourceId:
{
Description: Existing recommendation triage resource associated with a triage recommendation. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Triage resource properties. ,
Required: False ,
}
{
reviewId:
{
Description: Unique identifier for the review resource this triageResource belongs to. ,
Required: False ,
}
string ,
recommendationId:
{
Description: Unique identifier for the recommendation resource this triageResource belongs to. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Unique identifier for the subscription resource this triageResource belongs to. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Name of the resource group this triageResource belongs to. ,
Required: False ,
}
string ,
resourceType:
{
Description: Type of resource this triageResource corresponds to e.g. "Cosmos DB". ,
Required: False ,
}
string ,
resourceId:
{
Description: Full Azure resource id path of the resource this triageResource corresponds to. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the resource this triageResource corresponds to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
triageResources_List (removed)
Description :  List all triage resources that belong to a review and recommendation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/resiliencyReviews/{reviewId}/providers/Microsoft.Advisor/triageRecommendations/{recommendationId}/providers/Microsoft.Advisor/triageResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
reviewId:
{
Description: Existing review id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
recommendationId:
{
Description: Existing triage recommendation id. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of triage resources. ,
Required: True ,
}
[
{
properties:
{
Description: Triage resource properties. ,
Required: False ,
}
{
reviewId:
{
Description: Unique identifier for the review resource this triageResource belongs to. ,
Required: False ,
}
string ,
recommendationId:
{
Description: Unique identifier for the recommendation resource this triageResource belongs to. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Unique identifier for the subscription resource this triageResource belongs to. ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Name of the resource group this triageResource belongs to. ,
Required: False ,
}
string ,
resourceType:
{
Description: Type of resource this triageResource corresponds to e.g. "Cosmos DB". ,
Required: False ,
}
string ,
resourceId:
{
Description: Full Azure resource id path of the resource this triageResource corresponds to. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceName:
{
Description: Name of the resource this triageResource corresponds to. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of triage resources, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}