Spec-Zone.ru › Ansible 2.9

azure_rm_resource – Создание любого ресурса Azure

Новая версия 2.6.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Создание, обновление или удаление любого ресурса Azure с помощью API Azure REST.
  • Этот модуль предоставляет доступ к ресурсам, которые не поддерживаются модулями Ansible.
  • Подробные сведения о конкретном API REST ресурса см. на странице https://docs.microsoft.com/en-us/rest/api/.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью служебного принципала.
adfs_authority_url
строка
добавлен в 2.6
URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS.
api_profile
строка
добавлен в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для использования при общении с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
api_version
-
Конкретная версия API для использования.
auth_source
строка
добавлен в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto , если переменная не определена.
auto будет следовать стандартной очередности приоритета параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.
При установке значения cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.
Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке значения msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка.
msi был добавлен в Ansible 2.6.
body
-
Тело HTTP-запроса/ответа веб-сервису.
cert_validation_mode
строка
добавлен в 2.5
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификата для Azure-узлов. По умолчанию все модули будут проверять сертификат сервера, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано в профиле файла учетных данных или в переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала.
cloud_environment
строка
добавлен в 2.4
 По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано в профиле файла учетных данных или в переменной среды AZURE_CLOUD_ENVIRONMENT.
idempotency
булево
    Варианты:
  • нет ←
  • да
Если включено, проверка идемпотентности будет выполнена с помощью method=GET в первую очередь, а затем сравнена с body.
method
-
    Варианты:
  • GET
  • PUT ←
  • POST
  • HEAD
  • PATCH
  • DELETE
  • MERGE
HTTP-метод запроса или ответа. Он должен быть в верхнем регистре.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью служебного принципала.
polling_interval
целое число
добавлен в 2.8
 По умолчанию:
60
Если включено, проверка идемпотентности будет выполнена с помощью method=GET в первую очередь, а затем сравнена с body.
polling_timeout
целое число
добавлен в 2.8
 По умолчанию:
0
Если включено, проверка идемпотентности будет выполнена с помощью method=GET в первую очередь, а затем сравнена с body.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
provider
-
Тип поставщика.
Требуется, если URL не указан.
resource_group
-
Группа ресурсов для использования.
Требуется, если URL не указан.
resource_name
-
Имя ресурса.
Требуется, если URL не указан.
resource_type
-
Тип ресурса.
Требуется, если URL не указан.
secret
строка
Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
state
-
    Варианты:
  • absent
  • present ←
Утвердить состояние ресурса. Используйте present для создания или обновления ресурса или absent для удаления ресурса.
status_code
список
По умолчанию:
[200, 201, 202]
Действительный числовой HTTP-код состояния, указывающий на успешность запроса. Также может быть списком кодов состояния через запятую.
subresource
-
Список подресурсов.
name
-
Имя подресурса.
namespace
-
Пространство имен подресурса.
type
-
Тип подресурса.
subscription_id
строка
Ваш идентификатор подписки Azure.
tenant
строка
Идентификатор Azure-аренды. Используется при аутентификации с помощью служебного принципала.
url
-
URL-адрес ресурса Azure RM.

Примечания

Примечание

  • Для аутентификации с 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.

Примеры

- name: Update scaleset info using azure_rm_resource
  azure_rm_resource:
    resource_group: myResourceGroup
    provider: compute
    resource_type: virtualmachinescalesets
    resource_name: myVmss
    api_version: "2017-12-01"
    body: { body }

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ Возвращаемое значение Описание
response
сложный
всегда
Ответ, специфичный для типа ресурса.
id
строка
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Storage/storageAccounts/staccb57dc95183
kind
строка
всегда
Тип хранилища.

Пример:
Storage
location
строка
всегда
Расположение ресурса, по умолчанию совпадает с расположением группы ресурсов.

Пример:
eastus
name
строка
всегда
Имя хранилища.

Пример:
staccb57dc95183
properties
словарь
всегда
Свойства, связанные с хранилищем.

Пример:
{'creationTime': '2019-06-13T06:34:33.0996676Z', 'encryption': {'keySource': 'Microsoft.Storage', 'services': {'blob': {'enabled': True, 'lastEnabledTime': '2019-06-13T06:34:33.1934074Z'}, 'file': {'enabled': True, 'lastEnabledTime': '2019-06-13T06:34:33.1934074Z'}}}, 'networkAcls': {'bypass': 'AzureServices', 'defaultAction': 'Allow', 'ipRules': [], 'virtualNetworkRules': []}, 'primaryEndpoints': {'blob': 'https://staccb57dc95183.blob.core.windows.net/', 'file': 'https://staccb57dc95183.file.core.windows.net/', 'queue': 'https://staccb57dc95183.queue.core.windows.net/', 'table': 'https://staccb57dc95183.table.core.windows.net/'}, 'primaryLocation': 'eastus', 'provisioningState': 'Succeeded', 'secondaryLocation': 'westus', 'statusOfPrimary': 'available', 'statusOfSecondary': 'available', 'supportsHttpsTrafficOnly': False}
sku
словарь
всегда
SKU хранилища.

Пример:
{'name': 'Standard_GRS', 'tier': 'Standard'}
tags
словарь
всегда
Теги ресурса.

Пример:
{'key1': 'value1'}
type
строка
всегда
Тип ресурса.

Пример:
Microsoft.Storage/storageAccounts


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Zim Kalinowski (@zikalino)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_resource_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API