Compartilhar via

Workspaces - List Workspaces

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

Retorna uma lista de workspaces que a entidade de segurança pode acessar. Use o parâmetro de consulta de funções para filtrar os resultados pela função de workspace principal.
Essa API dá suporte a de paginação.

Escopos delegados necessários

Workspace.Read.All ou 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

GET https://api.fabric.microsoft.com/v1/workspaces
Com parâmetros opcionais: 
GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
continuationToken
 query

string

Um token para recuperar a próxima página de resultados.
preferWorkspaceSpecificEndpoints
 query

boolean

Uma configuração que controla se o ponto de extremidade de API específico do workspace deve ser incluído por workspace. True – Inclua o ponto de extremidade de API específico do workspace, False – Não inclua o ponto de extremidade de API específico do workspace.
roles
 query

string

Uma lista de funções. Separar valores usando uma vírgula. Se não for fornecido, todos os workspaces serão retornados.

Respostas

Nome Tipo Description
200 OK

Workspaces

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidParameter – função de workspace inválida.

  • UnknownError – Ocorreu um erro.

Exemplos

List workspaces example
List workspaces with continuation example
List workspaces with preferWorkspaceSpecificEndpoints example
List workspaces with roles filter example

List workspaces example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29"
    }
  ]
}

List workspaces with continuation example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Solicitação de exemplo

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

Resposta de exemplo

Código de status:
200 
{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

Solicitação de exemplo

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

Resposta de exemplo

Código de status:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

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

Um objeto de workspace.
Workspaces
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.

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.

Workspaces

Objeto
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.
value

Workspace[]

Uma lista de workspaces.

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.