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

Nome	Tipo	Description
201 Created	Workspace	Criado com êxito. Cabeçalhos Location: string
429 Too Many Requests	ErrorResponse	O limite de taxa de serviço foi excedido. O servidor retorna um `Retry-After` cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais. Cabeçalhos Retry-After: integer
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.

Workspace

Criado com êxito.

Cabeçalhos

Location: string

429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer

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",
  "capacityRegion": "West US"
}

Definições

Nome	Description
CapacityRegion	A região da capacidade associada a esse workspace. Valores de região de capacidade adicionais podem ser adicionados ao longo do tempo.
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.
WorkspaceAppliedTag	Representa uma marca aplicada.
WorkspaceType	Um tipo de workspace. Tipos de workspace adicionais podem ser adicionados ao longo do tempo.

CapacityRegion

Enumeração

A região da capacidade associada a esse workspace. Valores de região de capacidade adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Australia East	Região Leste da Austrália
Australia Southeast	Região Sudeste da Austrália
Brazil South	Região Sul do Brasil
Brazil Southeast	Região Sudeste do Brasil
Canada Central	Região Central do Canadá
Canada East	Região Leste do Canadá
Central India	Região central da Índia
Central US	Região central dos EUA
Central US EUAP	Região central dos EUAP
East Asia	Região leste da Ásia
East US	Região Leste dos EUA
East US 2	Região Leste dos EUA 2
France Central	Região Central da França
France South	Região Sul da França
Germany Central	Região Central da Alemanha
Germany Northeast	Região Nordeste da Alemanha
Israel Central	Região Central de Israel
Italy North	Região Norte da Itália
Japan East	Região Leste do Japão
Japan West	Região Oeste do Japão
Korea Central	Região Central da Coreia
Korea South	Região sul da Coreia do Sul
Mexico Central	Região Central do México
North Central US	Região Centro-Norte dos EUA
North Europe	Região Norte da Europa
Norway East	Região Leste da Noruega
Norway West	Região Oeste da Noruega
Poland Central	Região Central da Polônia
South Africa North	Região Norte da África do Sul
South Africa West	Região Oeste da África do Sul
South Central US	Região Centro-Sul dos EUA
South India	Região sul da Índia
Southeast Asia	Região sudeste da Ásia
Spain Central	Região Central da Espanha
Sweden Central	Região Central da Suécia
Switzerland North	Região Norte da Suíça
Switzerland West	Região Oeste da Suíça
West Europe	Região da Europa Ocidental
West India	Região Oeste da Índia
West US	Região Oeste dos EUA
West US 2	Região Oeste dos EUA 2
West US 3	Região Oeste dos EUA 3
West Central US	Região Centro-Oeste dos EUA
UAE Central	Região Central dos Emirados Árabes Unidos
UAE North	Região Norte dos Emirados Árabes Unidos
Qatar Central	Região Central do Catar
Germany West Central	Região Centro-Oeste da Alemanha
Germany North	Região Norte da Alemanha
UK South	Região Sul do Reino Unido
UK West	Região Oeste do Reino Unido
China North	Região Norte da China
China East	Região Leste da China
China East 2	Região leste da China 2
China East 3	Região leste da China 3
China North 2	Região Norte da China 2
China North 3	Região Norte da China 3

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.
isRetriable	boolean	Quando true, a solicitação pode ser repetida. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
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 (uuid)	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.
capacityRegion	CapacityRegion	A região da capacidade associada a esse workspace.
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.
tags	WorkspaceAppliedTag[]	Lista de marcas aplicadas.
type	WorkspaceType	O tipo de workspace.

WorkspaceAppliedTag

Objeto

Representa uma marca aplicada.

Nome	Tipo	Description
displayName	string	O nome da marca.
id	string (uuid)	A ID da marca.

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.