Compartir a través de

Recommendations - Get

  • Referencia
Servicio:
Advisor
Versión de la API:
2023-01-01

Obtiene los detalles de una recomendación almacenada en caché.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
recommendationId
 path True

string

Identificador de recomendación.
resourceUri
 path True

string

El identificador completo de Azure Resource Manager del recurso al que se aplica la recomendación.
api-version
 query True

string

Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre Tipo Description
200 OK

ResourceRecommendationBase

Aceptar. Se ha obtenido correctamente el detalle de la recomendación.
Other Status Codes

ArmErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

GetRecommendationDetail

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
}

Definiciones

Nombre Description
ArmErrorResponse
ARMErrorResponseBody

Cuerpo de respuesta de error de ARM.
category

Categoría de la recomendación.
createdByType

Tipo de identidad que creó el recurso.
impact

Impacto empresarial de la recomendación.
ResourceMetadata

Metadatos de recursos de recomendación
ResourceRecommendationBase

Recomendación de Advisor.
risk

Riesgo potencial de no implementar la recomendación.
ShortDescription

Resumen de la recomendación.
systemData

Metadatos relacionados con la creación y la última modificación del recurso.

ArmErrorResponse

Nombre Tipo Description
error

ARMErrorResponseBody

Cuerpo de respuesta de error de ARM.

ARMErrorResponseBody

Cuerpo de respuesta de error de ARM.

Nombre Tipo Description
code

string

Obtiene o establece la cadena que se puede usar para identificar mediante programación el error.
message

string

Obtiene o establece la cadena que describe el error en detalle y proporciona información de depuración.

category

Categoría de la recomendación.

Nombre Tipo Description
Cost

string

HighAvailability

string

OperationalExcellence

string

Performance

string

Security

string

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

impact

Impacto empresarial de la recomendación.

Nombre Tipo Description
High

string

Low

string

Medium

string

ResourceMetadata

Metadatos de recursos de recomendación

Nombre Tipo Description
action

object

Acción para ver el recurso.
plural

string

Nombre descriptivo plural del tipo de recurso. Por ejemplo: máquinas virtuales
resourceId

string

Identificador de recurso de Azure del recurso evaluado
singular

string

Nombre descriptivo singular del tipo de recurso. por ejemplo: máquina virtual
source

string

Origen desde el que se genera la recomendación

ResourceRecommendationBase

Recomendación de Advisor.

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Nombre del recurso.
properties.actions

object[]

Lista de acciones recomendadas para implementar la recomendación.
properties.category

category

Categoría de la recomendación.
properties.description

string

Descripción detallada de la recomendación.
properties.exposedMetadataProperties

object

Las propiedades de metadatos de recomendación expuestas al cliente para proporcionar información adicional.
properties.extendedProperties

object

Propiedades extendidas
properties.impact

impact

Impacto empresarial de la recomendación.
properties.impactedField

string

Tipo de recurso identificado por Advisor.
properties.impactedValue

string

Recurso identificado por Advisor.
properties.label

string

Etiqueta de recomendación.
properties.lastUpdated

string

La hora más reciente en la que Advisor comprobó la validez de la recomendación.
properties.learnMoreLink

string

Vínculo para obtener más información sobre la lógica de generación y recomendación.
properties.metadata

object

Metadatos de recomendación.
properties.potentialBenefits

string

Ventaja potencial de la implementación de la recomendación.
properties.recommendationTypeId

string

GUID de tipo de recomendación.
properties.remediation

object

La manera automatizada de aplicar la recomendación.
properties.resourceMetadata

ResourceMetadata

Metadatos del recurso que se evaluó
properties.risk

risk

Riesgo potencial de no implementar la recomendación.
properties.shortDescription

ShortDescription

Resumen de la recomendación.
properties.suppressionIds

string[]

Lista de reglas posadas y descartadas para la recomendación.
systemData

systemData

Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

risk

Riesgo potencial de no implementar la recomendación.

Nombre Tipo Description
Error

string

None

string

Warning

string

ShortDescription

Resumen de la recomendación.

Nombre Tipo Description
problem

string

El problema o la oportunidad identificados por la recomendación y la solución propuesta.
solution

string

El problema o la oportunidad identificados por la recomendación y la solución propuesta.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.