Aracılığıyla paylaş

Items - Update Environment Definition

Hizmet:
Environment
API Sürümü:
v1

Belirtilen ortam için tanımı geçersiz kılar.
Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Ortamın tanımını güncelleştirmek, duyarlılık etiketini etkilemez.

Permissions

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

Gerekli Temsilci Kapsamları

Environment.ReadWrite.All veya Item.ReadWrite.All

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}/updateDefinition
İsteğe bağlı parametrelerle: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/updateDefinition?updateMetadata={updateMetadata}

URI Parametreleri

Name İçinde Gerekli Tür Description
environmentId
 path True

string (uuid)

Ortam kimliği.
workspaceId
 path True

string (uuid)

Çalışma alanı kimliği.
updateMetadata
 query

boolean

True olarak ayarlandığında ve .platform dosyası tanımın bir parçası olarak sağlandığında, öğenin meta verileri .platform dosyasındaki meta veriler kullanılarak güncelleştirilir

İstek Gövdesi

Name Gerekli Tür Description
definition True

EnvironmentDefinition

Ortam genel tanımı nesnesi. Ortam genel tanımı oluşturma hakkında daha fazla bilgi için bu makaleye bakın.

Yanıtlar

Name Tür Description
200 OK

İstek başarıyla tamamlandı.
202 Accepted

İstek kabul edildi. Güncelleştirme tanımı devam ediyor.

Üst Bilgiler

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Yaygın hata kodları:

  • OperationNotSupportedForItem - İstenen öğe için işlem desteklenmiyor.

  • BozukPayload - Sağlanan yük bozuk.

Örnekler

Update a environment definition example

Örnek isteği

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "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"
      }
    ]
  }
}

Örnek yanıt

Durum kodu:
200
Durum kodu:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Tanımlar

Name Description
EnvironmentDefinition

Ortam genel tanımı nesnesi. Ortam genel tanımı oluşturma hakkında daha fazla bilgi için bu makaleye bakın.
EnvironmentDefinitionPart

Ortam tanımı parça nesnesi.
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.
UpdateEnvironmentDefinitionRequest

Ortam genel tanımı istek yükünü güncelleştirin.

EnvironmentDefinition

Object

Ortam genel tanımı nesnesi. Ortam genel tanımı oluşturma hakkında daha fazla bilgi için bu makaleye bakın.

Name Tür Description
format

string

Ortam tanımının biçimi.
parts

EnvironmentDefinitionPart[]

Tanım bölümlerinin listesi.

EnvironmentDefinitionPart

Object

Ortam tanımı parça nesnesi.

Name Tür Description
path

string

Ortam bölümü yolu.
payload

string

Ortam bölümü yükü.
payloadType

PayloadType

Yük türü.

ErrorRelatedResource

Object

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

Object

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

Object

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

PayloadType

Listeleme

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.

UpdateEnvironmentDefinitionRequest

Object

Ortam genel tanımı istek yükünü güncelleştirin.

Name Tür Description
definition

EnvironmentDefinition

Ortam genel tanımı nesnesi. Ortam genel tanımı oluşturma hakkında daha fazla bilgi için bu makaleye bakın.