Pool - Update Properties

Başvuru

Hizmet:: Batch Service

API Sürümü:: 2024-07-01.20.0

Belirtilen Havuzun özelliklerini güncelleştirir.
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=2024-07-01.20.0

İsteğe bağlı parametrelerle:

POST {batchUrl}/pools/{poolId}/updateproperties?timeout={timeout}&api-version=2024-07-01.20.0

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
batchUrl	path	True	string	Tüm Azure Batch hizmet isteklerinin temel URL'si.
poolId	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 cinsinden). Varsayılan değer 30 saniyedir. Değer 30'dan büyükse, bunun yerine varsayılan değer kullanılır.

İstek Başlığı

Media Types: "application/json; odata=minimalmetadata"

Name	Tür	Description
client-request-id	string (uuid)	Arayan tarafından oluşturulan istek kimliği, küme ayraçları gibi süslemesi olmayan bir GUID biçiminde, ö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	ApplicationPackageReference[]	Havuzdaki her İşlem Düğümüne yüklenecek Uygulama Paketlerinin listesi. Liste, Havuzdaki mevcut Uygulama Paketi başvurularının yerini alır. Uygulama Paketi başvurularındaki değişiklikler Havuza katılan tüm yeni İşlem Düğümlerini etkiler, ancak yeniden başlatılana veya yeniden tasarlanana kadar Havuzda bulunan İşlem Düğümlerini etkilemez. Belirli bir Havuzda en fazla 10 Uygulama Paketi başvurusu vardır. Atlanırsa veya boş bir koleksiyon belirtirseniz, mevcut Tüm Uygulama Paketleri başvuruları Havuzdan kaldırılır. Belirli bir Havuzda en fazla 10 başvuru belirtilebilir.
certificateReferences	True	CertificateReference[]	Havuzdaki her İşlem Düğümüne yüklenecek Sertifikaların listesi. Bu liste, Havuz'da yapılandırılan tüm mevcut Sertifika başvurularının yerini alır. Boş bir koleksiyon belirtirseniz, var olan tüm Sertifika başvuruları Havuzdan kaldırılır. Windows Düğümleri için Batch hizmeti Sertifikaları belirtilen Sertifika deposuna ve konumuna yükler. Linux İşlem Düğümleri için Sertifikalar Görev çalışma dizini içindeki bir dizinde depolanır ve bu konumu sorgulamak üzere Göreve AZ_BATCH_CERTIFICATES_DIR bir ortam değişkeni sağlanır. 'remoteUser' görünürlüğüne sahip sertifikalar için, kullanıcının giriş dizininde bir 'certs' dizini oluşturulur (örneğin, /home/{user-name}/certs) ve Sertifikalar bu dizine yerleştirilir. Uyarı: Bu özellik kullanım dışı bırakıldı ve Şubat 2024'den sonra kaldırılacak. Bunun yerine Azure KeyVault Uzantısı kullanın.
metadata	True	MetadataItem[]	Havuz ile meta veri olarak ilişkili ad-değer çiftlerinin listesi. Bu liste, Havuz'da yapılandırılan mevcut meta verilerin yerini alır. Atlanırsa veya boş bir koleksiyon belirtirseniz, mevcut meta veriler Havuzdan kaldırılır.
startTask		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. Bu öğe varsa, var olan Tüm StartTask'ın üzerine yazar. Atlanırsa, mevcut Tüm StartTask Havuz'dan kaldırılır.
targetNodeCommunicationMode		NodeCommunicationMode	Havuz için istenen düğüm iletişim modu. Bu ayar, Havuzdaki mevcut targetNodeCommunication ayarının yerini alır. Atlanırsa, mevcut ayar varsayılan ayardır.

Yanıtlar

Name	Tür	Description
204 No Content		Batch hizmetine yapılan istek başarılı oldu. Üst Bilgiler client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch hizmetinden gelen hata.

Name

Tür

Description

204 No Content

Batch hizmetine yapılan istek başarılı oldu.

Üst Bilgiler

client-request-id: string
request-id: string
ETag: string
Last-Modified: string
DataServiceId: string

Other Status Codes

BatchError

Batch hizmetinden gelen hata.

Güvenlik

azure_auth

Microsoft Entra OAuth 2.0 kimlik doğrulama kodu akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	Kullanıcı hesabınızın kimliğine bürünme

Authorization

Tür: apiKey
İçinde: header

Örnekler

Pool update

Örnek isteği

HTTP

POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0



{
  "startTask": {
    "commandLine": "/bin/bash -c 'echo start task'"
  },
  "certificateReferences": [],
  "applicationPackageReferences": [],
  "metadata": []
}

Örnek yanıt

Durum kodu:: 204

Tanımlar

Name	Description
ApplicationPackageReference	İşlem Düğümlerine dağıtılacak paket başvurusu.
AutoUserScope	Otomatik kullanıcının kapsamı
AutoUserSpecification	Batch hizmetinde görev çalıştıran otomatik kullanıcının parametrelerini belirtir.
BatchError	Azure Batch hizmetinden alınan bir hata yanıtı.
BatchErrorDetail	Azure Batch hata yanıtına dahil edilen ek bilgilerden oluşan bir öğe.
CertificateReference	Havuzdaki İşlem Düğümlerine yüklenecek sertifika başvurusu.
CertificateStoreLocation	sertifikanın yükleneceği İşlem Düğümündeki Sertifika deposunun konumu.
CertificateVisibility	İşlem Düğümündeki hangi kullanıcı hesaplarının Sertifikanın özel verilerine erişimi olmalıdır.
ComputeNodeIdentityReference	İşlem düğümlerinin kullanacağı Batch havuzuyla ilişkili kullanıcı tarafından atanan kimliğe başvuru.
ContainerHostBatchBindMountEntry	Görev kapsayıcısına bağlamak istediğiniz yol ve bağlama modunun girişi.
ContainerHostDataPath	Kapsayıcı görevinin kapsayıcısına bağlanacak yollar.
ContainerRegistry	Özel bir kapsayıcı kayıt defteri.
ContainerWorkingDirectory	Kapsayıcı Görev çalışma dizininin konumu.
ElevationLevel	Kullanıcının yükseltme düzeyi.
EnvironmentSetting	Görev işleminde ayarlanacak ortam değişkeni.
ErrorMessage	Azure Batch hata yanıtında bir hata iletisi alındı.
MetadataItem	Batch hizmet kaynağıyla ilişkilendirilmiş bir ad-değer çifti.
NodeCommunicationMode	Bir havuzun Batch hizmetiyle nasıl iletişim kurdığını belirler.
PoolUpdatePropertiesParameter	Havuzda yapılacak değişiklikler kümesi.
ResourceFile	İşlem Düğümüne indirilecek tek bir dosya veya birden çok dosya.
StartTask	Bir Düğüm Azure Batch hizmetindeki bir Havuza katıldığında veya İşlem Düğümü yeniden başlatıldığında veya yeniden oluşturulduğunda çalıştırılan görev.
TaskContainerSettings	Görev için kapsayıcı ayarları.
UserIdentity	Görevin çalıştırıldığı kullanıcı kimliğinin tanımı.

ApplicationPackageReference

Object

İşlem Düğümlerine dağıtılacak paket başvurusu.

Name	Tür	Description
applicationId	string	Dağıtılacak uygulamanın kimliği. Havuz oluştururken paketin uygulama kimliği tam (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}) olmalıdır.
version	string	Dağıtılacak uygulamanın sürümü. Atlanırsa, varsayılan sürüm dağıtılır. Bu bir Havuzda atlanırsa ve bu uygulama için varsayılan sürüm belirtilmezse, istek InvalidApplicationPackageReferences ve HTTP durum kodu 409 hata koduyla başarısız olur. Bir Görevde bu belirtilmezse ve bu uygulama için varsayılan sürüm belirtilmezse, Görev ön işleme hatasıyla başarısız olur.

AutoUserScope

Listeleme

Otomatik kullanıcının kapsamı

Değer	Description
pool	Görevin bir Havuzdaki her İşlem Düğümünde oluşturulan ortak otomatik kullanıcı Hesabı olarak çalıştırıldığını belirtir.
task	Hizmetin Görev için yeni bir kullanıcı oluşturması gerektiğini belirtir.

AutoUserSpecification

Object

Batch hizmetinde görev çalıştıran otomatik kullanıcının parametrelerini belirtir.

Name	Tür	Description
elevationLevel	ElevationLevel	Otomatik kullanıcının yükseltme düzeyi. Varsayılan değer nonAdmin'dir.
scope	AutoUserScope	Otomatik kullanıcının kapsamı Varsayılan değer havuzdur. Havuz Windows çalıştırıyorsa, görevler arasında daha sıkı yalıtım gerekiyorsa Görev değeri belirtilmelidir. Örneğin, görev kayıt defterini diğer görevleri etkileyebilecek bir şekilde sessize alırsa veya havuzda normal görevler tarafından erişilemeyen ancak StartTasks tarafından erişilebilir olması gereken sertifikalar belirtilmişse.

BatchError

Object

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	ErrorMessage	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
values	BatchErrorDetail[]	Hata hakkında ek ayrıntılar içeren anahtar-değer çiftleri koleksiyonu.

BatchErrorDetail

Object

Azure Batch hata yanıtına dahil edilen 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

Object

Havuzdaki İşlem Düğümlerine yüklenecek sertifika başvurusu.

Name	Tür	Description
storeLocation	CertificateStoreLocation	sertifikanın yükleneceği İşlem Düğümündeki Sertifika deposunun konumu. Varsayılan değer currentuser'dır. Bu özellik yalnızca Windows İşlem Düğümleri ile yapılandırılan Havuzlar için geçerlidir. Linux İşlem Düğümleri için Sertifikalar Görev çalışma dizini içindeki bir dizinde depolanır ve bu konumu sorgulamak üzere Göreve AZ_BATCH_CERTIFICATES_DIR bir ortam değişkeni sağlanır. 'remoteUser' görünürlüğüne sahip sertifikalar için, kullanıcının giriş dizininde bir 'certs' dizini oluşturulur (örneğin, /home/{user-name}/certs) ve Sertifikalar bu dizine yerleştirilir.
storeName	string	Sertifikanın yükleneceği İşlem Düğümündeki Sertifika deposunun adı. Bu özellik yalnızca Windows İşlem Düğümleri ile yapılandırılan Havuzlar için geçerlidir. Yaygın depo adları şunlardır: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, ancak herhangi bir özel mağaza adı da kullanılabilir. Varsayılan değer My değeridir.
thumbprint	string	Sertifikanın parmak izi.
thumbprintAlgorithm	string	Parmak izinin ilişkilendirildiği algoritma. Bu sha1 olmalı.
visibility	CertificateVisibility[]	İşlem Düğümündeki hangi kullanıcı hesaplarının Sertifikanın özel verilerine erişimi olmalıdır. Bu koleksiyonda birden fazla görünürlük belirtebilirsiniz. Varsayılan değer tüm Hesaplar'dır.

CertificateStoreLocation

Listeleme

sertifikanın yükleneceği İşlem Düğümündeki Sertifika deposunun konumu.

Değer	Description
currentuser	Sertifikaların CurrentUser Sertifika deposuna yüklenmesi gerekir.
localmachine	Sertifikalar LocalMachine Sertifika deposuna yüklenmelidir.

CertificateVisibility

Listeleme

İşlem Düğümündeki hangi kullanıcı hesaplarının Sertifikanın özel verilerine erişimi olmalıdır.

Değer	Description
remoteuser	Sertifika, kullanıcıların İşlem Düğümü'ne uzaktan erişen kullanıcı hesaplarına görünür olmalıdır.
starttask	Sertifika, StartTask'ın çalıştırıldığı kullanıcı hesabına görünür olmalıdır. Otomatik Kullanıcı Kapsamı hem StartTask hem de Görev için Havuz ise, bu sertifikanın Görev tarafından da görüleceğini unutmayın.
task	Sertifika, İş Görevlerinin çalıştırıldığı kullanıcı hesaplarına görünür olmalıdır.

ComputeNodeIdentityReference

Object

İş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.

ContainerHostBatchBindMountEntry

Object

Görev kapsayıcısına bağlamak istediğiniz yol ve bağlama modunun girişi.

Name	Tür	Description
isReadOnly	boolean	Bu kaynak yolu salt okunur mod olarak bağlayın veya bağlamayın. Varsayılan değer false (okuma/yazma modu). Linux için bu yolu okuma/yazma modu olarak bağlarsanız bu, kapsayıcıdaki tüm kullanıcıların yol için okuma/yazma erişimine sahip olduğu anlamına gelmez; konak VM'deki erişime bağlıdır. Bu yol salt okunur olarak bağlanırsa, kapsayıcıdaki tüm kullanıcılar yolu değiştiremez.
source	ContainerHostDataPath	Kapsayıcı müşterisine bağlanacak yol seçilebilir.

ContainerHostDataPath

Listeleme

Kapsayıcı görevinin kapsayıcısına bağlanacak yollar.

Değer	Description
Applications	Uygulama yolu.
JobPrep	İş hazırlama görev yolu.
Shared	Çok örnekli görevin dosyalarını paylaşma yolu.
Startup	Başlangıç görevinin yolu.
Task	Görev yolu.
VfsMounts	Yol, bu düğüme bağlı olan tüm sanal dosya sistemlerini içerir.

ContainerRegistry

Object

Özel bir kapsayıcı kayıt defteri.

Name	Tür	Description
identityReference	ComputeNodeIdentityReference	Kullanıcı adı ve parola yerine Azure Container Registry'ye erişmek için kullanılacak kullanıcı tarafından atanan kimliğe başvuru. İşlem düğümlerinin kullanacağı Batch havuzuyla ilişkili 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. Atlanırsa, varsayılan değer "docker.io"dir.
username	string	Kayıt defteri sunucusunda oturum açmak için kullanıcı adı.

ContainerWorkingDirectory

Listeleme

Kapsayıcı Görev çalışma dizininin konumu.

Değer	Description
containerImageDefault	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	Batch tarafından doldurulan Görev Kaynak Dosyalarını içeren standart Batch hizmeti Görev çalışma dizinini kullanın.

ElevationLevel

Listeleme

Kullanıcının yükseltme düzeyi.

Değer	Description
admin	Kullanıcı, yükseltilmiş erişimi olan bir kullanıcıdır ve tam Yönetici izinleriyle çalışır.
nonadmin	Kullanıcı, yükseltilmiş erişimi olmayan standart bir kullanıcıdır.

EnvironmentSetting

Object

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

Object

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

Object

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

Listeleme

Bir havuzun Batch hizmetiyle nasıl iletişim kurdığını belirler.

Değer	Description
classic	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ı noktasına giden TCP iletişimi. {region}" hizmet etiketleri.
default	Düğüm iletişim modu Batch hizmeti tarafından otomatik olarak ayarlanır.
simplified	Basitleştirilmiş iletişim modunu kullanan düğümler, 443 numaralı bağlantı noktasında "BatchNodeManagement" ile giden TCP iletişimi gerektirir. {region}" hizmet etiketi. Açık gelen bağlantı noktası gerekmez.