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 присутствует. | |
| 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 присутствует. | ||
| enable_automatic_failover логический тип |
| Включает автоматический переключение на резервный регион записи в редких случаях, когда регион недоступен из-за сбоя. Автоматическое переключение приведет к новому региону записи для учетной записи, и выбирается на основе настроек приоритетов переключения, настроенных для учетной записи. | |
| enable_cassandra логический тип |
| Включить Cassandra. | |
| enable_gremlin логический тип |
| Включить Gremlin. | |
| enable_multiple_write_locations логический тип |
| Включает возможность записи в несколько расположений. | |
| enable_table логический тип |
| Включить Таблицы. | |
| geo_rep_locations список | Массив, содержащий географические расположения, включенные для учетной записи Cosmos DB. Необходимо, когда state присутствует. | ||
| 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 присутствует. | ||
| name - / обязательно | Имя учетной записи базы данных Cosmos DB. | ||
| password - | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group - / обязательно | Имя группы Azure-ресурсов. | ||
| секрет строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью принципала службы. | ||
| состояние - |
| Утвердите состояние учетной записи базы данных. Используйте present для создания или обновления учетной записи базы данных и absent для ее удаления. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | ||
| теги словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. | ||
| арендатор строка | Идентификатор арендатора Azure. Используется при аутентификации с помощью принципала службы. | ||
| virtual_network_rules список | Список правил 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/azure_rm_cosmosdbaccount_module.html
