BatchClient class

Klasa klienta do dostępu do usługi Azure Batch.

Konstruktory

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

Metody

createJob(BatchJobCreateOptions, CreateJobOptionalParams)	Usługa Batch obsługuje dwa sposoby kontrolowania pracy wykonywanej w ramach zadania. W pierwszym podejściu użytkownik określa zadanie Menedżera Zadań. Usługa Batch uruchamia to zadanie, gdy jest gotowe do rozpoczęcia zadania. Zadanie Menedżera Zadań kontroluje wszystkie pozostałe zadania działające pod tym zadaniem, korzystając z API zadań. W drugim podejściu użytkownik bezpośrednio kontroluje wykonywanie zadań w ramach aktywnego zadania, korzystając z API zadań. Warto też zauważyć: przy nadawaniu nazw Jobs, unikaj podawania wrażliwych informacji, takich jak nazwy użytkowników czy tajne nazwy projektów. Informacje te mogą pojawiać się w dziennikach telemetrycznych dostępnych dla inżynierów pomoc techniczna firmy Microsoft.
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)	Tworzy harmonogram zadań dla określonego konta.
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)	Możesz dodać konto użytkownika do węzła obliczeniowego tylko wtedy, gdy jest on w stanie bezczynności lub w trybie działania. Zanim będziesz mógł zdalnie zalogować się do węzła obliczeniowego, musisz skonfigurować porty dostępu dla SSH i RDP. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)	Podczas nazewnictwa pul należy unikać dołączania poufnych informacji, takich jak nazwy użytkowników lub nazwy projektów tajnych. Informacje te mogą pojawiać się w dziennikach telemetrycznych dostępnych dla inżynierów pomoc techniczna firmy Microsoft.
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)	Maksymalny czas trwania zadania od dodania do ukończenia to 180 dni. Jeśli zadanie nie zostanie ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę wsadową i pozostawione w stanie, w jakim znajdowało się w danym momencie.
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)	Należy zauważyć, że każde Zadanie musi mieć unikalny identyfikator. Usługa wsadowa może nie zwracać wyników dla każdego zadania w tej samej kolejności, w jakiej zadania zostały przesłane w tym żądaniu. Jeśli serwer wygasa lub połączenie zostanie zamknięte podczas żądania, żądanie może zostać częściowo lub całkowicie przetworzone, albo wcale. W takich przypadkach użytkownik powinien ponownie wydać żądanie. Należy zauważyć, że to użytkownik musi prawidłowo radzić sobie z awariami podczas ponownego wysyłania żądania. Na przykład podczas ponownej próby powinieneś używać tych samych identyfikatorów zadań, aby jeśli poprzednia operacja się powiedzie, powtórka nie stworzyła niespodziewanie dodatkowych zadań. Jeśli odpowiedź zawiera zadania, które nie zostały dodane, klient może spróbować ponownie zażądać. Podczas ponownej próby najefektywniej jest przesłać tylko zadania, które nie dodały się, oraz pominąć zadania, które zostały pomyślnie dodane za pierwszym razem. Maksymalny czas trwania zadania od dodania do ukończenia to 180 dni. Jeśli zadanie nie zostanie ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę wsadową i pozostawione w stanie, w jakim znajdowało się w danym momencie.
deallocateNode(string, string, DeallocateNodeOptionalParams)	Przydział węzła obliczeniowego można cofnąć tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia.
deleteJob(string, DeleteJobOptionalParams)	Usunięcie zadania usuwa także wszystkie zadania należące do tego zadania oraz wszystkie statystyki pracy. To również nadpisuje okres przechowywania danych zadań; to znaczy, jeśli zadanie zawiera zadania nadal przechowywane na węzłach obliczeniowych, usługi wsadowe usuwają katalogi robocze tych zadań oraz całą ich zawartość. Gdy otrzymane zostanie żądanie Delete Job, usługa Batch ustawia Job do stanu usuwającego. Wszystkie operacje aktualizacji na zadaniu będącym w stanie usuwania zakończą się niepowodzeniem przy kodie statusowym 409 (Konflikt), a dodatkowe informacje wskazują, że zadanie jest usuwane.
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)	Po usunięciu harmonogramu zadań spowoduje to również usunięcie wszystkich zadań i zadań zgodnie z tym harmonogramem. Po usunięciu zadań wszystkie pliki w katalogach roboczych w węzłach obliczeniowych również zostaną usunięte (okres przechowywania jest ignorowany). Statystyki harmonogramu zadań nie są już dostępne po usunięciu harmonogramu zadań, mimo że są one nadal uwzględniane w statystykach okresu istnienia konta.
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)	Usuwa określony plik z węzła obliczeniowego.
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)	Konto użytkownika można usunąć do węzła obliczeniowego tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia. Zanim będziesz mógł zdalnie zalogować się do węzła obliczeniowego, musisz skonfigurować porty dostępu dla SSH i RDP. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
deletePool(string, DeletePoolOptionalParams)	Gdy zażądasz usunięcia puli, zostaną wykonane następujące akcje: stan puli zostanie ustawiony na usunięcie; wszystkie trwające operacje zmiany rozmiaru w puli są zatrzymywane; usługa Batch rozpoczyna zmianę rozmiaru puli na zero węzłów obliczeniowych; wszystkie zadania uruchomione w istniejących węzłach obliczeniowych są przerywane i ponownie kolejkowane (tak jak w przypadku żądania operacji zmiany rozmiaru puli z domyślną opcją ponownej kolejki); na koniec pula zostanie usunięta z systemu. Ponieważ uruchomione zadania są ponownie kolejkowane, użytkownik może ponownie uruchomić te zadania, aktualizując zadanie w celu kierowania innej puli. Następnie zadania mogą być uruchamiane w nowej puli. Jeśli chcesz zastąpić zachowanie ponownej kolejki, należy jawnie wywołać zmianę rozmiaru puli, aby zmniejszyć pulę do zera przed usunięciem puli. Jeśli wywołasz interfejs API aktualizacji, poprawek lub usuwania w puli w stanie usuwania, kod stanu HTTP 409 z kodem błędu PoolBeingDeleted zakończy się niepowodzeniem.
deleteTask(string, string, DeleteTaskOptionalParams)	Po usunięciu zadania wszystkie pliki w katalogu w węźle obliczeniowym, w którym zostało uruchomione, również zostaną usunięte (niezależnie od czasu przechowywania). W przypadku zadań z wieloma wystąpieniami operacja usuwania zadania jest stosowana synchronicznie do zadania podstawowego; podzadania i ich pliki są następnie usuwane asynchronicznie w tle.
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)	Usuwa określony plik zadania z węzła obliczeniowego, w którym uruchomiono zadanie.
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)	Usługa Batch natychmiast przenosi zadanie do stanu wyłączenia. Następnie Batch używa parametru disableTasks, aby określić, co zrobić z aktualnie działającymi zadaniami zadania zadania. Zadanie pozostaje w stanie wyłączania do czasu zakończenia operacji wyłączenia i załatwienia wszystkich zadań zgodnie z opcją wyłączenia zadań; Job przechodzi wtedy do stanu niepełnosprawności. Nowe zadania nie są uruchamiane pod zadaniem, dopóki nie wróci do aktywnego stanu. Jeśli spróbujesz wyłączyć zadanie w dowolnym stanie innym niż aktywny, wyłączony lub wyłączony, żądanie kończy się niepowodzeniem z kodem statusu 409.
disableJobSchedule(string, DisableJobScheduleOptionalParams)	Żadne nowe zadania nie zostaną utworzone do momentu ponownego włączenia harmonogramu zadań.
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)	Możesz wyłączyć harmonogramowanie zadań na węźle obliczeniowym tylko wtedy, gdy jego aktualny stan harmonogramowania jest włączony.
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)	Wyłącza automatyczne skalowanie puli.
enableJob(string, EnableJobOptionalParams)	Gdy wywołujesz to API, usługa Batch ustawia wyłączone zadanie do stanu umożliwiającego. Po zakończeniu tej operacji zadanie przechodzi do stanu aktywnego, a planowanie nowych zadań w ramach zadania wznawia się. Usługa Batch nie pozwala zadaniu pozostać w stanie aktywnym dłużej niż 180 dni. Dlatego jeśli włączysz Zadanie zawierające aktywne Zadania dodane ponad 180 dni temu, te Zadania nie będą działać.
enableJobSchedule(string, EnableJobScheduleOptionalParams)	Włącza harmonogram zadań.
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)	Możesz włączyć harmonogramowanie zadań na węźle obliczeniowym tylko wtedy, gdy jego obecny stan harmonogramowania jest wyłączony
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)	Nie można włączyć automatycznego skalowania w puli, jeśli operacja zmiany rozmiaru jest w toku w puli. Jeśli automatyczne skalowanie puli jest obecnie wyłączone, należy określić prawidłową formułę autoskalowania w ramach żądania. Jeśli automatyczne skalowanie puli jest już włączone, możesz określić nową formułę autoskalowania i/lub nowy interwał oceny. Nie można wywołać tego interfejsu API dla tej samej puli więcej niż raz co 30 sekund.
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)	Ten interfejs API jest przeznaczony głównie do sprawdzania poprawności formuły autoskalowania, ponieważ po prostu zwraca wynik bez stosowania formuły do puli. Pula musi mieć włączone automatyczne skalowanie w celu obliczenia formuły.
getApplication(string, GetApplicationOptionalParams)	Ta operacja zwraca tylko Aplikacje i wersje dostępne do użycia na węzłach obliczeniowych; czyli może być użyty w referencji pakietu. Aby uzyskać informacje administratorskie o aplikacjach i wersjach, które nie są jeszcze dostępne dla węzłów obliczeniowych, skorzystaj z portalu Azure lub API Azure Resource Manager.
getJob(string, GetJobOptionalParams)	Otrzymuje informacje o określonym stanowisku.
getJobSchedule(string, GetJobScheduleOptionalParams)	Otrzymuje informacje o określonym harmonogramie zadań.
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)	Liczba zadań zapewnia liczbę zadań według stanu zadania aktywnego, uruchomionego lub ukończonego oraz liczby zadań, które zakończyły się powodzeniem lub niepowodzeniem. Zadania w stanie przygotowywania są liczone jako uruchomione. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb zadań, użyj zapytania listy.
getNode(string, string, GetNodeOptionalParams)	Pobiera informacje o określonym węźle obliczeniowym.
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)	Otrzymuje informacje o określonym rozszerzeniu węzła obliczeniowego.
getNodeFile(string, string, string, GetNodeFileOptionalParams)	Zwraca zawartość określonego pliku Compute Node.
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)	Pobiera właściwości określonego pliku węzła obliczeniowego.
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)	Zanim będziesz mógł zdalnie zalogować się do węzła obliczeniowego za pomocą zdalnych ustawień logowania, musisz utworzyć konto użytkownika na węźle obliczeniowym i skonfigurować porty dostępu dla SSH i RDP. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
getPool(string, GetPoolOptionalParams)	Pobiera informacje o określonej puli.
getTask(string, string, GetTaskOptionalParams)	W przypadku zadań wieloinstancjowych informacje takie jak affinityId, executionInfo i nodeInfo odnoszą się do zadania głównego. Użyj API lista podzadań, aby pobrać informacje o podzadaniach.
getTaskFile(string, string, string, GetTaskFileOptionalParams)	Zwraca zawartość określonego pliku zadania.
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)	Pobiera właściwości określonego pliku zadania.
jobScheduleExists(string, JobScheduleExistsOptionalParams)	Sprawdza, czy istnieje określony harmonogram zadań.
listApplications(ListApplicationsOptionalParams)	Ta operacja zwraca tylko Aplikacje i wersje dostępne do użycia na węzłach obliczeniowych; czyli może być użyty w referencji pakietu. Aby uzyskać informacje administratorskie o aplikacjach i wersjach, które nie są jeszcze dostępne dla Compute Nodes, skorzystaj z portalu Azure lub API Azure Resource Manager.
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)	Ten interfejs API zwraca stan zadania przygotowania zadania i zadania zwolnienia zadania na wszystkich węzłach obliczeniowych z uruchomionym zadaniem przygotowania zadania lub zwolnienia zadania. Obejmuje to węzły obliczeniowe, które zostały usunięte z puli. Jeśli ten interfejs API jest wywoływany w zadaniu, które nie ma zadania przygotowania zadania lub zwolnienia zadania, usługa Batch zwraca kod stanu HTTP 409 (konflikt) z kodem błędu JobPreparationTaskNotSpecified.
listJobs(ListJobsOptionalParams)	Lista wszystkich stanowisk w określonym koncie.
listJobSchedules(ListJobSchedulesOptionalParams)	Zawiera wszystkie harmonogramy zadań w określonym koncie.
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)	Lista zadań utworzonych zgodnie z określonym harmonogramem zadań.
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)	Lista rozszerzeń węzłów obliczeniowych w określonej puli.
listNodeFiles(string, string, ListNodeFilesOptionalParams)	Wyświetla listę wszystkich plików w katalogach zadań w określonym węźle obliczeniowym.
listNodes(string, ListNodesOptionalParams)	Wyświetla listę węzłów obliczeniowych w określonej puli.
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)	Pobiera liczbę węzłów obliczeniowych w każdym stanie pogrupowanych według puli. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb węzłów, użyj zapytania listy.
listPools(ListPoolsOptionalParams)	Wyświetla listę wszystkich pul w określonym koncie.
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)	Jeśli nie określisz klauzuli $filter zawierającej identyfikator poolId, odpowiedź zawiera wszystkie pule, które istniały w ramach konta w zakresie czasu zwracanych interwałów agregacji. Jeśli nie określisz klauzuli $filter, w tym parametru startTime lub endTime, te filtry są domyślne dla czasów rozpoczęcia i zakończenia ostatniego dostępnego interwału agregacji; oznacza to, że zwracany jest tylko ostatni interwał agregacji.
listSubTasks(string, string, ListSubTasksOptionalParams)	Jeśli zadanie nie jest zadaniem z wieloma wystąpieniami, zwraca on pustą kolekcję.
listSupportedImages(ListSupportedImagesOptionalParams)	Wyświetla listę wszystkich obrazów maszyn wirtualnych obsługiwanych przez usługę Azure Batch.
listTaskFiles(string, string, ListTaskFilesOptionalParams)	Wyświetla listę plików w katalogu zadania w węźle obliczeniowym.
listTasks(string, ListTasksOptionalParams)	W przypadku zadań wieloinstancjowych informacje takie jak affinityId, executionInfo i nodeInfo odnoszą się do zadania głównego. Użyj API lista podzadań, aby pobrać informacje o podzadaniach.
poolExists(string, PoolExistsOptionalParams)	Otrzymuje podstawowe właściwości puli.
reactivateTask(string, string, ReactivateTaskOptionalParams)	Ponowna aktywacja powoduje, że zadanie kwalifikuje się do ponownego ponawiania próby do maksymalnej liczby ponownych prób. Stan zadania jest zmieniany na aktywny. Ponieważ zadanie nie jest już w stanie ukończonym, żadne poprzednie informacje o kodzie zakończenia lub niepowodzeniu nie są już dostępne po ponownym uaktywnieniu. Za każdym razem, gdy zadanie zostanie ponownie aktywowane, liczba ponownych prób zostanie zresetowana do wartości 0. Ponowne aktywowanie zakończy się niepowodzeniem dla zadań, które nie zostały ukończone lub które zostały wcześniej ukończone pomyślnie (z kodem zakończenia 0). Ponadto zadanie zakończy się niepowodzeniem, jeśli zadanie zostało ukończone (lub kończy lub usuwa).
rebootNode(string, string, RebootNodeOptionalParams)	Węzeł obliczeniowy można uruchomić ponownie tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia.
reimageNode(string, string, ReimageNodeOptionalParams)	System operacyjny można ponownie zainstalować w węźle obliczeniowym tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia. To API może być wywoływane tylko na pulach utworzonych z własnością konfiguracji usług chmurowych.
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)	Ta operacja może być uruchamiana tylko wtedy, gdy stan alokacji puli jest stały. Po uruchomieniu tej operacji stan alokacji zmienia się ze stałego na zmianę rozmiaru. Każde żądanie może usunąć maksymalnie 100 węzłów.
replaceJob(string, BatchJob, ReplaceJobOptionalParams)	To całkowicie zastępuje wszystkie aktualizowalne właściwości Job. Na przykład, jeśli zadanie ma przypisane ograniczenia, a ograniczenia nie są określone w tym żądaniu, usługa Batch usunie istniejące ograniczenia.
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)	To w pełni zastępuje wszystkie aktualizowalne właściwości Harmonogramu zadań. Na przykład, jeśli właściwość harmonogramu nie jest określona w tym żądaniu, usługa Batch usunie istniejący harmonogram. Zmiany w harmonogramie zadań dotyczą jedynie zadań utworzonych przez harmonogram po dokonaniu aktualizacji; obecnie działające Jobs pozostają niedotknięte.
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)	Ta operacja zastępuje wszystkie właściwości aktualizowalne Konta. Na przykład, jeśli element expiryTime nie jest określony, aktualna wartość jest zastępowana wartością domyślną, a nie pozostawiana bez zmian. Konto użytkownika na węźle obliczeniowym można aktualizować tylko wtedy, gdy jest ono w stanie bezczynności lub w trybie działania.
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)	To w pełni zastępuje wszystkie aktualizowalne właściwości Pool. Na przykład, jeśli Pula ma powiązane StartTask i StartTask nie jest określone w tym żądaniu, usługa Batch usunie istniejące StartTask.
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)	Aktualizuje właściwości określonego zadania.
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)	Rozmiar puli można zmienić tylko wtedy, gdy jego stan alokacji jest stały. Jeśli rozmiar puli jest już zmieniany, żądanie kończy się niepowodzeniem z kodem stanu 409. Po zmianie rozmiaru puli stan alokacji puli zmienia się ze stałego na zmianę rozmiaru. Nie można zmienić rozmiaru pul skonfigurowanych do automatycznego skalowania. Jeśli spróbujesz to zrobić, usługa Batch zwróci błąd 409. W przypadku zmiany rozmiaru puli w dół usługa Batch wybierze węzły obliczeniowe do usunięcia. Aby usunąć określone węzły obliczeniowe, zamiast tego użyj interfejsu API usuwania węzłów obliczeniowych puli.
startNode(string, string, StartNodeOptionalParams)	Możesz uruchomić węzeł obliczeniowy tylko wtedy, gdy został on zlokalizowany przez deale.
stopPoolResize(string, StopPoolResizeOptionalParams)	To nie przywraca Puli do stanu sprzed operacji zmiany rozmiaru: jedynie powstrzymuje wszelkie dalsze zmiany, a Pula zachowuje swój obecny stan. Po zatrzymaniu pula stabilizuje się na liczbie węzłów obliczeniowych, na której była w momencie zakończenia operacji zatrzymania. Podczas operacji zatrzymania stan przydziału puli najpierw zmienia się na zatrzymanie, a następnie na stabilizację. Operacja zmiany rozmiaru nie musi być jawnym żądaniem zmiany rozmiaru Pool; to API może być również użyte do zatrzymania początkowego rozmiarowania puli podczas jej tworzenia.
terminateJob(string, TerminateJobOptionalParams)	Gdy żądanie Zakończenia Zadania zostanie otrzymane, usługa Batch ustawia Zadanie do stanu zakończenia. Usługa wsadowa kończy następnie wszystkie działające zadania powiązane z zadaniem i wykonuje wymagane zadania zwolnienia zadań. Następnie praca przechodzi w stan ukończony. Jeśli w Pracy znajdują się jakiekolwiek Zadania w stanie aktywnym, pozostaną w stanie aktywnym. Po zakończeniu zadania nie można dodawać nowych zadań, a pozostałe aktywne zadania nie będą zaplanowane.
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)	Przerywa harmonogram zadań.
terminateTask(string, string, TerminateTaskOptionalParams)	Po zakończeniu zadania zostanie ono przeniesione do stanu ukończonego. W przypadku zadań z wieloma wystąpieniami operacja zakończenia zadania jest stosowana synchronicznie do zadania podstawowego; podzadania są następnie przerywane asynchronicznie w tle.
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)	Zastępuje to jedynie właściwości Job określone w żądaniu. Na przykład, jeśli Job ma ograniczenia, a żądanie nie określa elementu ograniczeń, to Job zachowuje istniejące ograniczenia.
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)	Zastępuje to jedynie właściwości harmonogramu zadań określone w żądaniu. Na przykład, jeśli właściwość harmonogramu nie jest określona w tym żądaniu, usługa Batch zachowa istniejący harmonogram. Zmiany w harmonogramie zadań dotyczą jedynie zadań utworzonych przez harmonogram po dokonaniu aktualizacji; obecnie działające Jobs pozostają niedotknięte.
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)	To zastępuje jedynie właściwości Puli określone w żądaniu. Na przykład, jeśli Pula ma przypisane StartZadanie, a żądanie nie określa elementu StartZadania, to Pula zachowuje istniejące StartZadanie.
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)	Służy to do automatycznego zbierania plików logów usług Azure Batch z węzłów obliczeniowych, jeśli napotkasz błąd i chcesz eskalować do wsparcia Azure. Pliki dziennika usługi Azure Batch powinny być udostępniane pomoc techniczna platformy Azure, aby ułatwić debugowanie problemów z usługą Batch.

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)

Parametry

endpointParam: string

credential: TokenCredential | AzureNamedKeyCredential

options: BatchClientOptionalParams

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

Usługa Batch obsługuje dwa sposoby kontrolowania pracy wykonywanej w ramach zadania. W pierwszym podejściu użytkownik określa zadanie Menedżera Zadań. Usługa Batch uruchamia to zadanie, gdy jest gotowe do rozpoczęcia zadania. Zadanie Menedżera Zadań kontroluje wszystkie pozostałe zadania działające pod tym zadaniem, korzystając z API zadań. W drugim podejściu użytkownik bezpośrednio kontroluje wykonywanie zadań w ramach aktywnego zadania, korzystając z API zadań. Warto też zauważyć: przy nadawaniu nazw Jobs, unikaj podawania wrażliwych informacji, takich jak nazwy użytkowników czy tajne nazwy projektów. Informacje te mogą pojawiać się w dziennikach telemetrycznych dostępnych dla inżynierów pomoc techniczna firmy Microsoft.

function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>

Parametry

job: BatchJobCreateOptions

options: CreateJobOptionalParams

Zwraca

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Tworzy harmonogram zadań dla określonego konta.

function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>

Parametry

jobSchedule: BatchJobScheduleCreateOptions

options: CreateJobScheduleOptionalParams

Zwraca

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Możesz dodać konto użytkownika do węzła obliczeniowego tylko wtedy, gdy jest on w stanie bezczynności lub w trybie działania. Zanim będziesz mógł zdalnie zalogować się do węzła obliczeniowego, musisz skonfigurować porty dostępu dla SSH i RDP. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>

Parametry

poolId: string

nodeId: string

user: BatchNodeUserCreateOptions

options: CreateNodeUserOptionalParams

Zwraca

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

Podczas nazewnictwa pul należy unikać dołączania poufnych informacji, takich jak nazwy użytkowników lub nazwy projektów tajnych. Informacje te mogą pojawiać się w dziennikach telemetrycznych dostępnych dla inżynierów pomoc techniczna firmy Microsoft.

function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>

Parametry

pool: BatchPoolCreateOptions

options: CreatePoolOptionalParams

Zwraca

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Maksymalny czas trwania zadania od dodania do ukończenia to 180 dni. Jeśli zadanie nie zostanie ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę wsadową i pozostawione w stanie, w jakim znajdowało się w danym momencie.

function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>

Parametry

jobId: string

task: BatchTaskCreateOptions

options: CreateTaskOptionalParams

Zwraca

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Należy zauważyć, że każde Zadanie musi mieć unikalny identyfikator. Usługa wsadowa może nie zwracać wyników dla każdego zadania w tej samej kolejności, w jakiej zadania zostały przesłane w tym żądaniu. Jeśli serwer wygasa lub połączenie zostanie zamknięte podczas żądania, żądanie może zostać częściowo lub całkowicie przetworzone, albo wcale. W takich przypadkach użytkownik powinien ponownie wydać żądanie. Należy zauważyć, że to użytkownik musi prawidłowo radzić sobie z awariami podczas ponownego wysyłania żądania. Na przykład podczas ponownej próby powinieneś używać tych samych identyfikatorów zadań, aby jeśli poprzednia operacja się powiedzie, powtórka nie stworzyła niespodziewanie dodatkowych zadań. Jeśli odpowiedź zawiera zadania, które nie zostały dodane, klient może spróbować ponownie zażądać. Podczas ponownej próby najefektywniej jest przesłać tylko zadania, które nie dodały się, oraz pominąć zadania, które zostały pomyślnie dodane za pierwszym razem. Maksymalny czas trwania zadania od dodania do ukończenia to 180 dni. Jeśli zadanie nie zostanie ukończone w ciągu 180 dni od dodania, zostanie zakończone przez usługę wsadową i pozostawione w stanie, w jakim znajdowało się w danym momencie.

function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>

Parametry

jobId: string

taskCollection: BatchTaskGroup

options: CreateTaskCollectionOptionalParams

Zwraca

Promise<BatchCreateTaskCollectionResult>

deallocateNode(string, string, DeallocateNodeOptionalParams)

Przydział węzła obliczeniowego można cofnąć tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia.

function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

nodeId: string

options: DeallocateNodeOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

Usunięcie zadania usuwa także wszystkie zadania należące do tego zadania oraz wszystkie statystyki pracy. To również nadpisuje okres przechowywania danych zadań; to znaczy, jeśli zadanie zawiera zadania nadal przechowywane na węzłach obliczeniowych, usługi wsadowe usuwają katalogi robocze tych zadań oraz całą ich zawartość. Gdy otrzymane zostanie żądanie Delete Job, usługa Batch ustawia Job do stanu usuwającego. Wszystkie operacje aktualizacji na zadaniu będącym w stanie usuwania zakończą się niepowodzeniem przy kodie statusowym 409 (Konflikt), a dodatkowe informacje wskazują, że zadanie jest usuwane.

function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>

Parametry

jobId: string

options: DeleteJobOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Po usunięciu harmonogramu zadań spowoduje to również usunięcie wszystkich zadań i zadań zgodnie z tym harmonogramem. Po usunięciu zadań wszystkie pliki w katalogach roboczych w węzłach obliczeniowych również zostaną usunięte (okres przechowywania jest ignorowany). Statystyki harmonogramu zadań nie są już dostępne po usunięciu harmonogramu zadań, mimo że są one nadal uwzględniane w statystykach okresu istnienia konta.

function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parametry

jobScheduleId: string

options: DeleteJobScheduleOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Usuwa określony plik z węzła obliczeniowego.

function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>

Parametry

poolId: string

nodeId: string

filePath: string

options: DeleteNodeFileOptionalParams

Zwraca

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Konto użytkownika można usunąć do węzła obliczeniowego tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia. Zanim będziesz mógł zdalnie zalogować się do węzła obliczeniowego, musisz skonfigurować porty dostępu dla SSH i RDP. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>

Parametry

poolId: string

nodeId: string

userName: string

options: DeleteNodeUserOptionalParams

Zwraca

Promise<void>

deletePool(string, DeletePoolOptionalParams)

Gdy zażądasz usunięcia puli, zostaną wykonane następujące akcje: stan puli zostanie ustawiony na usunięcie; wszystkie trwające operacje zmiany rozmiaru w puli są zatrzymywane; usługa Batch rozpoczyna zmianę rozmiaru puli na zero węzłów obliczeniowych; wszystkie zadania uruchomione w istniejących węzłach obliczeniowych są przerywane i ponownie kolejkowane (tak jak w przypadku żądania operacji zmiany rozmiaru puli z domyślną opcją ponownej kolejki); na koniec pula zostanie usunięta z systemu. Ponieważ uruchomione zadania są ponownie kolejkowane, użytkownik może ponownie uruchomić te zadania, aktualizując zadanie w celu kierowania innej puli. Następnie zadania mogą być uruchamiane w nowej puli. Jeśli chcesz zastąpić zachowanie ponownej kolejki, należy jawnie wywołać zmianę rozmiaru puli, aby zmniejszyć pulę do zera przed usunięciem puli. Jeśli wywołasz interfejs API aktualizacji, poprawek lub usuwania w puli w stanie usuwania, kod stanu HTTP 409 z kodem błędu PoolBeingDeleted zakończy się niepowodzeniem.

function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

options: DeletePoolOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

Po usunięciu zadania wszystkie pliki w katalogu w węźle obliczeniowym, w którym zostało uruchomione, również zostaną usunięte (niezależnie od czasu przechowywania). W przypadku zadań z wieloma wystąpieniami operacja usuwania zadania jest stosowana synchronicznie do zadania podstawowego; podzadania i ich pliki są następnie usuwane asynchronicznie w tle.

function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>

Parametry

jobId: string

taskId: string

options: DeleteTaskOptionalParams

Zwraca

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Usuwa określony plik zadania z węzła obliczeniowego, w którym uruchomiono zadanie.

function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>

Parametry

jobId: string

taskId: string

filePath: string

options: DeleteTaskFileOptionalParams

Zwraca

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

Usługa Batch natychmiast przenosi zadanie do stanu wyłączenia. Następnie Batch używa parametru disableTasks, aby określić, co zrobić z aktualnie działającymi zadaniami zadania zadania. Zadanie pozostaje w stanie wyłączania do czasu zakończenia operacji wyłączenia i załatwienia wszystkich zadań zgodnie z opcją wyłączenia zadań; Job przechodzi wtedy do stanu niepełnosprawności. Nowe zadania nie są uruchamiane pod zadaniem, dopóki nie wróci do aktywnego stanu. Jeśli spróbujesz wyłączyć zadanie w dowolnym stanie innym niż aktywny, wyłączony lub wyłączony, żądanie kończy się niepowodzeniem z kodem statusu 409.

function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>

Parametry

jobId: string

disableOptions: BatchJobDisableOptions

options: DisableJobOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Żadne nowe zadania nie zostaną utworzone do momentu ponownego włączenia harmonogramu zadań.

function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>

Parametry

jobScheduleId: string

options: DisableJobScheduleOptionalParams

Zwraca

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Możesz wyłączyć harmonogramowanie zadań na węźle obliczeniowym tylko wtedy, gdy jego aktualny stan harmonogramowania jest włączony.

function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>

Parametry

poolId: string

nodeId: string

options: DisableNodeSchedulingOptionalParams

Zwraca

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Wyłącza automatyczne skalowanie puli.

function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>

Parametry

poolId: string

options: DisablePoolAutoScaleOptionalParams

Zwraca

Promise<void>

enableJob(string, EnableJobOptionalParams)

Gdy wywołujesz to API, usługa Batch ustawia wyłączone zadanie do stanu umożliwiającego. Po zakończeniu tej operacji zadanie przechodzi do stanu aktywnego, a planowanie nowych zadań w ramach zadania wznawia się. Usługa Batch nie pozwala zadaniu pozostać w stanie aktywnym dłużej niż 180 dni. Dlatego jeśli włączysz Zadanie zawierające aktywne Zadania dodane ponad 180 dni temu, te Zadania nie będą działać.

function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>

Parametry

jobId: string

options: EnableJobOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Włącza harmonogram zadań.

function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>

Parametry

jobScheduleId: string

options: EnableJobScheduleOptionalParams

Zwraca

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Możesz włączyć harmonogramowanie zadań na węźle obliczeniowym tylko wtedy, gdy jego obecny stan harmonogramowania jest wyłączony

function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>

Parametry

poolId: string

nodeId: string

options: EnableNodeSchedulingOptionalParams

Zwraca

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Nie można włączyć automatycznego skalowania w puli, jeśli operacja zmiany rozmiaru jest w toku w puli. Jeśli automatyczne skalowanie puli jest obecnie wyłączone, należy określić prawidłową formułę autoskalowania w ramach żądania. Jeśli automatyczne skalowanie puli jest już włączone, możesz określić nową formułę autoskalowania i/lub nowy interwał oceny. Nie można wywołać tego interfejsu API dla tej samej puli więcej niż raz co 30 sekund.

function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>

Parametry

poolId: string

enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions

options: EnablePoolAutoScaleOptionalParams

Zwraca

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Ten interfejs API jest przeznaczony głównie do sprawdzania poprawności formuły autoskalowania, ponieważ po prostu zwraca wynik bez stosowania formuły do puli. Pula musi mieć włączone automatyczne skalowanie w celu obliczenia formuły.

function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>

Parametry

poolId: string

evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions

options: EvaluatePoolAutoScaleOptionalParams

Zwraca

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

Ta operacja zwraca tylko Aplikacje i wersje dostępne do użycia na węzłach obliczeniowych; czyli może być użyty w referencji pakietu. Aby uzyskać informacje administratorskie o aplikacjach i wersjach, które nie są jeszcze dostępne dla węzłów obliczeniowych, skorzystaj z portalu Azure lub API Azure Resource Manager.

function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>

Parametry

applicationId: string

options: GetApplicationOptionalParams

Zwraca

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

Otrzymuje informacje o określonym stanowisku.

function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>

Parametry

jobId: string

options: GetJobOptionalParams

Zwraca

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

Otrzymuje informacje o określonym harmonogramie zadań.

function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>

Parametry

jobScheduleId: string

options: GetJobScheduleOptionalParams

Zwraca

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

Liczba zadań zapewnia liczbę zadań według stanu zadania aktywnego, uruchomionego lub ukończonego oraz liczby zadań, które zakończyły się powodzeniem lub niepowodzeniem. Zadania w stanie przygotowywania są liczone jako uruchomione. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb zadań, użyj zapytania listy.

function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>

Parametry

jobId: string

options: GetJobTaskCountsOptionalParams

Zwraca

Promise<BatchTaskCountsResult>

getNode(string, string, GetNodeOptionalParams)

Pobiera informacje o określonym węźle obliczeniowym.

function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>

Parametry

poolId: string

nodeId: string

options: GetNodeOptionalParams

Zwraca

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

Otrzymuje informacje o określonym rozszerzeniu węzła obliczeniowego.

function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>

Parametry

poolId: string

nodeId: string

extensionName: string

options: GetNodeExtensionOptionalParams

Zwraca

Promise<BatchNodeVMExtension>

getNodeFile(string, string, string, GetNodeFileOptionalParams)

Zwraca zawartość określonego pliku Compute Node.

function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>

Parametry

poolId: string

nodeId: string

filePath: string

options: GetNodeFileOptionalParams

Zwraca

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

Pobiera właściwości określonego pliku węzła obliczeniowego.

function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parametry

poolId: string

nodeId: string

filePath: string

options: GetNodeFilePropertiesOptionalParams

Zwraca

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Zanim będziesz mógł zdalnie zalogować się do węzła obliczeniowego za pomocą zdalnych ustawień logowania, musisz utworzyć konto użytkownika na węźle obliczeniowym i skonfigurować porty dostępu dla SSH i RDP. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>

Parametry

poolId: string

nodeId: string

options: GetNodeRemoteLoginSettingsOptionalParams

Zwraca

Promise<BatchNodeRemoteLoginSettings>

getPool(string, GetPoolOptionalParams)

Pobiera informacje o określonej puli.

function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>

Parametry

poolId: string

options: GetPoolOptionalParams

Zwraca

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

W przypadku zadań wieloinstancjowych informacje takie jak affinityId, executionInfo i nodeInfo odnoszą się do zadania głównego. Użyj API lista podzadań, aby pobrać informacje o podzadaniach.

function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>

Parametry

jobId: string

taskId: string

options: GetTaskOptionalParams

Zwraca

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

Zwraca zawartość określonego pliku zadania.

function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>

Parametry

jobId: string

taskId: string

filePath: string

options: GetTaskFileOptionalParams

Zwraca

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

Pobiera właściwości określonego pliku zadania.

function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parametry

jobId: string

taskId: string

filePath: string

options: GetTaskFilePropertiesOptionalParams

Zwraca

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Sprawdza, czy istnieje określony harmonogram zadań.

function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>

Parametry

jobScheduleId: string

options: JobScheduleExistsOptionalParams

Zwraca

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

Ta operacja zwraca tylko Aplikacje i wersje dostępne do użycia na węzłach obliczeniowych; czyli może być użyty w referencji pakietu. Aby uzyskać informacje administratorskie o aplikacjach i wersjach, które nie są jeszcze dostępne dla Compute Nodes, skorzystaj z portalu Azure lub API Azure Resource Manager.

function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

Parametry

options: ListApplicationsOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Ten interfejs API zwraca stan zadania przygotowania zadania i zadania zwolnienia zadania na wszystkich węzłach obliczeniowych z uruchomionym zadaniem przygotowania zadania lub zwolnienia zadania. Obejmuje to węzły obliczeniowe, które zostały usunięte z puli. Jeśli ten interfejs API jest wywoływany w zadaniu, które nie ma zadania przygotowania zadania lub zwolnienia zadania, usługa Batch zwraca kod stanu HTTP 409 (konflikt) z kodem błędu JobPreparationTaskNotSpecified.

function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

Parametry

jobId: string

options: ListJobPreparationAndReleaseTaskStatusOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

listJobs(ListJobsOptionalParams)

Lista wszystkich stanowisk w określonym koncie.

function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parametry

options: ListJobsOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listJobSchedules(ListJobSchedulesOptionalParams)

Zawiera wszystkie harmonogramy zadań w określonym koncie.

function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

Parametry

options: ListJobSchedulesOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Lista zadań utworzonych zgodnie z określonym harmonogramem zadań.

function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parametry

jobScheduleId: string

options: ListJobsFromScheduleOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

Lista rozszerzeń węzłów obliczeniowych w określonej puli.

function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

Parametry

poolId: string

nodeId: string

options: ListNodeExtensionsOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

listNodeFiles(string, string, ListNodeFilesOptionalParams)

Wyświetla listę wszystkich plików w katalogach zadań w określonym węźle obliczeniowym.

function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parametry

poolId: string

nodeId: string

options: ListNodeFilesOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listNodes(string, ListNodesOptionalParams)

Wyświetla listę węzłów obliczeniowych w określonej puli.

function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

Parametry

poolId: string

options: ListNodesOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

Pobiera liczbę węzłów obliczeniowych w każdym stanie pogrupowanych według puli. Zwróć uwagę, że zwracane liczby mogą nie zawsze być aktualne. Jeśli potrzebujesz dokładnych liczb węzłów, użyj zapytania listy.

function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

Parametry

options: ListPoolNodeCountsOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

listPools(ListPoolsOptionalParams)

Wyświetla listę wszystkich pul w określonym koncie.

function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

Parametry

options: ListPoolsOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

Jeśli nie określisz klauzuli $filter zawierającej identyfikator poolId, odpowiedź zawiera wszystkie pule, które istniały w ramach konta w zakresie czasu zwracanych interwałów agregacji. Jeśli nie określisz klauzuli $filter, w tym parametru startTime lub endTime, te filtry są domyślne dla czasów rozpoczęcia i zakończenia ostatniego dostępnego interwału agregacji; oznacza to, że zwracany jest tylko ostatni interwał agregacji.

function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

Parametry

options: ListPoolUsageMetricsOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

listSubTasks(string, string, ListSubTasksOptionalParams)

Jeśli zadanie nie jest zadaniem z wieloma wystąpieniami, zwraca on pustą kolekcję.

function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

Parametry

jobId: string

taskId: string

options: ListSubTasksOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

listSupportedImages(ListSupportedImagesOptionalParams)

Wyświetla listę wszystkich obrazów maszyn wirtualnych obsługiwanych przez usługę Azure Batch.

function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

Parametry

options: ListSupportedImagesOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

listTaskFiles(string, string, ListTaskFilesOptionalParams)

Wyświetla listę plików w katalogu zadania w węźle obliczeniowym.

function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parametry

jobId: string

taskId: string

options: ListTaskFilesOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listTasks(string, ListTasksOptionalParams)

W przypadku zadań wieloinstancjowych informacje takie jak affinityId, executionInfo i nodeInfo odnoszą się do zadania głównego. Użyj API lista podzadań, aby pobrać informacje o podzadaniach.

function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

Parametry

jobId: string

options: ListTasksOptionalParams

Zwraca

PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

poolExists(string, PoolExistsOptionalParams)

Otrzymuje podstawowe właściwości puli.

function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>

Parametry

poolId: string

options: PoolExistsOptionalParams

Zwraca

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

Ponowna aktywacja powoduje, że zadanie kwalifikuje się do ponownego ponawiania próby do maksymalnej liczby ponownych prób. Stan zadania jest zmieniany na aktywny. Ponieważ zadanie nie jest już w stanie ukończonym, żadne poprzednie informacje o kodzie zakończenia lub niepowodzeniu nie są już dostępne po ponownym uaktywnieniu. Za każdym razem, gdy zadanie zostanie ponownie aktywowane, liczba ponownych prób zostanie zresetowana do wartości 0. Ponowne aktywowanie zakończy się niepowodzeniem dla zadań, które nie zostały ukończone lub które zostały wcześniej ukończone pomyślnie (z kodem zakończenia 0). Ponadto zadanie zakończy się niepowodzeniem, jeśli zadanie zostało ukończone (lub kończy lub usuwa).

function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>

Parametry

jobId: string

taskId: string

options: ReactivateTaskOptionalParams

Zwraca

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

Węzeł obliczeniowy można uruchomić ponownie tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia.

function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

nodeId: string

options: RebootNodeOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

System operacyjny można ponownie zainstalować w węźle obliczeniowym tylko wtedy, gdy jest w stanie bezczynności lub uruchomienia. To API może być wywoływane tylko na pulach utworzonych z własnością konfiguracji usług chmurowych.

function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

nodeId: string

options: ReimageNodeOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

Ta operacja może być uruchamiana tylko wtedy, gdy stan alokacji puli jest stały. Po uruchomieniu tej operacji stan alokacji zmienia się ze stałego na zmianę rozmiaru. Każde żądanie może usunąć maksymalnie 100 węzłów.

function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

removeOptions: BatchNodeRemoveOptions

options: RemoveNodesOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

To całkowicie zastępuje wszystkie aktualizowalne właściwości Job. Na przykład, jeśli zadanie ma przypisane ograniczenia, a ograniczenia nie są określone w tym żądaniu, usługa Batch usunie istniejące ograniczenia.

function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>

Parametry

jobId: string

job: BatchJob

options: ReplaceJobOptionalParams

Zwraca

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

To w pełni zastępuje wszystkie aktualizowalne właściwości Harmonogramu zadań. Na przykład, jeśli właściwość harmonogramu nie jest określona w tym żądaniu, usługa Batch usunie istniejący harmonogram. Zmiany w harmonogramie zadań dotyczą jedynie zadań utworzonych przez harmonogram po dokonaniu aktualizacji; obecnie działające Jobs pozostają niedotknięte.

function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>

Parametry

jobScheduleId: string

jobSchedule: BatchJobSchedule

options: ReplaceJobScheduleOptionalParams

Zwraca

Promise<void>

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

Ta operacja zastępuje wszystkie właściwości aktualizowalne Konta. Na przykład, jeśli element expiryTime nie jest określony, aktualna wartość jest zastępowana wartością domyślną, a nie pozostawiana bez zmian. Konto użytkownika na węźle obliczeniowym można aktualizować tylko wtedy, gdy jest ono w stanie bezczynności lub w trybie działania.

function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>

Parametry

poolId: string

nodeId: string

userName: string

updateOptions: BatchNodeUserUpdateOptions

options: ReplaceNodeUserOptionalParams

Zwraca

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

To w pełni zastępuje wszystkie aktualizowalne właściwości Pool. Na przykład, jeśli Pula ma powiązane StartTask i StartTask nie jest określone w tym żądaniu, usługa Batch usunie istniejące StartTask.

function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>

Parametry

poolId: string

pool: BatchPoolReplaceOptions

options: ReplacePoolPropertiesOptionalParams

Zwraca

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

Aktualizuje właściwości określonego zadania.

function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>

Parametry

jobId: string

taskId: string

task: BatchTask

options: ReplaceTaskOptionalParams

Zwraca

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

Rozmiar puli można zmienić tylko wtedy, gdy jego stan alokacji jest stały. Jeśli rozmiar puli jest już zmieniany, żądanie kończy się niepowodzeniem z kodem stanu 409. Po zmianie rozmiaru puli stan alokacji puli zmienia się ze stałego na zmianę rozmiaru. Nie można zmienić rozmiaru pul skonfigurowanych do automatycznego skalowania. Jeśli spróbujesz to zrobić, usługa Batch zwróci błąd 409. W przypadku zmiany rozmiaru puli w dół usługa Batch wybierze węzły obliczeniowe do usunięcia. Aby usunąć określone węzły obliczeniowe, zamiast tego użyj interfejsu API usuwania węzłów obliczeniowych puli.

function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

resizeOptions: BatchPoolResizeOptions

options: ResizePoolOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

Możesz uruchomić węzeł obliczeniowy tylko wtedy, gdy został on zlokalizowany przez deale.

function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

nodeId: string

options: StartNodeOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

To nie przywraca Puli do stanu sprzed operacji zmiany rozmiaru: jedynie powstrzymuje wszelkie dalsze zmiany, a Pula zachowuje swój obecny stan. Po zatrzymaniu pula stabilizuje się na liczbie węzłów obliczeniowych, na której była w momencie zakończenia operacji zatrzymania. Podczas operacji zatrzymania stan przydziału puli najpierw zmienia się na zatrzymanie, a następnie na stabilizację. Operacja zmiany rozmiaru nie musi być jawnym żądaniem zmiany rozmiaru Pool; to API może być również użyte do zatrzymania początkowego rozmiarowania puli podczas jej tworzenia.

function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>

Parametry

poolId: string

options: StopPoolResizeOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

Gdy żądanie Zakończenia Zadania zostanie otrzymane, usługa Batch ustawia Zadanie do stanu zakończenia. Usługa wsadowa kończy następnie wszystkie działające zadania powiązane z zadaniem i wykonuje wymagane zadania zwolnienia zadań. Następnie praca przechodzi w stan ukończony. Jeśli w Pracy znajdują się jakiekolwiek Zadania w stanie aktywnym, pozostaną w stanie aktywnym. Po zakończeniu zadania nie można dodawać nowych zadań, a pozostałe aktywne zadania nie będą zaplanowane.

function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>

Parametry

jobId: string

options: TerminateJobOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Przerywa harmonogram zadań.

function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parametry

jobScheduleId: string

options: TerminateJobScheduleOptionalParams

Zwraca

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

Po zakończeniu zadania zostanie ono przeniesione do stanu ukończonego. W przypadku zadań z wieloma wystąpieniami operacja zakończenia zadania jest stosowana synchronicznie do zadania podstawowego; podzadania są następnie przerywane asynchronicznie w tle.

function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>

Parametry

jobId: string

taskId: string

options: TerminateTaskOptionalParams

Zwraca

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Zastępuje to jedynie właściwości Job określone w żądaniu. Na przykład, jeśli Job ma ograniczenia, a żądanie nie określa elementu ograniczeń, to Job zachowuje istniejące ograniczenia.

function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>

Parametry

jobId: string

job: BatchJobUpdateOptions

options: UpdateJobOptionalParams

Zwraca

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Zastępuje to jedynie właściwości harmonogramu zadań określone w żądaniu. Na przykład, jeśli właściwość harmonogramu nie jest określona w tym żądaniu, usługa Batch zachowa istniejący harmonogram. Zmiany w harmonogramie zadań dotyczą jedynie zadań utworzonych przez harmonogram po dokonaniu aktualizacji; obecnie działające Jobs pozostają niedotknięte.

function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>

Parametry

jobScheduleId: string

jobSchedule: BatchJobScheduleUpdateOptions

options: UpdateJobScheduleOptionalParams

Zwraca

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

To zastępuje jedynie właściwości Puli określone w żądaniu. Na przykład, jeśli Pula ma przypisane StartZadanie, a żądanie nie określa elementu StartZadania, to Pula zachowuje istniejące StartZadanie.

function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>

Parametry

poolId: string

pool: BatchPoolUpdateOptions

options: UpdatePoolOptionalParams

Zwraca

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Służy to do automatycznego zbierania plików logów usług Azure Batch z węzłów obliczeniowych, jeśli napotkasz błąd i chcesz eskalować do wsparcia Azure. Pliki dziennika usługi Azure Batch powinny być udostępniane pomoc techniczna platformy Azure, aby ułatwić debugowanie problemów z usługą Batch.

function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>

Parametry

poolId: string

nodeId: string

uploadOptions: UploadBatchServiceLogsOptions

options: UploadNodeLogsOptionalParams

Zwraca

Promise<UploadBatchServiceLogsResult>

BatchClient class

Konstruktory

Metody

Szczegóły konstruktora

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

Parametry

Szczegóły metody

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

Parametry

Zwraca

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Parametry

Zwraca

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Parametry

Zwraca

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

Parametry

Zwraca

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Parametry

Zwraca

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Parametry

Zwraca

deallocateNode(string, string, DeallocateNodeOptionalParams)

Parametry

Zwraca

deleteJob(string, DeleteJobOptionalParams)

Parametry

Zwraca

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Parametry

Zwraca

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Parametry

Zwraca

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Parametry

Zwraca

deletePool(string, DeletePoolOptionalParams)

Parametry

Zwraca

deleteTask(string, string, DeleteTaskOptionalParams)

Parametry

Zwraca

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Parametry

Zwraca

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

Parametry

Zwraca

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Parametry

Zwraca

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Parametry

Zwraca

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Parametry

Zwraca

enableJob(string, EnableJobOptionalParams)

Parametry

Zwraca

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Parametry

Zwraca

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Parametry

Zwraca

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Parametry

Zwraca

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Parametry

Zwraca

getApplication(string, GetApplicationOptionalParams)

Parametry

Zwraca

getJob(string, GetJobOptionalParams)