Job - Disable
Letiltja a megadott feladatot, és megakadályozza az új feladatok futtatását.
A Batch szolgáltatás azonnal áthelyezi a feladatot a letiltó állapotba. A Batch ezután a disableTasks paraméterrel határozza meg, hogy mi a teendő a feladat aktuálisan futó feladataival. A feladat letiltási állapotban marad, amíg a letiltási művelet be nem fejeződik, és az összes feladat a disableTasks beállításnak megfelelően lett kezelve; A feladat ezután a letiltott állapotba kerül. A feladat alatt nem indulnak el új feladatok, amíg vissza nem kerül az aktív állapotba. Ha olyan feladatot próbál letiltani, amely nem aktív, letiltott vagy letiltott állapotban van, a kérés a 409-s állapotkóddal meghiúsul.
POST {batchUrl}/jobs/{jobId}/disable?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2023-11-01.18.0
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Az összes Azure Batch szolgáltatáskérés alap URL-címe. |
job
|
path | True |
string |
A letiltani kívánt feladat azonosítója. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
timeout
|
query |
integer int32 |
A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp. |
Kérelem fejléce
Media Types: "application/json; odata=minimalmetadata"
Name | Kötelező | Típus | Description |
---|---|---|---|
client-request-id |
string uuid |
A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban. |
|
ocp-date |
string date-time-rfc1123 |
A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg. |
|
If-Match |
string |
Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban pontosan megegyezik az ügyfél által megadott értékkel. |
|
If-None-Match |
string |
Az ügyfél által ismert erőforrás verziójához társított ETag-érték. A művelet csak akkor lesz végrehajtva, ha az erőforrás aktuális ETagje a szolgáltatásban nem egyezik meg az ügyfél által megadott értékkel. |
|
If-Modified-Since |
string date-time-rfc1123 |
Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás a megadott idő óta módosult. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Az ügyfél által ismert erőforrás utolsó módosítási idejét jelző időbélyeg. A művelet csak akkor lesz végrehajtva, ha a szolgáltatásban lévő erőforrás nem módosult a megadott idő óta. |
Kérelem törzse
Media Types: "application/json; odata=minimalmetadata"
Name | Kötelező | Típus | Description |
---|---|---|---|
disableTasks | True |
Mi a teendő a feladathoz társított aktív tevékenységekkel? |
Válaszok
Name | Típus | Description |
---|---|---|
202 Accepted |
A Batch szolgáltatásnak küldött kérés sikeres volt. Headers
|
|
Other Status Codes |
A Batch szolgáltatás hibája. |
Biztonság
azure_auth
Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | A felhasználói fiók megszemélyesítése |
Authorization
Type:
apiKey
In:
header
Példák
Job disable
Sample Request
POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2023-11-01.18.0
{
"disableTasks": "terminate"
}
Sample Response
Definíciók
Name | Description |
---|---|
Batch |
A Azure Batch szolgáltatástól kapott hibaválasz. |
Batch |
A Azure Batch hibaválaszban szereplő további információk egy eleme. |
Disable |
Mi a teendő a feladathoz társított aktív tevékenységekkel? |
Error |
Hibaüzenet érkezett egy Azure Batch hibaválaszban. |
Job |
A feladatok letiltásával kapcsolatos beállítások. |
BatchError
A Azure Batch szolgáltatástól kapott hibaválasz.
Name | Típus | Description |
---|---|---|
code |
string |
A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók. |
message |
A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre. |
|
values |
Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról. |
BatchErrorDetail
A Azure Batch hibaválaszban szereplő további információk egy eleme.
Name | Típus | Description |
---|---|---|
key |
string |
Az Érték tulajdonság jelentését meghatározó azonosító. |
value |
string |
A hibaválaszban szereplő további információk. |
DisableJobOption
Mi a teendő a feladathoz társított aktív tevékenységekkel?
Name | Típus | Description |
---|---|---|
requeue |
string |
Állítsa le a futó feladatokat, és állítsa le újra őket. A Feladatok újra futni fog, ha a feladat engedélyezve van. |
terminate |
string |
Állítsa le a futó feladatokat. A feladatok a failureInfo hibával fejeződnek be, jelezve, hogy leálltak, és nem futnak újra. |
wait |
string |
A feladatok futtatásának engedélyezése. |
ErrorMessage
Hibaüzenet érkezett egy Azure Batch hibaválaszban.
Name | Típus | Description |
---|---|---|
lang |
string |
A hibaüzenet nyelvkódja |
value |
string |
Az üzenet szövege. |
JobDisableParameter
A feladatok letiltásával kapcsolatos beállítások.
Name | Típus | Description |
---|---|---|
disableTasks |
Mi a teendő a feladathoz társított aktív tevékenységekkel? |