Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

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

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

Новое в версии 0.1.2: из azure.azcollection

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

Описание

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

Требования

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

  • 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 могут быть использованы для определения идентификатора подписки, если присутствует более одного; в противном случае используется стандартная подписка Azure 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
булево
    Варианты:
  • нет ←
  • да
Если включено, выполняется проверка идемпотентности с использованием method=GET, а затем сравнение с body.
method
строка
    Варианты:
  • GET
  • PUT ←
  • POST
  • HEAD
  • PATCH
  • DELETE
  • MERGE
HTTP-метод запроса или ответа. Он должен быть в верхнем регистре.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
polling_interval
целое число
Значение по умолчанию:
60
Если включено, выполняется проверка идемпотентности с использованием method=GET, а затем сравнение с body.
polling_timeout
целое число
Значение по умолчанию:
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. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_resource_module.html

Spec-Zone.ru

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