Workspaces - Create Workspace

Serviço:

Core

Versão da API:

v1

Cria um novo espaço de trabalho.

Permissões

• O chamador deve ter permissão para criar workspaces concedidos pelo administrador do Fabric. Para obter mais informações, consulte: criar workspaces.
• O chamador deve ter permissões de colaborador ou ser um administrador na capacidade. Para obter mais informações, consulte: permissões de usuário de capacidade.
• As Entidades de Serviço devem ter permissão concedida pelo administrador do Fabric. Para obter mais informações, consulte: as entidades de serviço podem criar workspaces, conexões e pipelines de implantação.

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	Sim
Entidade de serviço e identidades gerenciadas	Sim

Interfase

POST https://api.fabric.microsoft.com/v1/workspaces

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome de exibição do workspace. O nome de exibição não pode conter mais de 256 caracteres. Somente nomes de workspace não utilizados são permitidos. "Monitoramento de administrador" é um nome de workspace reservado.
capacityId		string (uuid)	A ID da capacidade à qual atribuir o workspace.
description		string	A descrição do workspace. A descrição não pode conter mais de 4.000 caracteres.
domainId		string (uuid)	A ID do domínio ao qual atribuir o workspace.

Respostas

Nome	Tipo	Description
201 Created	Workspace	Criado com êxito. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Códigos de erro comuns: DomainNotFound - O domínio fornecido não foi encontrado InsufficientPermissionsToDomain – A permissão de usuário para o domínio não é suficiente para executar a operação UnknownError – Ocorreu um erro.

Exemplos

Create a workspace example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces

{
  "displayName": "New workspace"
}

Resposta de exemplo

Código de status:

201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb22287ff

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb22287ff",
  "displayName": "New workspace",
  "description": "",
  "type": "Workspace"
}

Definições

Nome	Description
CreateWorkspaceRequest	Criar conteúdo da solicitação do workspace.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
Workspace	Um objeto de workspace.
WorkspaceType	Um tipo de workspace. Tipos de workspace adicionais podem ser adicionados ao longo do tempo.

CreateWorkspaceRequest

Objeto

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

Nome	Tipo	Description
capacityId	string (uuid)	A ID da capacidade à qual atribuir o workspace.
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. Somente nomes de workspace não utilizados são permitidos. "Monitoramento de administrador" é um nome de workspace reservado.
domainId	string (uuid)	A ID do domínio ao qual atribuir o workspace.

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.

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.