azure.azcollection.azure_rm_mariadbserver – Управление экземпляром сервера MariaDB

Примечание

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

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

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

Новый в версии 0.1.2: коллекции azure.azcollection

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

Обзор

Создание, обновление и удаление экземпляра сервера MariaDB.

Требования

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

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.
admin_password строка			Пароль администратора.
admin_username строка			Имя пользователя администратора сервера. Может быть указан только при создании сервера (и требуется для создания).
api_profile строка добавлен в 0.0.1 azure.azcollection		По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логический тип		Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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.
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`.
create_mode строка		По умолчанию: "Default"	Режим создания SQL Server.
enforce_ssl логический тип		Варианты: нет ← да	Включить принудительное использование SSL.
location строка			Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
name строка / обязательно			Имя сервера.
password строка			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно			Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
secret строка			Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
sku строка			SKU (тарифный план) сервера.
	capacity целое число		Масштабируемая емкость, представляющая вычислительные единицы сервера.
	name строка		Имя SKU, как правило, тариф + семейство + ядра, например `B_Gen4_1`, `GP_Gen5_8`.
	size строка		Код размера, который интерпретируется ресурсом соответствующим образом.
	tier строка	Варианты: basic standard	Уровень определенного SKU, например `Basic`.
state строка		Варианты: отсутствует существует ←	Утверждение состояния сервера MariaDB. Используйте `present` для создания или обновления сервера и `absent` для удаления.
storage_mb целое число			Максимальный объем памяти, разрешенный для сервера.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка для назначения метаданных объекту. Метаданные тегов объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка			Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
version строка		Варианты: 10.2 10.3	Версия сервера.

Примечания

Примечание

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

END_OF_DOCUMENT_MARKER

Примеры

- name: Create (or update) MariaDB Server
  azure_rm_mariadbserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: B_Gen5_1
      tier: Basic
    location: eastus
    storage_mb: 1024
    enforce_ssl: True
    version: 10.2
    admin_username: cloudsa
    admin_password: password

Значения возврата

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

Ключ	Возвращаемое значение	Описание
fully_qualified_domain_name строка	всегда	Полное доменное имя сервера. Пример: mariadbsrv1b6dd89593.mariadb.database.azure.com
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/mariadbsrv1b6dd89593
state строка	всегда	Состояние сервера, видимое пользователю. Возможные значения включают `Ready`, `Dropping`, `Disabled`. Пример: Готов
version строка	всегда	Версия сервера. Возможные значения включают `10.2` и `10.3`. Пример: 10.2

Авторы

Zim Kalinowski (@zikalino)
Matti Ranta (@techknowlogick)

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