Управление средой выполнения и связанными с ней модулями runbook

В этой статье содержатся сведения о создании среды выполнения и выполнении различных операций с помощью портал Azure и REST API.

Необходимые компоненты

Учетная запись служба автоматизации Azure в поддерживаемом общедоступном регионе (кроме Центральной Индии, Северной Индии, Северной Италии, Северной Италии, Центрально-Центрального Израиля, Центральной Польши, центрально-центрального оаэ и правительственных облаков).

Переключение между средой выполнения и старым интерфейсом

Среда выполнения

1. Выберите "Обзор" и выберите "Попробовать среду выполнения".

   

2. В разделе "Автоматизация процессов" есть среды выполнения (предварительная версия) и модули и пакеты Python в общих ресурсах удаляются, так как среда выполнения позволяет управлять пакетами, необходимыми во время выполнения Runbook.

   

3. Чтобы вернуться к старому интерфейсу управления модулями и пакетами, выберите "Обзор " в левой области и выберите "Переключиться на старый интерфейс".

   

Старый опыт

1. Перейдите к учетной записи службы автоматизации, в разделе "Автоматизация процессов" среды выполнения (предварительная версия) удаляется и в разделе "Общие ресурсы", "Модули и пакеты Python" можно увидеть.

   

Примечание.

Обновления Runbook сохраняются между новым интерфейсом среды выполнения и старым интерфейсом. Все изменения, внесенные в среду выполнения, связанной с модуном модуном модуме runbook, будут сохраняться во время выполнения модуля Runbook в старом интерфейсе.

Управление средой выполнения

Создание среды выполнения

Портал Azure

1. Войдите на портал Azure и выберите учетную запись службы автоматизации.

2. В разделе "Автоматизация процессов" выберите среды выполнения (предварительная версия) и нажмите кнопку "Создать".

3. В разделе "Основы" укажите следующие сведения:

   1. Имя среды выполнения. Он должен начинаться с алфавита и может содержать только алфавиты, цифры, символы подчеркивания и дефисы.

   2. В раскрывающемся списке "Язык" выберите язык сценариев для среды выполнения.

      • Выберите язык сценариев PowerShell для PowerShell или python для языка сценариев Python.

   3. Выберите версию среды выполнения для языка сценариев.

      • Для PowerShell выберите 5.1, 7.2
      • Для Python — выберите 3.8, 3.10 (предварительная версия)

   4. Укажите соответствующее описание.

      

4. Нажмите кнопку "Далее " и на вкладке "Пакеты" отправьте пакеты, необходимые во время выполнения модуля Runbook. Пакет Az PowerShell передается по умолчанию для всех сред среды выполнения PowerShell, включая все командлеты для управления ресурсами Azure. В раскрывающемся списке можно выбрать версию пакета Az. Выберите "Нет", если вы не хотите, чтобы пакет был отправлен во время выполнения модуля Runbook.

   

   Примечание.

   Команды Azure CLI поддерживаются (предварительная версия) в модулях Runbook, связанных с средой выполнения PowerShell 7.2. Команды Azure CLI версии 2.56.0 доступны в качестве пакета по умолчанию в среде выполнения PowerShell 7.2.

5. Для отправки дополнительных пакетов, необходимых во время выполнения модуля Runbook. Выберите " Добавить файл ", чтобы добавить файлы, хранящиеся локально на компьютере, или выберите "Добавить из коллекции" для отправки пакетов из коллекции PowerShell.

   

   Примечание.

   • При импорте пакета может потребоваться несколько минут. 100 МБ — это максимальный общий размер файлов, которые можно импортировать.
   • Используйте файлы .zip для типов runbook PowerShell, как упоминалось здесь
   • Для пакетов Python 3.8 используйте WHL-файлы, предназначенные для cp38-amd64.
   • Для пакетов Python 3.10 (предварительная версия) используйте WHL-файлы, предназначенные для ОС Linux cp310.

6. Нажмите кнопку "Далее" и на вкладке "Просмотр и создание", убедитесь, что параметры верны. При выборе " Создать" Azure выполняет проверку параметров среды выполнения, выбранных вами. Если проверка проходит, можно продолжить создание среды выполнения, портал указывает параметры, которые необходимо изменить.

На странице среды выполнения (предварительная версия) можно просмотреть только что созданную среду выполнения для учетной записи службы автоматизации. Если в списке не находятся только что созданные среды выполнения, нажмите кнопку "Обновить".

REST API

Вы можете создать новую среду выполнения для PowerShell 7.2 с помощью модуля Az PowerShell в службе автоматизации

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 

{ 
  "properties": { 
    "runtime": { 
        "language": "PowerShell",  
        "version": "7.2" 
        }, 
        "defaultPackages": { 
            "Az": "7.3.0" 
        } 
     }, 
    "name": "<runtimeEnvironmentName>" 
} 

Отправьте пакет Az.Accounts в среду выполнения.

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>/packages/Az.Accounts?api-version=2023-05-15-preview 
{ 
  "properties": { 
    "contentLink": { 
        "uri": "https://psg-prod-eastus.azureedge.net/packages/az.accounts.2.12.4.nupkg" 
    } 
  } 
} 

Просмотр среды выполнения

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

GET 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 

Перечисление сред выполнения

Чтобы перечислить все среды выполнения из учетной записи службы автоматизации:

Портал Azure

1. В учетной записи службы автоматизации в разделе "Автоматизация процессов" выберите среды выполнения (предварительная версия).

   

REST API

GET 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments?api-version=2023-05-15-preview 

Просмотр компонентов пакета Az PowerShell

Чтобы просмотреть все пакеты компонентов пакета Az PowerShell, выполните Get-Module -ListAvailable командлет в runbook PowerShell.

Выходные данные задания будут отображать все пакеты компонентов и их версии.

Удаление среды выполнения

Чтобы удалить среду выполнения из учетной записи службы автоматизации, выполните следующие действия.

Портал Azure

1. В учетной записи службы автоматизации в разделе "Автоматизация процессов" выберите среды выполнения (предварительная версия).

2. Выберите среду выполнения, которую требуется удалить.

3. Выберите "Удалить ", чтобы удалить среду выполнения.

   

REST API

DELETE  
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 

Обновление среды выполнения

Язык среды выполнения и версия среды выполнения являются неизменяемыми свойствами. Однако можно обновить версию модулей и добавить или удалить пакеты в среде выполнения. Модули Runbook, связанные с средой выполнения, автоматически обновляются с новыми параметрами.

Портал Azure

1. В учетной записи службы автоматизации в разделе "Автоматизация процессов" выберите среды выполнения (предварительная версия).

2. Выберите среду выполнения, которую требуется обновить.

3. Выберите версию из раскрывающегося списка, чтобы обновить версию существующих пакетов.

4. Выберите Сохранить.

   

5. Выберите "Добавить файл", чтобы отправить пакеты с локального компьютера или добавить из коллекции, чтобы отправить пакеты из коллекция PowerShell.

   

   Примечание.

   В среду выполнения можно добавить до 10 пакетов. Убедитесь, что вы сохраните после добавления 10 пакетов.

REST API

Обновите версию модуля Az существующей среды выполнения:

PATCH 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runtimeEnvironments/<runtimeEnvironmentName>?api-version=2023-05-15-preview 
{ 

  "properties": { 

        "defaultPackages": { 

            "Az": "9.0.0" 

        } 

     } 

} 

Управление модулями Runbook, связанными с средой выполнения

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

Вы можете создать модуль Runbook PowerShell, настроенный с помощью среды выполнения.

Портал Azure

Необходимые условия

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

Чтобы создать модуль Runbook, связанный с средой выполнения, выполните следующие действия.

1. В учетной записи службы автоматизации в разделе "Автоматизация процессов" выберите Модули Runbook.

2. Нажмите кнопку создания.

3. На вкладке "Основы" можно создать модуль Runbook или отправить файл с локального компьютера или из коллекции PowerShell.

   1. Укажите имя модуля Runbook. Оно должно начинаться с буквы и может содержать только буквы, цифры, символы подчеркивания и дефисы.

   2. В раскрывающемся списке типов Runbook выберите тип модуля Runbook, который требуется создать.

   3. Выберите среду выполнения для настройки модуля Runbook. Можно выбрать из существующих сред выполнения или создать новую среду выполнения и связать ее с Runbook. Список сред выполнения заполняется на основе типа Runbook, выбранного на шаге b.

   4. Укажите соответствующее описание.

      

   Примечание.

   Для типа Runbook PowerShell будет указана только среда выполнения PowerShell для выбора. Для типа Runbook Python для выбора будут указаны только среды выполнения Python.

4. Добавьте теги в модуль Runbook, просмотрите параметры и нажмите кнопку "Создать ", чтобы создать модуль Runbook.

Этот модуль Runbook связан с выбранной средой выполнения. Все пакеты в выбранной среде выполнения будут доступны во время выполнения модуля Runbook.

REST API

Необходимые условия

• Настройте среду выполнения PowerShell и предоставьте ее в качестве входных данных для создания модуля Runbook.

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runbooks/<runbookName>?api-version=2023-05-15-preview 

{ 
  "properties": { 
        "runbookType": "PowerShell", 
        "runtimeEnvironment": <runtimeEnvironmentName>, 
        "publishContentLink": { 
            "uri": "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1" 
        } 
    }, 
   "location": "East US"
} 

Примечание.

Аналогичные API также работают для типа Runbook Python.

Обновление Модуля Runbook

Модуль Runbook можно обновить, изменив среду выполнения, связанную с runbook. Для обновления можно выбрать один или несколько модулей Runbook. Модуль Runbook в состоянии выполнения не будет влиять на изменение среды выполнения, связанной с этим runbook.

Портал Azure

1. В учетной записи службы автоматизации в разделе "Автоматизация процессов" выберите Модули Runbook.

2. Установите флажок для модулей Runbook, которые требуется обновить.

3. Выберите Обновить.

4. Выберите среду выполнения из раскрывающегося списка, с которым нужно связать модули Runbook.

5. Выберите "Обновить", чтобы обновить выбранные модули Runbook с новой средой выполнения.

Проверьте, выполняется ли модуль Runbook должным образом после обновления. Если модуль Runbook не удается предоставить ожидаемый результат, можно снова обновить среду выполнения до старого интерфейса, выполнив шаги 1-4.

Примечание.

Обновления Runbook сохраняются между новым интерфейсом среды выполнения и старым интерфейсом. Все изменения, внесенные в среду выполнения, связанную с модулем runbook, будут сохраняться даже во время его выполнения в старом интерфейсе.

REST API

Обновление среды выполнения, связанной с runbook.

PATCH 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runbooks/<runbookName>?api-version=2023-05-15-preview 
{ 
  "properties": { 
    "type": "PowerShell" 
    "runtimeEnvironment": "<runtimeEnvironmentName>" 
  } 
} 

Примечание.

Вызовы View/Delete для Runbook остаются неизменными и могут ссылаться на Runbook — REST API служба автоматизации Azure | Microsoft Learn.

Тестирование обновления Runbook

Запустите тестовое задание для модуля Runbook с другой средой выполнения. Этот сценарий полезен, если модуль Runbook необходимо протестировать с помощью среды выполнения перед обновлением.

Портал Azure

Модули Runbook можно обновить, изменив среду выполнения, связанную с этим runbook. Перед публикацией изменений рекомендуется протестировать выполнение runbook. Это необходимо, чтобы модуль Runbook работал должным образом.

Чтобы протестировать выполнение runbook перед изменением среды выполнения публикации, выполните следующие действия.

1. Перейдите на страницу Runbooks и выберите runbook, для которого требуется обновить среду выполнения.

   

2. На странице "Изменить runbook" выберите "Изменить" на портале, чтобы открыть текстовый редактор.

3. В поле среды выполнения отображается существующая конфигурация. Выберите новую среду выполнения из раскрывающегося списка.

   

4. Выберите область "Тест", чтобы протестировать выполнение runbook с обновленной средой выполнения. Нажмите кнопку "Пуск" , чтобы начать тестовый запуск.

5. Закройте область тестирования и при необходимости внесите необходимые изменения в код Runbook или среду выполнения.

6. Выберите "Опубликовать" , чтобы обновить среду выполнения, связанную с runbook.

7. Выберите "Да" , чтобы переопределить ранее опубликованную версию и подтвердить изменения.

REST API

Запустите тестовое задание для модуля Runbook с другой средой выполнения. Этот сценарий полезен, если модуль Runbook необходимо протестировать с помощью среды выполнения перед обновлением.

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/runbooks/<runbookName>/draft/testJob?api-version=2023-05-15-preview 
{ 
  "properties": { 
    "runtimeEnvironment": "<runtimeEnvironmentName>" 
    "runOn": "" 
  } 
} 

Создание облачного задания

Портал Azure

В настоящее время модули Runbook, связанные с средой выполнения, будут выполняться в Azure.

REST API

Задания наследуют среду выполнения из модуля Runbook. Запустите облачное задание для опубликованного модуля Runbook:

PUT 
https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.Automation/automationAccounts/<accountName>/jobs/<jobName>?api-version=2023-05-15-preview 
{ 
  "properties": { 
    "runbook": { 
      "name": "<runbookName>" 
    }, 
    "runOn": "" 
  } 
} 

Примечание.

Вызовы создания и просмотра заданий остаются неизменными и могут ссылаться на запросы из API Job-REST (служба автоматизации Azure) | Microsoft Learn.

Связывание существующих модулей Runbook с средами среды выполнения, созданными системой

Все существующие модули Runbook в учетной записи служба автоматизации Azure будут автоматически связаны с средами среды выполнения, созданными системой. Эти системные среды выполнения создаются на основе языка среды выполнения, версии и модулей или пакетов, присутствующих в соответствующей учетной записи служба автоматизации Azure. Подробнее. Чтобы обновить существующие модули Runbook, измените среду выполнения, выполнив описанные здесь действия.

Следующие шаги

• Обзор среды выполнения.
• Сведения об устранении неполадок, связанных с выполнением последовательности runbook, см. в статье Устранение ошибок runbook.