Share via

Job Schedule - Terminate

  • Referens
Service:
Batch Service
API Version:
2023-11-01.18.0

Avslutar ett jobbschema.

POST {batchUrl}/jobschedules/{jobScheduleId}/terminate?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/jobschedules/{jobScheduleId}/terminate?timeout={timeout}&api-version=2023-11-01.18.0

URI-parametrar

Name I Obligatorisk Typ Description
batchUrl
 path True

string

Bas-URL:en för alla Azure Batch tjänstbegäranden.
jobScheduleId
 path True

string

ID:t för jobbschemat som ska avslutas.
api-version
 query True

string

Klient-API-version.
timeout
 query

integer

int32

Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

Media Types: "application/json; odata=minimalmetadata"

Name Obligatorisk Typ Description
client-request-id

string

uuid

Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Om servern ska returnera klient-request-id i svaret.
ocp-date

string

date-time-rfc1123

Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det uttryckligen om du anropar REST-API:et direkt.
If-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten exakt matchar det värde som anges av klienten.
If-None-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten inte matchar det värde som anges av klienten.
If-Modified-Since

string

date-time-rfc1123

En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since

string

date-time-rfc1123

En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten inte har ändrats sedan den angivna tiden.

Svar

Name Typ Description
202 Accepted

Begäran till Batch-tjänsten lyckades.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra autentiseringskodflöde för OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

JobSchedule terminate

Sample Request

POST account.region.batch.azure.com/jobschedules/jobScheduleId/terminate?api-version=2023-11-01.18.0

Sample Response

Status code:
202

Definitioner

Name Description
BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name Typ Description
code

string

En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message

ErrorMessage

Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values

BatchErrorDetail[]

En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name Typ Description
key

string

En identifierare som anger innebörden av egenskapen Value.
value

string

Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name Typ Description
lang

string

Språkkoden för felmeddelandet
value

string

Texten i meddelandet.