azure.azcollection.azure_rm_cosmosdbaccount – Управление экземпляром учетной записи Azure Database
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_cosmosdbaccount.
Новое в версии 0.1.2: из azure.azcollection
Обзор
- Создание, обновление и удаление экземпляра учетной записи Azure Database.
Требования
Ниже перечислены требования, необходимые на узле, на котором выполняется этот модуль.
- 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 of azure.azcollection | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags булево |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноничности любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлено в 0.0.1 of 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 of azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с главным принципом службы. | ||
| cloud_environment строка добавлено в 0.0.1 of 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 целое число | При использовании уровня согласованности Ограниченная устарелость, это значение представляет собой количество времени устарелости (в секундах), которое допускается. Допустимый диапазон значений — 5–86400. Требуется при default_consistency_policy=bounded_staleness. | ||
| max_staleness_prefix целое число | При использовании уровня согласованности Ограниченная устарелость, это значение представляет количество допускаемых устаревших запросов. Допустимый диапазон значений — 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 булево |
| Флаг для указания включения/отключения правил 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 список / элементы=строка | Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB. | ||
| ignore_missing_vnet_service_endpoint булево |
| Создать учетную запись Cosmos DB без существующей точки конечного доступа виртуальной сети. | |
| subnet string | Он может быть строкой, содержащей идентификатор ресурса подсети. Он может быть словарем, содержащим '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 и 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 string | всегда | Уникальный идентификатор ресурса учетной записи базы данных. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/myData baseAccount |
Авторы
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_cosmosdbaccount_module.html
