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 de continuação 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.

O encryptionStatus filtro é aplicado apenas quando o include parâmetro contém encryption.

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}&encryptionStatus={encryptionStatus}&include={include}

Parâmetros do URI

Name	Em	Tipo	Descrição
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.
encryptionStatus	query	string	Indica o estado de encriptação CMK do espaço de trabalho e é usado para filtrar espaços de trabalho que correspondem ao estado especificado.
include	query	string	Especifica dados adicionais a incluir para cada espaço de trabalho na resposta. Valores suportados: `encryption`.
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 Descrição

200 OK

Name	Tipo	Descrição
200 OK	Workspaces	A operação foi bem sucedida.
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: 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.

Workspaces

A operação foi bem sucedida.

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:

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

List workspaces for a given capacity, ignoring the encryptionStatus filter.

List workspaces with active encryption status in a given capacity

List workspaces with encryption details

Get a list of workspaces example

Pedido de amostra

HTTP

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",
      "tags": [
        {
          "id": "b3f2c8e9-4d8e-4a7c-9a32-f8c1b2e4d6af",
          "displayName": "Finance"
        },
        {
          "id": "6f1a8d3b-92c4-4f67-8c2d-1e5a9b7f4a23",
          "displayName": "Production"
        }
      ]
    }
  ],
  "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

HTTP

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
}

List workspaces for a given capacity, ignoring the encryptionStatus filter.

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active

Resposta da amostra

Código de estado:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with active encryption status in a given capacity

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?capacityId=61d6811f-7544-4e75-a1e6-1c59c0383312&encryptionStatus=Active&include=encryption

Resposta da amostra

Código de estado:: 200

{
  "workspaces": [
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

List workspaces with encryption details

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?encryptionStatus={encryptionStatus}&include=encryption

Resposta da amostra

Código de estado:: 200

{
  "workspaces": [
    {
      "id": "abf49964-6f70-4aea-a66c-4b78a22e3ddc",
      "name": "Contoso Workspace 1",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "9c7f06cc-e850-4961-b2bd-181a70b1a784",
      "name": "Contoso Workspace 2",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Disabled"
      }
    },
    {
      "id": "90119767-07b4-4657-82ee-53e90fece225",
      "name": "Contoso Workspace 3",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "61d6811f-7544-4e75-a1e6-1c59c0383312",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "Active",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/"
      }
    },
    {
      "id": "adaa3051-b1de-41ed-b1b4-d5e08887c1e9",
      "name": "Contoso Workspace 4",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9",
      "encryption": {
        "status": "EnableInProgress",
        "keyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test2k/",
        "previousStatus": "Active",
        "previousKeyIdentifier": "https://westus07112025-cmktest1.vault.azure.net/keys/test4k/"
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Definições

Name	Descrição
Encryption	Detalhes da encriptação do espaço de trabalho usando uma chave gerida pelo cliente (CMK).
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
Workspace	Workspace.
WorkspaceAppliedTag	Representa uma etiqueta aplicada.
WorkspaceEncryptionStatus	O estado da encriptação CMK do espaço de trabalho.
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.

Encryption

Object

Detalhes da encriptação do espaço de trabalho usando uma chave gerida pelo cliente (CMK).

Name	Tipo	Descrição
keyIdentifier	string	O identificador da chave de encriptação.
previousKeyIdentifier	string	O identificador de chave de encriptação anterior.
previousStatus	WorkspaceEncryptionStatus	O estado anterior da encriptação CMK do workspace.
status	WorkspaceEncryptionStatus	O estado da encriptação CMK do espaço de trabalho.

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

Workspace.

Name	Tipo	Descrição
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.
encryption	Encryption	Os detalhes de encriptação 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.
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.

WorkspaceEncryptionStatus

Enumeração

O estado da encriptação CMK do espaço de trabalho.

Valor	Descrição
Disabled	A encriptação do espaço de trabalho não está ativa.
Active	A encriptação do espaço de trabalho está ativa e o espaço de trabalho está encriptado.
EnableInProgress	A encriptação do espaço de trabalho é uma possibilitação.
DisableInProgress	A encriptação do espaço de trabalho está a desabilitar.
Failed	A aplicação de encriptação do espaço de trabalho falhou.

Workspaces

Object

Uma lista de espaços de trabalho.

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