Dela via

Job - Create

Tjänst:
Automation
API-version:
2024-10-23

Skapa ett jobb för runbooken.

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

URI-parametrar

Name I Obligatorisk Typ Description
automationAccountName
 path True

string

Namnet på automationskontot.
jobName
 path True

string

Jobbnamnet.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

Namnet på en Azure-resursgrupp.
subscriptionId
 path True

string

Hämtar prenumerationsautentiseringsuppgifter 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 parametrarna 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.

Svar

Name Typ Description
201 Created

Job

Skapades
Other Status Codes

ErrorResponse

Automation-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Create job

Exempelbegäran

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

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

Exempelsvar

Statuskod:
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": "",
    "jobRuntimeEnvironment": {
      "runtimeEnvironmentName": "environmentName"
    }
  }
}

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.
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.
JobRuntimeEnvironment

Runbook-egenskapen som är associerad med entiteten.
JobStatus

Hämtar eller anger jobbets status.
RunbookAssociationProperty

Runbook-egenskapen som är associerad med entiteten.
systemData

Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

Felsvar på ett åtgärdsfel

Name Typ Description
code

string

Felkod
message

string

Felmeddelande som anger varför åtgärden misslyckades.

Job

Objekt

Definition av jobbet.

Name Typ Description
id

string (arm-id)

Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Namnet på resursen
properties.creationTime

string (date-time)

Hämtar eller anger skapandetiden för jobbet.
properties.endTime

string (date-time)

Hämtar eller anger jobbets sluttid.
properties.exception

string

Hämtar eller anger undantaget för jobbet.
properties.jobId

string (uuid)

Hämtar eller anger jobbets ID.
properties.jobRuntimeEnvironment

JobRuntimeEnvironment

Körningsmiljöegenskap
properties.lastModifiedTime

string (date-time)

Hämtar eller anger den senaste ändrade tiden för jobbet.
properties.lastStatusModifiedTime

string (date-time)

Hämtar eller anger den senast ändrade statustiden för jobbet.
properties.parameters

object

Hämtar eller anger parametrarna för jobbet.
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 (date-time)

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.
systemData

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

JobCreateParameters

Objekt

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

Name Typ Description
properties.parameters

object

Hämtar eller anger parametrarna 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.

JobProvisioningState

Uppräkning

Det aktuella etableringstillståndet för jobbet.

Värde Description
Failed
Succeeded
Suspended
Processing

JobRuntimeEnvironment

Objekt

Runbook-egenskapen som är associerad med entiteten.

Name Typ Description
runtimeEnvironmentName

string

Namn på Körningsmiljö.

JobStatus

Uppräkning

Hämtar eller anger jobbets status.

Värde Description
New
Activating
Running
Completed
Failed
Stopped
Blocked
Suspended
Disconnected
Suspending
Stopping
Resuming
Removing

RunbookAssociationProperty

Objekt

Runbook-egenskapen som är associerad med entiteten.

Name Typ Description
name

string

Hämtar eller anger namnet på runbooken.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string (date-time)

Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy

string

Identiteten som senast ändrade resursen.
lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.