Job - Create

Служба:

Automation

Версия API:

2023-11-01

Создайте задание модуля Runbook.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
automationAccountName	path	True	string	Имя учетной записи службы автоматизации.
jobName	path	True	string	Имя задания.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Имя группы ресурсов Azure.
subscriptionId	path	True	string	Получает учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
clientRequestId		string	Определяет этот конкретный запрос клиента.

Текст запроса

Имя	Тип	Описание
properties.parameters	object	Возвращает или задает параметры задания.
properties.runOn	string	Возвращает или задает runOn, указывающий имя группы, в которой выполняется задание.
properties.runbook	RunbookAssociationProperty	Возвращает или задает модуль Runbook.

Ответы

Имя	Тип	Описание
201 Created	Job	Созданный
Other Status Codes	ErrorResponse	Ответ об ошибке автоматизации, описывающий, почему операция завершилась ошибкой.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Create job

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
ErrorResponse	Ответ на ошибку сбоя операции
Job	Определение задания.
JobCreateParameters	Параметры, предоставленные операции создания задания.
JobProvisioningState	Текущее состояние подготовки задания.
JobStatus	Возвращает или задает состояние задания.
RunbookAssociationProperty	Свойство Runbook, связанное с сущностью.

ErrorResponse

Object

Ответ на ошибку сбоя операции

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

Job

Object

Определение задания.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса
name	string	Имя ресурса
properties.creationTime	string (date-time)	Возвращает или задает время создания задания.
properties.endTime	string (date-time)	Возвращает или задает время окончания задания.
properties.exception	string	Возвращает или задает исключение задания.
properties.jobId	string (uuid)	Возвращает или задает идентификатор задания.
properties.lastModifiedTime	string (date-time)	Возвращает или задает время последнего изменения задания.
properties.lastStatusModifiedTime	string (date-time)	Возвращает или задает время последнего изменения состояния задания.
properties.parameters	object	Возвращает или задает параметры задания.
properties.provisioningState	JobProvisioningState	Текущее состояние подготовки задания.
properties.runOn	string	Возвращает или задает runOn, указывающий имя группы, в которой выполняется задание.
properties.runbook	RunbookAssociationProperty	Возвращает или задает модуль Runbook.
properties.startTime	string (date-time)	Возвращает или задает время начала задания.
properties.startedBy	string	Возвращает или задает задание, запущенного.
properties.status	JobStatus	Возвращает или задает состояние задания.
properties.statusDetails	string	Возвращает или задает сведения о состоянии задания.
type	string	Тип ресурса.

JobCreateParameters

Object

Параметры, предоставленные операции создания задания.

Имя	Тип	Описание
properties.parameters	object	Возвращает или задает параметры задания.
properties.runOn	string	Возвращает или задает runOn, указывающий имя группы, в которой выполняется задание.
properties.runbook	RunbookAssociationProperty	Возвращает или задает модуль Runbook.

JobProvisioningState

Перечисление

Текущее состояние подготовки задания.

Значение	Описание
Failed
Processing
Succeeded
Suspended

JobStatus

Перечисление

Возвращает или задает состояние задания.

Значение	Описание
Activating
Blocked
Completed
Disconnected
Failed
New
Removing
Resuming
Running
Stopped
Stopping
Suspended
Suspending

RunbookAssociationProperty

Object

Свойство Runbook, связанное с сущностью.

Имя	Тип	Описание
name	string	Возвращает или задает имя модуля Runbook.