Job - Create

Referentie

Service:: Automation

API-versie:: 2023-11-01

Maak een taak van het runbook.

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

URI-parameters

Name	In	Vereist	Type	Description
automationAccountName	path	True	string	De naam van het Automation-account.
jobName	path	True	string	De taaknaam.
resourceGroupName	path	True	string	Naam van een Azure-resourcegroep. Regex-patroon: `^[-\w\._]+$`
subscriptionId	path	True	string	Hiermee haalt u abonnementsreferenties op waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
clientRequestId		string	Identificeert deze specifieke clientaanvraag.

Aanvraagbody

Name	Type	Description
properties.parameters	object	Hiermee worden de parameters van de taak opgehaald of ingesteld.
properties.runOn	string	Hiermee wordt de runOn opgehaald of ingesteld, waarmee de groepsnaam wordt opgegeven waar de taak moet worden uitgevoerd.
properties.runbook	RunbookAssociationProperty	Hiermee wordt het runbook opgehaald of ingesteld.

Antwoorden

Name	Type	Description
201 Created	Job	Gemaakt
Other Status Codes	ErrorResponse	Automatiseringsfoutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Create job

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ErrorResponse	Foutreactie van een bewerkingsfout
Job	Definitie van de taak.
JobCreateParameters	De parameters die zijn opgegeven voor de bewerking voor het maken van de taak.
JobProvisioningState	De huidige inrichtingsstatus van de taak.
JobStatus	Hiermee wordt de status van de taak opgehaald of ingesteld.
RunbookAssociationProperty	De runbookeigenschap die is gekoppeld aan de entiteit.

ErrorResponse

Foutreactie van een bewerkingsfout

Name	Type	Description
code	string	Foutcode
message	string	Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

Job

Definitie van de taak.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource
name	string	De naam van de resource
properties.creationTime	string	Hiermee wordt de aanmaaktijd van de taak opgehaald of ingesteld.
properties.endTime	string	Hiermee wordt de eindtijd van de taak opgehaald of ingesteld.
properties.exception	string	Hiermee wordt de uitzondering van de taak opgehaald of ingesteld.
properties.jobId	string	Hiermee wordt de id van de taak opgehaald of ingesteld.
properties.lastModifiedTime	string	Hiermee wordt de laatste wijzigingstijd van de taak opgehaald of ingesteld.
properties.lastStatusModifiedTime	string	Hiermee wordt de laatste wijzigingstijd van de taak opgehaald of ingesteld.
properties.parameters	object	Hiermee worden de parameters van de taak opgehaald of ingesteld.
properties.provisioningState	JobProvisioningState	De huidige inrichtingsstatus van de taak.
properties.runOn	string	Hiermee wordt de runOn opgehaald of ingesteld, waarmee de groepsnaam wordt opgegeven waar de taak moet worden uitgevoerd.
properties.runbook	RunbookAssociationProperty	Hiermee wordt het runbook opgehaald of ingesteld.
properties.startTime	string	Hiermee wordt de begintijd van de taak opgehaald of ingesteld.
properties.startedBy	string	Hiermee wordt de taak opgehaald of ingesteld die is gestart door.
properties.status	JobStatus	Hiermee wordt de status van de taak opgehaald of ingesteld.
properties.statusDetails	string	Hiermee worden de statusdetails van de taak opgehaald of ingesteld.
type	string	Het type resource.

JobCreateParameters

De parameters die zijn opgegeven voor de bewerking voor het maken van de taak.

Name	Type	Description
properties.parameters	object	Hiermee worden de parameters van de taak opgehaald of ingesteld.
properties.runOn	string	Hiermee wordt de runOn opgehaald of ingesteld, waarmee de groepsnaam wordt opgegeven waar de taak moet worden uitgevoerd.
properties.runbook	RunbookAssociationProperty	Hiermee wordt het runbook opgehaald of ingesteld.

JobProvisioningState

De huidige inrichtingsstatus van de taak.

Name	Type	Description
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

Hiermee wordt de status van de taak opgehaald of ingesteld.

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

De runbookeigenschap die is gekoppeld aan de entiteit.

Name	Type	Description
name	string	Hiermee wordt de naam van het runbook opgehaald of ingesteld.

Delen via