Job - Create

Referencia

Service:: Automation

API Version:: 2023-11-01

Hozzon létre egy feladatot a runbookból.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}?api-version=2023-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
automationAccountName	path	True	string	Az automation-fiók neve.
jobName	path	True	string	A feladat neve.
resourceGroupName	path	True	string	Egy Azure-erőforráscsoport neve. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Lekéri az előfizetés hitelesítő adatait, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
clientRequestId		string	Azonosítja ezt az adott ügyfélkérést.

Kérelem törzse

Name	Típus	Description
properties.parameters	object	Lekéri vagy beállítja a feladat paramétereit.
properties.runOn	string	Lekéri vagy beállítja a runOnt, amely megadja a feladat végrehajtásának csoportnevét.
properties.runbook	RunbookAssociationProperty	Lekéri vagy beállítja a runbookot.

Válaszok

Name	Típus	Description
201 Created	Job	Létrehozva
Other Status Codes	ErrorResponse	Automatizálási hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Create job

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/foo?api-version=2023-11-01

{
  "properties": {
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "key01": "value01",
      "key02": "value02"
    },
    "runOn": ""
  }
}

Sample Response

Status code:: 201

{
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName",
  "name": "foo",
  "type": "Microsoft.Automation/AutomationAccounts/Jobs",
  "properties": {
    "jobId": "5b8a3960-e8ab-45f6-bec6-567df8467d1a",
    "runbook": {
      "name": "TestRunbook"
    },
    "provisioningState": "Processing",
    "creationTime": "2018-02-01T05:53:30.243+00:00",
    "endTime": null,
    "exception": null,
    "lastModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "lastStatusModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "startTime": null,
    "status": "New",
    "statusDetails": "None",
    "parameters": {
      "tag01": "value01",
      "tag02": "value02"
    },
    "runOn": ""
  }
}

Definíciók

Name	Description
ErrorResponse	Művelethiba hibaválasza
Job	A feladat definíciója.
JobCreateParameters	A létrehozási feladat művelethez megadott paraméterek.
JobProvisioningState	A feladat aktuális kiépítési állapota.
JobStatus	Lekéri vagy beállítja a feladat állapotát.
RunbookAssociationProperty	Az entitáshoz társított runbooktulajdonság.

ErrorResponse

Művelethiba hibaválasza

Name	Típus	Description
code	string	Hibakód
message	string	Hibaüzenet jelzi, hogy a művelet miért nem sikerült.

Job

A feladat definíciója.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója
name	string	Az erőforrás neve
properties.creationTime	string	Lekéri vagy beállítja a feladat létrehozási idejét.
properties.endTime	string	Lekéri vagy beállítja a feladat befejezési idejét.
properties.exception	string	Lekéri vagy beállítja a feladat kivételét.
properties.jobId	string	Lekéri vagy beállítja a feladat azonosítóját.
properties.lastModifiedTime	string	Lekéri vagy beállítja a feladat utolsó módosítási időpontját.
properties.lastStatusModifiedTime	string	Lekéri vagy beállítja a feladat utolsó módosított állapotát.
properties.parameters	object	Lekéri vagy beállítja a feladat paramétereit.
properties.provisioningState	JobProvisioningState	A feladat aktuális kiépítési állapota.
properties.runOn	string	Lekéri vagy beállítja a runOnt, amely megadja a feladat végrehajtásának csoportnevét.
properties.runbook	RunbookAssociationProperty	Lekéri vagy beállítja a runbookot.
properties.startTime	string	Lekéri vagy beállítja a feladat kezdési időpontját.
properties.startedBy	string	Lekéri vagy beállítja a feladatot.
properties.status	JobStatus	Lekéri vagy beállítja a feladat állapotát.
properties.statusDetails	string	Lekéri vagy beállítja a feladat állapotadatait.
type	string	Az erőforrás típusa.

JobCreateParameters

A létrehozási feladat művelethez megadott paraméterek.

Name	Típus	Description
properties.parameters	object	Lekéri vagy beállítja a feladat paramétereit.
properties.runOn	string	Lekéri vagy beállítja a runOnt, amely megadja a feladat végrehajtásának csoportnevét.
properties.runbook	RunbookAssociationProperty	Lekéri vagy beállítja a runbookot.

JobProvisioningState

A feladat aktuális kiépítési állapota.

Name	Típus	Description
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

Lekéri vagy beállítja a feladat állapotát.

Name	Típus	Description
Activating	string
Blocked	string
Completed	string
Disconnected	string
Failed	string
New	string
Removing	string
Resuming	string
Running	string
Stopped	string
Stopping	string
Suspended	string
Suspending	string

RunbookAssociationProperty

Az entitáshoz társított runbooktulajdonság.

Name	Típus	Description
name	string	Lekéri vagy beállítja a runbook nevét.

Share via