JobOperations Klas
JobOperations-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.objectJobOperations
Constructor
JobOperations(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 het opgegeven account. De Batch-service ondersteunt twee manieren om het werk te beheren dat wordt uitgevoerd als onderdeel van een taak. In de eerste benadering geeft de gebruiker een Taakbeheertaak op. De Batch-service start deze taak wanneer deze klaar is om de taak te starten. De Taakbeheertaak beheert alle andere taken die onder deze taak worden uitgevoerd, met behulp van de Taak-API's. In de tweede benadering beheert de gebruiker rechtstreeks de uitvoering van taken onder een actieve taak, met behulp van de Taak-API's. Opmerking: vermijd bij het benoemen van taken gevoelige informatie zoals gebruikersnamen of geheime projectnamen. Deze informatie kan worden weergegeven in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuning technici. |
| delete |
Hiermee verwijdert u een taak. Als u een taak verwijdert, worden ook alle taken verwijderd die deel uitmaken van die taak en alle taakstatistieken. Dit overschrijft ook de bewaarperiode voor taakgegevens; dat wil gezegd, als de taak taken bevat die nog steeds worden bewaard op rekenknooppunten, verwijderen de Batch-services de werkmappen van die taken en alle inhoud ervan. Wanneer een aanvraag voor een verwijdertaak wordt ontvangen, stelt de Batch-service de taak in op de status Verwijderen. Alle updatebewerkingen op een taak die de status Verwijderen heeft, mislukken met statuscode 409 (Conflict), waarbij aanvullende informatie aangeeft dat de taak wordt verwijderd. |
| disable |
Hiermee schakelt u de opgegeven taak uit, waardoor nieuwe taken niet kunnen worden uitgevoerd. De Batch-service verplaatst de taak onmiddellijk naar de uitgeschakelde status. Batch gebruikt vervolgens de parameter disableTasks om te bepalen wat er moet worden gedaan met de taken die momenteel worden uitgevoerd van de taak. De taak blijft in de uitgeschakelde status totdat de bewerking uitschakelen is voltooid en alle taken zijn afgehandeld volgens de optie disableTasks; de taak wordt vervolgens verplaatst naar de uitgeschakelde status. Er worden geen nieuwe taken gestart onder de taak totdat deze weer actief is. Als u een taak probeert uit te schakelen die een andere status heeft dan actief, uitschakelen of uitgeschakeld, mislukt de aanvraag met statuscode 409. |
| enable |
Hiermee schakelt u de opgegeven taak in, zodat nieuwe taken kunnen worden uitgevoerd. Wanneer u deze API aanroept, stelt de Batch-service een uitgeschakelde taak in op de inschakelende status. Nadat deze bewerking is voltooid, wordt de taak verplaatst naar de actieve status en wordt de planning van nieuwe taken onder de taak hervat. De Batch-service staat niet toe dat een taak langer dan 180 dagen actief blijft. Als u daarom een taak inschakelt die actieve taken bevat die meer dan 180 dagen geleden zijn toegevoegd, worden deze taken niet uitgevoerd. |
| get |
Hiermee haalt u informatie op over de opgegeven taak. |
| get_task_counts |
Hiermee haalt u het aantal taken voor de opgegeven taak op. Taaktellingen bieden een telling van de taken per actieve, actieve of voltooide taakstatus en een aantal taken die zijn geslaagd of mislukt. Taken in de voorbereidingsstatus worden geteld als actief. Houd er rekening mee dat de geretourneerde getallen mogelijk niet altijd up-to-date zijn. Als u exacte taakaantallen nodig hebt, gebruikt u een lijstquery. |
| list |
Een lijst met alle taken in het opgegeven account. |
| list_from_job_schedule |
Hiermee worden de taken weergegeven die zijn gemaakt onder de opgegeven taakplanning. |
| list_preparation_and_release_task_status |
Geeft de uitvoeringsstatus weer van de taakvoorbereiding en taakrelease voor de opgegeven taak op de rekenknooppunten waarop de taak is uitgevoerd. Deze API retourneert de taakvoorbereiding en taakreleasetaakstatus op alle rekenknooppunten waarop de taak voor taakvoorbereiding of taakreleasetaak is uitgevoerd. Dit omvat rekenknooppunten die sindsdien uit de pool zijn verwijderd. Als deze API wordt aangeroepen voor een taak die geen taakvoorbereiding of taakreleasetaak heeft, retourneert de Batch-service HTTP-statuscode 409 (Conflict) met de foutcode JobPreparationTaskNotSpecified. |
| patch |
Updates de eigenschappen van de opgegeven taak. Hiermee vervangt u alleen de taakeigenschappen die in de aanvraag zijn opgegeven. Als de taak bijvoorbeeld beperkingen heeft en een aanvraag het element beperkingen niet opgeeft, behoudt de taak de bestaande beperkingen. |
| terminate |
Hiermee beëindigt u de opgegeven taak en markeert deze als voltooid. Wanneer een aanvraag voor het beëindigen van de taak wordt ontvangen, stelt de Batch-service de taak in op de eindstatus. De Batch-service beëindigt vervolgens alle actieve taken die aan de taak zijn gekoppeld en voert alle vereiste taakreleasetaken uit. Vervolgens wordt de taak verplaatst naar de status Voltooid. Als er taken in de taak met de actieve status zijn, blijven deze in de actieve status. Zodra een taak is beëindigd, kunnen er geen nieuwe taken meer worden toegevoegd en worden resterende actieve taken niet meer gepland. |
| update |
Updates de eigenschappen van de opgegeven taak. Hiermee worden alle bijwerkbare eigenschappen van de taak volledig vervangen. Als er bijvoorbeeld beperkingen aan de taak zijn gekoppeld en als er geen beperkingen zijn opgegeven met deze aanvraag, verwijdert de Batch-service de bestaande beperkingen. |
add
Hiermee voegt u een taak toe aan het opgegeven account.
De Batch-service ondersteunt twee manieren om het werk te beheren dat wordt uitgevoerd als onderdeel van een taak. In de eerste benadering geeft de gebruiker een Taakbeheertaak op. De Batch-service start deze taak wanneer deze klaar is om de taak te starten. De Taakbeheertaak beheert alle andere taken die onder deze taak worden uitgevoerd, met behulp van de Taak-API's. In de tweede benadering beheert de gebruiker rechtstreeks de uitvoering van taken onder een actieve taak, met behulp van de Taak-API's. Opmerking: vermijd bij het benoemen van taken gevoelige informatie zoals gebruikersnamen of geheime projectnamen. Deze informatie kan worden weergegeven in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuning technici.
add(job, job_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
delete
Hiermee verwijdert u een taak.
Als u een taak verwijdert, worden ook alle taken verwijderd die deel uitmaken van die taak en alle taakstatistieken. Dit overschrijft ook de bewaarperiode voor taakgegevens; dat wil gezegd, als de taak taken bevat die nog steeds worden bewaard op rekenknooppunten, verwijderen de Batch-services de werkmappen van die taken en alle inhoud ervan. Wanneer een aanvraag voor een verwijdertaak wordt ontvangen, stelt de Batch-service de taak in op de status Verwijderen. Alle updatebewerkingen op een taak die de status Verwijderen heeft, mislukken met statuscode 409 (Conflict), waarbij aanvullende informatie aangeeft dat de taak wordt verwijderd.
delete(job_id, job_delete_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
disable
Hiermee schakelt u de opgegeven taak uit, waardoor nieuwe taken niet kunnen worden uitgevoerd.
De Batch-service verplaatst de taak onmiddellijk naar de uitgeschakelde status. Batch gebruikt vervolgens de parameter disableTasks om te bepalen wat er moet worden gedaan met de taken die momenteel worden uitgevoerd van de taak. De taak blijft in de uitgeschakelde status totdat de bewerking uitschakelen is voltooid en alle taken zijn afgehandeld volgens de optie disableTasks; de taak wordt vervolgens verplaatst naar de uitgeschakelde status. Er worden geen nieuwe taken gestart onder de taak totdat deze weer actief is. Als u een taak probeert uit te schakelen die een andere status heeft dan actief, uitschakelen of uitgeschakeld, mislukt de aanvraag met statuscode 409.
disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- disable_tasks
- str of DisableJobOption
Mogelijke waarden zijn: 'requeue', 'terminate', 'wait'
- job_disable_options
- JobDisableOptions
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
enable
Hiermee schakelt u de opgegeven taak in, zodat nieuwe taken kunnen worden uitgevoerd.
Wanneer u deze API aanroept, stelt de Batch-service een uitgeschakelde taak in op de inschakelende status. Nadat deze bewerking is voltooid, wordt de taak verplaatst naar de actieve status en wordt de planning van nieuwe taken onder de taak hervat. De Batch-service staat niet toe dat een taak langer dan 180 dagen actief blijft. Als u daarom een taak inschakelt die actieve taken bevat die meer dan 180 dagen geleden zijn toegevoegd, worden deze taken niet uitgevoerd.
enable(job_id, job_enable_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
get
Hiermee haalt u informatie op over de opgegeven taak.
get(job_id, job_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
CloudJob of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
get_task_counts
Hiermee haalt u het aantal taken voor de opgegeven taak op.
Taaktellingen bieden een telling van de taken per actieve, actieve of voltooide taakstatus en een aantal taken die zijn geslaagd of mislukt. Taken in de voorbereidingsstatus worden geteld als actief. Houd er rekening mee dat de geretourneerde getallen mogelijk niet altijd up-to-date zijn. Als u exacte taakaantallen nodig hebt, gebruikt u een lijstquery.
get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- job_get_task_counts_options
- JobGetTaskCountsOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
TaskCountsResult of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
list
Een lijst met alle taken in het opgegeven account.
list(job_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 CloudJob
Retourtype
Uitzonderingen
list_from_job_schedule
Hiermee worden de taken weergegeven die zijn gemaakt onder de opgegeven taakplanning.
list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- job_list_from_job_schedule_options
- JobListFromJobScheduleOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
Een iterator zoals een exemplaar van CloudJob
Retourtype
Uitzonderingen
list_preparation_and_release_task_status
Geeft de uitvoeringsstatus weer van de taakvoorbereiding en taakrelease voor de opgegeven taak op de rekenknooppunten waarop de taak is uitgevoerd.
Deze API retourneert de taakvoorbereiding en taakreleasetaakstatus op alle rekenknooppunten waarop de taak voor taakvoorbereiding of taakreleasetaak is uitgevoerd. Dit omvat rekenknooppunten die sindsdien uit de pool zijn verwijderd. Als deze API wordt aangeroepen voor een taak die geen taakvoorbereiding of taakreleasetaak heeft, retourneert de Batch-service HTTP-statuscode 409 (Conflict) met de foutcode JobPreparationTaskNotSpecified.
list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- job_list_preparation_and_release_task_status_options
- JobListPreparationAndReleaseTaskStatusOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
Een iterator-achtige instantie van JobPreparationAndReleaseTaskExecutionInformation
Retourtype
Uitzonderingen
patch
Updates de eigenschappen van de opgegeven taak.
Hiermee vervangt u alleen de taakeigenschappen die in de aanvraag zijn opgegeven. Als de taak bijvoorbeeld beperkingen heeft en een aanvraag het element beperkingen niet opgeeft, behoudt de taak de bestaande beperkingen.
patch(job_id, job_patch_parameter, job_patch_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
terminate
Hiermee beëindigt u de opgegeven taak en markeert deze als voltooid.
Wanneer een aanvraag voor het beëindigen van de taak wordt ontvangen, stelt de Batch-service de taak in op de eindstatus. De Batch-service beëindigt vervolgens alle actieve taken die aan de taak zijn gekoppeld en voert alle vereiste taakreleasetaken uit. Vervolgens wordt de taak verplaatst naar de status Voltooid. Als er taken in de taak met de actieve status zijn, blijven deze in de actieve status. Zodra een taak is beëindigd, kunnen er geen nieuwe taken meer worden toegevoegd en worden resterende actieve taken niet meer gepland.
terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- terminate_reason
- str
- job_terminate_options
- JobTerminateOptions
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.
Hiermee worden alle bijwerkbare eigenschappen van de taak volledig vervangen. Als er bijvoorbeeld beperkingen aan de taak zijn gekoppeld en als er geen beperkingen zijn opgegeven met deze aanvraag, verwijdert de Batch-service de bestaande beperkingen.
update(job_id, job_update_parameter, job_update_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
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