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


Microsoft.AutomationAccounts/runbooks 2023-05-15-preview

Определение ресурсов Bicep

Тип ресурса automationAccounts/Runbooks можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Automation/automationAccounts/runbooks, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Automation/automationAccounts/runbooks@2023-05-15-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    draft: {
      creationTime: 'string'
      draftContentLink: {
        contentHash: {
          algorithm: 'string'
          value: 'string'
        }
        uri: 'string'
        version: 'string'
      }
      inEdit: bool
      lastModifiedTime: 'string'
      outputTypes: [
        'string'
      ]
      parameters: {
        {customized property}: {
          defaultValue: 'string'
          isMandatory: bool
          position: int
          type: 'string'
        }
      }
    }
    logActivityTrace: int
    logProgress: bool
    logVerbose: bool
    publishContentLink: {
      contentHash: {
        algorithm: 'string'
        value: 'string'
      }
      uri: 'string'
      version: 'string'
    }
    runbookType: 'string'
    runtimeEnvironment: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

Microsoft.Automation/automationAccounts/runbook

Имя Описание Ценность
местоположение Возвращает или задает расположение ресурса. струна
имя Имя ресурса струна

Ограничения целостности:
Pattern = ^[a-zA-Z][a-zA-Z-_0-9]*$ (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: automationAccounts
свойства Возвращает или задает свойства создания или обновления модуля Runbook. RunbookCreateOrUpdatePropertiesOrRunbookProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ContentHash

Имя Описание Ценность
алгоритм Возвращает или задает алгоритм хэша содержимого, используемый для хэширования содержимого. строка (обязательно)
ценность Возвращает или задает ожидаемое хэш-значение содержимого. строка (обязательно)
Имя Описание Ценность
contentHash Возвращает или задает хэш. ContentHash
ури Возвращает или задает универсальный код ресурса (URI) содержимого. струна
Версия Возвращает или задает версию содержимого. струна

RunbookCreateOrUpdateParametersTags

Имя Описание Ценность

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Имя Описание Ценность
описание Возвращает или задает описание модуля Runbook. струна
черновик Возвращает или задает свойства черновика runbook. RunbookDraft (RunbookDraft)
logActivityTrace Возвращает или задает параметры трассировки на уровне действия модуля Runbook. инт
logProgres Возвращает или задает параметр журнала выполнения. булевая переменная (bool)
logVerbose Возвращает или задает подробный параметр журнала. булевая переменная (bool)
publishContentLink Возвращает или задает ссылку на опубликованное содержимое runbook. СодержаниеСсылка
RunbookType Возвращает или задает тип модуля Runbook. Graph
GraphPowerShell
GraphPowerShellWorkflow
PowerShell
PowerShellWorkflow
Python
Python2
Python3
"Скрипт" (обязательный)
runtimeEnvironment Среда runbook. струна

RunbookDraft (RunbookDraft)

Имя Описание Ценность
время создания Возвращает или задает время создания черновика runbook. струна
draftContentLink Возвращает или задает ссылку на содержимое модуля Runbook черновика. СодержаниеСсылка
вПравить Возвращает или задает, находится ли модуль Runbook в режиме редактирования. булевая переменная (bool)
время последнего изменения Возвращает или задает время последнего изменения черновика модуля Runbook. струна
outputTypes Возвращает или задает типы выходных данных Runbook. строка[]
Параметры Возвращает или задает параметры черновика модуля Runbook. Параметры RunbookDraftParameters

Параметры RunbookDraftParameters

Имя Описание Ценность

Параметр Runbook

Имя Описание Ценность
значение по умолчанию Возвращает или задает значение параметра по умолчанию. струна
является обязательным Возвращает или задает логическое значение, указывающее, является ли параметр обязательным или нет. булевая переменная (bool)
позиция Получение или установка позиции параметра. инт
тип Возвращает или задает тип параметра. струна

Примеры использования

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
runbook ASR Развертывание модулей Runbook службы автоматизации для планов восстановления ASR

Определение ресурса шаблона ARM

Тип ресурса automationAccounts/Runbooks можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Automation/automationAccounts/runbooks, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Automation/automationAccounts/runbooks",
  "apiVersion": "2023-05-15-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "description": "string",
    "draft": {
      "creationTime": "string",
      "draftContentLink": {
        "contentHash": {
          "algorithm": "string",
          "value": "string"
        },
        "uri": "string",
        "version": "string"
      },
      "inEdit": "bool",
      "lastModifiedTime": "string",
      "outputTypes": [ "string" ],
      "parameters": {
        "{customized property}": {
          "defaultValue": "string",
          "isMandatory": "bool",
          "position": "int",
          "type": "string"
        }
      }
    },
    "logActivityTrace": "int",
    "logProgress": "bool",
    "logVerbose": "bool",
    "publishContentLink": {
      "contentHash": {
        "algorithm": "string",
        "value": "string"
      },
      "uri": "string",
      "version": "string"
    },
    "runbookType": "string",
    "runtimeEnvironment": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

Microsoft.Automation/automationAccounts/runbook

Имя Описание Ценность
apiVersion Версия API «2023-05-15-превью»
местоположение Возвращает или задает расположение ресурса. струна
имя Имя ресурса струна

Ограничения целостности:
Pattern = ^[a-zA-Z][a-zA-Z-_0-9]*$ (обязательно)
свойства Возвращает или задает свойства создания или обновления модуля Runbook. RunbookCreateOrUpdatePropertiesOrRunbookProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Automation/automationAccounts/runbooks"

ContentHash

Имя Описание Ценность
алгоритм Возвращает или задает алгоритм хэша содержимого, используемый для хэширования содержимого. строка (обязательно)
ценность Возвращает или задает ожидаемое хэш-значение содержимого. строка (обязательно)
Имя Описание Ценность
contentHash Возвращает или задает хэш. ContentHash
ури Возвращает или задает универсальный код ресурса (URI) содержимого. струна
Версия Возвращает или задает версию содержимого. струна

RunbookCreateOrUpdateParametersTags

Имя Описание Ценность

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Имя Описание Ценность
описание Возвращает или задает описание модуля Runbook. струна
черновик Возвращает или задает свойства черновика runbook. RunbookDraft (RunbookDraft)
logActivityTrace Возвращает или задает параметры трассировки на уровне действия модуля Runbook. инт
logProgres Возвращает или задает параметр журнала выполнения. булевая переменная (bool)
logVerbose Возвращает или задает подробный параметр журнала. булевая переменная (bool)
publishContentLink Возвращает или задает ссылку на опубликованное содержимое runbook. СодержаниеСсылка
RunbookType Возвращает или задает тип модуля Runbook. Graph
GraphPowerShell
GraphPowerShellWorkflow
PowerShell
PowerShellWorkflow
Python
Python2
Python3
"Скрипт" (обязательный)
runtimeEnvironment Среда runbook. струна

RunbookDraft (RunbookDraft)

Имя Описание Ценность
время создания Возвращает или задает время создания черновика runbook. струна
draftContentLink Возвращает или задает ссылку на содержимое модуля Runbook черновика. СодержаниеСсылка
вПравить Возвращает или задает, находится ли модуль Runbook в режиме редактирования. булевая переменная (bool)
время последнего изменения Возвращает или задает время последнего изменения черновика модуля Runbook. струна
outputTypes Возвращает или задает типы выходных данных Runbook. строка[]
Параметры Возвращает или задает параметры черновика модуля Runbook. Параметры RunbookDraftParameters

Параметры RunbookDraftParameters

Имя Описание Ценность

Параметр Runbook

Имя Описание Ценность
значение по умолчанию Возвращает или задает значение параметра по умолчанию. струна
является обязательным Возвращает или задает логическое значение, указывающее, является ли параметр обязательным или нет. булевая переменная (bool)
позиция Получение или установка позиции параметра. инт
тип Возвращает или задает тип параметра. струна

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
runbook ASR

развертывание в Azure
Развертывание модулей Runbook службы автоматизации для планов восстановления ASR
набор средств для оптимизации ресурсов Azure (ARO)

развертывание в Azure
Набор средств оптимизации ресурсов Azure — это децентрализованное, собственное решение Azure с помощью бессерверных технологий для оптимизации ресурсов Azure в подписке. Оптимизация выполняется автоматически в подписке после включения или создания собственного расписания, включая новые ресурсы. Это учетная запись службы автоматизации Azure с предварительно настроенными модулями Runbook и расписаниями, которые можно использовать в подписке для начала экономии денег.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса automationAccounts/Runbooks можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Automation/automationAccounts/runbooks, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/runbooks@2023-05-15-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      description = "string"
      draft = {
        creationTime = "string"
        draftContentLink = {
          contentHash = {
            algorithm = "string"
            value = "string"
          }
          uri = "string"
          version = "string"
        }
        inEdit = bool
        lastModifiedTime = "string"
        outputTypes = [
          "string"
        ]
        parameters = {
          {customized property} = {
            defaultValue = "string"
            isMandatory = bool
            position = int
            type = "string"
          }
        }
      }
      logActivityTrace = int
      logProgress = bool
      logVerbose = bool
      publishContentLink = {
        contentHash = {
          algorithm = "string"
          value = "string"
        }
        uri = "string"
        version = "string"
      }
      runbookType = "string"
      runtimeEnvironment = "string"
    }
  }
}

Значения свойств

Microsoft.Automation/automationAccounts/runbook

Имя Описание Ценность
местоположение Возвращает или задает расположение ресурса. струна
имя Имя ресурса струна

Ограничения целостности:
Pattern = ^[a-zA-Z][a-zA-Z-_0-9]*$ (обязательно)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: automationAccounts
свойства Возвращает или задает свойства создания или обновления модуля Runbook. RunbookCreateOrUpdatePropertiesOrRunbookProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Automation/automationAccounts/runbooks@2023-05-15-preview"

ContentHash

Имя Описание Ценность
алгоритм Возвращает или задает алгоритм хэша содержимого, используемый для хэширования содержимого. строка (обязательно)
ценность Возвращает или задает ожидаемое хэш-значение содержимого. строка (обязательно)
Имя Описание Ценность
contentHash Возвращает или задает хэш. ContentHash
ури Возвращает или задает универсальный код ресурса (URI) содержимого. струна
Версия Возвращает или задает версию содержимого. струна

RunbookCreateOrUpdateParametersTags

Имя Описание Ценность

RunbookCreateOrUpdatePropertiesOrRunbookProperties

Имя Описание Ценность
описание Возвращает или задает описание модуля Runbook. струна
черновик Возвращает или задает свойства черновика runbook. RunbookDraft (RunbookDraft)
logActivityTrace Возвращает или задает параметры трассировки на уровне действия модуля Runbook. инт
logProgres Возвращает или задает параметр журнала выполнения. булевая переменная (bool)
logVerbose Возвращает или задает подробный параметр журнала. булевая переменная (bool)
publishContentLink Возвращает или задает ссылку на опубликованное содержимое runbook. СодержаниеСсылка
RunbookType Возвращает или задает тип модуля Runbook. Graph
GraphPowerShell
GraphPowerShellWorkflow
PowerShell
PowerShellWorkflow
Python
Python2
Python3
"Скрипт" (обязательный)
runtimeEnvironment Среда runbook. струна

RunbookDraft (RunbookDraft)

Имя Описание Ценность
время создания Возвращает или задает время создания черновика runbook. струна
draftContentLink Возвращает или задает ссылку на содержимое модуля Runbook черновика. СодержаниеСсылка
вПравить Возвращает или задает, находится ли модуль Runbook в режиме редактирования. булевая переменная (bool)
время последнего изменения Возвращает или задает время последнего изменения черновика модуля Runbook. струна
outputTypes Возвращает или задает типы выходных данных Runbook. строка[]
Параметры Возвращает или задает параметры черновика модуля Runbook. Параметры RunbookDraftParameters

Параметры RunbookDraftParameters

Имя Описание Ценность

Параметр Runbook

Имя Описание Ценность
значение по умолчанию Возвращает или задает значение параметра по умолчанию. струна
является обязательным Возвращает или задает логическое значение, указывающее, является ли параметр обязательным или нет. булевая переменная (bool)
позиция Получение или установка позиции параметра. инт
тип Возвращает или задает тип параметра. струна