Microsoft.Advisor (preview:2022-02-01)

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

Operations_List (new)
Description :  Lists all the available Advisor REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: 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 ,
}
,
}
Predict (new)
Description :  Predicts a recommendation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/predict
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
predictionRequest:
{
Description: Parameters for predict recommendation. ,
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 ,
}
object ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the prediction. ,
Required: False ,
}
{
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
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 ,
}
{
solution:
{
Description: The remediation action suggested by 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 ,
}
,
}
Operations_List (removed)
Description :  Lists all the available Advisor REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: 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 ,
}
,
}
Predict (removed)
Description :  Predicts a recommendation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/predict
{
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
predictionRequest:
{
Description: Parameters for predict recommendation. ,
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 ,
}
object ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the prediction. ,
Required: False ,
}
{
extendedProperties:
{
Description: Extended properties ,
Required: False ,
}
object ,
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 ,
}
{
solution:
{
Description: The remediation action suggested by 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 ,
}
,
}