Items - Get User Data Function Definition

Hizmet:: UserDataFunction

API Sürümü:: v1

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

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

Permissions

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

Gerekli Temsilci Kapsamları

Item.ReadWrite.All

Desteklenen kimlikleri Microsoft Entra

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

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

Arayüz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/userDataFunctions/{userDataFunctionId}/getDefinition

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
userDataFunctionId	path	True	string (uuid)	UserDataFunction Kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
format	query		string	UserDataFunction genel tanımının biçimi.

Yanıtlar

Name	Tür	Description
200 OK	UserDataFunctionDefinitionResponse	İ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 UserDataFunction public definition example

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 200

{
  "definition": {
    "parts": [
      {
        "path": "UserDataFunctionV1.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ",
        "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

Name	Description
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.
UserDataFunctionDefinitionResponse	UserDataFunction genel tanım yanıtı.
UserDataFunctionPublicDefinition	UserDataFunction genel tanım nesnesi. UserDataFunction tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.
UserDataFunctionPublicDefinitionPart	UserDataFunction tanımı parça nesnesi.

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

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

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.

UserDataFunctionDefinitionResponse

Nesne

UserDataFunction genel tanım yanıtı.

Name	Tür	Description
definition	UserDataFunctionPublicDefinition	UserDataFunction genel tanım nesnesi. UserDataFunction tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

UserDataFunctionPublicDefinition

Nesne

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

Name	Tür	Description
format	string	Kullanıcı verileri işlev tanımının biçimi.
parts	UserDataFunctionPublicDefinitionPart[]	Tanım bölümlerinin listesi.

UserDataFunctionPublicDefinitionPart

Nesne

UserDataFunction tanımı parça nesnesi.

Name	Tür	Description
path	string	UserDataFunction genel tanımı bölüm yolu.
payload	string	UserDataFunction genel tanımı parça yükü.
payloadType	PayloadType	Yük türü.