Items - List Environments

Serviço:: Environment

Versão da API:: v1

Retorna uma lista de ambientes do espaço de trabalho especificado.
Esta API suporta paginação.

Permissões

O chamador deve ter uma função de espaço de trabalho de visualizador .

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pela Microsoft Entra

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

Identidade	Suporte
Utilizador	Sim
Entidade de serviço e identidades geridas	Sim

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?recursive={recursive}&rootFolderId={rootFolderId}&continuationToken={continuationToken}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
continuationToken	query		string	Um token para recuperar a próxima página de resultados.
recursive	query		boolean	Lista itens em uma pasta e suas pastas aninhadas, ou apenas uma pasta. True - Todos os itens na pasta e suas pastas aninhadas são listados, Falso - Somente os itens na pasta são listados. O valor padrão é true.
rootFolderId	query		string (uuid)	Este parâmetro permite que os usuários filtrem itens com base em uma pasta raiz específica. Se não for fornecido, o espaço de trabalho será usado como a pasta raiz.

Respostas

Name Tipo Description

200 OK

Name	Tipo	Description
200 OK	Environments	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: InvalidItemType - Tipo de item inválido

Environments

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:

InvalidItemType - Tipo de item inválido

Exemplos

List environments in workspace example

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      },
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      },
      "sensitivityLabel": {
        "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
      }
    }
  ]
}

Definições

Name	Description
ComponentPublishInfo	Publique informações para cada componente no ambiente.
EntireTenantPrincipal	Representa um principal inquilino
Environment	Um item Ambiente.
EnvironmentProperties	Propriedades do ambiente.
EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.
Environments	Uma lista de ambientes.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
GroupPrincipal	Representa um grupo de segurança.
GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.
ItemTag	Representa uma tag aplicada em um item.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
PrincipalType	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
PublishDetails	Detalhes da operação de publicação.
SensitivityLabel	Representa uma etiqueta de sensibilidade aplicada a um item.
ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
ServicePrincipalPrincipal	Representa um principal de serviço Microsoft Entra.
ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representa um perfil de principal de serviço.
SparkLibraries	Bibliotecas Spark.
SparkSettings	Configurações de faísca.
UserDetails	Detalhes específicos principais do usuário. Aplicável quando o tipo principal é `User`.
UserPrincipal	Representa um principal utilizador Microsoft Entra.

ComponentPublishInfo

Object

Publique informações para cada componente no ambiente.

Name	Tipo	Description
sparkLibraries	SparkLibraries	As bibliotecas do Spark publicam informações.
sparkSettings	SparkSettings	As configurações do Spark publicam informações.

EntireTenantPrincipal

Object

Representa um principal inquilino

Name	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
id	string (uuid)	O ID da entidade de segurança.
type	string: EntireTenant	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

Environment

Object

Um item Ambiente.

Name	Tipo	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	A identidade padrão do item.
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	O ID da pasta.
id	string (uuid)	O ID do item.
properties	EnvironmentProperties	As propriedades do ambiente.
sensitivityLabel	SensitivityLabel	A etiqueta de sensibilidade do item.
tags	ItemTag[]	Lista de tags aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O ID do espaço de trabalho.

EnvironmentProperties

Object

Propriedades do ambiente.

Name	Tipo	Description
publishDetails	PublishDetails	Ambiente publicar detalhes da operação.

EnvironmentPublishState

Enumeração

Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Success	A publicação do ambiente está em estado de sucesso.
Cancelled	A publicação do ambiente está em estado cancelado.
Failed	A publicação do ambiente está em estado de falha.
Cancelling	A publicação do ambiente está em estado de cancelamento.
Running	A publicação do ambiente está em estado de execução.
Waiting	A publicação do ambiente está em estado de espera.

Environments

Object

Uma lista de ambientes.

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	Environment[]	Uma lista de ambientes.

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 (uuid)	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.

GroupDetails

Object

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Name	Tipo	Description
groupType	GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupPrincipal

Object

Representa um grupo de segurança.

Name	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
groupDetails	GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
id	string (uuid)	O ID da entidade de segurança.
type	string: Group	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

GroupType

Enumeração

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Unknown	O tipo de grupo principal é desconhecido.
SecurityGroup	Principal é um grupo de segurança.
DistributionList	Principal é uma lista de distribuição.

ItemTag

Object

Representa uma tag aplicada em um item.

Name	Tipo	Description
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Dashboard	Painel do PowerBI.
Report	Relatório do PowerBI.
SemanticModel	Modelo semântico do PowerBI.
PaginatedReport	Relatório paginado do PowerBI.
Datamart	Datamart do PowerBI.
Lakehouse	Uma casa no lago.
Eventhouse	Uma casa de eventos.
Environment	Um ambiente.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
KQLDashboard	Um painel KQL.
DataPipeline	Um pipeline de dados.
Notebook	Um caderno.
SparkJobDefinition	Uma definição de trabalho de faísca.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
Warehouse	Um armazém.
Eventstream	Um fluxo de eventos.
SQLEndpoint	Um ponto de extremidade SQL.
MirroredWarehouse	Um armazém espelhado.
MirroredDatabase	Um banco de dados espelhado.
Reflex	Um reflexo.
GraphQLApi	Uma API para o item GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Uma VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo de construtor de gêmeos digitais.
MirroredAzureDatabricksCatalog	Um catálogo de databricks azure espelhado.
Map	Um mapa.
AnomalyDetector	Um detetor de anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.
OperationsAgent	Um Agente de Operações.
CosmosDBDatabase	Uma base de dados Cosmos DB.
Ontology	Uma ontologia.
EventSchemaSet	Um EventoSchemaSet.
DataAgent	Um DataAgent.

PrincipalType

Enumeração

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

Valor	Description
User	O principal é um utilizador principal da Microsoft Entra.
ServicePrincipal	O principal é um principal do serviço Microsoft Entra.
Group	Principal é um grupo de segurança.
ServicePrincipalProfile	Principal é um perfil de entidade de serviço.
EntireTenant	Principal representa todos os usuários locatários.

PublishDetails

Object

Detalhes da operação de publicação.

Name	Tipo	Description
componentPublishInfo	ComponentPublishInfo	Componente Ambiente publicar informações.
endTime	string (date-time)	Hora de término da operação de publicação em UTC, usando o formato AAAA-MM-DDTHH:mm:ss.ssssssssZ .
startTime	string (date-time)	Hora de início da operação de publicação em UTC, usando o formato AAAA-MM-DDTHH:mm:ss.ssssssssZ .
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.
targetVersion	string (uuid)	Target verion a ser publicado.

SensitivityLabel

Object

Representa uma etiqueta de sensibilidade aplicada a um item.

Name	Tipo	Description
id	string (uuid)	O ID da etiqueta de sensibilidade.

ServicePrincipalDetails

Object

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Name	Tipo	Description
aadAppId	string (uuid)	O Microsoft Entra AppId, do principal do serviço.

ServicePrincipalPrincipal

Object

Representa um principal de serviço Microsoft Entra.

Name	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
id	string (uuid)	O ID da entidade de segurança.
servicePrincipalDetails	ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
type	string: ServicePrincipal	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

ServicePrincipalProfileDetails

Object

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Name	Tipo	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	A entidade principal do perfil da entidade de serviço.

ServicePrincipalProfilePrincipal

Object

Representa um perfil de principal de serviço.

Name	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
id	string (uuid)	O ID da entidade de segurança.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

SparkLibraries

Object

Bibliotecas Spark.

Name	Tipo	Description
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.

SparkSettings

Object

Configurações de faísca.

Name	Tipo	Description
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.

UserDetails

Object

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

Name	Tipo	Description
userPrincipalName	string	O nome principal do usuário.

UserPrincipal

Object

Representa um principal utilizador Microsoft Entra.

Name	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
id	string (uuid)	O ID da entidade de segurança.
type	string: User	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
userDetails	UserDetails	Detalhes específicos principais do usuário. Aplicável quando o tipo principal é `User`.

Partilhar via

Items - List Environments

Permissões

Escopos delegados necessários

Identidades suportadas pela Microsoft Entra

Interfaz

Parâmetros do URI

Respostas

Exemplos

List environments in workspace example

Pedido de amostra

Resposta da amostra

Definições

ComponentPublishInfo

EntireTenantPrincipal

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemTag

ItemType

PrincipalType

PublishDetails

SensitivityLabel

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

SparkLibraries

SparkSettings

UserDetails

UserPrincipal