Partilhar via

Domains - Update Domain (preview)

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

Atualiza as informações de domínio especificadas (visualização).

Observação

Esta API de pré-visualização será preterida em 31 de março de 2026 e substituída por uma versão estável, disponível aqui. A nova versão introduz alterações significativas e não é compatível com versões anteriores. Ao chamar essa API, os chamadores devem especificar true como o valor para o parâmetro previewde consulta .

Aviso de descontinuação

Um novo parâmetro preview de consulta foi introduzido para facilitar essa transição:

  • Atualmente, o previewtrueparâmetro de consulta assume como padrão .
  • Defina o preview valor do parâmetro query para false usar a versão Release desta API.
  • A partir de 31 de março de 2026, o valor padrão para preview será alterado para false.

É recomendável migrar sua integração para usar a versão Release o mais rápido possível, especificando false para o preview parâmetro query (o valor padrão para o preview parâmetro query será definido como false na data de descontinuação da API).

As seguintes alterações incompatíveis foram introduzidas na versão de lançamento:

  • A propriedade contributorsScope Request foi removida.
  • A propriedade contributorsScope Response foi removida.

Permissions

O chamador deve ser um administrador de malha.

Escopos delegados necessários

Tenant.ReadWrite.All.

Limitações

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

Identidades suportadas pelo Entra da Microsoft

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

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

Interfaz

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 true usar a versão de visualização descrita nesta página ou para false usar a versão de lançamento detalhada aqui. A partir de 31 de março de 2026, o valor padrão para preview será alterado para false.

Corpo do Pedido

Name Tipo Description
contributorsScope

ContributorsScopeType

O escopo dos colaboradores do domínio.
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

DomainPreview

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

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

  • UnknownError - Ocorreu um erro.

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

Exemplos

Update a domain example

Pedido de amostra

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

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

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,
  "contributorsScope": "SpecificUsersAndGroups"
}

Definições

Name Description
ContributorsScopeType

O escopo do contribuidor. Escopos de contribuidor adicionais podem ser adicionados ao longo do tempo.
DomainPreview
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
UpdateDomainRequestPreview

ContributorsScopeType

Enumeração

O escopo do contribuidor. Escopos de contribuidor adicionais podem ser adicionados ao longo do tempo.

Valor Description
AllTenant

Todos os utilizadores do inquilino.
SpecificUsersAndGroups

Usuários e grupos específicos.
AdminsOnly

Somente administradores de locatário e domínio.

DomainPreview

Object
Name Tipo Description
contributorsScope

ContributorsScopeType

O escopo dos colaboradores 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.

UpdateDomainRequestPreview

Object
Name Tipo Description
contributorsScope

ContributorsScopeType

O escopo dos colaboradores do domínio.
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.