Items - List Environments

Hizmet:: Environment

API Sürümü:: v1

Belirtilen çalışma alanından ortamların listesini döndürür.
Bu API, sayfalandırmadestekler.

İzinler

Çağıranın bir görüntüleyici çalışma alanı rolü olmalıdır.

Gerekli Temsilci Kapsamları

Workspace.Read.All veya Workspace.ReadWrite.All

Microsoft Entra tarafından desteklenen kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik	Destek
Kullanıcı	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Evet

Arayüz

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
continuationToken	query		string	Sonuçların sonraki sayfasını almak için bir belirteç.
recursive	query		boolean	Bir klasördeki ve iç içe klasörlerdeki veya yalnızca bir klasördeki öğeleri listeler. True - Klasördeki ve iç içe klasörlerdeki tüm öğeler, Yanlış - Yalnızca klasördeki öğeler listelenir. Varsayılan değer true değeridir.
rootFolderId	query		string (uuid)	Bu parametre, kullanıcıların öğeleri belirli bir kök klasöre göre filtrelemesine olanak tanır. Sağlanmadıysa, çalışma alanı kök klasör olarak kullanılır.

Yanıtlar

Name	Tür	Description
200 OK	Environments	İstek başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Yaygın hata kodları: InvalidItemType - Geçersiz öğe türü

Name

Tür

Description

200 OK

Environments

İstek başarıyla tamamlandı.

Other Status Codes

ErrorResponse

Yaygın hata kodları:

InvalidItemType - Geçersiz öğe türü

Örnekler

List environments in workspace example

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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"
            }
          }
        }
      }
    }
  ]
}

Tanımlar

Name	Description
ComponentPublishInfo	Ortamdaki her bileşen için bilgi yayımlayın.
Environment	Ortam öğesi.
EnvironmentProperties	Ortam özellikleri.
EnvironmentPublishState	Yayımlama durumu. Zaman içinde ek durum türleri eklenebilir.
Environments	Ortamların listesi.
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
ItemTag	Bir öğeye uygulanan etiketi temsil eder.
ItemType	Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.
PublishDetails	Yayımlama işleminin ayrıntıları.
SparkLibraries	Spark kitaplıkları.
SparkSettings	Spark ayarları.

ComponentPublishInfo

Nesne

Ortamdaki her bileşen için bilgi yayımlayın.

Name	Tür	Description
sparkLibraries	SparkLibraries	Spark kitaplıkları bilgileri yayımlar.
sparkSettings	SparkSettings	Spark ayarları bilgileri yayımlar.

Environment

Nesne

Ortam öğesi.

Name	Tür	Description
description	string	Öğe açıklaması.
displayName	string	Öğenin görünen adı.
folderId	string (uuid)	Klasör kimliği.
id	string (uuid)	Öğe kimliği.
properties	EnvironmentProperties	Ortam özellikleri.
tags	ItemTag[]	Uygulanan etiketlerin listesi.
type	ItemType	Öğe türü.
workspaceId	string (uuid)	Çalışma alanı kimliği.

EnvironmentProperties

Nesne

Ortam özellikleri.

Name	Tür	Description
publishDetails	PublishDetails	Ortam yayımlama işlemi ayrıntıları.

EnvironmentPublishState

Numaralandırma

Yayımlama durumu. Zaman içinde ek durum türleri eklenebilir.

Değer	Description
Success	Ortam yayımlama başarılı durumda.
Cancelled	Ortam yayımlama iptal edildi durumunda.
Failed	Ortam yayımlama başarısız durumda.
Cancelling	Ortam yayımlama iptal etme durumunda.
Running	Ortam yayımlama çalışıyor durumda.
Waiting	Ortam yayımlama bekleme durumunda.

Environments

Nesne

Ortamların listesi.

Name	Tür	Description
continuationToken	string	Sonraki sonuç kümesi toplu işleminin belirteci. Başka kayıt yoksa yanıttan kaldırılır.
continuationUri	string	Sonraki sonuç kümesi toplu işleminin URI'sini. Başka kayıt yoksa yanıttan kaldırılır.
value	Environment[]	Ortamların listesi.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

ItemTag

Nesne

Bir öğeye uygulanan etiketi temsil eder.

Name	Tür	Description
displayName	string	Etiketin adı.
id	string (uuid)	Etiket kimliği.

ItemType

Numaralandırma

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.

Değer	Description
Dashboard	PowerBI panosu.
Report	PowerBI raporu.
SemanticModel	PowerBI anlam modeli.
PaginatedReport	PowerBI sayfalandırılmış raporu.
Datamart	PowerBI datamart.
Lakehouse	Göl evi.
Eventhouse	Bir olay evi.
Environment	Bir ortam.
KQLDatabase	KQL veritabanı.
KQLQueryset	KQL sorgu kümesi.
KQLDashboard	KQL panosu.
DataPipeline	Veri işlem hattı.
Notebook	Bir not defteri.
SparkJobDefinition	Spark iş tanımı.
MLExperiment	Makine öğrenmesi denemesi.
MLModel	Makine öğrenmesi modeli.
Warehouse	Bir depo.
Eventstream	Bir olay akışı.
SQLEndpoint	Bir SQL uç noktası.
MirroredWarehouse	Aynalı bir depo.
MirroredDatabase	Yansıtılmış veritabanı.
Reflex	Bir refleks.
GraphQLApi	GraphQL öğesi için bir API.
MountedDataFactory	Bir MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopyalama işi.
VariableLibrary	Bir VariableLibrary.
Dataflow	Veri akışı.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Ambar anlık görüntüsü.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Dijital İkiz Oluşturucu Akışı.
MirroredAzureDatabricksCatalog	Yansıtılmış azure databricks kataloğu.
Map	Bir harita.
AnomalyDetector	Anomali Algılayıcısı.
UserDataFunction	Kullanıcı Verileri İşlevi.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake hesabından oluşturulan Iceberg tablolarını depolamak için bir Snowflake Veritabanı.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB Veritabanı.
Ontology	Bir Ontoloji.
EventSchemaSet	Bir EventSchemaSet.

PublishDetails

Nesne

Yayımlama işleminin ayrıntıları.

Name	Tür	Description
componentPublishInfo	ComponentPublishInfo	Ortam bileşeni yayımlama bilgileri.
endTime	string (date-time)	YYYY-MM-DDTHH:mm:ss.ssZ biçimini kullanarak UTC'de yayımlama işleminin bitiş saati.
startTime	string (date-time)	YYYY-MM-DDTHH:mm:ss.ssZ biçimini kullanarak utc'de yayımlama işleminin başlangıç saati.
state	EnvironmentPublishState	Yayımlama durumu. Zaman içinde ek durum türleri eklenebilir.
targetVersion	string (uuid)	Yayımlanacak verion'ı hedefle.

SparkLibraries

Nesne

Spark kitaplıkları.

Name	Tür	Description
state	EnvironmentPublishState	Yayımlama durumu. Zaman içinde ek durum türleri eklenebilir.

SparkSettings

Nesne

Spark ayarları.

Name	Tür	Description
state	EnvironmentPublishState	Yayımlama durumu. Zaman içinde ek durum türleri eklenebilir.

Aracılığıyla paylaş

Items - List Environments

İzinler

Gerekli Temsilci Kapsamları

Microsoft Entra tarafından desteklenen kimlikler

Arayüz

URI Parametreleri

Yanıtlar

Örnekler

List environments in workspace example

Örnek isteği

Örnek yanıt

Tanımlar

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SparkLibraries

SparkSettings