Job - Create

Odwołanie

Usługa:: Automation

Wersja interfejsu API:: 2023-11-01

Utwórz zadanie elementu Runbook.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
automationAccountName	path	True	string	Nazwa konta usługi Automation.
jobName	path	True	string	Nazwa zadania.
resourceGroupName	path	True	string	Nazwa grupy zasobów platformy Azure. Wzorzec wyrażenia regularnego: `^[-\w\._]+$`
subscriptionId	path	True	string	Pobiera poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
clientRequestId		string	Identyfikuje to konkretne żądanie klienta.

Treść żądania

Nazwa	Typ	Opis
properties.parameters	object	Pobiera lub ustawia parametry zadania.
properties.runOn	string	Pobiera lub ustawia wartość runOn, która określa nazwę grupy, w której ma zostać wykonane zadanie.
properties.runbook	RunbookAssociationProperty	Pobiera lub ustawia element Runbook.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Job	Utworzone
Other Status Codes	ErrorResponse	Odpowiedź na błąd automatyzacji opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create job

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
ErrorResponse	Odpowiedź na błąd operacji
Job	Definicja zadania.
JobCreateParameters	Parametry podane do operacji tworzenia zadania.
JobProvisioningState	Bieżący stan aprowizacji zadania.
JobStatus	Pobiera lub ustawia stan zadania.
RunbookAssociationProperty	Właściwość elementu Runbook skojarzona z jednostką.

ErrorResponse

Odpowiedź na błąd operacji

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

Job

Definicja zadania.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu
name	string	Nazwa zasobu
properties.creationTime	string	Pobiera lub ustawia czas tworzenia zadania.
properties.endTime	string	Pobiera lub ustawia czas zakończenia zadania.
properties.exception	string	Pobiera lub ustawia wyjątek zadania.
properties.jobId	string	Pobiera lub ustawia identyfikator zadania.
properties.lastModifiedTime	string	Pobiera lub ustawia czas ostatniej modyfikacji zadania.
properties.lastStatusModifiedTime	string	Pobiera lub ustawia czas ostatniej modyfikacji stanu zadania.
properties.parameters	object	Pobiera lub ustawia parametry zadania.
properties.provisioningState	JobProvisioningState	Bieżący stan aprowizacji zadania.
properties.runOn	string	Pobiera lub ustawia wartość runOn, która określa nazwę grupy, w której ma zostać wykonane zadanie.
properties.runbook	RunbookAssociationProperty	Pobiera lub ustawia element Runbook.
properties.startTime	string	Pobiera lub ustawia godzinę rozpoczęcia zadania.
properties.startedBy	string	Pobiera lub ustawia zadanie rozpoczęte przez.
properties.status	JobStatus	Pobiera lub ustawia stan zadania.
properties.statusDetails	string	Pobiera lub ustawia szczegóły stanu zadania.
type	string	Typ zasobu.

JobCreateParameters

Parametry podane do operacji tworzenia zadania.

Nazwa	Typ	Opis
properties.parameters	object	Pobiera lub ustawia parametry zadania.
properties.runOn	string	Pobiera lub ustawia wartość runOn, która określa nazwę grupy, w której ma zostać wykonane zadanie.
properties.runbook	RunbookAssociationProperty	Pobiera lub ustawia element Runbook.

JobProvisioningState

Bieżący stan aprowizacji zadania.

Nazwa	Typ	Opis
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

Pobiera lub ustawia stan zadania.

Nazwa	Typ	Opis
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

Właściwość elementu Runbook skojarzona z jednostką.

Nazwa	Typ	Opis
name	string	Pobiera lub ustawia nazwę elementu Runbook.

Udostępnij za pośrednictwem