Entities - Add Data Annotation

Serviço:: Monitor

Versão da API:: 2026-05-01-preview

Adicionar uma anotação de dados a uma entidade

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CloudHealth/healthmodels/{healthModelName}/entities/{entityName}/addDataAnnotation?api-version=2026-05-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
entityName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$	Nome da entidade. Deve ser exclusivo em um modelo de integridade.
healthModelName	path	True	string pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,42}[a-zA-Z0-9]$	Nome do recurso do modelo de saúde
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
annotationDetails	True	object	Detalhes de anotação como um recipiente de pares chave-valor dinâmico. Limites imposto pelo serviço: um máximo de 10 entradas por anotação e um tamanho máximo de valor de 256 caracteres. As solicitações que excedem esses limites serão rejeitadas com uma resposta de 400.
description		string maxLength: 4096	Descrição opcional da anotação

Respostas

Nome	Tipo	Description
200 OK	DataAnnotation	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do 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	se passar pela sua conta de usuário

Exemplos

Entities_AddDataAnnotation

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/abcdef12-3456-7890-abcd-ef1234567890/resourceGroups/online-store-rg/providers/Microsoft.CloudHealth/healthmodels/online-store/entities/web-frontend/addDataAnnotation?api-version=2026-05-01-preview

{
  "annotationDetails": {
    "environment": "production",
    "deploymentId": "deploy-2026-05-04-001",
    "changedBy": "release-pipeline"
  },
  "description": "Deployed release 2.4.1 to the web frontend."
}

Resposta de exemplo

Código de status:: 200

{
  "annotationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "annotationDetails": {
    "environment": "production",
    "deploymentId": "deploy-2026-05-04-001",
    "changedBy": "release-pipeline"
  },
  "description": "Deployed release 2.4.1 to the web frontend.",
  "createdAt": "2026-05-04T14:30:00Z"
}

Definições

Nome	Description
AddDataAnnotationRequest	Solicite ao corpo da aplicação de uma anotação de dados.
DataAnnotation	Uma única anotação de dados em uma entidade
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

AddDataAnnotationRequest

Objeto

Solicite ao corpo da aplicação de uma anotação de dados.

Nome	Tipo	Description
annotationDetails	object	Detalhes de anotação como um recipiente de pares chave-valor dinâmico. Limites imposto pelo serviço: um máximo de 10 entradas por anotação e um tamanho máximo de valor de 256 caracteres. As solicitações que excedem esses limites serão rejeitadas com uma resposta de 400.
description	string maxLength: 4096	Descrição opcional da anotação

DataAnnotation

Objeto

Uma única anotação de dados em uma entidade

Nome	Tipo	Description
annotationDetails	object	Detalhes de anotação como um recipiente de pares chave-valor dinâmico. Limites imposto pelo serviço: um máximo de 10 entradas por anotação e um tamanho máximo de valor de 256 caracteres. As solicitações que excedem esses limites serão rejeitadas com uma resposta de 400.
annotationId	string maxLength: 256	Identificador automaticamente atribuído para a anotação
createdAt	string (date-time)	Carimbo de data e hora da criação da anotação
description	string maxLength: 4096	Descrição opcional da anotação

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.