Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

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

Новое в azure.azcollection 0.1.2

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

Описание

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

Требования

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

  • python >= 2.7
  • На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection.
  • Полные инструкции по установке см. на странице https://galaxy.ansible.com/azure/azcollection
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

ad_user

строка

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с управляемым принципом.

adfs_authority_url

строка

добавлен в azure.azcollection 0.0.1

URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.

api_profile

строка

добавлен в azure.azcollection 0.0.1

Выбирает профиль API для использования при общении с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

По умолчанию: "latest"

api_version

строка

Конкретная версия API для использования.

auth_source

строка

добавлен в azure.azcollection 0.0.1

Управляет источником учетных данных для аутентификации.

Также может быть задан через переменную среды 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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

body

любой

Тело HTTP-запроса/ответа веб-сервису.

cert_validation_mode

строка

добавлен в azure.azcollection 0.0.1

Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"
... (rest of the translated table)
END_OF_DOCUMENT_MARKER

polling_interval

integer

Если включено, проверка идемпотентности будет выполнена с использованием method=GET в первую очередь, а затем сравнена с body.

По умолчанию: 60

polling_timeout

integer

Если включено, проверка идемпотентности будет выполнена с использованием method=GET в первую очередь, а затем сравнена с body.

По умолчанию: 0

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

provider

string

Тип поставщика.

Требуется, если URL не указан.

resource_group

string

Используемая группа ресурсов.

Требуется, если URL не указан.

resource_name

string

Имя ресурса.

Требуется, если URL не указан.

resource_type

string

Тип ресурса.

Требуется, если URL не указан.

secret

string

Секретный ключ Azure. Используется при аутентификации с помощью принципала службы.

state

string

Утверждение состояния ресурса. Используйте present, чтобы создать или обновить ресурс, или absent, чтобы удалить ресурс.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

status_code

list / elements=integer

Действительный числовой HTTP-код состояния, указывающий на успешность запроса. Также может быть перечислением кодов состояний, разделенных запятыми.

По умолчанию: [200, 201, 202]

subresource

list / elements=dictionary

Список подресурсов.

По умолчанию: []

name

string

Имя подресурса.

namespace

string

Имя пространства подресурса.

type

string

Тип подресурса.

subscription_id

string

Ваш идентификатор подписки Azure.

tenant

string

Идентификатор Azure-аренды. Используется при аутентификации с помощью принципала службы.

thumbprint

string

добавлен в azure.azcollection 1.14.0

Отпечаток частного ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью принципала службы.

Требуется, если определен x509_certificate_path.

url

string

URL Azure RM Resource.

x509_certificate_path

path

добавлен в azure.azcollection 1.14.0

Путь к X509-сертификату, используемому для создания принципала службы в формате PEM.

Сертификат должен быть присоединён к частному ключу.

Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

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

Авторы

  • Zim Kalinowski (@zikalino)

Ссылки на коллекцию

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_resource_module.html

Spec-Zone.ru

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