Condividi tramite


Recommendations - Get

Ottiene i dettagli di una raccomandazione memorizzata nella cache.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
recommendationId
path True

string

ID raccomandazione.

resourceUri
path True

string

Identificatore completo di Azure Resource Manager della risorsa a cui si applica la raccomandazione.

api-version
query True

string

Versione dell'API da usare con la richiesta client.

Risposte

Nome Tipo Descrizione
200 OK

ResourceRecommendationBase

OK. È stato ottenuto un dettaglio di raccomandazione.

Other Status Codes

ArmErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

GetRecommendationDetail

Esempio di richiesta

GET https://management.azure.com/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId?api-version=2023-01-01

Risposta di esempio

{
  "id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId",
  "name": "recommendationId",
  "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"
    },
    "remediation": {
      "additionalProperties": {
        "httpMethod": "POST",
        "uri": "uri",
        "details": "link to document"
      }
    },
    "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/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachines/xyz"
        }
      },
      "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": "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"
}

Definizioni

Nome Descrizione
ArmErrorResponse
ARMErrorResponseBody

Corpo della risposta all'errore arm.

category

Categoria della raccomandazione.

createdByType

Tipo di identità che ha creato la risorsa.

impact

Impatto aziendale della raccomandazione.

ResourceMetadata

Metadati delle risorse consigliate

ResourceRecommendationBase

Raccomandazione di Advisor.

risk

Rischio potenziale di non implementare la raccomandazione.

ShortDescription

Riepilogo della raccomandazione.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

ArmErrorResponse

Nome Tipo Descrizione
error

ARMErrorResponseBody

Corpo della risposta all'errore arm.

ARMErrorResponseBody

Corpo della risposta all'errore arm.

Nome Tipo Descrizione
code

string

Ottiene o imposta la stringa che può essere usata per identificare a livello di codice l'errore.

message

string

Ottiene o imposta la stringa che descrive l'errore in dettaglio e fornisce informazioni di debug.

category

Categoria della raccomandazione.

Nome Tipo Descrizione
Cost

string

HighAvailability

string

OperationalExcellence

string

Performance

string

Security

string

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

impact

Impatto aziendale della raccomandazione.

Nome Tipo Descrizione
High

string

Low

string

Medium

string

ResourceMetadata

Metadati delle risorse consigliate

Nome Tipo Descrizione
action

object

Azione da visualizzare.

plural

string

Nome descrittivo plurale del tipo di risorsa. ad esempio: macchine virtuali

resourceId

string

ID risorsa di Azure della risorsa valutata

singular

string

Nome descrittivo singolare del tipo di risorsa. ad esempio: macchina virtuale

source

string

Origine da cui viene generata la raccomandazione

ResourceRecommendationBase

Raccomandazione di Advisor.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

nome della risorsa.

properties.actions

object[]

Elenco delle azioni consigliate per implementare le raccomandazioni.

properties.category

category

Categoria della raccomandazione.

properties.description

string

Descrizione dettagliata della raccomandazione.

properties.exposedMetadataProperties

object

Le proprietà dei metadati dei consigli esposte al cliente per fornire informazioni aggiuntive.

properties.extendedProperties

object

Proprietà estese

properties.impact

impact

Impatto aziendale della raccomandazione.

properties.impactedField

string

Tipo di risorsa identificato da Advisor.

properties.impactedValue

string

Risorsa identificata da Advisor.

properties.label

string

Etichetta della raccomandazione.

properties.lastUpdated

string

L'ora più recente in cui Advisor ha controllato la validità della raccomandazione.

properties.learnMoreLink

string

Collegamento per altre informazioni sulla logica di raccomandazione e generazione.

properties.metadata

object

Metadati della raccomandazione.

properties.potentialBenefits

string

Potenziale vantaggio dell'implementazione della raccomandazione.

properties.recommendationTypeId

string

GUID di tipo raccomandazione.

properties.remediation

object

Modo automatizzato per applicare le raccomandazioni.

properties.resourceMetadata

ResourceMetadata

Metadati della risorsa valutata

properties.risk

risk

Rischio potenziale di non implementare la raccomandazione.

properties.shortDescription

ShortDescription

Riepilogo della raccomandazione.

properties.suppressionIds

string[]

Elenco di regole snoozed e ignorate per la raccomandazione.

systemData

systemData

Metadati di Azure Resource Manager contenenti le informazioni createBy e modificateBy.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

risk

Rischio potenziale di non implementare la raccomandazione.

Nome Tipo Descrizione
Error

string

None

string

Warning

string

ShortDescription

Riepilogo della raccomandazione.

Nome Tipo Descrizione
problem

string

Il problema o l'opportunità identificata dalla raccomandazione e dalla soluzione proposta.

solution

string

Il problema o l'opportunità identificata dalla raccomandazione e dalla soluzione proposta.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima risorsa.