Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
- последние
- 2023-08-01
- 2020-10-01
- 2019-10-01-превью
Замечания
Дополнительные сведения о выполнении скриптов во время развертывания см. в статье Использование скриптов развертывания в Bicep или Использование скриптов развертывания в шаблонах ARM.
Определение ресурсов Bicep
Тип ресурса deploymentScripts можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Примеры использования
Примеры Bicep
Простой пример развертывания скрипта развертывания ресурсов.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource deploymentScript 'Microsoft.Resources/deploymentScripts@2020-10-01' = {
name: resourceName
location: location
kind: 'AzurePowerShell'
properties: {
azPowerShellVersion: '8.3'
cleanupPreference: 'Always'
retentionInterval: 'P1D'
scriptContent: ''' $output = ''Hello''
Write-Output $output
$DeploymentScriptOutputs = @{}
$DeploymentScriptOutputs[''text''] = $output
'''
timeout: 'P1D'
}
}
Проверенные модули Azure
Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.
| Модуль | Описание |
|---|---|
| Сценарий развертывания | Ресурсный модуль AVM для сценария развертывания |
Примеры быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.
| Bicep-файл | Описание |
|---|---|
| службе контейнеров Azure (AKS) с helm | Развертывание управляемого кластера с помощью службы контейнеров Azure (AKS) с помощью Helm |
| построитель образов Azure с базовых показателей Windows Azure | Создает среду построителя образов Azure и создает образ Windows Server с использованием последних обновлений Windows и примененных базовых показателей Windows. |
| Сборка образов контейнеров с помощью задач ACR | Этот шаблон использует DeploymentScript для оркестрации ACR для создания образа контейнера из репозитория кода. |
| настройка службы Dev Box | Этот шаблон создаст все ресурсы администратора Dev Box в рамках краткого руководства по началу работы Dev Box (/azure/dev-box/quickstart-create-dev-box). Вы можете просмотреть все созданные ресурсы или напрямую перейти к DevPortal.microsoft.com для создания первого поля разработки. |
| Копирование файла из URI в контейнер хранилища BLOB-объектов | Этот модуль загружает файл из URI и копирует его в контейнер BLOB-объектов службы хранилища Azure. StorageAccount уже должен существовать, и исходный файл должен быть поставлен в универсальный код ресурса (URI). |
| краткое руководство по созданию большого двоичного объекта для средства копирования данных фабрики данных | Этот шаблон создает хранилище BLOB-объектов и отправляет файл для краткого руководства по копированию данных |
| создание скрипта развертывания со сложными входными данными & выходных данных | Этот шаблон демонстрирует рекомендации по передаче и чтению сложных входных данных, выходных данных и журналов в скрипт развертывания Az CLI |
| создание скрипта развертывания со сложными входными данными & выходных данных | В этом шаблоне демонстрируются рекомендации по передаче и чтению сложных входных и выходных данных и журналов в скрипт развертывания Az PowerShell |
| создание сайта WordPress | Этот шаблон создает сайт WordPress в экземпляре контейнера |
| Создание AKS с помощью Prometheus и Grafana с помощью ссылки privae | Вы создадите azure grafana, AKS и установите Prometheus, набор средств мониторинга и оповещений с открытым кодом в кластере Службы Azure Kubernetes (AKS). Затем вы используете управляемую частную конечную точку Azure Grafana для подключения к этому серверу Prometheus и отображения данных Prometheus на панели мониторинга Grafana |
| создание задания "Очистка машинного обучения Azure" | Этот шаблон создает задание "Очистка машинного обучения Azure" для настройки гиперпараметра. |
| Создание диспетчера виртуальных сетей Azure и примеры виртуальных сетей | Этот шаблон развертывает диспетчер виртуальных сетей Azure и примеры виртуальных сетей в именованной группе ресурсов. Он поддерживает несколько топологий подключения и типов членства в группах сети. |
| Создание сервера SFTP по запросу с постоянным хранилищем | Этот шаблон демонстрирует сервер SFTP по запросу с помощью экземпляра контейнера Azure (ACI). |
| создание шлюза приложений с помощью сертификатов | В этом шаблоне показано, как создавать самозаверяющие сертификаты Key Vault, а затем ссылаться на нее из шлюза приложений. |
| создание приложения контейнера и среды с реестра | Создайте среду приложения-контейнера с базовым приложением контейнера из реестра контейнеров Azure. Она также развертывает рабочую область Log Analytics для хранения журналов. |
| создает приложение микрослужб Dapr с помощью приложений контейнеров | Создайте приложение микрослужб Dapr с помощью контейнерных приложений. |
| Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров | Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений. |
| Развертывание простого приложения микрослужбы Приложения Azure Spring | Этот шаблон развертывает простое приложение микрослужбы Приложения Azure Spring для запуска в Azure. |
| развертывает статический веб-сайт | Развертывание статического веб-сайта с резервной учетной записью хранения |
| концентратора FinOps |
Этот шаблон создает новый экземпляр концентратора FinOps, включая Data Explorer, хранилище Озеро данных и фабрику данных. |
| Front Door Standard/Premium со статическим источником веб-сайта | Этот шаблон создает front Door Standard/Premium и статический веб-сайт службы хранилища Azure и настраивает Front Door для отправки трафика на статический веб-сайт. |
| импортируйте образы контейнеров в ACR | Этот шаблон использует модуль импорта ACR из реестра bicep для импорта общедоступных образов контейнеров в реестр контейнеров Azure. |
| Дополнительные возможности можно использовать в Фабрике данных Azure. Чтобы попробовать фабрики данных Azure, щелкните один щелчком. | Этот шаблон создает конвейер фабрики данных для действия копирования из БОЛЬШОго двоичного объекта Azure в другой BLOB-объект Azure |
| агент с управляемым удостоверением пользователя | Этот набор шаблонов демонстрирует настройку службы агента ИИ Azure с изоляцией виртуальной сети с помощью проверки подлинности управляемого удостоверения пользователей для подключения службы ИИ/AOAI и частных сетевых каналов для подключения агента к защищенным данным. |
| настройка стандартного агента | В этом наборе шаблонов показано, как настроить службу агента ИИ Azure со стандартной настройкой, то есть с проверкой подлинности управляемого удостоверения для подключений к проекту или концентратору и общедоступного доступа к Интернету. Агенты используют ресурсы поиска и хранилища с одним клиентом. С помощью этой настройки вы можете полностью контролировать и просматривать эти ресурсы, но вы будете нести расходы на основе использования. |
| среда тестирования для брандмауэра Azure Premium | Этот шаблон создает политику брандмауэра Azure premium и брандмауэра с такими функциями, как обнаружение вторжений (IDPS), проверка TLS и фильтрация веб-категорий |
| Использование скрипта развертывания для создания объектов Azure AD | В этом примере используется скрипт развертывания для создания объектов в Azure Active Directory. |
Формат ресурса
Чтобы создать ресурс Microsoft.Resources/deploymentScripts, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.Resources/deploymentScripts@2019-10-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
tags: {
{customized property}: 'string'
}
kind: 'string'
// For remaining properties, see Microsoft.Resources/deploymentScripts objects
}
Объекты Microsoft.Resources/deploymentScripts
Задайте свойство типа, чтобы указать тип объекта.
Для AzureCLIиспользуйте:
{
kind: 'AzureCLI'
properties: {
arguments: 'string'
azCliVersion: 'string'
cleanupPreference: 'string'
containerSettings: {
containerGroupName: 'string'
}
environmentVariables: [
{
name: 'string'
secureValue: 'string'
value: 'string'
}
]
forceUpdateTag: 'string'
primaryScriptUri: 'string'
retentionInterval: 'string'
scriptContent: 'string'
storageAccountSettings: {
storageAccountKey: 'string'
storageAccountName: 'string'
}
supportingScriptUris: [
'string'
]
timeout: 'string'
}
}
Для AzurePowerShellиспользуйте:
{
kind: 'AzurePowerShell'
properties: {
arguments: 'string'
azPowerShellVersion: 'string'
cleanupPreference: 'string'
containerSettings: {
containerGroupName: 'string'
}
environmentVariables: [
{
name: 'string'
secureValue: 'string'
value: 'string'
}
]
forceUpdateTag: 'string'
primaryScriptUri: 'string'
retentionInterval: 'string'
scriptContent: 'string'
storageAccountSettings: {
storageAccountKey: 'string'
storageAccountName: 'string'
}
supportingScriptUris: [
'string'
]
timeout: 'string'
}
}
Значения свойств
Microsoft.Resources/deploymentScripts
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Необязательное свойство. Управляемое удостоверение, используемое для этого сценария развертывания. В настоящее время поддерживается только назначаемое пользователем MSI. | ManagedServiceIdentity (обязательно) |
| добрый | Установите значение AzureCLI для типа AzureCliScript. Установите значение AzurePowerShell для типа AzurePowerShellScript. | AzureCLI AzurePowerShell (обязательный) |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 90 (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
AzureCliScript
| Имя | Описание | Ценность |
|---|---|---|
| добрый | Тип скрипта. | AzureCLI (обязательно) |
| свойства | Свойства объекта скрипта Azure CLI. | AzureCliScriptProperties (обязательно) |
Свойства AzureCliScriptProperties
| Имя | Описание | Ценность |
|---|---|---|
| Аргументы | Аргументы командной строки для передачи скрипту. Аргументы разделены пробелами. ex: -Name синий* -Location "Западная часть США 2" | струна |
| azCliVersion | Используемая версия модуля Azure CLI. | строка (обязательно) |
| cleanupПредпочтения | Предпочтения очистки при выполнении скрипта в состоянии терминала. Значение по умолчанию — Always. | "Always" OnExpiration «На успех» |
| Настройки контейнера | Параметры контейнера. | ContainerConfiguration (Конфигурация контейнера) |
| переменные окружения | Переменные среды, передаваемые в скрипт. | Переменная среды[] |
| forceUpdateTag | Возвращает или задает способ принудительного выполнения скрипта развертывания, даже если ресурс скрипта не изменился. Может быть текущей меткой времени или GUID. | струна |
| первичныйScriptUri | Универсальный код ресурса (URI) для скрипта. Это точка входа для внешнего скрипта. | струна |
| retentionInterval | Интервал, для которого служба сохраняет ресурс скрипта после достижения состояния терминала. Ресурс будет удален при истечении этого срока действия. Длительность основана на шаблоне ISO 8601 (например, P1D означает один день). | строка (обязательно) |
| scriptContent | Текст скрипта. | струна |
| storageAccountSettings | Параметры учетной записи хранения. | StorageAccountConfiguration (Конфигурация учетной записи хранилища) |
| поддержкаScriptUris | Вспомогательные файлы для внешнего скрипта. | строка[] |
| Времени ожидания | Максимально допустимое время выполнения скрипта, указанное в формате ISO 8601. Значение по умолчанию — P1D | струна |
AzurePowerShellScript
| Имя | Описание | Ценность |
|---|---|---|
| добрый | Тип скрипта. | AzurePowerShell (обязательный) |
| свойства | Свойства объекта скрипта Azure PowerShell. | AzurePowerShellScriptProperties (обязательно) |
AzurePowerShellScriptProperties
| Имя | Описание | Ценность |
|---|---|---|
| Аргументы | Аргументы командной строки для передачи скрипту. Аргументы разделены пробелами. ex: -Name синий* -Location "Западная часть США 2" | струна |
| azPowerShellVersion | Используемая версия модуля Azure PowerShell. | строка (обязательно) |
| cleanupПредпочтения | Предпочтения очистки при выполнении скрипта в состоянии терминала. Значение по умолчанию — Always. | "Always" OnExpiration «На успех» |
| Настройки контейнера | Параметры контейнера. | ContainerConfiguration (Конфигурация контейнера) |
| переменные окружения | Переменные среды, передаваемые в скрипт. | Переменная среды[] |
| forceUpdateTag | Возвращает или задает способ принудительного выполнения скрипта развертывания, даже если ресурс скрипта не изменился. Может быть текущей меткой времени или GUID. | струна |
| первичныйScriptUri | Универсальный код ресурса (URI) для скрипта. Это точка входа для внешнего скрипта. | струна |
| retentionInterval | Интервал, для которого служба сохраняет ресурс скрипта после достижения состояния терминала. Ресурс будет удален при истечении этого срока действия. Длительность основана на шаблоне ISO 8601 (например, P1D означает один день). | строка (обязательно) |
| scriptContent | Текст скрипта. | струна |
| storageAccountSettings | Параметры учетной записи хранения. | StorageAccountConfiguration (Конфигурация учетной записи хранилища) |
| поддержкаScriptUris | Вспомогательные файлы для внешнего скрипта. | строка[] |
| Времени ожидания | Максимально допустимое время выполнения скрипта, указанное в формате ISO 8601. Значение по умолчанию — P1D | струна |
ContainerConfiguration (Конфигурация контейнера)
| Имя | Описание | Ценность |
|---|---|---|
| containerGroupName | Имя группы контейнеров, если оно не указано, оно будет автоматически создано. Не указывая имя containerGroupName, система создает уникальное имя, которое может привести к добавлению несоответствующего требованиям политики Azure. Используйте containerGroupName, если у вас есть политика Azure, которая ожидает определенное соглашение об именовании или когда вы хотите полностью контролировать имя. Свойство containerGroupName должно находиться в диапазоне от 1 до 63 символов, должно содержать только строчные буквы, цифры и дефисы, которые не могут начинаться или заканчиваться дефисом и последовательными дефисами. Чтобы указать свойство containerGroupName, добавьте следующий объект в свойства: { containerSettings: { containerGroupName: "contoso-container" } }. Если вы не хотите указывать свойство containerGroupName, не добавляйте свойство containerSettings. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 63 |
Переменная среды
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя переменной среды. | строка (обязательно) |
| Функция secureValue | Значение переменной безопасной среды. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| ценность | Значение переменной среды. | струна |
Управляемая служебная идентичность
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип управляемого удостоверения. | UserAssigned |
| ИдентичностиНазначенныеПользователем | Список назначаемых пользователем управляемых удостоверений, связанных с ресурсом. Ключом является идентификатор ресурса Azure управляемого удостоверения. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
StorageAccountConfiguration (Конфигурация учетной записи хранилища)
| Имя | Описание | Ценность |
|---|---|---|
| ключХранилищаАккаунта | Ключ доступа к учетной записи хранения. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| storageAccountName | Имя учетной записи хранения. | струна |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
Пользовательская назначенная идентичность
| Имя | Описание | Ценность |
|---|
Определение ресурса шаблона ARM
Тип ресурса deploymentScripts можно развернуть с помощью операций, предназначенных для следующих операций:
- Группы ресурсов — см. команды развертывания групп ресурсов Для списка изменённых свойств в каждой версии API см. журнал изменений.
Примеры использования
Шаблоны быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
службе контейнеров Azure (AKS) с helm развертывание |
Развертывание управляемого кластера с помощью службы контейнеров Azure (AKS) с помощью Helm |
|
построитель образов Azure с базовых показателей Windows Azure развертывание |
Создает среду построителя образов Azure и создает образ Windows Server с использованием последних обновлений Windows и примененных базовых показателей Windows. |
|
Сборка образов контейнеров с помощью задач ACR развертывание |
Этот шаблон использует DeploymentScript для оркестрации ACR для создания образа контейнера из репозитория кода. |
|
настройка службы Dev Box развертывание |
Этот шаблон создаст все ресурсы администратора Dev Box в рамках краткого руководства по началу работы Dev Box (/azure/dev-box/quickstart-create-dev-box). Вы можете просмотреть все созданные ресурсы или напрямую перейти к DevPortal.microsoft.com для создания первого поля разработки. |
|
Копирование файла из URI в контейнер хранилища BLOB-объектов развертывание |
Этот модуль загружает файл из URI и копирует его в контейнер BLOB-объектов службы хранилища Azure. StorageAccount уже должен существовать, и исходный файл должен быть поставлен в универсальный код ресурса (URI). |
|
краткое руководство по созданию большого двоичного объекта для средства копирования данных фабрики данных развертывание |
Этот шаблон создает хранилище BLOB-объектов и отправляет файл для краткого руководства по копированию данных |
|
создание скрипта развертывания со сложными входными данными & выходных данных развертывание |
Этот шаблон демонстрирует рекомендации по передаче и чтению сложных входных данных, выходных данных и журналов в скрипт развертывания Az CLI |
|
создание скрипта развертывания со сложными входными данными & выходных данных развертывание |
В этом шаблоне демонстрируются рекомендации по передаче и чтению сложных входных и выходных данных и журналов в скрипт развертывания Az PowerShell |
|
создание сайта WordPress развертывание |
Этот шаблон создает сайт WordPress в экземпляре контейнера |
|
Создание AKS с помощью Prometheus и Grafana с помощью ссылки privae развертывание |
Вы создадите azure grafana, AKS и установите Prometheus, набор средств мониторинга и оповещений с открытым кодом в кластере Службы Azure Kubernetes (AKS). Затем вы используете управляемую частную конечную точку Azure Grafana для подключения к этому серверу Prometheus и отображения данных Prometheus на панели мониторинга Grafana |
|
создание задания "Очистка машинного обучения Azure" развертывание |
Этот шаблон создает задание "Очистка машинного обучения Azure" для настройки гиперпараметра. |
|
Создание диспетчера виртуальных сетей Azure и примеры виртуальных сетей развертывание |
Этот шаблон развертывает диспетчер виртуальных сетей Azure и примеры виртуальных сетей в именованной группе ресурсов. Он поддерживает несколько топологий подключения и типов членства в группах сети. |
|
Создание сервера SFTP по запросу с постоянным хранилищем развертывание |
Этот шаблон демонстрирует сервер SFTP по запросу с помощью экземпляра контейнера Azure (ACI). |
|
создание шлюза приложений с помощью сертификатов развертывание |
В этом шаблоне показано, как создавать самозаверяющие сертификаты Key Vault, а затем ссылаться на нее из шлюза приложений. |
|
Создание ключей ssh и хранение в KeyVault развертывание |
Этот шаблон использует ресурс deploymentScript для создания ключей SSH и хранения закрытого ключа в keyVault. |
|
создание приложения контейнера и среды с реестра развертывание |
Создайте среду приложения-контейнера с базовым приложением контейнера из реестра контейнеров Azure. Она также развертывает рабочую область Log Analytics для хранения журналов. |
|
создает приложение микрослужб Dapr с помощью приложений контейнеров развертывание |
Создайте приложение микрослужб Dapr с помощью контейнерных приложений. |
|
Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров развертывание |
Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений. |
|
Развертывание простого приложения микрослужбы Приложения Azure Spring развертывание |
Этот шаблон развертывает простое приложение микрослужбы Приложения Azure Spring для запуска в Azure. |
|
развертывает статический веб-сайт развертывание |
Развертывание статического веб-сайта с резервной учетной записью хранения |
| концентратора FinOps развертывание |
Этот шаблон создает новый экземпляр концентратора FinOps, включая Data Explorer, хранилище Озеро данных и фабрику данных. |
|
Front Door Standard/Premium со статическим источником веб-сайта развертывание |
Этот шаблон создает front Door Standard/Premium и статический веб-сайт службы хранилища Azure и настраивает Front Door для отправки трафика на статический веб-сайт. |
| Приложение-функция в плане потребления Linux с удаленной сборки развертывание |
Этот шаблон подготавливает приложение-функцию в плане потребления Linux и выполняет удаленную сборку во время развертывания кода. Приложение выполняется по запросу, и вы выставляете счета за выполнение без постоянного обязательства по ресурсу. |
|
импортируйте образы контейнеров в ACR развертывание |
Этот шаблон использует модуль импорта ACR из реестра bicep для импорта общедоступных образов контейнеров в реестр контейнеров Azure. |
|
импорт больших двоичных объектов VHD из URL-адреса ZIP-архива развертывание |
Для развертывания виртуальных машин на основе специализированных образов дисков требуется импортировать VHD-файлы в учетную запись хранения. В случае, если в одном ZIP-файле есть несколько VHD-файлов, и вы получили URL-адрес для получения ZIP-архива, этот шаблон ARM облегчит задание: скачивание, извлечение и импорт в существующий контейнер BLOB-объектов учетной записи хранения. |
|
min.io шлюза Azure развертывание |
Полное частное min.io развертывание шлюза Azure для предоставления API хранилища, соответствующего S3, поддерживаемого хранилищем BLOB-объектов |
|
Дополнительные возможности можно использовать в Фабрике данных Azure. Чтобы попробовать фабрики данных Azure, щелкните один щелчком. развертывание |
Этот шаблон создает конвейер фабрики данных для действия копирования из БОЛЬШОго двоичного объекта Azure в другой BLOB-объект Azure |
|
агент с управляемым удостоверением пользователя развертывание |
Этот набор шаблонов демонстрирует настройку службы агента ИИ Azure с изоляцией виртуальной сети с помощью проверки подлинности управляемого удостоверения пользователей для подключения службы ИИ/AOAI и частных сетевых каналов для подключения агента к защищенным данным. |
|
настройка стандартного агента развертывание |
В этом наборе шаблонов показано, как настроить службу агента ИИ Azure со стандартной настройкой, то есть с проверкой подлинности управляемого удостоверения для подключений к проекту или концентратору и общедоступного доступа к Интернету. Агенты используют ресурсы поиска и хранилища с одним клиентом. С помощью этой настройки вы можете полностью контролировать и просматривать эти ресурсы, но вы будете нести расходы на основе использования. |
| среда тестирования для брандмауэра Azure Premium развертывание |
Этот шаблон создает политику брандмауэра Azure premium и брандмауэра с такими функциями, как обнаружение вторжений (IDPS), проверка TLS и фильтрация веб-категорий |
|
Использование скрипта развертывания для создания объектов Azure AD развертывание |
В этом примере используется скрипт развертывания для создания объектов в Azure Active Directory. |
Формат ресурса
Чтобы создать ресурс Microsoft.Resources/deploymentScripts, добавьте следующий код JSON в шаблон.
{
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"name": "string",
"tags": {
"{customized property}": "string"
},
"kind": "string"
// For remaining properties, see Microsoft.Resources/deploymentScripts objects
}
Объекты Microsoft.Resources/deploymentScripts
Задайте свойство типа, чтобы указать тип объекта.
Для AzureCLIиспользуйте:
{
"kind": "AzureCLI",
"properties": {
"arguments": "string",
"azCliVersion": "string",
"cleanupPreference": "string",
"containerSettings": {
"containerGroupName": "string"
},
"environmentVariables": [
{
"name": "string",
"secureValue": "string",
"value": "string"
}
],
"forceUpdateTag": "string",
"primaryScriptUri": "string",
"retentionInterval": "string",
"scriptContent": "string",
"storageAccountSettings": {
"storageAccountKey": "string",
"storageAccountName": "string"
},
"supportingScriptUris": [ "string" ],
"timeout": "string"
}
}
Для AzurePowerShellиспользуйте:
{
"kind": "AzurePowerShell",
"properties": {
"arguments": "string",
"azPowerShellVersion": "string",
"cleanupPreference": "string",
"containerSettings": {
"containerGroupName": "string"
},
"environmentVariables": [
{
"name": "string",
"secureValue": "string",
"value": "string"
}
],
"forceUpdateTag": "string",
"primaryScriptUri": "string",
"retentionInterval": "string",
"scriptContent": "string",
"storageAccountSettings": {
"storageAccountKey": "string",
"storageAccountName": "string"
},
"supportingScriptUris": [ "string" ],
"timeout": "string"
}
}
Значения свойств
Microsoft.Resources/deploymentScripts
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | «2019-10-01-превью» |
| тождество | Необязательное свойство. Управляемое удостоверение, используемое для этого сценария развертывания. В настоящее время поддерживается только назначаемое пользователем MSI. | ManagedServiceIdentity (обязательно) |
| добрый | Установите значение AzureCLI для типа AzureCliScript. Установите значение AzurePowerShell для типа AzurePowerShellScript. | AzureCLI AzurePowerShell (обязательный) |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 90 (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.Resources/deploymentScripts" |
AzureCliScript
| Имя | Описание | Ценность |
|---|---|---|
| добрый | Тип скрипта. | AzureCLI (обязательно) |
| свойства | Свойства объекта скрипта Azure CLI. | AzureCliScriptProperties (обязательно) |
Свойства AzureCliScriptProperties
| Имя | Описание | Ценность |
|---|---|---|
| Аргументы | Аргументы командной строки для передачи скрипту. Аргументы разделены пробелами. ex: -Name синий* -Location "Западная часть США 2" | струна |
| azCliVersion | Используемая версия модуля Azure CLI. | строка (обязательно) |
| cleanupПредпочтения | Предпочтения очистки при выполнении скрипта в состоянии терминала. Значение по умолчанию — Always. | "Always" OnExpiration «На успех» |
| Настройки контейнера | Параметры контейнера. | ContainerConfiguration (Конфигурация контейнера) |
| переменные окружения | Переменные среды, передаваемые в скрипт. | Переменная среды[] |
| forceUpdateTag | Возвращает или задает способ принудительного выполнения скрипта развертывания, даже если ресурс скрипта не изменился. Может быть текущей меткой времени или GUID. | струна |
| первичныйScriptUri | Универсальный код ресурса (URI) для скрипта. Это точка входа для внешнего скрипта. | струна |
| retentionInterval | Интервал, для которого служба сохраняет ресурс скрипта после достижения состояния терминала. Ресурс будет удален при истечении этого срока действия. Длительность основана на шаблоне ISO 8601 (например, P1D означает один день). | строка (обязательно) |
| scriptContent | Текст скрипта. | струна |
| storageAccountSettings | Параметры учетной записи хранения. | StorageAccountConfiguration (Конфигурация учетной записи хранилища) |
| поддержкаScriptUris | Вспомогательные файлы для внешнего скрипта. | строка[] |
| Времени ожидания | Максимально допустимое время выполнения скрипта, указанное в формате ISO 8601. Значение по умолчанию — P1D | струна |
AzurePowerShellScript
| Имя | Описание | Ценность |
|---|---|---|
| добрый | Тип скрипта. | AzurePowerShell (обязательный) |
| свойства | Свойства объекта скрипта Azure PowerShell. | AzurePowerShellScriptProperties (обязательно) |
AzurePowerShellScriptProperties
| Имя | Описание | Ценность |
|---|---|---|
| Аргументы | Аргументы командной строки для передачи скрипту. Аргументы разделены пробелами. ex: -Name синий* -Location "Западная часть США 2" | струна |
| azPowerShellVersion | Используемая версия модуля Azure PowerShell. | строка (обязательно) |
| cleanupПредпочтения | Предпочтения очистки при выполнении скрипта в состоянии терминала. Значение по умолчанию — Always. | "Always" OnExpiration «На успех» |
| Настройки контейнера | Параметры контейнера. | ContainerConfiguration (Конфигурация контейнера) |
| переменные окружения | Переменные среды, передаваемые в скрипт. | Переменная среды[] |
| forceUpdateTag | Возвращает или задает способ принудительного выполнения скрипта развертывания, даже если ресурс скрипта не изменился. Может быть текущей меткой времени или GUID. | струна |
| первичныйScriptUri | Универсальный код ресурса (URI) для скрипта. Это точка входа для внешнего скрипта. | струна |
| retentionInterval | Интервал, для которого служба сохраняет ресурс скрипта после достижения состояния терминала. Ресурс будет удален при истечении этого срока действия. Длительность основана на шаблоне ISO 8601 (например, P1D означает один день). | строка (обязательно) |
| scriptContent | Текст скрипта. | струна |
| storageAccountSettings | Параметры учетной записи хранения. | StorageAccountConfiguration (Конфигурация учетной записи хранилища) |
| поддержкаScriptUris | Вспомогательные файлы для внешнего скрипта. | строка[] |
| Времени ожидания | Максимально допустимое время выполнения скрипта, указанное в формате ISO 8601. Значение по умолчанию — P1D | струна |
ContainerConfiguration (Конфигурация контейнера)
| Имя | Описание | Ценность |
|---|---|---|
| containerGroupName | Имя группы контейнеров, если оно не указано, оно будет автоматически создано. Не указывая имя containerGroupName, система создает уникальное имя, которое может привести к добавлению несоответствующего требованиям политики Azure. Используйте containerGroupName, если у вас есть политика Azure, которая ожидает определенное соглашение об именовании или когда вы хотите полностью контролировать имя. Свойство containerGroupName должно находиться в диапазоне от 1 до 63 символов, должно содержать только строчные буквы, цифры и дефисы, которые не могут начинаться или заканчиваться дефисом и последовательными дефисами. Чтобы указать свойство containerGroupName, добавьте следующий объект в свойства: { containerSettings: { containerGroupName: "contoso-container" } }. Если вы не хотите указывать свойство containerGroupName, не добавляйте свойство containerSettings. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 63 |
Переменная среды
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя переменной среды. | строка (обязательно) |
| Функция secureValue | Значение переменной безопасной среды. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| ценность | Значение переменной среды. | струна |
Управляемая служебная идентичность
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип управляемого удостоверения. | UserAssigned |
| ИдентичностиНазначенныеПользователем | Список назначаемых пользователем управляемых удостоверений, связанных с ресурсом. Ключом является идентификатор ресурса Azure управляемого удостоверения. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
StorageAccountConfiguration (Конфигурация учетной записи хранилища)
| Имя | Описание | Ценность |
|---|---|---|
| ключХранилищаАккаунта | Ключ доступа к учетной записи хранения. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| storageAccountName | Имя учетной записи хранения. | струна |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
Пользовательская назначенная идентичность
| Имя | Описание | Ценность |
|---|
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса deploymentScripts можно развернуть с помощью операций, предназначенных для следующих операций:
- Группы ресурсов Список изменённых свойств в каждой версии API см. журнал изменений.
Примеры использования
Примеры Terraform
Простой пример развертывания скрипта развертывания ресурсов.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "deploymentScript" {
type = "Microsoft.Resources/deploymentScripts@2020-10-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "AzurePowerShell"
properties = {
azPowerShellVersion = "8.3"
cleanupPreference = "Always"
environmentVariables = null
retentionInterval = "P1D"
scriptContent = "\t\t$output = 'Hello'\n\t\tWrite-Output $output\n\t\t$DeploymentScriptOutputs = @{}\n\t\t$DeploymentScriptOutputs['text'] = $output\n"
supportingScriptUris = null
timeout = "P1D"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Формат ресурса
Чтобы создать ресурс Microsoft.Resources/deploymentScripts, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
name = "string"
tags = {
{customized property} = "string"
}
kind = "string"
// For remaining properties, see Microsoft.Resources/deploymentScripts objects
}
Объекты Microsoft.Resources/deploymentScripts
Задайте свойство типа, чтобы указать тип объекта.
Для AzureCLIиспользуйте:
{
kind = "AzureCLI"
properties = {
arguments = "string"
azCliVersion = "string"
cleanupPreference = "string"
containerSettings = {
containerGroupName = "string"
}
environmentVariables = [
{
name = "string"
secureValue = "string"
value = "string"
}
]
forceUpdateTag = "string"
primaryScriptUri = "string"
retentionInterval = "string"
scriptContent = "string"
storageAccountSettings = {
storageAccountKey = "string"
storageAccountName = "string"
}
supportingScriptUris = [
"string"
]
timeout = "string"
}
}
Для AzurePowerShellиспользуйте:
{
kind = "AzurePowerShell"
properties = {
arguments = "string"
azPowerShellVersion = "string"
cleanupPreference = "string"
containerSettings = {
containerGroupName = "string"
}
environmentVariables = [
{
name = "string"
secureValue = "string"
value = "string"
}
]
forceUpdateTag = "string"
primaryScriptUri = "string"
retentionInterval = "string"
scriptContent = "string"
storageAccountSettings = {
storageAccountKey = "string"
storageAccountName = "string"
}
supportingScriptUris = [
"string"
]
timeout = "string"
}
}
Значения свойств
Microsoft.Resources/deploymentScripts
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Необязательное свойство. Управляемое удостоверение, используемое для этого сценария развертывания. В настоящее время поддерживается только назначаемое пользователем MSI. | ManagedServiceIdentity (обязательно) |
| добрый | Установите значение AzureCLI для типа AzureCliScript. Установите значение AzurePowerShell для типа AzurePowerShellScript. | AzureCLI AzurePowerShell (обязательный) |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 90 (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.Resources/deploymentScripts@2019-10-01-preview" |
AzureCliScript
| Имя | Описание | Ценность |
|---|---|---|
| добрый | Тип скрипта. | AzureCLI (обязательно) |
| свойства | Свойства объекта скрипта Azure CLI. | AzureCliScriptProperties (обязательно) |
Свойства AzureCliScriptProperties
| Имя | Описание | Ценность |
|---|---|---|
| Аргументы | Аргументы командной строки для передачи скрипту. Аргументы разделены пробелами. ex: -Name синий* -Location "Западная часть США 2" | струна |
| azCliVersion | Используемая версия модуля Azure CLI. | строка (обязательно) |
| cleanupПредпочтения | Предпочтения очистки при выполнении скрипта в состоянии терминала. Значение по умолчанию — Always. | "Always" OnExpiration «На успех» |
| Настройки контейнера | Параметры контейнера. | ContainerConfiguration (Конфигурация контейнера) |
| переменные окружения | Переменные среды, передаваемые в скрипт. | Переменная среды[] |
| forceUpdateTag | Возвращает или задает способ принудительного выполнения скрипта развертывания, даже если ресурс скрипта не изменился. Может быть текущей меткой времени или GUID. | струна |
| первичныйScriptUri | Универсальный код ресурса (URI) для скрипта. Это точка входа для внешнего скрипта. | струна |
| retentionInterval | Интервал, для которого служба сохраняет ресурс скрипта после достижения состояния терминала. Ресурс будет удален при истечении этого срока действия. Длительность основана на шаблоне ISO 8601 (например, P1D означает один день). | строка (обязательно) |
| scriptContent | Текст скрипта. | струна |
| storageAccountSettings | Параметры учетной записи хранения. | StorageAccountConfiguration (Конфигурация учетной записи хранилища) |
| поддержкаScriptUris | Вспомогательные файлы для внешнего скрипта. | строка[] |
| Времени ожидания | Максимально допустимое время выполнения скрипта, указанное в формате ISO 8601. Значение по умолчанию — P1D | струна |
AzurePowerShellScript
| Имя | Описание | Ценность |
|---|---|---|
| добрый | Тип скрипта. | AzurePowerShell (обязательный) |
| свойства | Свойства объекта скрипта Azure PowerShell. | AzurePowerShellScriptProperties (обязательно) |
AzurePowerShellScriptProperties
| Имя | Описание | Ценность |
|---|---|---|
| Аргументы | Аргументы командной строки для передачи скрипту. Аргументы разделены пробелами. ex: -Name синий* -Location "Западная часть США 2" | струна |
| azPowerShellVersion | Используемая версия модуля Azure PowerShell. | строка (обязательно) |
| cleanupПредпочтения | Предпочтения очистки при выполнении скрипта в состоянии терминала. Значение по умолчанию — Always. | "Always" OnExpiration «На успех» |
| Настройки контейнера | Параметры контейнера. | ContainerConfiguration (Конфигурация контейнера) |
| переменные окружения | Переменные среды, передаваемые в скрипт. | Переменная среды[] |
| forceUpdateTag | Возвращает или задает способ принудительного выполнения скрипта развертывания, даже если ресурс скрипта не изменился. Может быть текущей меткой времени или GUID. | струна |
| первичныйScriptUri | Универсальный код ресурса (URI) для скрипта. Это точка входа для внешнего скрипта. | струна |
| retentionInterval | Интервал, для которого служба сохраняет ресурс скрипта после достижения состояния терминала. Ресурс будет удален при истечении этого срока действия. Длительность основана на шаблоне ISO 8601 (например, P1D означает один день). | строка (обязательно) |
| scriptContent | Текст скрипта. | струна |
| storageAccountSettings | Параметры учетной записи хранения. | StorageAccountConfiguration (Конфигурация учетной записи хранилища) |
| поддержкаScriptUris | Вспомогательные файлы для внешнего скрипта. | строка[] |
| Времени ожидания | Максимально допустимое время выполнения скрипта, указанное в формате ISO 8601. Значение по умолчанию — P1D | струна |
ContainerConfiguration (Конфигурация контейнера)
| Имя | Описание | Ценность |
|---|---|---|
| containerGroupName | Имя группы контейнеров, если оно не указано, оно будет автоматически создано. Не указывая имя containerGroupName, система создает уникальное имя, которое может привести к добавлению несоответствующего требованиям политики Azure. Используйте containerGroupName, если у вас есть политика Azure, которая ожидает определенное соглашение об именовании или когда вы хотите полностью контролировать имя. Свойство containerGroupName должно находиться в диапазоне от 1 до 63 символов, должно содержать только строчные буквы, цифры и дефисы, которые не могут начинаться или заканчиваться дефисом и последовательными дефисами. Чтобы указать свойство containerGroupName, добавьте следующий объект в свойства: { containerSettings: { containerGroupName: "contoso-container" } }. Если вы не хотите указывать свойство containerGroupName, не добавляйте свойство containerSettings. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 63 |
Переменная среды
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя переменной среды. | строка (обязательно) |
| Функция secureValue | Значение переменной безопасной среды. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| ценность | Значение переменной среды. | струна |
Управляемая служебная идентичность
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип управляемого удостоверения. | UserAssigned |
| ИдентичностиНазначенныеПользователем | Список назначаемых пользователем управляемых удостоверений, связанных с ресурсом. Ключом является идентификатор ресурса Azure управляемого удостоверения. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
StorageAccountConfiguration (Конфигурация учетной записи хранилища)
| Имя | Описание | Ценность |
|---|---|---|
| ключХранилищаАккаунта | Ключ доступа к учетной записи хранения. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| storageAccountName | Имя учетной записи хранения. | струна |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
Пользовательская назначенная идентичность
| Имя | Описание | Ценность |
|---|