Job - Create

Usługa:: Automation

Wersja interfejsu API:: 2024-10-23

Utwórz zadanie elementu Runbook.

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

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 minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nazwa grupy zasobów platformy Azure.
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 element runOn, który 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	Utworzono
Other Status Codes	ErrorResponse	Odpowiedź na błąd automatyzacji opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu 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=2024-10-23

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorResponse	Odpowiedź na błąd operacji
Job	Definicja zadania.
JobCreateParameters	Parametry podane do operacji tworzenia zadania.
JobProvisioningState	Bieżący stan aprowizacji zadania.
JobRuntimeEnvironment	Właściwość elementu Runbook skojarzona z jednostką.
JobStatus	Pobiera lub ustawia stan zadania.
RunbookAssociationProperty	Właściwość elementu Runbook skojarzona z jednostką.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorResponse

Objekt

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

Objekt

Definicja zadania.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.creationTime	string (date-time)	Pobiera lub ustawia czas tworzenia zadania.
properties.endTime	string (date-time)	Pobiera lub ustawia godzinę zakończenia zadania.
properties.exception	string	Pobiera lub ustawia wyjątek zadania.
properties.jobId	string (uuid)	Pobiera lub ustawia identyfikator zadania.
properties.jobRuntimeEnvironment	JobRuntimeEnvironment	Właściwość środowiska uruchomieniowego
properties.lastModifiedTime	string (date-time)	Pobiera lub ustawia czas ostatniej modyfikacji zadania.
properties.lastStatusModifiedTime	string (date-time)	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 element runOn, który określa nazwę grupy, w której ma zostać wykonane zadanie.
properties.runbook	RunbookAssociationProperty	Pobiera lub ustawia element Runbook.
properties.startTime	string (date-time)	Pobiera lub ustawia godzinę rozpoczęcia zadania.
properties.startedBy	string	Pobiera lub ustawia zadanie uruchomione przez.
properties.status	JobStatus	Pobiera lub ustawia stan zadania.
properties.statusDetails	string	Pobiera lub ustawia szczegóły stanu zadania.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

JobCreateParameters

Objekt

Parametry podane do operacji tworzenia zadania.

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

JobProvisioningState

Wyliczanie

Bieżący stan aprowizacji zadania.

Wartość	Opis
Failed
Succeeded
Suspended
Processing

JobRuntimeEnvironment

Objekt

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

Nazwa	Typ	Opis
runtimeEnvironmentName	string	Nazwa środowiska uruchomieniowego.

JobStatus

Wyliczanie

Pobiera lub ustawia stan zadania.

Wartość	Opis
New
Activating
Running
Completed
Failed
Stopped
Blocked
Suspended
Disconnected
Suspending
Stopping
Resuming
Removing

RunbookAssociationProperty

Objekt

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

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

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij przez

Job - Create

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Create job

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

ErrorResponse

Job

JobCreateParameters

JobProvisioningState

JobRuntimeEnvironment

JobStatus

RunbookAssociationProperty

systemData