Compartir a través de

Workspaces - Update Workspace

Servicio:
Core
Versión de la API:
v1

Actualiza las propiedades del área de trabajo especificadas.

Permisos

El autor de la llamada debe tener rol de administrador área de trabajo.

Ámbitos delegados necesarios

Workspace.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad Apoyo
Usuario Sí
Entidad de servicio e Identidades administradas Sí

Interfaz

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
 path True

string (uuid)

El identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Tipo Description
description

string

Descripción del área de trabajo.
La descripción no puede contener más de 4000 caracteres.
displayName

string

Nombre para mostrar del área de trabajo.
El nombre para mostrar no puede contener más de 256 caracteres.
Los nombres de área de trabajo deben ser únicos dentro del inquilino.
"Supervisión del administrador" es un nombre de área de trabajo reservada.

Respuestas

Nombre Tipo Description
200 OK

Workspace

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • UnknownError: se produjo un error.

Ejemplos

Update a workspace example

Solicitud de ejemplo

PATCH https://api.fabric.microsoft.com/v1/workspaces/33bae707-5fe7-4352-89bd-061a1318b60a

{
  "displayName": "Workspace New displayName",
  "description": "Workspace New description"
}

Respuesta de muestra

status code:
200 
{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace",
  "domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
}

Definiciones

Nombre Description
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
UpdateWorkspaceRequest

Actualizar la carga de la solicitud del área de trabajo.
Workspace

Un objeto de área de trabajo.
WorkspaceType

Tipo de área de trabajo. Se pueden agregar tipos de área de trabajo adicionales a lo largo del tiempo.

ErrorRelatedResource

Object

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

Object

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

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

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

ErrorRelatedResource

Detalles del recurso relacionado con el error.

UpdateWorkspaceRequest

Object

Actualizar la carga de la solicitud del área de trabajo.

Nombre Tipo Description
description

string

Descripción del área de trabajo.
La descripción no puede contener más de 4000 caracteres.
displayName

string

Nombre para mostrar del área de trabajo.
El nombre para mostrar no puede contener más de 256 caracteres.
Los nombres de área de trabajo deben ser únicos dentro del inquilino.
"Supervisión del administrador" es un nombre de área de trabajo reservada.

Workspace

Object

Un objeto de área de trabajo.

Nombre Tipo Description
apiEndpoint

string (uri)

Dirección URL HTTP que representa el punto de conexión de API específico del área de trabajo. Este valor de punto de conexión se devuelve cuando el usuario habilita preferWorkspaceSpecificEndpoints. Permite el acceso a la API a través de vínculos privados.
capacityId

string (uuid)

Identificador de la capacidad a la que se asigna el área de trabajo.
description

string

Descripción del área de trabajo.
displayName

string

Nombre para mostrar del área de trabajo.
domainId

string (uuid)

Identificador del dominio al que se asigna el área de trabajo.
id

string (uuid)

El identificador del área de trabajo.
type

WorkspaceType

Tipo de área de trabajo.

WorkspaceType

Enumeración

Tipo de área de trabajo. Se pueden agregar tipos de área de trabajo adicionales a lo largo del tiempo.

Valor Description
Personal

Mi carpeta o Mi área de trabajo se usa para administrar elementos de usuario.
Workspace

Área de trabajo que se usa para administrar los elementos de Fabric.
AdminWorkspace

Área de trabajo de supervisión de administración. Contiene informes de administración, como el informe de auditoría y el informe de uso y adopción.