Recommendations - Get

Odwołanie

Usługa:: Advisor

Wersja interfejsu API:: 2023-01-01

Uzyskuje szczegóły buforowanej rekomendacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
recommendationId	path	True	string	Identyfikator rekomendacji.
resourceUri	path	True	string	W pełni kwalifikowany identyfikator Resource Manager platformy Azure zasobu, do którego ma zastosowanie zalecenie.
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ResourceRecommendationBase	OK. Pomyślnie otrzymaliśmy szczegóły rekomendacji.
Other Status Codes	ArmErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

GetRecommendationDetail

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
ArmErrorResponse
ARMErrorResponseBody	Treść odpowiedzi na błędy usługi ARM.
category	Kategoria zalecenia.
createdByType	Typ tożsamości, która utworzyła zasób.
impact	Wpływ na firmę zalecenia.
ResourceMetadata	Metadane zasobów rekomendacji
ResourceRecommendationBase	Zalecenie doradcy.
risk	Potencjalne ryzyko braku implementacji zalecenia.
ShortDescription	Podsumowanie zalecenia.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ArmErrorResponse

Nazwa	Typ	Opis
error	ARMErrorResponseBody	Treść odpowiedzi na błędy usługi ARM.

ARMErrorResponseBody

Treść odpowiedzi na błędy usługi ARM.

Nazwa	Typ	Opis
code	string	Pobiera lub ustawia ciąg, który może służyć do programowego identyfikowania błędu.
message	string	Pobiera lub ustawia ciąg opisujący szczegółowo błąd i udostępnia informacje o debugowaniu.

Nazwa	Typ	Opis
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

impact

Wpływ na firmę zalecenia.

Nazwa	Typ	Opis
High	string
Low	string
Medium	string

ResourceMetadata

Metadane zasobów rekomendacji

Nazwa	Typ	Opis
action	object	Akcja wyświetlania zasobu.
plural	string	Przyjazna dla użytkownika nazwa typu zasobu w liczbie mnogiej. np. maszyny wirtualne
resourceId	string	Identyfikator zasobu platformy Azure dla ocenianego zasobu
singular	string	Pojedyncza przyjazna nazwa typu zasobu. np. maszyna wirtualna
source	string	Źródło, z którego jest generowane zalecenie

ResourceRecommendationBase

Zalecenie doradcy.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.actions	object[]	Lista zalecanych akcji do zaimplementowania rekomendacji.
properties.category	category	Kategoria zalecenia.
properties.description	string	Szczegółowy opis rekomendacji.
properties.exposedMetadataProperties	object	Właściwości metadanych rekomendacji uwidocznione klientowi w celu udostępnienia dodatkowych informacji.
properties.extendedProperties	object	Właściwości rozszerzone
properties.impact	impact	Wpływ na firmę zalecenia.
properties.impactedField	string	Typ zasobu zidentyfikowany przez usługę Advisor.
properties.impactedValue	string	Zasób zidentyfikowany przez usługę Advisor.
properties.label	string	Etykieta zalecenia.
properties.lastUpdated	string	Ostatni raz, kiedy usługa Advisor sprawdziła ważność zalecenia.
properties.learnMoreLink	string	Link, aby dowiedzieć się więcej o logice rekomendacji i generowania.
properties.metadata	object	Metadane rekomendacji.
properties.potentialBenefits	string	Potencjalna korzyść z implementacji rekomendacji.
properties.recommendationTypeId	string	Identyfikator GUID typu rekomendacji.
properties.remediation	object	Zautomatyzowany sposób stosowania rekomendacji.
properties.resourceMetadata	ResourceMetadata	Metadane zasobu, który został oceniony
properties.risk	risk	Potencjalne ryzyko braku implementacji zalecenia.
properties.shortDescription	ShortDescription	Podsumowanie zalecenia.
properties.suppressionIds	string[]	Lista odsuniętych i odrzuconych reguł dla zalecenia.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

risk

Potencjalne ryzyko braku implementacji zalecenia.

Nazwa	Typ	Opis
Error	string
None	string
Warning	string

ShortDescription

Podsumowanie zalecenia.

Nazwa	Typ	Opis
problem	string	Problem lub szansa sprzedaży zidentyfikowana przez zalecenie i proponowane rozwiązanie.
solution	string	Problem lub szansa sprzedaży zidentyfikowana przez zalecenie i proponowane rozwiązanie.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem