Workspaces - List Workspaces

Serviço:: Admin

Versão da API:: v1

Retorna uma lista de workspaces.

Note

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção.

Essa API dá suporte a de paginação. Um máximo de 10.000 registros pode ser retornado por solicitação. Com o token contínuo fornecido na resposta, você pode obter os próximos 10.000 registros.

Permissions

O chamador deve ser um administrador do Fabric ou autenticar usando uma entidade de serviço.

Escopos delegados necessários

Tenant.Read.All ou Tenant.ReadWrite.All

Limitations

Máximo de 200 solicitações por hora.

Identidades com suporte do Microsoft Entra

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

Identity	Support
User	Yes
Entidade de serviço e identidades gerenciadas	Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

Parâmetros de URI

Nome	Em	Tipo	Description
capacityId	query	string (uuid)	A ID de capacidade do workspace.
continuationToken	query	string	Token de continuação. Usado para obter os próximos itens na lista.
name	query	string	O nome do workspace.
state	query	string	O estado do workspace. Os estados com suporte estão ativos e excluídos.
type	query	string	O tipo de workspace. Os tipos com suporte são pessoal, workspace, adminworkspace.

Respostas

Nome Tipo Description

200 OK

Nome	Tipo	Description
200 OK	Workspaces	A operação foi bem-sucedida.
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: BadRequest – Parâmetros de consulta como `workspaceType` ou `workspaceState` não são válidos. InsufficientPrivileges – o chamador não tem permissões para chamar a API.

Workspaces

A operação foi bem-sucedida.

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:

BadRequest – Parâmetros de consulta como workspaceType ou workspaceState não são válidos.
InsufficientPrivileges – o chamador não tem permissões para chamar a API.

Exemplos

Get a list of workspaces example

Get a list of workspaces using state query parameter example

Get a list of workspaces example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces

Resposta de exemplo

Código de status:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Resposta de exemplo

Código de status:: 200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

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.
Workspace	Workspace.
WorkspaceAppliedTag	Representa uma marca aplicada.
Workspaces	Uma lista de workspaces.
WorkspaceState	O estado do workspace. Estados de workspace adicionais podem ser adicionados ao longo do tempo.
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.
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

Workspace.

Nome	Tipo	Description
capacityId	string (uuid)	A ID de capacidade do workspace.
domainId	string (uuid)	A ID de domínio do workspace.
id	string (uuid)	O identificador do espaço de trabalho.
name	string	O nome do workspace.
state	WorkspaceState	O estado do workspace.
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.

Workspaces

Objeto

Uma lista de workspaces.

Nome	Tipo	Description
continuationToken	string	O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
workspaces	Workspace[]	A lista de workspaces de malha.

WorkspaceState

Enumeração

O estado do workspace. Estados de workspace adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Active	O workspace está ativo. Workspaces órfãos são exibidos como ativos.
Deleted	O workspace é excluído.

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.