Pool - Update Properties
Belirtilen Havuzun özelliklerini Güncelleştirmeler.
Bu, Havuzun tüm güncelleştirilebilir özelliklerinin yerini alır. Örneğin, Havuz ile ilişkilendirilmiş bir StartTask varsa ve StartTask bu istekle belirtilmezse, Batch hizmeti mevcut StartTask'ı kaldırır.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2023-11-01.18.0
POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2023-11-01.18.0
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Tüm Azure Batch hizmet isteklerinin temel URL'si. |
pool
|
path | True |
string |
Güncelleştirilecek havuzun kimliği. |
api-version
|
query | True |
string |
İstemci API Sürümü. |
timeout
|
query |
integer int32 |
Sunucunun isteği işlemek için harcayabileceği en uzun süre (saniye olarak). Varsayılan değer 30 saniyedir. |
İstek Başlığı
Media Types: "application/json; odata=minimalmetadata"
Name | Gerekli | Tür | Description |
---|---|---|---|
client-request-id |
string uuid |
Çağıran tarafından oluşturulan istek kimliği, küme ayraçları gibi dekorasyonu olmayan bir GUID biçimindedir; örneğin 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Sunucunun yanıtta client-request-id döndürip döndürmeyeceği. |
|
ocp-date |
string date-time-rfc1123 |
İsteğin verildiği saat. İstemci kitaplıkları bunu genellikle geçerli sistem saat saatine ayarlar; REST API'yi doğrudan çağırıyorsanız açıkça ayarlayın. |
İstek Gövdesi
Media Types: "application/json; odata=minimalmetadata"
Name | Gerekli | Tür | Description |
---|---|---|---|
applicationPackageReferences | True |
Havuzdaki her İşlem Düğümüne yüklenecek Uygulama Paketlerinin listesi. |
|
certificateReferences | True |
Havuzdaki her İşlem Düğümüne yüklenecek Sertifikaların listesi. Uyarı: Bu özellik kullanım dışıdır ve Şubat 2024'den sonra kaldırılacaktır. Lütfen bunun yerine Azure KeyVault Uzantısını kullanın. |
|
metadata | True |
Havuz ile meta veri olarak ilişkili ad-değer çiftlerinin listesi. |
|
startTask |
Havuza katıldığında her İşlem Düğümünde çalıştırılacak bir Görev. Görev, İşlem Düğümü Havuza eklendiğinde veya İşlem Düğümü yeniden başlatıldığında çalışır. |
||
targetNodeCommunicationMode |
Havuz için istenen düğüm iletişim modu. |
Yanıtlar
Name | Tür | Description |
---|---|---|
204 No Content |
Batch hizmetine yapılan istek başarılı oldu. Headers
|
|
Other Status Codes |
Batch hizmetinden gelen hata. |
Güvenlik
azure_auth
OAuth 2.0 kimlik doğrulama kodu akışını Microsoft Entra
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Kullanıcı hesabınızın kimliğine bürünme |
Authorization
Type:
apiKey
In:
header
Örnekler
Pool update
Sample Request
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2023-11-01.18.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
Sample Response
Tanımlar
Name | Description |
---|---|
Application |
İşlem Düğümlerine dağıtılacak bir Paket başvurusu. |
Auto |
Otomatik kullanıcının kapsamı |
Auto |
Batch hizmetinde görev çalıştıran otomatik kullanıcının parametrelerini belirtir. |
Batch |
Azure Batch hizmetinden alınan bir hata yanıtı. |
Batch |
Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe. |
Certificate |
Havuzdaki İşlem Düğümlerine yüklenecek sertifika başvurusu. |
Certificate |
İşlem Düğümünde Sertifika deposunun sertifikanın yükleneceği konum. |
Certificate |
İşlem Düğümündeki hangi kullanıcı hesaplarının Sertifikanın özel verilerine erişimi olmalıdır. |
Compute |
İşlem düğümlerinin kullanacağı Batch havuzuyla ilişkili kullanıcı tarafından atanan kimliğe başvuru. |
Container |
Özel kapsayıcı kayıt defteri. |
Container |
Kapsayıcı Görev çalışma dizininin konumu. |
Elevation |
Kullanıcının yükseltme düzeyi. |
Environment |
Görev işleminde ayarlanacak ortam değişkeni. |
Error |
Azure Batch hata yanıtında bir hata iletisi alındı. |
Metadata |
Batch hizmet kaynağıyla ilişkilendirilmiş bir ad-değer çifti. |
Node |
Havuzun Batch hizmetiyle nasıl iletişim kurdığını belirler. |
Pool |
Havuzda yapılacak değişiklik kümesi. |
Resource |
İşlem Düğümüne indirilecek tek bir dosya veya birden çok dosya. |
Start |
Düğüm Azure Batch hizmetindeki bir Havuza katıldığında veya İşlem Düğümü yeniden başlatıldığında veya yeniden başlatıldığında çalıştırılan görev. |
Task |
Görevin kapsayıcı ayarları. |
User |
Görevin altında çalıştırıldığı kullanıcı kimliğinin tanımı. |
ApplicationPackageReference
İşlem Düğümlerine dağıtılacak bir Paket başvurusu.
Name | Tür | Description |
---|---|---|
applicationId |
string |
Dağıtılacak uygulamanın kimliği. |
version |
string |
Dağıtılacak uygulamanın sürümü. Atlanırsa, varsayılan sürüm dağıtılır. |
AutoUserScope
Otomatik kullanıcının kapsamı
Name | Tür | Description |
---|---|---|
pool |
string |
Görevin, havuzdaki her İşlem Düğümünde oluşturulan ortak otomatik kullanıcı hesabı olarak çalıştırıldığını belirtir. |
task |
string |
Hizmetin Görev için yeni bir kullanıcı oluşturması gerektiğini belirtir. |
AutoUserSpecification
Batch hizmetinde görev çalıştıran otomatik kullanıcının parametrelerini belirtir.
Name | Tür | Description |
---|---|---|
elevationLevel |
Otomatik kullanıcının yükseltme düzeyi. |
|
scope |
Otomatik kullanıcının kapsamı |
BatchError
Azure Batch hizmetinden alınan bir hata yanıtı.
Name | Tür | Description |
---|---|---|
code |
string |
Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır. |
message |
Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti. |
|
values |
Hatayla ilgili ek ayrıntıları içeren anahtar-değer çiftleri koleksiyonu. |
BatchErrorDetail
Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.
Name | Tür | Description |
---|---|---|
key |
string |
Value özelliğinin anlamını belirten tanımlayıcı. |
value |
string |
Hata yanıtına eklenen ek bilgiler. |
CertificateReference
Havuzdaki İşlem Düğümlerine yüklenecek sertifika başvurusu.
Name | Tür | Description |
---|---|---|
storeLocation |
Sertifikanın yükleneceği İşlem Düğümündeki Sertifika deposunun konumu. |
|
storeName |
string |
Sertifikanın yükleneceği İşlem Düğümündeki Sertifika deposunun adı. |
thumbprint |
string |
Sertifikanın parmak izi. |
thumbprintAlgorithm |
string |
Parmak izinin ilişkilendirildiği algoritma. Bu sha1 olmalı. |
visibility |
İşlem Düğümündeki hangi kullanıcı Hesaplarının Sertifikanın özel verilerine erişimi olmalıdır. |
CertificateStoreLocation
İşlem Düğümünde Sertifika deposunun sertifikanın yükleneceği konum.
Name | Tür | Description |
---|---|---|
currentuser |
string |
Sertifikaların CurrentUser Sertifika deposuna yüklenmesi gerekir. |
localmachine |
string |
Sertifikalar LocalMachine Sertifika deposuna yüklenmelidir. |
CertificateVisibility
İşlem Düğümündeki hangi kullanıcı hesaplarının Sertifikanın özel verilerine erişimi olmalıdır.
Name | Tür | Description |
---|---|---|
remoteuser |
string |
Sertifika, kullanıcıların İşlem Düğümü'ne uzaktan erişecekleri kullanıcı hesaplarına görünür olmalıdır. |
starttask |
string |
Sertifika, StartTask'ın altında çalıştırıldığı kullanıcı hesabına görünür olmalıdır. AutoUser Kapsamı hem StartTask hem de Görev için Pool ise, bu sertifikanın Görev tarafından da görüleceğini unutmayın. |
task |
string |
Sertifika, altında İş Görevlerinin çalıştırıldığı kullanıcı hesaplarına görünür olmalıdır. |
ComputeNodeIdentityReference
İşlem düğümlerinin kullanacağı Batch havuzuyla ilişkili kullanıcı tarafından atanan kimliğe başvuru.
Name | Tür | Description |
---|---|---|
resourceId |
string |
Kullanıcı tarafından atanan kimliğin ARM kaynak kimliği. |
ContainerRegistry
Özel kapsayıcı kayıt defteri.
Name | Tür | Description |
---|---|---|
identityReference |
Kullanıcı adı ve parola yerine bir Azure Container Registry erişmek için kullanılacak kullanıcı tarafından atanan kimliğe başvuru. |
|
password |
string |
Kayıt defteri sunucusunda oturum açma parolası. |
registryServer |
string |
Kayıt defteri URL'si. |
username |
string |
Kayıt defteri sunucusunda oturum açmak için kullanıcı adı. |
ContainerWorkingDirectory
Kapsayıcı Görev çalışma dizininin konumu.
Name | Tür | Description |
---|---|---|
containerImageDefault |
string |
Kapsayıcı görüntüsünde tanımlanan çalışma dizinini kullanın. Bu dizinin Batch tarafından indirilen Kaynak Dosyalarını içermeyeceğini dikkate alın. |
taskWorkingDirectory |
string |
Batch tarafından doldurulan Görev Kaynak Dosyalarını içeren standart Batch hizmeti Görev çalışma dizinini kullanın. |
ElevationLevel
Kullanıcının yükseltme düzeyi.
Name | Tür | Description |
---|---|---|
admin |
string |
Kullanıcı, yükseltilmiş erişimi olan bir kullanıcıdır ve tam Yönetici izinleriyle çalışır. |
nonadmin |
string |
Kullanıcı, yükseltilmiş erişimi olmayan standart bir kullanıcıdır. |
EnvironmentSetting
Görev işleminde ayarlanacak ortam değişkeni.
Name | Tür | Description |
---|---|---|
name |
string |
Ortam değişkeninin adı. |
value |
string |
Ortam değişkeninin değeri. |
ErrorMessage
Azure Batch hata yanıtında bir hata iletisi alındı.
Name | Tür | Description |
---|---|---|
lang |
string |
Hata iletisinin dil kodu |
value |
string |
İletinin metni. |
MetadataItem
Batch hizmet kaynağıyla ilişkilendirilmiş bir ad-değer çifti.
Name | Tür | Description |
---|---|---|
name |
string |
Meta veri öğesinin adı. |
value |
string |
Meta veri öğesinin değeri. |
NodeCommunicationMode
Havuzun Batch hizmetiyle nasıl iletişim kurdığını belirler.
Name | Tür | Description |
---|---|---|
classic |
string |
Klasik iletişim modunu kullanan düğümler, "BatchNodeManagement" bağlantı noktalarından 29876 ve 29877 numaralı bağlantı noktalarında gelen TCP iletişimi gerektirir. {region}" hizmet etiketi ve 443 numaralı bağlantı noktasından "Storage.region" ve "BatchNodeManagement" bağlantı noktalarına giden TCP iletişimi. {region}" hizmet etiketleri. |
default |
string |
Düğüm iletişim modu Batch hizmeti tarafından otomatik olarak ayarlanır. |
simplified |
string |
Basitleştirilmiş iletişim modunu kullanan düğümler, 443 numaralı bağlantı noktasından "BatchNodeManagement"a giden TCP iletişimi gerektirir. {region}" hizmet etiketi. Açık gelen bağlantı noktası gerekmez. |
PoolUpdatePropertiesParameter
Havuzda yapılacak değişiklik kümesi.
Name | Tür | Description |
---|---|---|
applicationPackageReferences |
Havuzdaki her İşlem Düğümüne yüklenecek Uygulama Paketlerinin listesi. |
|
certificateReferences |
Havuzdaki her İşlem Düğümüne yüklenecek Sertifikaların listesi. Uyarı: Bu özellik kullanım dışı bırakıldı ve Şubat 2024'den sonra kaldırılacak. Lütfen bunun yerine Azure KeyVault Uzantısı'nı kullanın. |
|
metadata |
Havuz ile meta veri olarak ilişkili ad-değer çiftlerinin listesi. |
|
startTask |
Havuza katıldığında her İşlem Düğümünde çalıştırılacak bir Görev. Görev, İşlem Düğümü Havuza eklendiğinde veya İşlem Düğümü yeniden başlatıldığında çalışır. |
|
targetNodeCommunicationMode |
Havuz için istenen düğüm iletişim modu. |
ResourceFile
İşlem Düğümüne indirilecek tek bir dosya veya birden çok dosya.
Name | Tür | Description |
---|---|---|
autoStorageContainerName |
string |
Otomatik depolama hesabındaki depolama kapsayıcısı adı. |
blobPrefix |
string |
Azure Depolama kapsayıcısından blob indirirken kullanılacak blob ön eki. Yalnızca adları belirtilen ön ek ile başlayan bloblar indirilir. |
fileMode |
string |
Sekizli biçimde dosya izin modu özniteliği. |
filePath |
string |
İşlem Düğümünde, Görevin çalışma dizinine göre dosyaları indirebileceğiniz konum. |
httpUrl |
string |
İndirilmesi gereken dosyanın URL'si. |
identityReference |
storageContainerUrl veya httpUrl tarafından belirtilen Azure Blob Depolama erişmek için kullanılacak kullanıcı tarafından atanan kimliğe başvuru |
|
storageContainerUrl |
string |
Azure Blob Depolama içindeki blob kapsayıcısının URL'si. |
StartTask
Düğüm Azure Batch hizmetindeki bir Havuza katıldığında veya İşlem Düğümü yeniden başlatıldığında veya yeniden başlatıldığında çalıştırılan görev.
Name | Tür | Description |
---|---|---|
commandLine |
string |
StartTask komut satırı. |
containerSettings |
StartTask'ın altında çalıştığı kapsayıcının ayarları. |
|
environmentSettings |
StartTask için ortam değişkeni ayarlarının listesi. |
|
maxTaskRetryCount |
integer |
Görevin yeniden denenebileceği en fazla sayı. |
resourceFiles |
Batch hizmetinin komut satırını çalıştırmadan önce İşlem Düğümü'ne indireceği dosyaların listesi. Kaynak dosyaları listesi için boyut üst sınırı vardır. Maksimum boyut aşıldığında istek başarısız olur ve yanıt hata kodu RequestEntityTooLarge olur. Bu durumda ResourceFiles koleksiyonunun boyutu azaltılmalıdır. Bu, .zip dosyaları, Uygulama Paketleri veya Docker Kapsayıcıları kullanılarak elde edilebilir. |
|
userIdentity |
StartTask'ın altında çalıştığı kullanıcı kimliği. |
|
waitForSuccess |
boolean |
Batch hizmetinin İşlem Düğümünde herhangi bir Görevi zamanlamadan önce StartTask'ın başarıyla tamamlanmasını (yani çıkış kodu 0 ile çıkmak için) beklemesi gerekip gerekmediği. |
TaskContainerSettings
Görevin kapsayıcı ayarları.
Name | Tür | Description |
---|---|---|
containerRunOptions |
string |
Kapsayıcı oluşturma komutuna ek seçenekler. |
imageName |
string |
Görevin çalıştırılacağı kapsayıcıyı oluşturmak için kullanılacak Görüntü. |
registry |
Kapsayıcı görüntüsünü içeren özel kayıt defteri. |
|
workingDirectory |
Görev çalışma dizini kapsayıcısının konumu. |
UserIdentity
Görevin altında çalıştırıldığı kullanıcı kimliğinin tanımı.
Name | Tür | Description |
---|---|---|
autoUser |
Görevin altında çalıştırıldığı otomatik kullanıcı. |
|
username |
string |
Görevin altında çalıştırıldığı kullanıcı kimliğinin adı. |