Items - List Environments

Referência

Serviço:: Environment

Versão da API:: v1

Retorna uma lista de ambientes do workspace especificado.
Essa API dá suporte a de paginação.

Permissões

O chamador deve ter função de workspace do visualizador ou superior.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Sim

Interface

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string uuid	A ID do workspace.
continuationToken	query		string	Um token para recuperar a próxima página de resultados.

Respostas

Nome	Tipo	Description
200 OK	Environments	Solicitação concluída com êxito.
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType – Tipo de item inválido

Nome

Tipo

Description

200 OK

Environments

Solicitação concluída com êxito.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType – Tipo de item inválido

Exemplos

List environments in workspace example

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
            }
          }
        }
      }
    },
    {
      "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"
            }
          }
        }
      }
    }
  ]
}

Definições

Nome	Description
ComponentPublishInfo	Publicar informações para cada componente no ambiente.
Environment	Um item de Ambiente.
EnvironmentPublishInfo	Informações de publicação 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.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
PublishDetails	Detalhes da operação de publicação.
SparkLibraries	Bibliotecas do Spark.
SparkSettings	Configurações do Spark.

ComponentPublishInfo

Objeto

Publicar informações para cada componente no ambiente.

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

Environment

Objeto

Um item de Ambiente.

Nome	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
id	string uuid	A ID do item.
properties	EnvironmentPublishInfo	As propriedades do ambiente.
type	ItemType	O tipo de item.
workspaceId	string uuid	A ID do workspace.

EnvironmentPublishInfo

Objeto

Informações de publicação do ambiente.

Nome	Tipo	Description
publishDetails	PublishDetails	Detalhes da operação de publicação do ambiente.

EnvironmentPublishState

Enumeração

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

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

Environments

Objeto

Uma lista de ambientes.

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

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

ItemType

Enumeração

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

Valor	Description
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Datamart	Datamart do PowerBI.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Um item de API para GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um bloco de anotações.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um Reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho do Spark.
Warehouse	Um armazém.

PublishDetails

Objeto

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

Nome	Tipo	Description
componentPublishInfo	ComponentPublishInfo	Informações de publicação do componente de ambiente.
endTime	string date-time	Hora de término da operação de publicação.
startTime	string date-time	Hora de início da operação de publicação.
state	EnvironmentPublishState	Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.
targetVersion	string uuid	Vértices de destino a serem publicados.

SparkLibraries

Objeto

Bibliotecas do Spark.

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

SparkSettings

Objeto

Configurações do Spark.

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

Compartilhar via

Items - List Environments

Permissões

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interface

Parâmetros de URI

Respostas

Exemplos

List environments in workspace example

Solicitação de exemplo

Resposta de exemplo

Definições

ComponentPublishInfo

Environment

EnvironmentPublishInfo

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

Recursos adicionais