Pool - Resize

Service:

Batch Service

API Version:

2023-11-01.18.0

Havuza atanan İşlem Düğümlerinin sayısını değiştirir.
Havuzu yalnızca ayırma durumu sabit olduğunda yeniden boyutlandırabilirsiniz. Havuz zaten yeniden boyutlandırılıyorsa istek 409 durum koduyla başarısız olur. Havuzu yeniden boyutlandırdığınızda Havuzun ayırma durumu sabitten yeniden boyutlandırmaya dönüşür. Otomatik ölçeklendirme için yapılandırılmış havuzları yeniden boyutlandıramazsınız. Bunu yapmayı denerseniz, Batch hizmeti 409 hatasını döndürür. Havuzu aşağı doğru yeniden boyutlandırırsanız, Batch hizmeti hangi İşlem Düğümlerinin kaldırılacağını seçer. Belirli İşlem Düğümlerini kaldırmak için havuz kaldırma İşlem Düğümleri API'sini kullanın.

POST {batchUrl}/pools/{poolId}/resize?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/resize?timeout={timeout}&api-version=2023-11-01.18.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	Yeniden boyutlandıracak 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.
If-Match		string	İstemci tarafından bilinen kaynağın sürümüyle ilişkili bir ETag değeri. İşlem yalnızca kaynağın hizmetteki geçerli ETag değeri istemci tarafından belirtilen değerle tam olarak eşleşiyorsa gerçekleştirilir.
If-None-Match		string	İstemci tarafından bilinen kaynağın sürümüyle ilişkili bir ETag değeri. İşlem yalnızca kaynağın hizmetteki geçerli ETag'i istemci tarafından belirtilen değerle eşleşmiyorsa gerçekleştirilir.
If-Modified-Since		string date-time-rfc1123	İstemci tarafından bilinen kaynağın son değiştirilme zamanını gösteren zaman damgası. İşlem yalnızca hizmet üzerindeki kaynak belirtilen süreden sonra değiştirilmişse gerçekleştirilir.
If-Unmodified-Since		string date-time-rfc1123	İstemci tarafından bilinen kaynağın son değiştirilme zamanını gösteren zaman damgası. İşlem yalnızca hizmet üzerindeki kaynak belirtilen süreden sonra değiştirilmediyse gerçekleştirilir.

İstek Gövdesi

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

Name	Tür	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Havuz boyutu azaldıysa İşlem Düğümü ve çalışan görevleriyle ne yapacağını belirler. Varsayılan değer yeniden kuyruru.
resizeTimeout	string	Düğümlerin Havuza ayrılması veya İşlem Düğümlerinin Havuzdan kaldırılması için zaman aşımı. Varsayılan değer 15 dakikadır. En düşük değer 5 dakikadır. 5 dakikadan kısa bir değer belirtirseniz, Batch hizmeti bir hata döndürür; REST API'yi doğrudan çağırıyorsanız HTTP durum kodu 400'dür (Hatalı İstek).
targetDedicatedNodes	integer	Havuzdaki ayrılmış İşlem Düğümlerinin istenen sayısı.
targetLowPriorityNodes	integer	Havuzdaki spot/düşük öncelikli işlem düğümlerinin istenen sayısı.

Yanıtlar

Name	Tür	Description
202 Accepted		Batch hizmetine yapılan istek başarılı oldu. Headers 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

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 resize

Sample Request

HTTP

POST account.region.batch.azure.com/pools/resizePool/resize?api-version=2023-11-01.18.0



{
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Sample Response

Status code:

202

Tanımlar

Name	Description
BatchError	Azure Batch hizmetinden alınan bir hata yanıtı.
BatchErrorDetail	Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.
ComputeNodeDeallocationOption	Serbest bırakma için seçildikten sonra İşlem Düğümü ve çalışan görevleriyle ne yapacağını belirler.
ErrorMessage	Azure Batch hata yanıtında bir hata iletisi alındı.
PoolResizeParameter	Havuzun boyutunu değiştirme seçenekleri.

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	ErrorMessage	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
values	BatchErrorDetail[]	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.

ComputeNodeDeallocationOption

Serbest bırakma için seçildikten sonra İşlem Düğümü ve çalışan görevleriyle ne yapacağını belirler.

Name	Tür	Description
requeue	string	Çalışan Görev işlemlerini sonlandırın ve Görevleri yeniden sıraya alın. İşlem Düğümü kullanılabilir olduğunda Görevler yeniden çalışır. Görevler sonlandırılır sonlandırılmaz İşlem Düğümlerini kaldırın.
retaineddata	string	Çalışmakta olan Görevlerin tamamlanmasına izin verin, ardından tüm Görev verileri saklama sürelerinin dolmasını bekleyin. Beklerken yeni Görev zamanlama. Tüm Görev saklama sürelerinin süresi dolduğunda İşlem Düğümlerini kaldırın.
taskcompletion	string	Çalışmakta olan Görevlerin tamamlanmasına izin verin. Beklerken yeni Görev zamanlama. Tüm Görevler tamamlandığında İşlem Düğümlerini kaldırın.
terminate	string	Çalışan Görevleri sonlandır. Görevler, sonlandırıldıklarını belirten failureInfo ile tamamlanır ve yeniden çalıştırılmaz. Görevler sonlandırılır sonlandırılmaz İşlem Düğümlerini kaldırın.

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.

PoolResizeParameter

Havuzun boyutunu değiştirme seçenekleri.

Name	Tür	Description
nodeDeallocationOption	ComputeNodeDeallocationOption	Havuz boyutu azaldıysa İşlem Düğümü ve çalışan görevleriyle ne yapacağını belirler. Varsayılan değer yeniden kuyruru.
resizeTimeout	string	Düğümlerin Havuza ayrılması veya İşlem Düğümlerinin Havuzdan kaldırılması için zaman aşımı. Varsayılan değer 15 dakikadır. En düşük değer 5 dakikadır. 5 dakikadan kısa bir değer belirtirseniz, Batch hizmeti bir hata döndürür; REST API'yi doğrudan çağırıyorsanız HTTP durum kodu 400'dür (Hatalı İstek).
targetDedicatedNodes	integer	Havuzdaki ayrılmış İşlem Düğümlerinin istenen sayısı.
targetLowPriorityNodes	integer	Havuzdaki spot/düşük öncelikli işlem düğümlerinin istenen sayısı.