Recommendations - List

Service:

Advisor

API Version:

2023-01-01

Obtient des recommandations mises en cache pour un abonnement. Les recommandations sont générées ou calculées en appelant generateRecommendations.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations?api-version=2023-01-01&$filter={$filter}&$top={$top}&$skipToken={$skipToken}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	L’ID d’abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.
$filter	query		string	Filtre à appliquer aux recommandations. Le filtre peut être appliqué aux propriétés ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', 'Category'] avec les opérateurs ['eq', 'and', 'or']. Exemple : - $filter=Category eq 'Cost' et ResourceGroup eq 'MyResourceGroup'
$skipToken	query		string	Jeton de continuation de page à utiliser avec une version paginée de cette API.
$top	query		integer int32	Nombre de recommandations par page si une version paginée de cette API est utilisée.

Réponses

Nom	Type	Description
200 OK	ResourceRecommendationBaseListResult	OK. Recommandations mises en cache obtenues avec succès.
Other Status Codes	ArmErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ListRecommendations

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/recommendations?api-version=2023-01-01&$top=10

Sample Response

Status code:

200

{
  "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/recommendations?api-version=2023-01-01&$top=10&$skiptoken=skiptoken",
  "value": [
    {
      "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recGUID1",
      "name": "recGUID1",
      "properties": {
        "category": "HighAvailability",
        "impact": "Medium",
        "impactedField": "Microsoft.Compute/availabilitySets",
        "impactedValue": "armavset",
        "lastUpdated": "2017-02-24T22:24:43.3216408Z",
        "risk": "Warning",
        "remediation": {
          "additionalProperties": {
            "httpMethod": "POST",
            "uri": "uri",
            "details": "link to document"
          }
        },
        "shortDescription": {
          "problem": "To ensure high availability add one or more virtual machines to this availability set",
          "solution": "To ensure high availability add one or more virtual machines to this availability set"
        },
        "resourceMetadata": {
          "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/availabilitysets/abc",
          "action": {
            "additionalProperties": {
              "actionType": "Document",
              "link": "https://link3",
              "caption": "Enable Soft Delete to protect blob data",
              "description": "Enable Soft Delete to protect blob data"
            },
            "metadata": {
              "id": "/subscriptions/subscriptionId"
            }
          },
          "singular": "Availability set",
          "plural": "Availability sets"
        },
        "actions": [
          {
            "additionalProperties": {
              "actionType": "Document",
              "link": "https://link1",
              "caption": "Enable Soft Delete to protect blob data",
              "description": "Enable Soft Delete to protect blob data"
            },
            "metadata": {
              "id": "/subscriptions/subscriptionId"
            }
          }
        ],
        "description": "After enabling Soft Delete, deleted data transitions to a soft deleted state instead of being permanently deleted. When data is overwritten, a soft deleted snapshot is generated to save the state of the overwritten data. You can configure the amount of time soft deleted data is recoverable before it permanently expires.",
        "label": "Enable Soft Delete",
        "learnMoreLink": "https://link2",
        "potentialBenefits": "Save and recover your data when blobs or blob snapshots are accidentally overwritten or deleted"
      },
      "type": "Microsoft.Advisor/recommendations"
    },
    {
      "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recGUID2",
      "name": "recGUID2",
      "properties": {
        "category": "Security",
        "impact": "Medium",
        "impactedField": "Microsoft.Compute/virtualMachines",
        "impactedValue": "armavset",
        "lastUpdated": "2017-02-24T22:24:43.3216408Z",
        "risk": "Warning",
        "shortDescription": {
          "problem": "Monitoring agent should be installed on your machines",
          "solution": "Monitoring agent should be installed on your machines"
        },
        "resourceMetadata": {
          "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz",
          "source": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz/providers/Microsoft.Security/assessments/assessmentGuid",
          "action": {
            "additionalProperties": {
              "actionType": "Document",
              "link": "https://link3",
              "caption": "Enable Soft Delete to protect blob data",
              "description": "Enable Soft Delete to protect blob data"
            },
            "metadata": {
              "id": "/subscriptions/subscriptionId"
            }
          },
          "singular": "Virtual machine",
          "plural": "Virtual machines"
        },
        "actions": [
          {
            "additionalProperties": {
              "actionType": "Document",
              "link": "https://link1",
              "caption": "Enable Soft Delete to protect blob data",
              "description": "Enable Soft Delete to protect blob data"
            },
            "metadata": {
              "id": "/subscriptions/subscriptionId"
            }
          }
        ],
        "description": "Monitoring agent should be installed on your machines.",
        "label": "Enable monitoring agent",
        "learnMoreLink": "https://link2",
        "potentialBenefits": "Protect and monitor machine"
      },
      "type": "Microsoft.Advisor/recommendations"
    }
  ]
}

Définitions

Nom	Description
ArmErrorResponse
ARMErrorResponseBody	Corps de réponse d’erreur ARM.
category	Catégorie de la recommandation.
createdByType	Type d’identité qui a créé la ressource.
impact	Impact de la recommandation sur l’entreprise.
ResourceMetadata	Métadonnées de ressource de recommandation
ResourceRecommendationBase	Recommandation advisor.
ResourceRecommendationBaseListResult	Liste des recommandations d’Advisor.
risk	Risque potentiel de ne pas mettre en œuvre la recommandation.
ShortDescription	Résumé de la recommandation.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

ArmErrorResponse

Nom	Type	Description
error	ARMErrorResponseBody	Corps de réponse d’erreur ARM.

ARMErrorResponseBody

Corps de réponse d’erreur ARM.

Nom	Type	Description
code	string	Obtient ou définit la chaîne qui peut être utilisée pour identifier l’erreur par programmation.
message	string	Obtient ou définit la chaîne qui décrit l’erreur en détail et fournit des informations de débogage.

category

Catégorie de la recommandation.

Nom	Type	Description
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

impact

Impact de la recommandation sur l’entreprise.

Nom	Type	Description
High	string
Low	string
Medium	string

ResourceMetadata

Métadonnées de ressource de recommandation

Nom	Type	Description
action	object	Action permettant d’afficher la ressource.
plural	string	Nom convivial pluriel du type de ressource. par exemple : machines virtuelles
resourceId	string	ID de ressource Azure de la ressource évaluée
singular	string	Nom convivial unique du type de ressource. par exemple : machine virtuelle
source	string	Source à partir de laquelle la recommandation est générée

ResourceRecommendationBase

Recommandation advisor.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	nom de la ressource.
properties.actions	object[]	Liste des actions recommandées pour implémenter la recommandation.
properties.category	category	Catégorie de la recommandation.
properties.description	string	Description détaillée de la recommandation.
properties.exposedMetadataProperties	object	Propriétés de métadonnées de recommandation exposées au client pour fournir des informations supplémentaires.
properties.extendedProperties	object	Propriétés étendues
properties.impact	impact	Impact de la recommandation sur l’entreprise.
properties.impactedField	string	Type de ressource identifié par Advisor.
properties.impactedValue	string	Ressource identifiée par Advisor.
properties.label	string	Étiquette de recommandation.
properties.lastUpdated	string	L’heure la plus récente où Advisor a vérifié la validité de la recommandation.
properties.learnMoreLink	string	Lien pour en savoir plus sur la logique de recommandation et de génération.
properties.metadata	object	Métadonnées de recommandation.
properties.potentialBenefits	string	L’avantage potentiel de la mise en œuvre de la recommandation.
properties.recommendationTypeId	string	GUID de type recommandation.
properties.remediation	object	Méthode automatisée pour appliquer la recommandation.
properties.resourceMetadata	ResourceMetadata	Métadonnées de ressource évaluées
properties.risk	risk	Risque potentiel de ne pas mettre en œuvre la recommandation.
properties.shortDescription	ShortDescription	Résumé de la recommandation.
properties.suppressionIds	string[]	Liste des règles ignorées et ignorées pour la recommandation.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ResourceRecommendationBaseListResult

Liste des recommandations d’Advisor.

Nom	Type	Description
nextLink	string	Lien utilisé pour obtenir la page suivante de recommandations.
value	ResourceRecommendationBase[]	Liste des recommandations.

risk

Risque potentiel de ne pas mettre en œuvre la recommandation.

Nom	Type	Description
Error	string
None	string
Warning	string

ShortDescription

Résumé de la recommandation.

Nom	Type	Description
problem	string	Problème ou opportunité identifié par la recommandation et la solution proposée.
solution	string	Problème ou opportunité identifié par la recommandation et la solution proposée.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.