Recommendations - Get

Referência

Serviço:: Advisor

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

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
recommendationId	path	True	string	A ID da recomendação.
resourceUri	path	True	string	O identificador de Resource Manager do Azure totalmente qualificado do recurso ao qual a recomendação se aplica.
api-version	query	True	string	A versão da API a ser usada com a solicitação do cliente.

Respostas

Nome	Tipo	Description
200 OK	ResourceRecommendationBase	OK. Obteve detalhes da recomendação com êxito.
Other Status Codes	ArmErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GetRecommendationDetail

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
ArmErrorResponse
ARMErrorResponseBody	Corpo da resposta de erro do ARM.
category	A categoria da recomendação.
createdByType	O tipo de identidade que criou o recurso.
impact	O impacto nos negócios da recomendação.
ResourceMetadata	Metadados de recurso 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

Nome	Tipo	Description
error	ARMErrorResponseBody	Corpo da resposta de erro do ARM.

ARMErrorResponseBody

Corpo da resposta de erro do ARM.

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

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

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

impact

O impacto nos negócios da recomendação.

Nome	Tipo	Description
High	string
Low	string
Medium	string

ResourceMetadata

Metadados de recurso de recomendação

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

ResourceRecommendationBase

Recomendação do Assistente.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada 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 estendidas
properties.impact	impact	O impacto nos negócios da recomendação.
properties.impactedField	string	O tipo de recurso identificado pelo Assistente.
properties.impactedValue	string	O recurso identificado pelo Assistente.
properties.label	string	O rótulo de recomendação.
properties.lastUpdated	string	A hora mais recente em que o Assistente verificou a validade da recomendação.
properties.learnMoreLink	string	O link 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 benefício potencial da implementação da recomendação.
properties.recommendationTypeId	string	O GUID do tipo recomendação.
properties.remediation	object	A maneira automatizada de aplicar a recomendação.
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 cochiladas e ignoradas para a recomendação.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

risk

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

Nome	Tipo	Description
Error	string
None	string
Warning	string

ShortDescription

Um resumo da recomendação.

Nome	Tipo	Description
problem	string	O problema ou a oportunidade identificados pela recomendação e pela solução proposta.
solution	string	O problema ou a oportunidade identificados pela recomendação e pela solução proposta.

systemData

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

Nome	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.

Compartilhar via