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

Limites de limitação

Tipo de Limite	Value
Quota Unificada para APIs de Plataforma	200 chamadas/min
Limite da API	200 chamadas/min

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	Tipo	Descrição
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 Descrição

200 OK

Name	Tipo	Descrição
200 OK	Workspaces	Pedido concluído com sucesso.
429 Too Many Requests	ErrorResponse	O limite de tarifa de serviço foi ultrapassado. O servidor devolve um `Retry-After` cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais. Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidParameter - Função de espaço de trabalho inválida. UnknownError - Ocorreu um erro.

Workspaces

Pedido concluído com sucesso.

429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

Retry-After: integer

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

HTTP

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

Pedido de amostra

HTTP

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

List workspaces with preferWorkspaceSpecificEndpoints example

Pedido de amostra

HTTP

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

HTTP

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	Descrição
CapacityRegion	A região da capacidade associada a este espaço de trabalho. Valores adicionais de região de capacidade 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 espaço de trabalho.
WorkspaceAppliedTag	Representa uma etiqueta aplicada.
Workspaces
WorkspaceType	Um tipo de espaço de trabalho. Tipos de espaço de trabalho adicionais podem ser adicionados ao longo do tempo.

CapacityRegion

Enumeração

A região da capacidade associada a este espaço de trabalho. Valores adicionais de região de capacidade podem ser adicionados ao longo do tempo.

Valor	Descrição
Australia East	Região Leste da Austrália
Australia Southeast	Austrália Região Sudeste
Brazil South	Região Sul do Brasil
Brazil Southeast	Brasil Região Sudeste
Canada Central	Região central do Canadá
Canada East	Região Leste do Canadá
Central India	Região da Índia Central
Central US	Região central dos EUA
Central US EUAP	Região EUAP dos EUA Central
East Asia	Região da Ásia Oriental
East US	Região Leste dos EUA
East US 2	Leste dos EUA 2 região
France Central	França Região central
France South	Região Sul da França
Germany Central	Alemanha Região central
Germany Northeast	Alemanha Região Nordeste
Israel Central	Região Central de Israel
Italy North	Itália Região Norte
Japan East	Região Leste do Japão
Japan West	Região Oeste do Japão
Korea Central	Coreia Central
Korea South	Coreia do Sul
Mexico Central	Região do México Central
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	Polónia Região central
South Africa North	África do Sul Região Norte
South Africa West	África do Sul Região Oeste
South Central US	Região Centro-Sul dos EUA
South India	Região Sul da Índia
Southeast Asia	Região do Sudeste Asiático
Spain Central	Espanha Região Central
Sweden Central	Suécia Região central
Switzerland North	Suíça Região Norte
Switzerland West	Suíça Região Oeste
West Europe	Região da Europa Ocidental
West India	Região da Índia Ocidental
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 Catar Central
Germany West Central	Alemanha região Centro-Oeste
Germany North	Alemanha Região Norte
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	China Leste 2 região
China East 3	China Leste 3 região
China North 2	China Norte 2 região
China North 3	China Norte 3 região

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Descrição
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	Descrição
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.
isRetriable	boolean	Quando confirmado, o pedido pode ser retentado. Use o `Retry-After` cabeçalho de resposta para determinar o atraso, se disponível.
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 (uuid)	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Descrição
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	Descrição
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.
capacityRegion	CapacityRegion	A região da capacidade associada a este espaço de trabalho.
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.
tags	WorkspaceAppliedTag[]	Lista de tags aplicadas.
type	WorkspaceType	O tipo de espaço de trabalho.

WorkspaceAppliedTag

Object

Representa uma etiqueta aplicada.

Name	Tipo	Descrição
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

Workspaces

Object

Name	Tipo	Descrição
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	Descrição
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.