Domains - Update Domain
Nota
Esta API está en versión preliminar.
Actualiza la información de dominio especificada.
Permisos
El autor de la llamada debe ser administrador de Fabric.
Ámbitos delegados necesarios
Tenant.ReadWrite.All.
Limitaciones
Máximo de 25 solicitudes por minuto por entidad de seguridad.
Identidades admitidas de Microsoft Entra
Esta API admite las identidades de Microsoft enumeradas en esta sección.
Identidad | Apoyo |
---|---|
Usuario | Sí |
de entidad de servicio y identidades administradas | Sí |
Interfaz
PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
domain
|
path | True |
string uuid |
Identificador de dominio. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
contributorsScope |
Ámbito de colaboradores de dominio. |
|
description |
string |
Descripción del dominio. La descripción no puede contener más de 256 caracteres. |
displayName |
string |
Nombre para mostrar del dominio. El nombre para mostrar no puede contener más de 40 caracteres. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Solicitud completada correctamente. |
|
Other Status Codes |
Códigos de error comunes:
|
Ejemplos
Update a domain example
Solicitud de ejemplo
PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f
{
"displayName": "Domain's new name",
"description": "Domain's new description",
"contributorsScope": "SpecificUsersAndGroups"
}
Respuesta de muestra
{
"id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
"displayName": "Domain's new name",
"description": "Domain's new description",
"parentDomainId": null,
"contributorsScope": "SpecificUsersAndGroups"
}
Definiciones
Nombre | Description |
---|---|
Contributors |
Ámbito de colaborador. Se pueden agregar ámbitos de colaborador adicionales a lo largo del tiempo. |
Domain |
Representa un dominio o subdominio. |
Error |
Objeto de detalles del recurso relacionado con el error. |
Error |
Respuesta de error. |
Error |
Detalles de la respuesta de error. |
Update |
Carga de solicitud para actualizar un dominio. |
ContributorsScopeType
Ámbito de colaborador. Se pueden agregar ámbitos de colaborador adicionales a lo largo del tiempo.
Valor | Description |
---|---|
AdminsOnly |
Solo administradores de inquilinos y dominios. |
AllTenant |
Todos los usuarios del inquilino. |
SpecificUsersAndGroups |
Usuarios y grupos específicos. |
Domain
Representa un dominio o subdominio.
Nombre | Tipo | Description |
---|---|---|
contributorsScope |
Ámbito de colaboradores de dominio. |
|
description |
string |
Descripción del dominio. |
displayName |
string |
Nombre del dominio. |
id |
string uuid |
Identificador del objeto de dominio. |
parentDomainId |
string uuid |
Identificador de objeto primario del dominio. |
ErrorRelatedResource
Objeto de detalles del recurso relacionado con el error.
Nombre | Tipo | Description |
---|---|---|
resourceId |
string |
Identificador de recurso implicado en el error. |
resourceType |
string |
Tipo del recurso implicado en el error. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
errorCode |
string |
Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios. |
message |
string |
Representación legible del error. |
moreDetails |
Lista de detalles de error adicionales. |
|
relatedResource |
Detalles del recurso relacionado con el error. |
|
requestId |
string |
Identificador de la solicitud asociada al error. |
ErrorResponseDetails
Detalles de la respuesta de error.
Nombre | Tipo | Description |
---|---|---|
errorCode |
string |
Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios. |
message |
string |
Representación legible del error. |
relatedResource |
Detalles del recurso relacionado con el error. |
UpdateDomainRequest
Carga de solicitud para actualizar un dominio.
Nombre | Tipo | Description |
---|---|---|
contributorsScope |
Ámbito de colaboradores de dominio. |
|
description |
string |
Descripción del dominio. La descripción no puede contener más de 256 caracteres. |
displayName |
string |
Nombre para mostrar del dominio. El nombre para mostrar no puede contener más de 40 caracteres. |