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	Имя группы ресурсов Azure. Шаблон регулярного выражения: `^[-\w\._]+$`
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

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

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

Job

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

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

JobCreateParameters

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

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

JobProvisioningState

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

Имя	Тип	Описание
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

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

Имя	Тип	Описание
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

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

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

Поделиться через