Partilhar via

Workspaces - List Workspaces

Serviço:
Admin
Versão da API:
v1

Retorna uma lista de espaços de trabalho.

Note

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção.

Esta API suporta paginação. Um máximo de 10.000 registros podem ser devolvidos 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 de malha ou autenticar usando uma entidade de serviço.

Escopos delegados necessários

Tenant.Read.All ou Tenant.ReadWrite.All

Limitations

Máximo de 200 pedidos por hora.

Identidades suportadas pelo Entra da Microsoft

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

Identity Support
User Yes
Entidade de serviço e identidades geridas 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 do URI

Name Em Necessário Tipo Description
capacityId
 query

string (uuid)

O ID de capacidade do espaço de trabalho.
continuationToken
 query

string

Token de continuação. Usado para obter os próximos itens na lista.
name
 query

string

O nome do espaço de trabalho.
state
 query

string

O estado do espaço de trabalho. Os estados suportados são ativos e excluídos.
type
 query

string

O tipo de espaço de trabalho. Os tipos suportados são personal, workspace, adminworkspace.

Respostas

Name Tipo Description
200 OK

Workspaces

A operação foi bem sucedida.
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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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"
    }
  ],
  "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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Name 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.
Workspaces

Uma lista de espaços de trabalho.
WorkspaceState

O estado do espaço de trabalho. Estados de espaço de trabalho adicionais podem ser adicionados ao longo do tempo.
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.

Workspace

Object

Workspace.

Name Tipo Description
capacityId

string (uuid)

O ID de capacidade do espaço de trabalho.
domainId

string (uuid)

A ID de domínio do espaço de trabalho.
id

string (uuid)

O ID do espaço de trabalho.
name

string

O nome do espaço de trabalho.
state

WorkspaceState

O estado do espaço de trabalho.
type

WorkspaceType

O tipo de espaço de trabalho.

Workspaces

Object

Uma lista de espaços de trabalho.

Name Tipo Description
continuationToken

string

O token para o próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri

string

O URI do próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
workspaces

Workspace[]

A lista de espaços de trabalho de malha.

WorkspaceState

Enumeração

O estado do espaço de trabalho. Estados de espaço de trabalho adicionais podem ser adicionados ao longo do tempo.

Valor Description
Active

O espaço de trabalho está ativo. Os espaços de trabalho órfãos são exibidos como ativos.
Deleted

O espaço de trabalho é excluído.

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.