Advisor Scores - Get

Reference

Service:: Advisor

API Version:: 2023-01-01

Gets the advisor score.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	The scope of Advisor score entity.
subscriptionId	path	True	string	The Azure subscription ID.
api-version	query	True	string	The version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	advisorScoreEntity	OK.
Other Status Codes	ArmErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GetAdvisorScoreDetail

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/advisorScore/Cost?api-version=2023-01-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subId/Microsoft.Advisor/AdvisorScore/Cost",
  "name": "Cost",
  "type": "Microsoft.Advisor/advisorScore",
  "properties": {
    "lastRefreshedScore": {
      "date": "2020-06-25T00:00:00Z",
      "score": 1,
      "consumptionUnits": 12,
      "impactedResourceCount": 1,
      "potentialScoreIncrease": 0,
      "categoryCount": 1
    },
    "timeSeries": [
      {
        "aggregationLevel": "day",
        "scoreHistory": [
          {
            "date": "2020-06-25T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-24T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-23T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-22T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-21T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-20T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-19T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          }
        ]
      },
      {
        "aggregationLevel": "month",
        "scoreHistory": [
          {
            "date": "2020-06-25T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-05-30T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-04-30T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          }
        ]
      },
      {
        "aggregationLevel": "week",
        "scoreHistory": [
          {
            "date": "2020-06-25T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-21T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-14T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-06-07T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-05-31T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          },
          {
            "date": "2020-05-24T00:00:00Z",
            "score": 1,
            "consumptionUnits": 12,
            "impactedResourceCount": 1,
            "potentialScoreIncrease": 0
          }
        ]
      }
    ]
  }
}

Definitions

Name	Description
advisorScoreEntity	The details of Advisor score for a single category.
aggregated	The aggregation level of the score.
ArmErrorResponse
ARMErrorResponseBody	ARM error response body.
createdByType	The type of identity that created the resource.
Properties	The Advisor score data.
scoreEntity	The details of Advisor Score
systemData	Metadata pertaining to creation and last modification of the resource.
timeSeriesEntity	The historic data at different aggregation levels.

advisorScoreEntity

The details of Advisor score for a single category.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	Properties	The Advisor score data.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

aggregated

The aggregation level of the score.

Name	Type	Description
day	string
month	string
week	string

ArmErrorResponse

Name	Type	Description
error	ARMErrorResponseBody	ARM error response body.

ARMErrorResponseBody

ARM error response body.

Name	Type	Description
code	string	Gets or sets the string that can be used to programmatically identify the error.
message	string	Gets or sets the string that describes the error in detail and provides debugging information.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Properties

The Advisor score data.

Name	Type	Description
lastRefreshedScore	scoreEntity	The details of latest available score.
timeSeries	timeSeriesEntity[]	The historic Advisor score data.

scoreEntity

The details of Advisor Score

Name	Type	Description
categoryCount	number	The count of impacted categories.
consumptionUnits	number	The consumption units for the score.
date	string	The date score was calculated.
impactedResourceCount	number	The number of impacted resources.
potentialScoreIncrease	number	The potential percentage increase in overall score at subscription level once all recommendations in this scope are implemented.
score	number	The percentage score.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

timeSeriesEntity

The historic data at different aggregation levels.

Name	Type	Description
aggregationLevel	aggregated	The aggregation level of the score.
scoreHistory	scoreEntity[]	The past score data

Share via