Task class
Klasse die een taak vertegenwoordigt.
Constructors
| Task(Batch |
Een taak maken. |
Methoden
| add(string, Task |
|
| add(string, Task |
De maximale levensduur van een taak vanaf aanvulling tot voltooiing is 180 dagen. Als een taak niet binnen 180 dagen na het toevoegen is voltooid, wordt deze beëindigd door de Batch-service en blijft deze in de toestand waarin deze zich op dat moment bevond. |
| add(string, Task |
|
| add |
|
| add |
Houd er rekening mee dat elke taak een unieke id moet hebben. De Batch-service retourneert mogelijk niet de resultaten voor elke taak in dezelfde volgorde als de taken zijn verzonden in deze aanvraag. Als er een time-out optreedt voor de server of de verbinding tijdens de aanvraag wordt gesloten, is de aanvraag mogelijk gedeeltelijk of volledig verwerkt of helemaal niet. In dergelijke gevallen moet de gebruiker de aanvraag opnieuw uitgeven. Houd er rekening mee dat het aan de gebruiker is om fouten correct te verwerken bij het opnieuw uitgeven van een aanvraag. U moet bijvoorbeeld dezelfde taak-id's gebruiken tijdens een nieuwe poging, zodat als de vorige bewerking is geslaagd, er geen extra taken onverwacht worden gemaakt. Als het antwoord taken bevat die niet kunnen worden toegevoegd, kan een client de aanvraag opnieuw proberen. Bij een nieuwe poging is het meest efficiënt om alleen taken opnieuw in te dienen die niet konden worden toegevoegd en om taken weg te laten die bij de eerste poging zijn toegevoegd. De maximale levensduur van een taak vanaf aanvulling tot voltooiing is 180 dagen. Als een taak niet binnen 180 dagen na het toevoegen is voltooid, wordt deze beëindigd door de Batch-service en blijft deze in de toestand waarin deze zich op dat moment bevond. |
| add |
|
| delete |
|
| delete |
Wanneer een taak wordt verwijderd, worden alle bestanden in de map op het rekenknooppunt waarop deze is uitgevoerd ook verwijderd (ongeacht de bewaartijd). Voor taken met meerdere exemplaren wordt de verwijdertaak synchroon toegepast op de primaire taak; subtaken en hun bestanden worden vervolgens asynchroon op de achtergrond verwijderd. |
| delete |
|
| get(string, string, Service |
|
| get(string, string, Task |
Voor taken met meerdere exemplaren verwijst informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen. |
| get(string, string, Task |
|
| list(string, Service |
|
| list(string, Task |
Voor taken met meerdere exemplaren verwijst informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen. |
| list(string, Task |
|
| list |
|
| list |
Voor taken met meerdere exemplaren verwijst informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen. |
| list |
|
| list |
|
| list |
Als de taak geen taak met meerdere exemplaren is, retourneert dit een lege verzameling. |
| list |
|
| reactivate(string, string, Service |
|
| reactivate(string, string, Task |
Door opnieuw te activeren kan een taak opnieuw worden geprobeerd tot het maximumaantal nieuwe pogingen. De status van de taak wordt gewijzigd in actief. Omdat de taak niet langer de status Voltooid heeft, zijn eventuele eerdere afsluitcode of foutinformatie niet meer beschikbaar na opnieuw activeren. Telkens wanneer een taak opnieuw wordt geactiveerd, wordt het aantal nieuwe pogingen opnieuw ingesteld op 0. Opnieuw activeren mislukt voor taken die niet zijn voltooid of die eerder zijn voltooid (met een afsluitcode van 0). Bovendien mislukt het als de taak is voltooid (of wordt beëindigd of verwijderd). |
| reactivate(string, string, Task |
|
| terminate(string, string, Service |
|
| terminate(string, string, Task |
Wanneer de taak is beëindigd, wordt deze verplaatst naar de voltooide status. Voor taken met meerdere exemplaren wordt de beëindigingstaak synchroon toegepast op de primaire taak; subtaken worden vervolgens asynchroon op de achtergrond beëindigd. |
| terminate(string, string, Task |
|
| update(string, string, Service |
|
| update(string, string, Task |
Hiermee worden de eigenschappen van de opgegeven taak bijgewerkt. |
| update(string, string, Task |
Constructordetails
Task(BatchServiceClientContext)
Een taak maken.
new Task(client: BatchServiceClientContext)Parameters
- client
- BatchServiceClientContext
Verwijzing naar de serviceclient.
Methodedetails
add(string, TaskAddParameter, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak waaraan de taak moet worden toegevoegd.
- task
- TaskAddParameter
De taak die moet worden toegevoegd.
- callback
-
ServiceCallback<void>
De callback
add(string, TaskAddParameter, TaskAddOptionalParams)
De maximale levensduur van een taak vanaf aanvulling tot voltooiing is 180 dagen. Als een taak niet binnen 180 dagen na het toevoegen is voltooid, wordt deze beëindigd door de Batch-service en blijft deze in de toestand waarin deze zich op dat moment bevond.
function add(jobId: string, task: TaskAddParameter, options?: TaskAddOptionalParams): Promise<TaskAddResponse>Parameters
- jobId
-
string
De id van de taak waaraan de taak moet worden toegevoegd.
- task
- TaskAddParameter
De taak die moet worden toegevoegd.
- options
- TaskAddOptionalParams
De optionele parameters
Retouren
Promise<TaskAddResponse>
Promise<Models.TaskAddResponse->
add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
function add(jobId: string, task: TaskAddParameter, options: TaskAddOptionalParams, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak waaraan de taak moet worden toegevoegd.
- task
- TaskAddParameter
De taak die moet worden toegevoegd.
- options
- TaskAddOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], callback: ServiceCallback<TaskAddCollectionResult>)Parameters
- jobId
-
string
De id van de taak waaraan de taakverzameling moet worden toegevoegd.
- value
De verzameling taken die u wilt toevoegen. Het maximumaantal taken is 100. De totale geserialiseerde grootte van deze verzameling moet kleiner zijn dan 1 MB. Als deze groter is dan 1 MB (bijvoorbeeld als elke taak 100 resourcebestanden of omgevingsvariabelen heeft), mislukt de aanvraag met code RequestBodyTooLarge en moet het opnieuw worden geprobeerd met minder taken.
- callback
De callback
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)
Houd er rekening mee dat elke taak een unieke id moet hebben. De Batch-service retourneert mogelijk niet de resultaten voor elke taak in dezelfde volgorde als de taken zijn verzonden in deze aanvraag. Als er een time-out optreedt voor de server of de verbinding tijdens de aanvraag wordt gesloten, is de aanvraag mogelijk gedeeltelijk of volledig verwerkt of helemaal niet. In dergelijke gevallen moet de gebruiker de aanvraag opnieuw uitgeven. Houd er rekening mee dat het aan de gebruiker is om fouten correct te verwerken bij het opnieuw uitgeven van een aanvraag. U moet bijvoorbeeld dezelfde taak-id's gebruiken tijdens een nieuwe poging, zodat als de vorige bewerking is geslaagd, er geen extra taken onverwacht worden gemaakt. Als het antwoord taken bevat die niet kunnen worden toegevoegd, kan een client de aanvraag opnieuw proberen. Bij een nieuwe poging is het meest efficiënt om alleen taken opnieuw in te dienen die niet konden worden toegevoegd en om taken weg te laten die bij de eerste poging zijn toegevoegd. De maximale levensduur van een taak vanaf aanvulling tot voltooiing is 180 dagen. Als een taak niet binnen 180 dagen na het toevoegen is voltooid, wordt deze beëindigd door de Batch-service en blijft deze in de toestand waarin deze zich op dat moment bevond.
function addCollection(jobId: string, value: TaskAddParameter[], options?: TaskAddCollectionOptionalParams): Promise<TaskAddCollectionResponse>Parameters
- jobId
-
string
De id van de taak waaraan de taakverzameling moet worden toegevoegd.
- value
De verzameling taken die u wilt toevoegen. Het maximumaantal taken is 100. De totale geserialiseerde grootte van deze verzameling moet kleiner zijn dan 1 MB. Als deze groter is dan 1 MB (bijvoorbeeld als elke taak 100 resourcebestanden of omgevingsvariabelen heeft), mislukt de aanvraag met code RequestBodyTooLarge en moet het opnieuw worden geprobeerd met minder taken.
- options
- TaskAddCollectionOptionalParams
De optionele parameters
Retouren
Promise<TaskAddCollectionResponse>
Beloof<modellen.TaskAddCollectionResponse>
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
function addCollection(jobId: string, value: TaskAddParameter[], options: TaskAddCollectionOptionalParams, callback: ServiceCallback<TaskAddCollectionResult>)Parameters
- jobId
-
string
De id van de taak waaraan de taakverzameling moet worden toegevoegd.
- value
De verzameling taken die u wilt toevoegen. Het maximumaantal taken is 100. De totale geserialiseerde grootte van deze verzameling moet kleiner zijn dan 1 MB. Als deze groter is dan 1 MB (bijvoorbeeld als elke taak 100 resourcebestanden of omgevingsvariabelen heeft), mislukt de aanvraag met code RequestBodyTooLarge en moet het opnieuw worden geprobeerd met minder taken.
- options
- TaskAddCollectionOptionalParams
De optionele parameters
- callback
De callback
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak waaruit de taak moet worden verwijderd.
- taskId
-
string
De id van de taak die moet worden verwijderd.
- callback
-
ServiceCallback<void>
De callback
deleteMethod(string, string, TaskDeleteMethodOptionalParams)
Wanneer een taak wordt verwijderd, worden alle bestanden in de map op het rekenknooppunt waarop deze is uitgevoerd ook verwijderd (ongeacht de bewaartijd). Voor taken met meerdere exemplaren wordt de verwijdertaak synchroon toegepast op de primaire taak; subtaken en hun bestanden worden vervolgens asynchroon op de achtergrond verwijderd.
function deleteMethod(jobId: string, taskId: string, options?: TaskDeleteMethodOptionalParams): Promise<TaskDeleteResponse>Parameters
- jobId
-
string
De id van de taak waaruit de taak moet worden verwijderd.
- taskId
-
string
De id van de taak die moet worden verwijderd.
- options
- TaskDeleteMethodOptionalParams
De optionele parameters
Retouren
Promise<TaskDeleteResponse>
Beloof<modellen.TaskDeleteResponse>
deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobId: string, taskId: string, options: TaskDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak waaruit de taak moet worden verwijderd.
- taskId
-
string
De id van de taak die moet worden verwijderd.
- options
- TaskDeleteMethodOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback
get(string, string, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, callback: ServiceCallback<CloudTask>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak om informatie over op te halen.
- callback
De callback
get(string, string, TaskGetOptionalParams)
Voor taken met meerdere exemplaren verwijst informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen.
function get(jobId: string, taskId: string, options?: TaskGetOptionalParams): Promise<TaskGetResponse>Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak om informatie over op te halen.
- options
- TaskGetOptionalParams
De optionele parameters
Retouren
Promise<TaskGetResponse>
Promise<Models.TaskGetResponse->
get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
function get(jobId: string, taskId: string, options: TaskGetOptionalParams, callback: ServiceCallback<CloudTask>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak om informatie over op te halen.
- options
- TaskGetOptionalParams
De optionele parameters
- callback
De callback
list(string, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, callback: ServiceCallback<CloudTaskListResult>)Parameters
- jobId
-
string
De id van de taak.
- callback
De callback
list(string, TaskListOptionalParams)
Voor taken met meerdere exemplaren verwijst informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen.
function list(jobId: string, options?: TaskListOptionalParams): Promise<TaskListResponse>Parameters
- jobId
-
string
De id van de taak.
- options
- TaskListOptionalParams
De optionele parameters
Retouren
Promise<TaskListResponse>
Beloof<modellen.TaskListResponse>
list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
function list(jobId: string, options: TaskListOptionalParams, callback: ServiceCallback<CloudTaskListResult>)Parameters
- jobId
-
string
De id van de taak.
- options
- TaskListOptionalParams
De optionele parameters
- callback
De callback
listNext(string, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudTaskListResult>)Parameters
- nextPageLink
-
string
De NextLink van de vorige geslaagde aanroep naar lijstbewerking.
- callback
De callback
listNext(string, TaskListNextOptionalParams)
Voor taken met meerdere exemplaren verwijst informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen.
function listNext(nextPageLink: string, options?: TaskListNextOptionalParams): Promise<TaskListResponse>Parameters
- nextPageLink
-
string
De NextLink van de vorige geslaagde aanroep naar lijstbewerking.
- options
- TaskListNextOptionalParams
De optionele parameters
Retouren
Promise<TaskListResponse>
Beloof<modellen.TaskListResponse>
listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
function listNext(nextPageLink: string, options: TaskListNextOptionalParams, callback: ServiceCallback<CloudTaskListResult>)Parameters
- nextPageLink
-
string
De NextLink van de vorige geslaagde aanroep naar lijstbewerking.
- options
- TaskListNextOptionalParams
De optionele parameters
- callback
De callback
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, callback: ServiceCallback<CloudTaskListSubtasksResult>)Parameters
- jobId
-
string
De id van de taak.
- taskId
-
string
De id van de taak.
- callback
De callback
listSubtasks(string, string, TaskListSubtasksOptionalParams)
Als de taak geen taak met meerdere exemplaren is, retourneert dit een lege verzameling.
function listSubtasks(jobId: string, taskId: string, options?: TaskListSubtasksOptionalParams): Promise<TaskListSubtasksResponse>Parameters
- jobId
-
string
De id van de taak.
- taskId
-
string
De id van de taak.
- options
- TaskListSubtasksOptionalParams
De optionele parameters
Retouren
Promise<TaskListSubtasksResponse>
Beloof<modellen.TaskListSubtasksResponse>
listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
function listSubtasks(jobId: string, taskId: string, options: TaskListSubtasksOptionalParams, callback: ServiceCallback<CloudTaskListSubtasksResult>)Parameters
- jobId
-
string
De id van de taak.
- taskId
-
string
De id van de taak.
- options
- TaskListSubtasksOptionalParams
De optionele parameters
- callback
De callback
reactivate(string, string, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die opnieuw moet worden geactiveerd.
- callback
-
ServiceCallback<void>
De callback
reactivate(string, string, TaskReactivateOptionalParams)
Door opnieuw te activeren kan een taak opnieuw worden geprobeerd tot het maximumaantal nieuwe pogingen. De status van de taak wordt gewijzigd in actief. Omdat de taak niet langer de status Voltooid heeft, zijn eventuele eerdere afsluitcode of foutinformatie niet meer beschikbaar na opnieuw activeren. Telkens wanneer een taak opnieuw wordt geactiveerd, wordt het aantal nieuwe pogingen opnieuw ingesteld op 0. Opnieuw activeren mislukt voor taken die niet zijn voltooid of die eerder zijn voltooid (met een afsluitcode van 0). Bovendien mislukt het als de taak is voltooid (of wordt beëindigd of verwijderd).
function reactivate(jobId: string, taskId: string, options?: TaskReactivateOptionalParams): Promise<TaskReactivateResponse>Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die opnieuw moet worden geactiveerd.
- options
- TaskReactivateOptionalParams
De optionele parameters
Retouren
Promise<TaskReactivateResponse>
Beloof<modellen.TaskReactivateResponse>
reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
function reactivate(jobId: string, taskId: string, options: TaskReactivateOptionalParams, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die opnieuw moet worden geactiveerd.
- options
- TaskReactivateOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback
terminate(string, string, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die moet worden beëindigd.
- callback
-
ServiceCallback<void>
De callback
terminate(string, string, TaskTerminateOptionalParams)
Wanneer de taak is beëindigd, wordt deze verplaatst naar de voltooide status. Voor taken met meerdere exemplaren wordt de beëindigingstaak synchroon toegepast op de primaire taak; subtaken worden vervolgens asynchroon op de achtergrond beëindigd.
function terminate(jobId: string, taskId: string, options?: TaskTerminateOptionalParams): Promise<TaskTerminateResponse>Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die moet worden beëindigd.
- options
- TaskTerminateOptionalParams
De optionele parameters
Retouren
Promise<TaskTerminateResponse>
Beloof<modellen.TaskTerminateResponse>
terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobId: string, taskId: string, options: TaskTerminateOptionalParams, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die moet worden beëindigd.
- options
- TaskTerminateOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback
update(string, string, ServiceCallback<void>)
function update(jobId: string, taskId: string, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die moet worden bijgewerkt.
- callback
-
ServiceCallback<void>
De callback
update(string, string, TaskUpdateOptionalParams)
Hiermee worden de eigenschappen van de opgegeven taak bijgewerkt.
function update(jobId: string, taskId: string, options?: TaskUpdateOptionalParams): Promise<TaskUpdateResponse>Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die moet worden bijgewerkt.
- options
- TaskUpdateOptionalParams
De optionele parameters
Retouren
Promise<TaskUpdateResponse>
Beloof<modellen.TaskUpdateResponse>
update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)
function update(jobId: string, taskId: string, options: TaskUpdateOptionalParams, callback: ServiceCallback<void>)Parameters
- jobId
-
string
De id van de taak die de taak bevat.
- taskId
-
string
De id van de taak die moet worden bijgewerkt.
- options
- TaskUpdateOptionalParams
De optionele parameters
- callback
-
ServiceCallback<void>
De callback