Compartilhar via


Recommendation Metadata - List

Obtém a lista de entidades de metadados.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
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

MetadataEntityListResult

OK. Entidades de metadados recuperadas 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

GetMetadata

Sample Request

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

Sample Response

{
  "nextLink": "string",
  "value": [
    {
      "id": "providers/Microsoft.Advisor/metadata/recommendationType",
      "name": "recommendationType",
      "type": "Microsoft.Advisor/metadata",
      "properties": {
        "displayName": "Recommendation Type",
        "dependsOn": [
          "category",
          "impact"
        ],
        "applicableScenarios": [
          "Alerts"
        ],
        "supportedValues": [
          {
            "id": "6a2b1e70-bd4c-4163-86de-5243d7ac05ee",
            "displayName": "Upgrade your SKU or add more instances to ensure fault tolerance"
          },
          {
            "id": "da6630fb-4286-4996-92a3-a43f5f26dd34",
            "displayName": "Delete ExpressRoute circuits in the provider status of Not Provisioned"
          }
        ]
      }
    },
    {
      "id": "providers/Microsoft.Advisor/metadata/recommendationCategory",
      "name": "recommendationCategory",
      "type": "Microsoft.Advisor/metadata",
      "properties": {
        "displayName": "Category",
        "dependsOn": null,
        "applicableScenarios": [
          "Alerts"
        ],
        "supportedValues": [
          {
            "id": "Cost",
            "displayName": "Cost"
          },
          {
            "id": "Performance",
            "displayName": "Performance"
          }
        ]
      }
    },
    {
      "id": "providers/Microsoft.Advisor/metadata/recommendationImpact",
      "name": "recommendationImpact",
      "type": "Microsoft.Advisor/metadata",
      "properties": {
        "displayName": "Impact",
        "dependsOn": null,
        "applicableScenarios": null,
        "supportedValues": [
          {
            "id": "High",
            "displayName": "High"
          },
          {
            "id": "Medium",
            "displayName": "Medium"
          },
          {
            "id": "Low",
            "displayName": "Low"
          }
        ]
      }
    }
  ]
}

Definições

Nome Description
ArmErrorResponse
ARMErrorResponseBody

Corpo da resposta de erro do ARM.

MetadataEntity

O contrato de entidade de metadados.

MetadataEntityListResult

A lista de entidades de metadados

MetadataSupportedValueDetail

Os detalhes do valor com suporte para metadados.

Scenario

A lista de cenários aplicáveis a essa entidade de metadados.

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.

MetadataEntity

O contrato de entidade de metadados.

Nome Tipo Description
id

string

A ID do recurso da entidade de metadados.

name

string

O nome da entidade de metadados.

properties.applicableScenarios

Scenario[]

A lista de cenários aplicáveis a essa entidade de metadados.

properties.dependsOn

string[]

A lista de chaves da qual essa entidade depende.

properties.displayName

string

O nome para exibição.

properties.supportedValues

MetadataSupportedValueDetail[]

A lista de valores com suporte.

type

string

O tipo da entidade de metadados.

MetadataEntityListResult

A lista de entidades de metadados

Nome Tipo Description
nextLink

string

O link usado para obter a próxima página de metadados.

value

MetadataEntity[]

A lista de entidades de metadados.

MetadataSupportedValueDetail

Os detalhes do valor com suporte para metadados.

Nome Tipo Description
displayName

string

O nome para exibição.

id

string

A ID.

Scenario

A lista de cenários aplicáveis a essa entidade de metadados.

Nome Tipo Description
Alerts

string