Recommendations - Get

Reference

Služba:: Advisor

Verze rozhraní API:: 2023-01-01

Získá podrobnosti o doporučení uloženém v mezipaměti.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
recommendationId	path	True	string	ID doporučení.
resourceUri	path	True	string	Plně kvalifikovaný identifikátor Azure Resource Manager prostředku, na který se doporučení vztahuje.
api-version	query	True	string	Verze rozhraní API, která se má použít s žádostí klienta.

Odpovědi

Name	Typ	Description
200 OK	ResourceRecommendationBase	OK. Podrobnosti o doporučení se úspěšně získaly.
Other Status Codes	ArmErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetRecommendationDetail

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
ArmErrorResponse
ARMErrorResponseBody	Text odpovědi na chybu ARM.
category	Kategorie doporučení.
createdByType	Typ identity, která vytvořila prostředek.
impact	Obchodní dopad doporučení
ResourceMetadata	Metadata prostředků doporučení
ResourceRecommendationBase	Doporučení poradce.
risk	Potenciální riziko, že doporučení nebudete implementovat.
ShortDescription	Souhrn doporučení.
systemData	Metadata týkající se vytvoření a poslední změny prostředku

ArmErrorResponse

Name	Typ	Description
error	ARMErrorResponseBody	Text odpovědi na chybu ARM.

ARMErrorResponseBody

Text odpovědi na chybu ARM.

Name	Typ	Description
code	string	Získá nebo nastaví řetězec, který lze použít k programové identifikaci chyby.
message	string	Získá nebo nastaví řetězec, který podrobně popisuje chybu a poskytuje informace o ladění.

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

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

impact

Obchodní dopad doporučení

Name	Typ	Description
High	string
Low	string
Medium	string

ResourceMetadata

Metadata prostředků doporučení

Name	Typ	Description
action	object	Akce pro zobrazení prostředku
plural	string	Množné číslo popisného názvu typu prostředku. např.: virtuální počítače
resourceId	string	ID prostředku Azure pro hodnocený prostředek
singular	string	Jedinečný popisný název typu prostředku. např.: virtuální počítač
source	string	Zdroj, ze kterého se vygeneruje doporučení

ResourceRecommendationBase

Doporučení poradce.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.actions	object[]	Seznam doporučených akcí k implementaci doporučení
properties.category	category	Kategorie doporučení.
properties.description	string	Podrobný popis doporučení.
properties.exposedMetadataProperties	object	Vlastnosti metadat doporučení zpřístupněné zákazníkovi za účelem poskytnutí dalších informací
properties.extendedProperties	object	Rozšířené vlastnosti
properties.impact	impact	Obchodní dopad doporučení
properties.impactedField	string	Typ prostředku identifikovaný advisorem.
properties.impactedValue	string	Prostředek identifikovaný advisorem.
properties.label	string	Popisek doporučení.
properties.lastUpdated	string	Poslední čas, kdy Advisor zkontroloval platnost doporučení.
properties.learnMoreLink	string	Odkaz na další informace o doporučení a logice generování
properties.metadata	object	Metadata doporučení.
properties.potentialBenefits	string	Potenciální přínos implementace doporučení.
properties.recommendationTypeId	string	Identifikátor GUID typu doporučení.
properties.remediation	object	Automatizovaný způsob uplatňování doporučení
properties.resourceMetadata	ResourceMetadata	Metadata hodnoceného prostředku
properties.risk	risk	Potenciální riziko, že doporučení nebudete implementovat.
properties.shortDescription	ShortDescription	Souhrn doporučení.
properties.suppressionIds	string[]	Seznam odložených a zamítnutých pravidel pro doporučení.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

risk

Potenciální riziko, že doporučení nebudete implementovat.

Name	Typ	Description
Error	string
None	string
Warning	string

ShortDescription

Souhrn doporučení.

Name	Typ	Description
problem	string	Problém nebo příležitost určená doporučením a navrhovaným řešením.
solution	string	Problém nebo příležitost určená doporučením a navrhovaným řešením.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím