Items - Get Environment Definition

Hizmet:: Environment

API Sürümü:: v1

Belirtilen ortam genel tanımını döndürür.
Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Bir ortamın genel tanımını aldığınızda duyarlılık etiketi tanımın bir parçası değildir.

Permissions

Çağıranın ortam için okuma ve yazma izinlerine sahip olması gerekir.

Gerekli Temsilci Kapsamları

Environment.ReadWrite.All veya Item.ReadWrite.All

Sınırlamalar

Bu API, şifrelenmiş duyarlılık etiketine sahip bir ortam için engellenir.

Microsoft Entra destekli kimlikler

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

Kimlik	Support
User	Yes
Hizmet sorumlusu ve yönetilen kimlikler	Yes

Arayüz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/getDefinition

İsteğe bağlı parametrelerle:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/getDefinition?format={format}

URI Parametreleri

Veri Akışı Adı	İçinde	Gerekli	Tür	Description
environmentId	path	True	string (uuid)	Ortam kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
format	query		string	Ortam genel tanımının biçimi.

Yanıtlar

Veri Akışı Adı	Tür	Description
200 OK	EnvironmentDefinitionResponse	İstek başarıyla tamamlandı.
202 Accepted		İstek kabul edildi. Tanımı alma işlemi devam ediyor. Üst Bilgiler Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir `Retry-After` üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: OperationNotSupportedForItem - İstenen öğe için işlem desteklenmiyor.

Örnekler

Get a environment definition example

Örnek isteği

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/environments/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Örnek yanıt

Durum kodu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Durum kodu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Tanımlar

Veri Akışı Adı	Description
EnvironmentDefinition	Ortam genel tanımı nesnesi. Ortam tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.
EnvironmentDefinitionPart	Ortam tanımı parça nesnesi.
EnvironmentDefinitionResponse	Ortam genel tanımı yanıtı.
ErrorParameter	Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
PayloadType	Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

EnvironmentDefinition

Nesne

Ortam genel tanımı nesnesi. Ortam tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

Veri Akışı Adı	Tür	Description
format	string	Ortam tanımının biçimi.
parts	EnvironmentDefinitionPart[]	Tanım bölümlerinin listesi.

EnvironmentDefinitionPart

Nesne

Ortam tanımı parça nesnesi.

Veri Akışı Adı	Tür	Description
path	string	Ortam bölümü yolu.
payload	string	Ortam bölümü yükü.
payloadType	PayloadType	Yük türü.

EnvironmentDefinitionResponse

Nesne

Ortam genel tanımı yanıtı.

Veri Akışı Adı	Tür	Description
definition	EnvironmentDefinition	Ortam genel tanımı nesnesi. Ortam tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

ErrorParameter

Nesne

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.

Veri Akışı Adı	Tür	Description
message	string	Parametrenin anlamının insan tarafından okunabilen açıklaması.
name	string	Parametre tanımlayıcısı.
value	string	Parametre değeridir.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Veri Akışı Adı	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ı.

Veri Akışı Adı	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ı.
isRetriable	boolean	True olduğunda istek yeniden denenebilir. Varsa gecikmeyi `Retry-After` belirlemek için yanıt üst bilgisini kullanın.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
parameters	ErrorParameter[]	Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

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

Veri Akışı Adı	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.
parameters	ErrorParameter[]	Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

PayloadType

Numaralandırma

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer	Description
InlineBase64	Satır içi Temel 64.