Job - Create

Referens

Service:: Automation

API Version:: 2023-11-01

Skapa ett jobb för runbooken.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
automationAccountName	path	True	string	Namnet på automationskontot.
jobName	path	True	string	Jobbnamnet.
resourceGroupName	path	True	string	Namnet på en Azure-resursgrupp. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Hämtar autentiseringsuppgifter för prenumerationer som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
clientRequestId		string	Identifierar den här specifika klientbegäran.

Begärandetext

Name	Typ	Description
properties.parameters	object	Hämtar eller anger jobbets parametrar.
properties.runOn	string	Hämtar eller anger runOn som anger gruppnamnet där jobbet ska köras.
properties.runbook	RunbookAssociationProperty	Hämtar eller ställer in runbooken.

Svar

Name	Typ	Description
201 Created	Job	Skapad
Other Status Codes	ErrorResponse	Automation-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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": ""
  }
}

Definitioner

Name	Description
ErrorResponse	Felsvar på ett åtgärdsfel
Job	Definition av jobbet.
JobCreateParameters	Parametrarna som angavs för åtgärden skapa jobb.
JobProvisioningState	Det aktuella etableringstillståndet för jobbet.
JobStatus	Hämtar eller anger jobbets status.
RunbookAssociationProperty	Runbook-egenskapen som är associerad med entiteten.

ErrorResponse

Felsvar på ett åtgärdsfel

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

Job

Definition av jobbet.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen
name	string	Namnet på resursen
properties.creationTime	string	Hämtar eller anger skapandetiden för jobbet.
properties.endTime	string	Hämtar eller anger jobbets sluttid.
properties.exception	string	Hämtar eller anger undantaget för jobbet.
properties.jobId	string	Hämtar eller anger jobbets ID.
properties.lastModifiedTime	string	Hämtar eller anger den senast ändrade tiden för jobbet.
properties.lastStatusModifiedTime	string	Hämtar eller anger den senaste ändrade statustiden för jobbet.
properties.parameters	object	Hämtar eller anger jobbets parametrar.
properties.provisioningState	JobProvisioningState	Det aktuella etableringstillståndet för jobbet.
properties.runOn	string	Hämtar eller anger runOn som anger gruppnamnet där jobbet ska köras.
properties.runbook	RunbookAssociationProperty	Hämtar eller ställer in runbooken.
properties.startTime	string	Hämtar eller anger starttiden för jobbet.
properties.startedBy	string	Hämtar eller ställer in jobbet som startas av.
properties.status	JobStatus	Hämtar eller anger jobbets status.
properties.statusDetails	string	Hämtar eller anger statusinformation för jobbet.
type	string	Resurstypen.

JobCreateParameters

Parametrarna som angavs för åtgärden skapa jobb.

Name	Typ	Description
properties.parameters	object	Hämtar eller anger jobbets parametrar.
properties.runOn	string	Hämtar eller anger runOn som anger gruppnamnet där jobbet ska köras.
properties.runbook	RunbookAssociationProperty	Hämtar eller ställer in runbooken.

JobProvisioningState

Det aktuella etableringstillståndet för jobbet.

Name	Typ	Description
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

Hämtar eller anger jobbets status.

Name	Typ	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

Runbook-egenskapen som är associerad med entiteten.

Name	Typ	Description
name	string	Hämtar eller anger namnet på runbooken.

Share via