JobOperations Sınıf

JobOperations işlemleri.

Doğrudan bu sınıfın örneğini oluşturmamalı, ancak sizin için oluşturacak ve öznitelik olarak ekleyecek bir İstemci örneği oluşturmalısınız.

Devralma
builtins.object
JobOperations

Oluşturucu

JobOperations(client, config, serializer, deserializer)

Parametreler

client
Gerekli

Hizmet istekleri için istemci.

config
Gerekli

Hizmet istemcisi yapılandırması.

serializer
Gerekli

Nesne modeli seri hale getirici.

deserializer
Gerekli

Nesne modeli seri durumdan çıkarıcı.

Değişkenler

api_version

İstek için kullanılacak API sürümü. Sabit değer: "2023-05-01.17.0".

Yöntemler

add

Belirtilen Hesaba bir İş ekler.

Batch hizmeti, bir işin parçası olarak yapılan işi denetlemenin iki yolunu destekler. İlk yaklaşımda kullanıcı bir İş Yöneticisi Görevi belirtir. Batch hizmeti, İşi başlatmaya hazır olduğunda bu Görevi başlatır. İş Yöneticisi Görevi, Görev API'lerini kullanarak bu İş altında çalışan diğer tüm Görevleri denetler. İkinci yaklaşımda kullanıcı, Görev API'lerini kullanarak etkin bir İş altında Görevlerin yürütülmesini doğrudan denetler. Ayrıca unutmayın: İşleri adlandırırken, kullanıcı adları veya gizli proje adları gibi hassas bilgileri dahil etmekten kaçının. Bu bilgiler, Microsoft Desteği mühendislerin erişebildiği telemetri günlüklerinde görünebilir.

delete

bir İşi siler.

Bir işin silinmesi, bu İşin parçası olan tüm Görevleri ve tüm İş istatistiklerini de siler. Bu, Görev verilerinin saklama süresini de geçersiz kılar; başka bir ifadeyle, İş hala İşlem Düğümlerinde tutulan Görevler içeriyorsa, Batch hizmetleri söz konusu Görevlerin çalışma dizinlerini ve tüm içeriklerini siler. Bir İşi Sil isteği alındığında, Batch hizmeti İşi silme durumuna ayarlar. Silme durumundaki bir İş üzerindeki tüm güncelleştirme işlemleri 409 (Çakışma) durum koduyla başarısız olur ve işin silindiğini belirten ek bilgiler sağlanır.

disable

Belirtilen İşi devre dışı bırakır ve yeni Görevlerin çalışmasını engeller.

Batch Hizmeti işi hemen devre dışı bırakma durumuna taşır. Batch daha sonra disableTasks parametresini kullanarak işin çalışmakta olan Görevleriyle ne yapacağını belirler. devre dışı bırakma işlemi tamamlanana ve tüm Görevler disableTasks seçeneğine göre ele alınana kadar İş devre dışı bırakma durumunda kalır; daha sonra İş devre dışı durumuna geçer. Etkin duruma geri dönene kadar İş altında yeni Görev başlatılmaz. Etkin, devre dışı veya devre dışı dışında herhangi bir durumda olan bir İşi devre dışı bırakmaya çalışırsanız, istek 409 durum koduyla başarısız olur.

enable

Belirtilen İşi etkinleştirir ve yeni Görevlerin çalışmasına izin verir.

Bu API'yi çağırdığınızda Batch hizmeti devre dışı bırakılmış bir İşi etkinleştirme durumuna ayarlar. Bu işlem tamamlandıktan sonra İş etkin duruma geçer ve İş altındaki yeni Görevlerin zamanlanması devam eder. Batch hizmeti bir Görevin 180 günden uzun süre etkin durumda kalmasına izin vermez. Bu nedenle, 180 günden daha önce eklenmiş etkin Görevler içeren bir İşi etkinleştirirseniz, bu Görevler çalışmaz.

get

Belirtilen İş hakkında bilgi alır.

get_task_counts

Belirtilen İş için Görev sayılarını alır.

Görev sayıları etkin, çalıştırılan veya tamamlanan Görev durumuna göre Görevlerin sayısını ve başarılı veya başarısız olan Görevlerin sayısını sağlar. Hazırlık durumundaki görevler çalışıyor olarak sayılır. Döndürülen sayıların her zaman güncel olmayabileceğini unutmayın. Tam görev sayılarına ihtiyacınız varsa, bir liste sorgusu kullanın.

list

Belirtilen Hesaptaki tüm İşleri listeler.

list_from_job_schedule

Belirtilen İş Zamanlaması altında oluşturulan İşleri listeler.

list_preparation_and_release_task_status

İşin çalıştırıldığı İşlem Düğümleri genelinde belirtilen İş için İş Hazırlama ve İş Bırakma Görevinin yürütme durumunu listeler.

Bu API, İş Hazırlama veya İş Bırakma Görevi'ni çalıştıran tüm İşlem Düğümlerinde İş Hazırlama ve İş Bırakma Görevi durumunu döndürür. Bu, havuzdan kaldırılmış olan İşlem Düğümlerini içerir. Bu API, İş Hazırlama veya İş Bırakma Görevi olmayan bir İş üzerinde çağrılırsa, Batch hizmeti JobPreparationTaskNotSpecified hata koduyla 409 (Çakışma) HTTP durum kodunu döndürür.

patch

Belirtilen İşin özelliklerini Güncelleştirmeler.

Bu, yalnızca istekte belirtilen İş özelliklerinin yerini alır. Örneğin, İş'in kısıtlamaları varsa ve bir istek constraints öğesini belirtmiyorsa, İş mevcut kısıtlamaları korur.

terminate

Belirtilen İşi tamamlandı olarak işaretleyerek sonlandırır.

İşi Sonlandır isteği alındığında, Batch hizmeti İşi sonlandırma durumuna ayarlar. Batch hizmeti daha sonra İş ile ilişkili çalışan görevleri sonlandırır ve gerekli İş yayın Görevlerini çalıştırır. Ardından İş tamamlanmış duruma geçer. İşinde etkin durumda görevler varsa, etkin durumda kalırlar. bir İş sonlandırıldıktan sonra yeni Görevler eklenemez ve kalan etkin Görevler zamanlanmaz.

update

Belirtilen İşin özelliklerini Güncelleştirmeler.

Bu, İşin tüm güncelleştirilebilir özelliklerinin yerini alır. Örneğin, İşin kendisiyle ilişkili kısıtlamaları varsa ve bu istekle sınırlamalar belirtilmezse, Batch hizmeti mevcut kısıtlamaları kaldırır.

add

Belirtilen Hesaba bir İş ekler.

Batch hizmeti, bir işin parçası olarak yapılan işi denetlemenin iki yolunu destekler. İlk yaklaşımda kullanıcı bir İş Yöneticisi Görevi belirtir. Batch hizmeti, İşi başlatmaya hazır olduğunda bu Görevi başlatır. İş Yöneticisi Görevi, Görev API'lerini kullanarak bu İş altında çalışan diğer tüm Görevleri denetler. İkinci yaklaşımda kullanıcı, Görev API'lerini kullanarak etkin bir İş altında Görevlerin yürütülmesini doğrudan denetler. Ayrıca unutmayın: İşleri adlandırırken, kullanıcı adları veya gizli proje adları gibi hassas bilgileri dahil etmekten kaçının. Bu bilgiler, Microsoft Desteği mühendislerin erişebildiği telemetri günlüklerinde görünebilir.

add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job
JobAddParameter
Gerekli

Eklenecek İş.

job_add_options
JobAddOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

Özel durumlar

delete

bir İşi siler.

Bir işin silinmesi, bu İşin parçası olan tüm Görevleri ve tüm İş istatistiklerini de siler. Bu, Görev verilerinin saklama süresini de geçersiz kılar; başka bir ifadeyle, İş hala İşlem Düğümlerinde tutulan Görevler içeriyorsa, Batch hizmetleri söz konusu Görevlerin çalışma dizinlerini ve tüm içeriklerini siler. Bir İşi Sil isteği alındığında, Batch hizmeti İşi silme durumuna ayarlar. Silme durumundaki bir İş üzerindeki tüm güncelleştirme işlemleri 409 (Çakışma) durum koduyla başarısız olur ve işin silindiğini belirten ek bilgiler sağlanır.

delete(job_id, job_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

Silinecek işin kimliği.

job_delete_options
JobDeleteOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

Özel durumlar

disable

Belirtilen İşi devre dışı bırakır ve yeni Görevlerin çalışmasını engeller.

Batch Hizmeti işi hemen devre dışı bırakma durumuna taşır. Batch daha sonra disableTasks parametresini kullanarak işin çalışmakta olan Görevleriyle ne yapacağını belirler. devre dışı bırakma işlemi tamamlanana ve tüm Görevler disableTasks seçeneğine göre ele alınana kadar İş devre dışı bırakma durumunda kalır; daha sonra İş devre dışı durumuna geçer. Etkin duruma geri dönene kadar İş altında yeni Görev başlatılmaz. Etkin, devre dışı veya devre dışı dışında herhangi bir durumda olan bir İşi devre dışı bırakmaya çalışırsanız, istek 409 durum koduyla başarısız olur.

disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

Devre dışı bırakacak işin kimliği.

disable_tasks
str veya DisableJobOption
Gerekli

Olası değerler şunlardır: 'requeue', 'terminate', 'wait'

job_disable_options
JobDisableOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

Özel durumlar

enable

Belirtilen İşi etkinleştirir ve yeni Görevlerin çalışmasına izin verir.

Bu API'yi çağırdığınızda Batch hizmeti devre dışı bırakılmış bir İşi etkinleştirme durumuna ayarlar. Bu işlem tamamlandıktan sonra İş etkin duruma geçer ve İş altındaki yeni Görevlerin zamanlanması devam eder. Batch hizmeti bir Görevin 180 günden uzun süre etkin durumda kalmasına izin vermez. Bu nedenle, 180 günden daha önce eklenmiş etkin Görevler içeren bir İşi etkinleştirirseniz, bu Görevler çalışmaz.

enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

Etkinleştirecek işin kimliği.

job_enable_options
JobEnableOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

Özel durumlar

get

Belirtilen İş hakkında bilgi alır.

get(job_id, job_get_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

İşin Kimliği.

job_get_options
JobGetOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

CloudJob veya ClientRawResponse if raw=true

Dönüş türü

Özel durumlar

get_task_counts

Belirtilen İş için Görev sayılarını alır.

Görev sayıları etkin, çalıştırılan veya tamamlanan Görev durumuna göre Görevlerin sayısını ve başarılı veya başarısız olan Görevlerin sayısını sağlar. Hazırlık durumundaki görevler çalışıyor olarak sayılır. Döndürülen sayıların her zaman güncel olmayabileceğini unutmayın. Tam görev sayılarına ihtiyacınız varsa, bir liste sorgusu kullanın.

get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

İşin Kimliği.

job_get_task_counts_options
JobGetTaskCountsOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

TaskCountsResult veya ClientRawResponse if raw=true

Dönüş türü

Özel durumlar

list

Belirtilen Hesaptaki tüm İşleri listeler.

list(job_list_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_list_options
JobListOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

CloudJob örneği gibi bir yineleyici

Dönüş türü

Özel durumlar

list_from_job_schedule

Belirtilen İş Zamanlaması altında oluşturulan İşleri listeler.

list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_schedule_id
str
Gerekli

İşlerin listesini almak istediğiniz İş Zamanlamasının kimliği.

job_list_from_job_schedule_options
JobListFromJobScheduleOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

CloudJob örneği gibi bir yineleyici

Dönüş türü

Özel durumlar

list_preparation_and_release_task_status

İşin çalıştırıldığı İşlem Düğümleri genelinde belirtilen İş için İş Hazırlama ve İş Bırakma Görevinin yürütme durumunu listeler.

Bu API, İş Hazırlama veya İş Bırakma Görevi'ni çalıştıran tüm İşlem Düğümlerinde İş Hazırlama ve İş Bırakma Görevi durumunu döndürür. Bu, havuzdan kaldırılmış olan İşlem Düğümlerini içerir. Bu API, İş Hazırlama veya İş Bırakma Görevi olmayan bir İş üzerinde çağrılırsa, Batch hizmeti JobPreparationTaskNotSpecified hata koduyla 409 (Çakışma) HTTP durum kodunu döndürür.

list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

İşin Kimliği.

job_list_preparation_and_release_task_status_options
JobListPreparationAndReleaseTaskStatusOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

JobPreparationAndReleaseTaskExecutionInformation örneği gibi bir yineleyici

Dönüş türü

Özel durumlar

patch

Belirtilen İşin özelliklerini Güncelleştirmeler.

Bu, yalnızca istekte belirtilen İş özelliklerinin yerini alır. Örneğin, İş'in kısıtlamaları varsa ve bir istek constraints öğesini belirtmiyorsa, İş mevcut kısıtlamaları korur.

patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

Özelliklerini güncelleştirmek istediğiniz İşin kimliği.

job_patch_parameter
JobPatchParameter
Gerekli

İsteğin parametreleri.

job_patch_options
JobPatchOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

Özel durumlar

terminate

Belirtilen İşi tamamlandı olarak işaretleyerek sonlandırır.

İşi Sonlandır isteği alındığında, Batch hizmeti İşi sonlandırma durumuna ayarlar. Batch hizmeti daha sonra İş ile ilişkili çalışan görevleri sonlandırır ve gerekli İş yayın Görevlerini çalıştırır. Ardından İş tamamlanmış duruma geçer. İşinde etkin durumda görevler varsa, etkin durumda kalırlar. bir İş sonlandırıldıktan sonra yeni Görevler eklenemez ve kalan etkin Görevler zamanlanmaz.

terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

Sonlandıracak işin kimliği.

terminate_reason
str
varsayılan değer: None
job_terminate_options
JobTerminateOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

Özel durumlar

update

Belirtilen İşin özelliklerini Güncelleştirmeler.

Bu, İşin tüm güncelleştirilebilir özelliklerinin yerini alır. Örneğin, İşin kendisiyle ilişkili kısıtlamaları varsa ve bu istekle sınırlamalar belirtilmezse, Batch hizmeti mevcut kısıtlamaları kaldırır.

update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)

Parametreler

job_id
str
Gerekli

Özelliklerini güncelleştirmek istediğiniz İşin kimliği.

job_update_parameter
JobUpdateParameter
Gerekli

İsteğin parametreleri.

job_update_options
JobUpdateOptions
varsayılan değer: None

İşlem için ek parametreler

custom_headers
dict
varsayılan değer: None

isteğe eklenecek üst bilgiler

raw
bool
varsayılan değer: False

seri durumdan çıkarılmış yanıtla birlikte doğrudan yanıtı döndürür

operation_config
Gerekli

İşlem yapılandırması geçersiz kılmaları.

Döndürülenler

None veya ClientRawResponse if raw=true

Dönüş türü

None,

Özel durumlar

Öznitelikler

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>