TaskOperations Klas
TaskOperations-bewerkingen.
U moet deze klasse niet rechtstreeks instantiëren, maar een clientexemplaar maken dat deze voor u maakt en deze als kenmerk koppelt.
- Overname
-
builtins.objectTaskOperations
Constructor
TaskOperations(client, config, serializer, deserializer)Parameters
- client
Client voor serviceaanvragen.
- config
Configuratie van de serviceclient.
- serializer
Een serialisatiefunctie voor objectmodellen.
- deserializer
Een deserializer voor objectmodellen.
Variabelen
- api_version
De API-versie die moet worden gebruikt voor de aanvraag. Constante waarde: "2023-05-01.17.0".
Methoden
| add |
Hiermee voegt u een taak toe aan de opgegeven taak. De maximale levensduur van een taak van optellen tot voltooien is 180 dagen. Als een taak niet binnen 180 dagen na toevoeging is voltooid, wordt deze beëindigd door de Batch-service en achtergelaten in de status waarin deze zich op dat moment bevond. |
| add_collection |
Hiermee voegt u een verzameling taken toe aan de opgegeven taak. 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 die in deze aanvraag zijn ingediend. Als er een time-out optreedt voor de server of als de verbinding wordt gesloten tijdens de aanvraag, 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 af te handelen bij het opnieuw verzenden van een aanvraag. U moet bijvoorbeeld dezelfde taak-id's gebruiken tijdens een nieuwe poging, zodat als de vorige bewerking is geslaagd, de nieuwe poging niet onverwacht extra taken zal maken. Als het antwoord taken bevat die niet kunnen worden toegevoegd, kan een client de aanvraag opnieuw proberen. In een nieuwe poging is het het efficiëntst om alleen taken opnieuw te verzenden die niet zijn toegevoegd en om taken weg te laten die bij de eerste poging zijn toegevoegd. De maximale levensduur van een taak van optellen tot voltooien is 180 dagen. Als een taak niet binnen 180 dagen na het toevoegen is voltooid, wordt deze beëindigd door de Batch-service en achtergelaten in de staat waarin deze zich op dat moment bevond. |
| delete |
Hiermee verwijdert u een taak uit de opgegeven taak. Wanneer een taak wordt verwijderd, worden alle bestanden in de map op het rekenknooppunt waarop de taak is uitgevoerd, ook verwijderd (ongeacht de retentietijd). Voor taken met meerdere exemplaren wordt de bewerking Taak verwijderen synchroon toegepast op de primaire taak; subtaken en de bijbehorende bestanden worden vervolgens asynchroon op de achtergrond verwijderd. |
| get |
Hiermee haalt u informatie op over de opgegeven taak. Voor taken met meerdere exemplaren verwijzen informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen. |
| list |
Een lijst met alle taken die zijn gekoppeld aan de opgegeven taak. Voor taken met meerdere exemplaren verwijzen informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen. |
| list_subtasks |
Een lijst met alle subtaken die zijn gekoppeld aan de opgegeven taak met meerdere exemplaren. Als de taak geen taak met meerdere exemplaren is, retourneert dit een lege verzameling. |
| reactivate |
Hiermee wordt een taak opnieuw geactiveerd, zodat deze opnieuw kan worden uitgevoerd, zelfs als het aantal nieuwe pogingen is uitgeput. Door opnieuw te activeren kan een taak opnieuw worden geprobeerd tot het maximale aantal nieuwe pogingen. De status van de taak wordt gewijzigd in actief. Omdat de taak niet langer de voltooide status heeft, zijn eerdere afsluitcode of foutgegevens 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 afsluitcode 0). Bovendien mislukt deze als de taak is voltooid (of wordt beëindigd of verwijderd). |
| terminate |
Hiermee wordt de opgegeven taak beëindigd. Wanneer de taak is beëindigd, wordt deze verplaatst naar de voltooide status. Voor taken met meerdere exemplaren wordt de bewerking Taak beëindigen synchroon toegepast op de primaire taak; subtaken worden vervolgens asynchroon op de achtergrond beëindigd. |
| update |
Updates de eigenschappen van de opgegeven taak. |
add
Hiermee voegt u een taak toe aan de opgegeven taak.
De maximale levensduur van een taak van optellen tot voltooien is 180 dagen. Als een taak niet binnen 180 dagen na toevoeging is voltooid, wordt deze beëindigd door de Batch-service en achtergelaten in de status waarin deze zich op dat moment bevond.
add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
add_collection
Hiermee voegt u een verzameling taken toe aan de opgegeven taak.
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 die in deze aanvraag zijn ingediend. Als er een time-out optreedt voor de server of als de verbinding wordt gesloten tijdens de aanvraag, 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 af te handelen bij het opnieuw verzenden van een aanvraag. U moet bijvoorbeeld dezelfde taak-id's gebruiken tijdens een nieuwe poging, zodat als de vorige bewerking is geslaagd, de nieuwe poging niet onverwacht extra taken zal maken. Als het antwoord taken bevat die niet kunnen worden toegevoegd, kan een client de aanvraag opnieuw proberen. In een nieuwe poging is het het efficiëntst om alleen taken opnieuw te verzenden die niet zijn toegevoegd en om taken weg te laten die bij de eerste poging zijn toegevoegd. De maximale levensduur van een taak van optellen tot voltooien is 180 dagen. Als een taak niet binnen 180 dagen na het toevoegen is voltooid, wordt deze beëindigd door de Batch-service en achtergelaten in de staat waarin deze zich op dat moment bevond.
add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)Parameters
- value
- list of TaskAddParameter
De verzameling taken die u wilt toevoegen. De totale geserialiseerde grootte van deze verzameling moet kleiner zijn dan 4 MB. Als deze groter is dan 4 MB (bijvoorbeeld als elke taak 100's resourcebestanden of omgevingsvariabelen heeft), mislukt de aanvraag met de code RequestBodyTooLarge en moet deze opnieuw worden geprobeerd met minder taken.
- task_add_collection_options
- TaskAddCollectionOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- threads
- int
aantal threads dat parallel moet worden gebruikt bij het toevoegen van taken. Indien opgegeven en groter dan 0, worden extra threads gestart om aanvragen te verzenden en te wachten tot ze zijn voltooid. Anders worden add_collection aanvragen opeenvolgend verzonden op de hoofdthread
Retouren
TaskAddCollectionResult of ClientRawResponse als raw =true
Retourtype
Uitzonderingen
delete
Hiermee verwijdert u een taak uit de opgegeven taak.
Wanneer een taak wordt verwijderd, worden alle bestanden in de map op het rekenknooppunt waarop de taak is uitgevoerd, ook verwijderd (ongeacht de retentietijd). Voor taken met meerdere exemplaren wordt de bewerking Taak verwijderen synchroon toegepast op de primaire taak; subtaken en de bijbehorende bestanden worden vervolgens asynchroon op de achtergrond verwijderd.
delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- task_delete_options
- TaskDeleteOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
get
Hiermee haalt u informatie op over de opgegeven taak.
Voor taken met meerdere exemplaren verwijzen informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen.
get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
CloudTask of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
list
Een lijst met alle taken die zijn gekoppeld aan de opgegeven taak.
Voor taken met meerdere exemplaren verwijzen informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen.
list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
Een iterator zoals een exemplaar van CloudTask
Retourtype
Uitzonderingen
list_subtasks
Een lijst met alle subtaken die zijn gekoppeld aan de opgegeven taak met meerdere exemplaren.
Als de taak geen taak met meerdere exemplaren is, retourneert dit een lege verzameling.
list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- task_list_subtasks_options
- TaskListSubtasksOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
CloudTaskListSubtasksResult of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
reactivate
Hiermee wordt een taak opnieuw geactiveerd, zodat deze opnieuw kan worden uitgevoerd, zelfs als het aantal nieuwe pogingen is uitgeput.
Door opnieuw te activeren kan een taak opnieuw worden geprobeerd tot het maximale aantal nieuwe pogingen. De status van de taak wordt gewijzigd in actief. Omdat de taak niet langer de voltooide status heeft, zijn eerdere afsluitcode of foutgegevens 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 afsluitcode 0). Bovendien mislukt deze als de taak is voltooid (of wordt beëindigd of verwijderd).
reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- task_reactivate_options
- TaskReactivateOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
terminate
Hiermee wordt de opgegeven taak beëindigd.
Wanneer de taak is beëindigd, wordt deze verplaatst naar de voltooide status. Voor taken met meerdere exemplaren wordt de bewerking Taak beëindigen synchroon toegepast op de primaire taak; subtaken worden vervolgens asynchroon op de achtergrond beëindigd.
terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- task_terminate_options
- TaskTerminateOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
update
Updates de eigenschappen van de opgegeven taak.
update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- constraints
- TaskConstraints
Beperkingen die van toepassing zijn op deze taak. Als u dit weglaat, krijgt de taak de standaardbeperkingen. Voor taken met meerdere exemplaren geldt het bijwerken van de bewaartijd alleen voor de primaire taak en niet voor subtaken.
- task_update_options
- TaskUpdateOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
Kenmerken
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor