Recommendations - Get

Referência

Serviço:: Advisor

Versão da API:: 2023-01-01

Obtém detalhes de uma recomendação em cache.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
recommendationId	path	True	string	O ID da recomendação.
resourceUri	path	True	string	O identificador de Resource Manager completamente qualificado do Azure do recurso ao qual a recomendação se aplica.
api-version	query	True	string	A versão da API a utilizar com o pedido de cliente.

Respostas

Name	Tipo	Description
200 OK	ResourceRecommendationBase	OK. Os detalhes da recomendação foram obtidos com êxito.
Other Status Codes	ArmErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

GetRecommendationDetail

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
}

Definições

Name	Description
ArmErrorResponse
ARMErrorResponseBody	Corpo da resposta a erros do ARM.
category	A categoria da recomendação.
createdByType	O tipo de identidade que criou o recurso.
impact	O impacto comercial da recomendação.
ResourceMetadata	Metadados de recursos de recomendação
ResourceRecommendationBase	Recomendação do Assistente.
risk	O risco potencial de não implementar a recomendação.
ShortDescription	Um resumo da recomendação.
systemData	Metadados relativos à criação e última modificação do recurso.

ArmErrorResponse

Name	Tipo	Description
error	ARMErrorResponseBody	Corpo da resposta a erros do ARM.

ARMErrorResponseBody

Corpo da resposta a erros do ARM.

Name	Tipo	Description
code	string	Obtém ou define a cadeia que pode ser utilizada para identificar programaticamente o erro.
message	string	Obtém ou define a cadeia que descreve o erro em detalhe e fornece informações de depuração.

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

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

impact

O impacto comercial da recomendação.

Name	Tipo	Description
High	string
Low	string
Medium	string

ResourceMetadata

Metadados de recursos de recomendação

Name	Tipo	Description
action	object	A ação para ver o recurso.
plural	string	O nome amigável de utilizador plural do tipo de recurso. por exemplo: máquinas virtuais
resourceId	string	ID do recurso do Azure do recurso avaliado
singular	string	O nome amigável de utilizador singular do tipo de recurso. por exemplo: máquina virtual
source	string	Origem a partir da qual a recomendação é gerada

ResourceRecommendationBase

Recomendação do Assistente.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.actions	object[]	A lista de ações recomendadas para implementar a recomendação.
properties.category	category	A categoria da recomendação.
properties.description	string	A descrição detalhada da recomendação.
properties.exposedMetadataProperties	object	As propriedades de metadados de recomendação expostas ao cliente para fornecer informações adicionais.
properties.extendedProperties	object	Propriedades expandidas
properties.impact	impact	O impacto comercial da recomendação.
properties.impactedField	string	O tipo de recurso identificado pelo Assistente.
properties.impactedValue	string	O recurso identificado pelo Assistente.
properties.label	string	A etiqueta de recomendação.
properties.lastUpdated	string	A hora mais recente em que o Assistente verificou a validade da recomendação.
properties.learnMoreLink	string	A ligação para saber mais sobre a lógica de recomendação e geração.
properties.metadata	object	Os metadados de recomendação.
properties.potentialBenefits	string	O potencial benefício da implementação da recomendação.
properties.recommendationTypeId	string	O GUID do tipo de recomendação.
properties.remediation	object	A forma automatizada de aplicar recomendações.
properties.resourceMetadata	ResourceMetadata	Metadados do recurso que foi avaliado
properties.risk	risk	O risco potencial de não implementar a recomendação.
properties.shortDescription	ShortDescription	Um resumo da recomendação.
properties.suppressionIds	string[]	A lista de regras snoozed e rejeitadas para a recomendação.
systemData	systemData	O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

risk

O risco potencial de não implementar a recomendação.

Name	Tipo	Description
Error	string
None	string
Warning	string

ShortDescription

Um resumo da recomendação.

Name	Tipo	Description
problem	string	O problema ou oportunidade identificado pela recomendação e solução proposta.
solution	string	O problema ou oportunidade identificado pela recomendação e solução proposta.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via