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

Limitações

Tipo de limite	Value
Cota unificada para APIs de plataforma	200 chamadas/min
Limite de API	200 chamadas/min

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

Nome	Tipo	Description
200 OK	Workspaces	Solicitação concluída com êxito.
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: InvalidParameter – função de workspace inválida. UnknownError – Ocorreu um erro.

Workspaces

Solicitação concluída com êxito.

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:

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

HTTP

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",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    },
    {
      "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",
      "capacityRegion": "East US",
      "tags": [
        {
          "id": "9b8c7d6e-5f4a-3b2c-1d0e-9f8a7b6c5d4e",
          "displayName": "Finance"
        },
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Marketing"
        }
      ]
    }
  ]
}

List workspaces with continuation example

Solicitação de exemplo

HTTP

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",
      "capacityRegion": "East US"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Solicitação de exemplo

HTTP

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

HTTP

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
CapacityRegion	A região da capacidade associada a esse workspace. Valores de região de capacidade adicionais podem ser adicionados ao longo do tempo.
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.
Workspaces
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

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.

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.