azure.azcollection.azure_rm_deployment – Создание или удаление развертываний шаблонов Azure Resource Manager
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_deployment.
Добавлено в версии 0.1.0: коллекции azure.azcollection
Обзор
- Создание или удаление развертываний шаблонов Azure Resource Manager с помощью Azure SDK для Python.
- Вы можете найти некоторые шаблоны быстрой настройки в GitHub по адресу https://github.com/azure/azure-quickstart-templates.
- Дополнительную информацию о шаблонах Azure Resource Manager см. на сайте https://azure.microsoft.com/ru-ru/documentation/articles/resource-group-template-deploy/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципа сервиса. | |
| adfs_authority_url строка добавлен в 0.0.1 of azure.azcollection | URL авторитета Azure AD. Используется при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS. | |
| api_profile строка добавлен в 0.0.1 of azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags логическое значение |
| Управление тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом значении теги, не найденные в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлен в 0.0.1 of azure.azcollection |
| Управление источником учетных данных для аутентификации. Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в auto (значение по умолчанию) приоритет имеет модуль параметров -> env -> credential_file -> cli.При установке в env, учетные данные будут считываться из переменных окружения.При установке в credential_file, профиль будет считываться из ~/.azure/credentials.При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если их несколько, иначе используется стандартная подписка az cli.При установке в msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, иначе выбирается первая подписка.Параметр msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлен в 0.0.1 of azure.azcollection |
| Управление поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или взаимодействии с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с принципом сервиса. | |
| cloud_environment строка добавлен в 0.0.1 of azure.azcollection | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, используется имя среды (определенное Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| deployment_mode строка |
| В поэтапном режиме ресурсы развертываются без удаления существующих ресурсов, которые не включены в шаблон. В полном режиме ресурсы развертываются, а существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. |
| location строка | По умолчанию: "westus" | Географическое расположение, в котором будет размещена группа ресурсов. |
| name строка | По умолчанию: "ansible-arm" | Имя развертывания, которое будет отслеживаться в истории развертывания группы ресурсов. Использование имени развертывания перезапишет предыдущее значение в истории развертывания группы ресурсов. алиасы: deployment_name |
| parameters словарь | Хэш всех необходимых переменных шаблона для шаблона развертывания. Этот параметр взаимоисключающий с parameters_link. Если state=present, требуется либо parameters_link, либо parameters. | |
| parameters_link строка | Uri файла, содержащего тело параметров. Этот параметр взаимоисключающий с parameters. Если state=present, требуется либо parameters_link, либо parameters. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципа сервиса. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов, которое следует использовать или создать для размещения развернутого шаблона. алиасы: resource_group_name | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципом сервиса. | |
| state строка |
| Если state=present, шаблон будет создан. Если state=present и развертывание существует, оно будет обновлено. Если state=absent, группа ресурсов будет удалена. |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags словарь | Словарь пар строка:строка, которые будут назначены в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false. | |
| template словарь | Хэш, содержащий встроенные шаблоны. Этот параметр взаимоисключающий с template_link. Если state=present, требуется либо template, либо template_link. | |
| template_link строка | Uri файла, содержащего тело шаблона. Этот параметр взаимоисключающий с template. Если state=present, требуется либо template, либо template_link. | |
| tenant строка | Идентификатор клиента Azure. Используется при аутентификации с принципом сервиса. | |
| wait_for_deployment_completion логическое значение |
| Блокировать ожидание завершения развертывания или нет. |
| wait_for_deployment_polling_period строка | По умолчанию: 10 | Время (в секундах) ожидания между опросами при ожидании завершения развертывания. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или книги команд с
az login. - Аутентификация также возможна с использованием службы-принципала или пользователя Active Directory.
- Для аутентификации через службу-принципал передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы данные для аутентификации могут быть сохранены в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавление дополнительных профилей. Укажите профиль, передав параметр profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как войти в систему, используя команду
az login.
Примеры
# Destroy a template deployment
- name: Destroy Azure Deploy
azure_rm_deployment:
resource_group: myResourceGroup
name: myDeployment
state: absent
# Create or update a template deployment based on uris using parameter and template links
- name: Create Azure Deploy
azure_rm_deployment:
resource_group: myResourceGroup
name: myDeployment
template_link: 'https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-linux/azuredeploy.json'
parameters_link: 'https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-linux/azuredeploy.parameters.json'
# Create or update a template deployment based on a uri to the template and parameters specified inline.
# This deploys a VM with SSH support for a given public key, then stores the result in 'azure_vms'. The result is then
# used to create a new host group. This host group is then used to wait for each instance to respond to the public IP SSH.
- name: Create Azure Deploy
azure_rm_deployment:
resource_group: myResourceGroup
name: myDeployment
parameters:
newStorageAccountName:
value: devopsclestorage1
adminUsername:
value: devopscle
dnsNameForPublicIP:
value: devopscleazure
location:
value: West US
vmSize:
value: Standard_A2
vmName:
value: ansibleSshVm
sshKeyData:
value: YOUR_SSH_PUBLIC_KEY
template_link: 'https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-sshkey/azuredeploy.json'
register: azure
- name: Add new instance to host group
add_host:
hostname: "{{ item['ips'][0].public_ip }}"
groupname: azure_vms
loop: "{{ azure.deployment.instances }}"
# Deploy an Azure WebApp running a hello world'ish node app
- name: Create Azure WebApp Deployment at http://devopscleweb.azurewebsites.net/hello.js
azure_rm_deployment:
resource_group: myResourceGroup
name: myDeployment
parameters:
repoURL:
value: 'https://github.com/devigned/az-roadshow-oss.git'
siteName:
value: devopscleweb
hostingPlanName:
value: someplan
siteLocation:
value: westus
sku:
value: Standard
template_link: 'https://raw.githubusercontent.com/azure/azure-quickstart-templates/master/201-web-app-github-deploy/azuredeploy.json'
# Create or update a template deployment based on an inline template and parameters
- name: Create Azure Deploy
azure_rm_deployment:
resource_group: myResourceGroup
name: myDeployment
template:
$schema: "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#"
contentVersion: "1.0.0.0"
parameters:
newStorageAccountName:
type: "string"
metadata:
description: "Unique DNS Name for the Storage Account where the Virtual Machine's disks will be placed."
adminUsername:
type: "string"
metadata:
description: "User name for the Virtual Machine."
adminPassword:
type: "securestring"
metadata:
description: "Password for the Virtual Machine."
dnsNameForPublicIP:
type: "string"
metadata:
description: "Unique DNS Name for the Public IP used to access the Virtual Machine."
ubuntuOSVersion:
type: "string"
defaultValue: "14.04.2-LTS"
allowedValues:
- "12.04.5-LTS"
- "14.04.2-LTS"
- "15.04"
metadata:
description: >
The Ubuntu version for the VM. This will pick a fully patched image of this given Ubuntu version.
Allowed values: 12.04.5-LTS, 14.04.2-LTS, 15.04."
variables:
location: "West US"
imagePublisher: "Canonical"
imageOffer: "UbuntuServer"
OSDiskName: "osdiskforlinuxsimple"
nicName: "myVMNic"
addressPrefix: "192.0.2.0/24"
subnetName: "Subnet"
subnetPrefix: "10.0.0.0/24"
storageAccountType: "Standard_LRS"
publicIPAddressName: "myPublicIP"
publicIPAddressType: "Dynamic"
vmStorageAccountContainerName: "vhds"
vmName: "MyUbuntuVM"
vmSize: "Standard_D1"
virtualNetworkName: "MyVNET"
vnetID: "[resourceId('Microsoft.Network/virtualNetworks',variables('virtualNetworkName'))]"
subnetRef: "[concat(variables('vnetID'),'/subnets/',variables('subnetName'))]"
resources:
- type: "Microsoft.Storage/storageAccounts"
name: "[parameters('newStorageAccountName')]"
apiVersion: "2015-05-01-preview"
location: "[variables('location')]"
properties:
accountType: "[variables('storageAccountType')]"
- apiVersion: "2015-05-01-preview"
type: "Microsoft.Network/publicIPAddresses"
name: "[variables('publicIPAddressName')]"
location: "[variables('location')]"
properties:
publicIPAllocationMethod: "[variables('publicIPAddressType')]"
dnsSettings:
domainNameLabel: "[parameters('dnsNameForPublicIP')]"
- type: "Microsoft.Network/virtualNetworks"
apiVersion: "2015-05-01-preview"
name: "[variables('virtualNetworkName')]"
location: "[variables('location')]"
properties:
addressSpace:
addressPrefixes:
- "[variables('addressPrefix')]"
subnets:
-
name: "[variables('subnetName')]"
properties:
addressPrefix: "[variables('subnetPrefix')]"
- type: "Microsoft.Network/networkInterfaces"
apiVersion: "2015-05-01-preview"
name: "[variables('nicName')]"
location: "[variables('location')]"
dependsOn:
- "[concat('Microsoft.Network/publicIPAddresses/', variables('publicIPAddressName'))]"
- "[concat('Microsoft.Network/virtualNetworks/', variables('virtualNetworkName'))]"
properties:
ipConfigurations:
-
name: "ipconfig1"
properties:
privateIPAllocationMethod: "Dynamic"
publicIPAddress:
id: "[resourceId('Microsoft.Network/publicIPAddresses',variables('publicIPAddressName'))]"
subnet:
id: "[variables('subnetRef')]"
- type: "Microsoft.Compute/virtualMachines"
apiVersion: "2015-06-15"
name: "[variables('vmName')]"
location: "[variables('location')]"
dependsOn:
- "[concat('Microsoft.Storage/storageAccounts/', parameters('newStorageAccountName'))]"
- "[concat('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
properties:
hardwareProfile:
vmSize: "[variables('vmSize')]"
osProfile:
computername: "[variables('vmName')]"
adminUsername: "[parameters('adminUsername')]"
adminPassword: "[parameters('adminPassword')]"
storageProfile:
imageReference:
publisher: "[variables('imagePublisher')]"
offer: "[variables('imageOffer')]"
sku: "[parameters('ubuntuOSVersion')]"
version: "latest"
osDisk:
name: "osdisk"
vhd:
uri: >
[concat('http://',parameters('newStorageAccountName'),'.blob.core.windows.net/',variables('vmStorageAccountContainerName'),'/',
variables('OSDiskName'),'.vhd')]
caching: "ReadWrite"
createOption: "FromImage"
networkProfile:
networkInterfaces:
-
id: "[resourceId('Microsoft.Network/networkInterfaces',variables('nicName'))]"
diagnosticsProfile:
bootDiagnostics:
enabled: "true"
storageUri: "[concat('http://',parameters('newStorageAccountName'),'.blob.core.windows.net')]"
parameters:
newStorageAccountName:
value: devopsclestorage
adminUsername:
value: devopscle
adminPassword:
value: Password1!
dnsNameForPublicIP:
value: devopscleazure
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||||
|---|---|---|---|---|---|---|
| deployment complex | всегда | Подробности развертывания. | ||||
| group_name string | всегда | Имя группы ресурсов. Пример: myResourceGroup | ||||
| id string | всегда | Идентификатор развертывания Azure. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/myD eployment | ||||
| instances list / elements=string | всегда | Предоставляет общедоступные IP-адреса для каждого экземпляра виртуальной машины. | ||||
| ips list / elements=string | всегда | Список общедоступных IP-адресов. | ||||
| dns_settings complex | всегда | Настройки DNS. | ||||
| domain_name_label string | всегда | Метка доменного имени. Пример: myvirtualmachine | ||||
| fqdn string | всегда | Полное доменное имя. Пример: myvirtualmachine.eastus2.cloudapp.azure.com | ||||
| id string | всегда | Идентификатор ресурса общедоступного IP. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/p ublicIPAddresses/myPublicIP | ||||
| name string | всегда | Имя ресурса общедоступного IP. Пример: myPublicIP | ||||
| public_ip string | всегда | Значение общедоступного IP-адреса. Пример: 104.209.244.123 | ||||
| public_ip_allocation_method string | всегда | Метод выделения общедоступного IP-адреса. Пример: Динамический | ||||
| vm_name string | всегда | Имя виртуальной машины. Пример: myvirtualmachine | ||||
| name string | всегда | Имя развертывания. Пример: myDeployment | ||||
| outputs complex | всегда | Словарь полученных результатов развертывания. Пример: {'hostname': {'type': 'String', 'value': 'myvirtualmachine.eastus2.cloudapp.azure.com'}} | ||||
Авторы
- David Justice (@devigned)
- Laurent Mazuel (@lmazuel)
- Andre Price (@obsoleted)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_deployment_module.html