Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook укажите: azure.azcollection.azure_rm_resource.

В версии 0.1.2: из azure.azcollection

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

Обзор

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

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

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

Примечания

Примечание

  • Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в файле ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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
complex
всегда
Данные ответа, специфичные для типа ресурса.
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


Авторы

  • Zim Kalinowski (@zikalino)

© 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_resource_module.html

Spec-Zone.ru

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