Recommendations - Get

Referenz

Dienst:: Advisor

API-Version:: 2023-01-01

Ruft Details zu einer zwischengespeicherten Empfehlung ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
recommendationId	path	True	string	Die Empfehlungs-ID.
resourceUri	path	True	string	Der vollqualifizierte Azure Resource Manager Bezeichner der Ressource, für die die Empfehlung gilt.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ResourceRecommendationBase	OK. Empfehlungsdetails wurden erfolgreich erhalten.
Other Status Codes	ArmErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

GetRecommendationDetail

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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"
}

Definitionen

Name	Beschreibung
ArmErrorResponse
ARMErrorResponseBody	ARM-Fehlerantworttext.
category	Die Kategorie der Empfehlung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
impact	Die geschäftlichen Auswirkungen der Empfehlung.
ResourceMetadata	Empfehlungsressourcenmetadaten
ResourceRecommendationBase	Empfehlung des Beraters.
risk	Das potenzielle Risiko, die Empfehlung nicht umzusetzen.
ShortDescription	Eine Zusammenfassung der Empfehlung.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

ArmErrorResponse

Name	Typ	Beschreibung
error	ARMErrorResponseBody	ARM-Fehlerantworttext.

ARMErrorResponseBody

ARM-Fehlerantworttext.

Name	Typ	Beschreibung
code	string	Ruft die Zeichenfolge ab, die zum programmgesteuerten Identifizieren des Fehlers verwendet werden kann, oder legt diese fest.
message	string	Ruft die Zeichenfolge ab, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt, oder legt diese fest.

Name	Typ	Beschreibung
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

impact

Die geschäftlichen Auswirkungen der Empfehlung.

Name	Typ	Beschreibung
High	string
Low	string
Medium	string

ResourceMetadata

Empfehlungsressourcenmetadaten

Name	Typ	Beschreibung
action	object	Die Aktion zum Anzeigen der Ressource.
plural	string	Der benutzerfreundliche Pluralname des Ressourcentyps. z. B. virtuelle Computer
resourceId	string	Azure-Ressourcen-ID der bewerteten Ressource
singular	string	Der singuläre benutzerfreundliche Name des Ressourcentyps. z. B. virtueller Computer
source	string	Quelle, aus der die Empfehlung generiert wird

ResourceRecommendationBase

Empfehlung des Beraters.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.actions	object[]	Die Liste der empfohlenen Maßnahmen zum Implementieren der Empfehlung.
properties.category	category	Die Kategorie der Empfehlung.
properties.description	string	Die ausführliche Beschreibung der Empfehlung.
properties.exposedMetadataProperties	object	Die Empfehlungsmetadateneigenschaften, die dem Kunden zur Bereitstellung zusätzlicher Informationen zur Verfügung gestellt werden.
properties.extendedProperties	object	Erweiterte Eigenschaften
properties.impact	impact	Die geschäftlichen Auswirkungen der Empfehlung.
properties.impactedField	string	Der vom Advisor identifizierte Ressourcentyp.
properties.impactedValue	string	Die vom Advisor identifizierte Ressource.
properties.label	string	Die Bezeichnung der Empfehlung.
properties.lastUpdated	string	Der letzte Zeitpunkt, zu dem Advisor die Gültigkeit der Empfehlung überprüft hat.
properties.learnMoreLink	string	Der Link, um mehr über Empfehlungs- und Generierungslogik zu erfahren.
properties.metadata	object	Die Empfehlungsmetadaten.
properties.potentialBenefits	string	Der potenzielle Nutzen der Umsetzung der Empfehlung.
properties.recommendationTypeId	string	Die GUID vom Empfehlungstyp.
properties.remediation	object	Die automatisierte Methode zum Anwenden der Empfehlung.
properties.resourceMetadata	ResourceMetadata	Metadaten der Ressource, die bewertet wurden
properties.risk	risk	Das potenzielle Risiko, die Empfehlung nicht umzusetzen.
properties.shortDescription	ShortDescription	Eine Zusammenfassung der Empfehlung.
properties.suppressionIds	string[]	Die Liste der verworfenen und verworfenen Regeln für die Empfehlung.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

risk

Das potenzielle Risiko, die Empfehlung nicht umzusetzen.

Name	Typ	Beschreibung
Error	string
None	string
Warning	string

ShortDescription

Eine Zusammenfassung der Empfehlung.

Name	Typ	Beschreibung
problem	string	Das Problem oder die Gelegenheit, die durch die Empfehlung und die vorgeschlagene Lösung identifiziert werden.
solution	string	Das Problem oder die Gelegenheit, die durch die Empfehlung und die vorgeschlagene Lösung identifiziert werden.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über