Job Schedule - Create

Служба:

Automation

Версия API:

2023-11-01

Создание расписания заданий.

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

Параметры URI

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

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

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

Ответы

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

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Create a job schedule

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

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc?api-version=2023-11-01

{
  "properties": {
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

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

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

201

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
  "properties": {
    "jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
    "runbook": {
      "name": "TestRunbook"
    },
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runOn": null,
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

Определения

Имя	Описание
ErrorResponse	Ответ на ошибку сбоя операции
JobSchedule	Определение расписания задания.
JobScheduleCreateParameters	Параметры, предоставленные операции создания расписания заданий.
RunbookAssociationProperty	Свойство Runbook, связанное с сущностью.
ScheduleAssociationProperty	Свойство расписания, связанное с сущностью.

ErrorResponse

Object

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

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

JobSchedule

Object

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

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

JobScheduleCreateParameters

Object

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

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

RunbookAssociationProperty

Object

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

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

ScheduleAssociationProperty

Object

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

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