Workspaces - Update Workspace

Serviço:

Core

Versão da API:

v1

Atualiza as propriedades do espaço de trabalho especificado.

Permissões

O chamador deve ter a função de espaço de trabalho de administrador .

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

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

Identidade	Apoio
Utilizador	Yes
Entidade de serviço e identidades geridas	Yes

Interfaz

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Name	Tipo	Description
description	string	A descrição do espaço de trabalho. A descrição não pode conter mais de 4000 caracteres.
displayName	string	O nome de exibição do espaço de trabalho. O nome para exibição não pode conter mais de 256 caracteres. Os nomes dos espaços de trabalho devem ser exclusivos dentro do locatário. "Monitoramento de administrador" é um nome de espaço de trabalho reservado.

Respostas

Name	Tipo	Description
200 OK	Workspace	Pedido concluído com sucesso.
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError - Ocorreu um erro.

Exemplos

Update a workspace example

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
UpdateWorkspaceRequest	Atualizar carga útil de solicitação de espaço de trabalho.
Workspace	Um objeto de espaço de trabalho.
WorkspaceType	Um tipo de espaço de trabalho. Tipos de espaço de trabalho adicionais podem ser adicionados ao longo do tempo.

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.

UpdateWorkspaceRequest

Object

Atualizar carga útil de solicitação de espaço de trabalho.

Name	Tipo	Description
description	string	A descrição do espaço de trabalho. A descrição não pode conter mais de 4000 caracteres.
displayName	string	O nome de exibição do espaço de trabalho. O nome para exibição não pode conter mais de 256 caracteres. Os nomes dos espaços de trabalho devem ser exclusivos dentro do locatário. "Monitoramento de administrador" é um nome de espaço de trabalho reservado.

Workspace

Object

Um objeto de espaço de trabalho.

Name	Tipo	Description
apiEndpoint	string (uri)	URL HTTP que representa o ponto de extremidade da API específico para o espaço de trabalho. Esse valor de ponto de extremidade é retornado quando o usuário habilita preferWorkspaceSpecificEndpoints. Ele permite o acesso à API através de links privados.
capacityId	string (uuid)	A ID da capacidade à qual o espaço de trabalho é atribuído.
description	string	A descrição do espaço de trabalho.
displayName	string	O nome de exibição do espaço de trabalho.
domainId	string (uuid)	A ID do domínio ao qual o espaço de trabalho é atribuído.
id	string (uuid)	O ID do espaço de trabalho.
type	WorkspaceType	O tipo de espaço de trabalho.

WorkspaceType

Enumeração

Um tipo de espaço de trabalho. Tipos de espaço de trabalho adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Personal	Minha pasta ou Meu espaço de trabalho usado para gerenciar itens de usuário.
Workspace	Espaço de trabalho usado para gerenciar os itens de malha.
AdminWorkspace	Espaço de trabalho de monitoramento de administrador. Contém relatórios administrativos, como o relatório de auditoria e o relatório de uso e adoção.