Partilhar via

Workspaces - List Workspaces

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

Retorna uma lista de espaços de trabalho que a entidade de segurança pode acessar. Use o parâmetro de consulta roles para filtrar os resultados pela função de espaço de trabalho principal.
Esta API suporta paginação.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

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

Identidade Apoio
Utilizador Yes
Entidade de serviço e identidades geridas Yes

Interfaz

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 do URI

Name Em Necessá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 da API específico do espaço de trabalho deve ser incluído por espaço de trabalho. True - Inclua o ponto de extremidade da API específico do espaço de trabalho, Falso - Não inclua o ponto de extremidade da API específico do espaço de trabalho.
roles
 query

string

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

Respostas

Name Tipo Description
200 OK

Workspaces

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidParameter - Função de espaço de trabalho 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

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

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

Um objeto de espaço de trabalho.
Workspaces
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

Um objeto de espaço de trabalho.

Name Tipo Description
apiEndpoint

string (uri)

URL HTTP que representa o ponto de extremidade da API específico para o espaço de trabalho. Esse valor de ponto de extremidade é retornado quando o usuário habilita preferWorkspaceSpecificEndpoints. Ele permite o acesso à API através de links privados.
capacityId

string (uuid)

A ID da capacidade à qual o espaço de trabalho é atribuído.
description

string

A descrição do espaço de trabalho.
displayName

string

O nome de exibição do espaço de trabalho.
domainId

string (uuid)

A ID do domínio ao qual o espaço de trabalho é atribuído.
id

string (uuid)

O ID do espaço de trabalho.
type

WorkspaceType

O tipo de espaço de trabalho.

Workspaces

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

Workspace[]

Uma lista de espaços de trabalho.

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.