Workspaces - Update Workspace

Serviço:

Core

Versão da API:

v1

Atualiza as propriedades do workspace especificadas.

Permissões

O chamador deve ter função de administrador workspace.

Escopos delegados necessários

Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

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

Interfase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Tipo	Description
description	string	A descrição do workspace. A descrição não pode conter mais de 4.000 caracteres.
displayName	string	O nome de exibição do workspace. O nome de exibição não pode conter mais de 256 caracteres. Os nomes do workspace devem ser exclusivos dentro do locatário. "Monitoramento de administrador" é um nome de workspace reservado.

Respostas

Nome	Tipo	Description
200 OK	Workspace	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Exemplos

Update a workspace example

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:

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

Nome	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 o conteúdo da solicitação do workspace.
Workspace	Um objeto de workspace.
WorkspaceType	Um tipo de workspace. Tipos de workspace adicionais podem ser adicionados ao longo do tempo.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

UpdateWorkspaceRequest

Objeto

Atualizar o conteúdo da solicitação do workspace.

Nome	Tipo	Description
description	string	A descrição do workspace. A descrição não pode conter mais de 4.000 caracteres.
displayName	string	O nome de exibição do workspace. O nome de exibição não pode conter mais de 256 caracteres. Os nomes do workspace devem ser exclusivos dentro do locatário. "Monitoramento de administrador" é um nome de workspace reservado.

Workspace

Objeto

Um objeto de workspace.

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

WorkspaceType

Enumeração

Um tipo de workspace. Tipos de workspace adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Personal	Minha pasta ou meu workspace usado para gerenciar itens de usuário.
Workspace	Workspace usado para gerenciar os itens do Fabric.
AdminWorkspace	Workspace de monitoramento do administrador. Contém relatórios de administrador, como o relatório de auditoria e o relatório de uso e adoção.