Partilhar via

Domains - Update Domain

Serviço:
Admin
Versão da API:
v1

Atualiza as informações de domínio especificadas.

Note

Esta API é uma versão de lançamento de uma versão de pré-visualização que deverá ser preterida em 31 de março de 2026. Ao chamar essa API - os chamadores devem definir o parâmetro preview de consulta como o valor false

Permissions

O chamador deve ser um administrador de malha.

Escopos delegados necessários

Tenant.ReadWrite.All.

Limitations

Máximo de 25 pedidos por minuto e por entidade principal.

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identity Support
User Yes
Entidade de serviço e identidades geridas Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}?preview={preview}

Parâmetros do URI

Name Em Necessário Tipo Description
domainId
 path True

string (uuid)

O ID do domínio.
preview
 query True

boolean

Este parâmetro especifica qual versão da API deve ser usada. Defina para false usar a versão de lançamento.

Corpo do Pedido

Name Tipo Description
defaultLabelId

string (uuid)

O rótulo de sensibilidade padrão do domínio.

Para remover o defaultLabelId de um domínio, defina seu valor como um UUID vazio em sua solicitação: "00000000-0000-0000-0000-00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
description

string

A descrição do domínio. A descrição não pode conter mais de 256 caracteres.
displayName

string

O nome de exibição do domínio. O nome para exibição não pode conter mais de 40 caracteres.

Respostas

Name Tipo Description
200 OK

Domain

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • DomainNotFound - O domínio fornecido não foi encontrado

  • EntityConflict - Falha na atualização do domínio porque o nome de exibição do domínio já existe.

  • UnknownError - Ocorreu um erro.

Exemplos

Update a domain example

Pedido de amostra

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f?preview=false

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

Resposta da amostra

Código de estado:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

Definições

Name Description
Domain
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
UpdateDomainRequest

Domain

Object
Name Tipo Description
defaultLabelId

string (uuid)

O rótulo de sensibilidade padrão do domínio.
description

string

A descrição do domínio.
displayName

string

O nome do domínio.
id

string (uuid)

O ID do objeto de domínio.
parentDomainId

string (uuid)

O ID do objeto pai do domínio.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

UpdateDomainRequest

Object
Name Tipo Description
defaultLabelId

string (uuid)

O rótulo de sensibilidade padrão do domínio.

Para remover o defaultLabelId de um domínio, defina seu valor como um UUID vazio em sua solicitação: "00000000-0000-0000-0000-00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
description

string

A descrição do domínio. A descrição não pode conter mais de 256 caracteres.
displayName

string

O nome de exibição do domínio. O nome para exibição não pode conter mais de 40 caracteres.