azure_rm_cosmosdbaccount – Управление экземпляром учетной записи Azure Database Account
Новая в версии 2.8.
Описание
- Создание, обновление и удаление экземпляра учетной записи Azure Database Account.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным сервисом. | ||
| adfs_authority_url строка добавлено в 2.6 | URL-адрес источника Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном источнике ADFS. | ||
| api_profile строка добавлено в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags логическое |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных, используемых для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto если переменная не определена.auto будет следовать стандартной очередности приоритетов параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке значения cli, учетные данные будут получены из профиля Azure CLI по умолчанию.Также можно установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке значения msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может быть использована для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. | |
| cert_validation_mode строка добавлено в 2.5 |
| Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы. | ||
| cloud_environment строка добавлено в 2.4 | Значение по умолчанию: "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 логическое |
| Включить таблицы. | |
| 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 string | Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| state - |
| Установить состояние учетной записи базы данных. Используйте present для создания или обновления учетной записи базы данных и absent для ее удаления. | |
| subscription_id string | Ваш идентификатор подписки Azure. | ||
| tags dictionary | Словарь пар «строка:строка» для присвоения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | ||
| tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| virtual_network_rules list | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | ||
| ignore_missing_vnet_service_endpoint boolean |
| Создать учетную запись Cosmos DB без существующего конечного пункта службы виртуальной сети. | |
| subnet - | Может быть строкой, содержащей идентификатор ресурса подсети. Может быть словарем, содержащим «resource_group», «virtual_network_name» и «subnet_name» | ||
Примечания
Примечание
- Для аутентификации с 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 и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы данные учетных данных можно хранить в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 string | всегда | Уникальный идентификатор ресурса учетной записи базы данных. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/myData baseAccount |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/azure_rm_cosmosdbaccount_module.html
