Runbook - Create Or Update

Ссылка

Служба:: Automation

Версия API:: 2023-11-01

Создайте модуль Runbook, определяемый по имени runbook.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
automationAccountName	path	True	string	Имя учетной записи службы автоматизации.
resourceGroupName	path	True	string	Имя группы ресурсов Azure. Шаблон регулярного выражения: `^[-\w\._]+$`
runbookName	path	True	string	Имя модуля Runbook. Шаблон регулярного выражения: `^[a-zA-Z][a-zA-Z-_0-9]*$`
subscriptionId	path	True	string	Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

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

Имя	Обязательно	Тип	Описание
properties.runbookType	True	RunbookTypeEnum	Возвращает или задает тип модуля Runbook.
location		string	Получает или задает расположение ресурса.
name		string	Получает или задает имя ресурса.
properties.description		string	Возвращает или задает описание модуля Runbook.
properties.draft		RunbookDraft	Возвращает или задает черновик свойств runbook.
properties.logActivityTrace		integer	Возвращает или задает параметры трассировки на уровне действия модуля Runbook.
properties.logProgress		boolean	Возвращает или задает параметр журнала выполнения.
properties.logVerbose		boolean	Возвращает или задает подробный параметр журнала.
properties.publishContentLink		ContentLink	Возвращает или задает ссылку на опубликованное содержимое runbook.
tags		object	Получает или задает теги, вложенные в ресурс.

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

Create or update runbook and publish it

Create runbook as draft

Create or update runbook and publish it

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

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2023-11-01

{
  "properties": {
    "logVerbose": false,
    "logProgress": true,
    "runbookType": "PowerShellWorkflow",
    "publishContentLink": {
      "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
      "contentHash": {
        "algorithm": "SHA256",
        "value": "115775B8FF2BE672D8A946BD0B489918C724DDE15A440373CA54461D53010A80"
      }
    },
    "description": "Description of the Runbook",
    "logActivityTrace": 1
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

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

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

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318837230000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:43.723+00:00"
  }
}

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

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": true,
    "logProgress": true,
    "logActivityTrace": 1,
    "runbookType": "PowerShellWorkflow",
    "parameters": {},
    "state": "Published",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "outputTypes": [],
    "creationTime": "2017-03-28T21:04:43.66+00:00",
    "lastModifiedBy": "myEmaild@microsoft.com",
    "lastModifiedTime": "2017-03-28T21:04:46.6+00:00"
  }
}

Create runbook as draft

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

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial?api-version=2023-11-01

{
  "properties": {
    "logVerbose": false,
    "logProgress": false,
    "runbookType": "PowerShellWorkflow",
    "description": "Description of the Runbook",
    "draft": {}
  },
  "name": "Get-AzureVMTutorial",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  }
}

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

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

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318837230000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "runbookType": "Script",
    "parameters": {},
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00",
    "outputTypes": []
  }
}

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

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial",
  "name": "Get-AzureVMTutorial",
  "type": "Microsoft.Automation/AutomationAccounts/Runbooks",
  "location": "East US 2",
  "tags": {
    "tag01": "value01",
    "tag02": "value02"
  },
  "etag": "\"636263318866000000\"",
  "properties": {
    "description": "Description of the Runbook",
    "logVerbose": false,
    "logProgress": false,
    "logActivityTrace": 0,
    "runbookType": "Script",
    "parameters": {},
    "state": "New",
    "jobCount": 0,
    "provisioningState": "Succeeded",
    "creationTime": "2018-02-09T03:25:59.097+00:00",
    "lastModifiedTime": "2018-02-09T03:25:59.097+00:00"
  }
}

Определения

Имя	Описание
ContentHash	Определение типа свойства Runbook.
ContentLink	Определение ссылки на содержимое.
ErrorResponse	Ответ на ошибку при сбое операции
Runbook	Определение типа runbook.
RunbookCreateOrUpdateParameters	Параметры, предоставленные для операции создания или обновления модуля Runbook.
RunbookDraft
RunbookParameter	Определение типа параметра Runbook.
RunbookProvisioningState	Возвращает или задает состояние подготовки модуля Runbook.
RunbookState	Возвращает или задает состояние модуля Runbook.
RunbookTypeEnum	Возвращает или задает тип модуля Runbook.

ContentHash

Определение типа свойства Runbook.

Имя	Тип	Описание
algorithm	string	Возвращает или задает алгоритм хэша содержимого, используемый для хэширования содержимого.
value	string	Возвращает или задает ожидаемое хэш-значение содержимого.

ContentLink

Определение ссылки на содержимое.

Имя	Тип	Описание
contentHash	ContentHash	Задает хэш.
uri	string	Задает универсальный код ресурса (URI) содержимого.
version	string	Задает версию содержимого.

ErrorResponse

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

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

Runbook

Определение типа runbook.

Имя	Тип	Описание
etag	string	Возвращает или задает etag ресурса.
id	string	Полный идентификатор ресурса для ресурса
location	string	Регион Azure, в котором находится ресурс
name	string	Имя ресурса.
properties.creationTime	string	Возвращает или задает время создания.
properties.description	string	Возвращает или задает описание.
properties.draft	RunbookDraft	Возвращает или задает черновик свойств runbook.
properties.jobCount	integer	Возвращает или задает количество заданий модуля Runbook.
properties.lastModifiedBy	string	Возвращает или задает последнее изменение.
properties.lastModifiedTime	string	Возвращает или задает время последнего изменения.
properties.logActivityTrace	integer	Возвращает или задает параметр для записи в журнал трассировки действий runbook.
properties.logProgress	boolean	Возвращает или задает параметр журнала выполнения.
properties.logVerbose	boolean	Возвращает или задает подробный параметр журнала.
properties.outputTypes	string[]	Возвращает или задает типы выходных данных модуля Runbook.
properties.parameters	<string, RunbookParameter>	Возвращает или задает параметры модуля Runbook.
properties.provisioningState	RunbookProvisioningState	Возвращает или задает состояние подготовки модуля Runbook.
properties.publishContentLink	ContentLink	Возвращает или задает ссылку на опубликованное содержимое runbook.
properties.runbookType	RunbookTypeEnum	Возвращает или задает тип модуля Runbook.
properties.state	RunbookState	Возвращает или задает состояние модуля Runbook.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

RunbookCreateOrUpdateParameters

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

Имя	Тип	Описание
location	string	Получает или задает расположение ресурса.
name	string	Получает или задает имя ресурса.
properties.description	string	Возвращает или задает описание модуля Runbook.
properties.draft	RunbookDraft	Возвращает или задает черновик свойств runbook.
properties.logActivityTrace	integer	Возвращает или задает параметры трассировки на уровне действия модуля Runbook.
properties.logProgress	boolean	Возвращает или задает параметр журнала выполнения.
properties.logVerbose	boolean	Возвращает или задает подробный параметр журнала.
properties.publishContentLink	ContentLink	Возвращает или задает ссылку на опубликованное содержимое runbook.
properties.runbookType	RunbookTypeEnum	Возвращает или задает тип модуля Runbook.
tags	object	Получает или задает теги, вложенные в ресурс.

RunbookDraft

Имя	Тип	Описание
creationTime	string	Возвращает или задает время создания черновика runbook.
draftContentLink	ContentLink	Возвращает или задает ссылку на содержимое модуля Runbook черновика.
inEdit	boolean	Возвращает или задает значение, указывающее, находится ли модуль Runbook в режиме редактирования.
lastModifiedTime	string	Возвращает или задает время последнего изменения черновика runbook.
outputTypes	string[]	Возвращает или задает типы выходных данных модуля Runbook.
parameters	<string, RunbookParameter>	Возвращает или задает параметры черновика модуля Runbook.

RunbookParameter

Определение типа параметра Runbook.

Имя	Тип	Описание
defaultValue	string	Возвращает или задает значение параметра по умолчанию.
isMandatory	boolean	Возвращает или задает логическое значение, указывающее, является ли параметр обязательным.
position	integer	Получает или задает позицию параметра.
type	string	Возвращает или задает тип параметра.

RunbookProvisioningState

Возвращает или задает состояние подготовки модуля Runbook.

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

RunbookState

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

Имя	Тип	Описание
Edit	string
New	string
Published	string

RunbookTypeEnum

Возвращает или задает тип модуля Runbook.

Имя	Тип	Описание
Graph	string
GraphPowerShell	string
GraphPowerShellWorkflow	string
PowerShell	string
PowerShell72	string
PowerShellWorkflow	string
Python2	string
Python3	string
Script	string

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

Runbook - Create Or Update

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

Create or update runbook and publish it

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

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

Create runbook as draft

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

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

Определения

ContentHash

ContentLink

ErrorResponse

Runbook

RunbookCreateOrUpdateParameters

RunbookDraft

RunbookParameter

RunbookProvisioningState

RunbookState

RunbookTypeEnum

Дополнительные ресурсы