azure.azcollection.azure_rm_cosmosdbaccount – Управление экземпляром учетной записи Azure Database Account
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_cosmosdbaccount.
Добавлено в версии 0.1.2: of azure.azcollection
Обзор
- Создание, обновление и удаление экземпляра учетной записи Azure Database Account.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. | |
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлен в 0.0.1 azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды 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 |
| Управляет поведением проверки сертификатов для 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. | |
| consistency_policy строка | Политика согласованности для учетной записи Cosmos DB. | ||
| default_consistency_level строка |
| Уровень и настройки конфигурации согласованности по умолчанию для учетной записи Cosmos DB. Необходим при state=present. | |
| max_interval_in_seconds целое число | При использовании уровня согласованности Bounded Staleness, это значение представляет собой допустимое время устаревания (в секундах). Допустимый диапазон значений составляет 5 - 86400. Требуется при default_consistency_policy=bounded_staleness. | ||
| max_staleness_prefix целое число | При использовании уровня согласованности Bounded Staleness, это значение представляет собой количество допустимых устаревших запросов. Допустимый диапазон значений составляет 1 - 2 147 483 647. Требуется при default_consistency_policy=bounded_staleness. | ||
| database_account_offer_type строка | Тип предложения учетной записи базы данных, например, Standard
Необходим при state=present. | ||
| enable_automatic_failover логическое значение |
| Включает автоматическое переключение на резервный регион записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическое переключение приведет к новому региону записи для учетной записи, выбираемому на основе приоритетов переключения, настроенных для учетной записи. | |
| enable_cassandra логическое значение |
| Включить Cassandra. | |
| enable_gremlin логическое значение |
| Включить Gremlin. | |
| enable_multiple_write_locations логическое значение |
| Включает возможность записи в несколько регионов для учетной записи. | |
| enable_table логическое значение |
| Включить Table. | |
| geo_rep_locations список / элементы=строка | Массив, содержащий регионы географической репликации, включенные для учетной записи Cosmos DB. Требуется при state=present. | ||
| failover_priority целое число | Приоритет переключения для региона. Приоритет переключения 0 означает регион записи. Максимальное значение приоритета переключения = (общее число регионов - 1). Значения приоритета переключения должны быть уникальными для каждого региона, в котором существует учетная запись базы данных. | ||
| name строка | Имя региона. | ||
| ip_range_filter строка | Поддержка брандмауэра Cosmos DB. Это значение задаёт набор IP-адресов или диапазонов IP-адресов. В формате CIDR для включения разрешенного списка клиентских IP-адресов для данной учетной записи базы данных. IP-адреса/диапазоны должны быть разделены запятыми и не должны содержать пробелов. | ||
| is_virtual_network_filter_enabled логическое значение |
| Флаг, указывающий на включение/отключение правил Virtual Network ACL. | |
| kind строка |
| Указывает тип учетной записи базы данных. Его можно задать только при создании учетной записи базы данных. | |
| location строка | Расположение группы ресурсов, к которой относится ресурс. Требуется при state=present. | ||
| name строка / обязательно | Имя учетной записи базы данных Cosmos DB. | ||
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group строка / обязательно | Имя группы Azure-ресурсов. | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с главным принципом службы. | ||
| state строка |
| Утверждает состояние учетной записи базы данных. Используйте present, чтобы создать или обновить учетную запись базы данных, и absent, чтобы удалить её. | |
| subscription_id строка | Ваш идентификатор Azure-подписки. | ||
| tags словарь | Словарь пар «строка:строка» для задания метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. | ||
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с главным принципом службы. | ||
| virtual_network_rules список / элементы=строка | Список правил Virtual Network ACL, настроенных для учетной записи Cosmos DB. | ||
| ignore_missing_vnet_service_endpoint логическое значение |
| Создать учетную запись Cosmos DB без существующей точки входа виртуальной сети. | |
| подсеть строка | Может быть строкой, содержащей идентификатор ресурса подсети. Может быть словарем, содержащим 'группа_ресурсов', 'имя_виртуальной_сети' и 'имя_подсети' |
Примечания
Примечание
- Для аутентификации с 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: Create Cosmos DB Account - min
azure_rm_cosmosdbaccount:
resource_group: myResourceGroup
name: myDatabaseAccount
location: westus
geo_rep_locations:
- name: southcentralus
failover_priority: 0
database_account_offer_type: Standard
- name: Create Cosmos DB Account - max
azure_rm_cosmosdbaccount:
resource_group: myResourceGroup
name: myDatabaseAccount
location: westus
kind: mongo_db
geo_rep_locations:
- name: southcentralus
failover_priority: 0
database_account_offer_type: Standard
ip_range_filter: 10.10.10.10
enable_multiple_write_locations: yes
virtual_network_rules:
- subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVi
rtualNetwork/subnets/mySubnet"
consistency_policy:
default_consistency_level: bounded_staleness
max_staleness_prefix: 10
max_interval_in_seconds: 1000
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | всегда | Уникальный идентификатор ресурса учетной записи базы данных. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/myData baseAccount |
Авторы
- 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_cosmosdbaccount_module.html
