azure_rm_cosmosdbaccount_facts – Получение фактов о учетной записи Azure Cosmos DB
Новая версия с 2.8.
Обзор
- Получение фактов об учетной записи Azure Cosmos DB.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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. |
| 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. |
| name - | Имя учетной записи базы данных Cosmos DB. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - | Имя группы Azure-ресурсов. | |
| retrieve_connection_strings boolean |
| Получение строк подключения. |
| retrieve_keys строка |
| Получение ключей и строк подключения. |
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы. | |
| subscription_id строка | Идентификатор вашей Azure-подписки. | |
| tags - | Ограничение результатов предоставлением списка тегов. Формат тегов 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с 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: Get instance of Database Account
azure_rm_cosmosdbaccount_facts:
resource_group: myResourceGroup
name: testaccount
- name: List instances of Database Account
azure_rm_cosmosdbaccousnt_facts:
resource_group: myResourceGroup
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| accounts сложный | всегда | Список словарей, содержащих данные для учетной записи базы данных. | ||
| connection_strings список | при запросе | Список строк подключения. | ||
| connection_string строка | всегда | Описание строки подключения. Пример: Первичная строка подключения к SQL | ||
| description строка | всегда | Строка подключения. Пример: AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=fSEjathnk6ZeBTrXkud9j5kfhtSEQ q3dpJxJga76h9BZkK2BJJrDzSO6DDn6yKads017OZBZ1YZWyq1cW4iuvA== | ||
| consistency_policy сложный | всегда | Политика согласованности. | ||
| default_consistency_level строка | всегда | Уровень согласованности по умолчанию. Пример: сессия | ||
| max_interval_in_seconds целое число | всегда | Максимальный интервал в секундах. Пример: 5 | ||
| max_staleness_prefix целое число | всегда | Максимальное значение префикса устарелости. Пример: 100 | ||
| database_account_offer_type строка | всегда | Тип предложения. Пример: Стандартный | ||
| document_endpoint строка | всегда | Конечная точка документа. Пример: https://testaccount.documents.azure.com:443/ | ||
| enable_automatic_failover булево | всегда | Включить автоматическое переключение. Пример: Истина | ||
| enable_cassandra булево | всегда | Включить Cassandra Пример: Истина | ||
| enable_gremlin булево | всегда | Включить Gremlin. Пример: Истина | ||
| enable_multiple_write_locations булево | всегда | Включить несколько мест записи. Пример: Истина | ||
| enable_table булево | всегда | Включить таблицу. Пример: Истина | ||
| failover_policies сложный | всегда | Расположения для чтения | ||
| failover_priority целое число | всегда | Приоритет переключения. | ||
| id строка | всегда | Идентификатор расположения для чтения. Пример: testaccount-eastus | ||
| name строка | всегда | Название расположения. Пример: eastus | ||
| id строка | всегда | Уникальный идентификатор ресурса учетной записи базы данных. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccount s/testaccount | ||
| ip_range_filter строка | всегда | Включить фильтр диапазонов IP. Пример: 10.10.10.10 | ||
| is_virtual_network_filter_enabled булево | всегда | Включить фильтр виртуальной сети. Пример: Истина | ||
| kind строка | всегда | Указывает тип учетной записи базы данных. Пример: global_document_db | ||
| location строка | всегда | Расположение группы ресурсов, к которой принадлежит ресурс. Пример: westus | ||
| name строка | всегда | Имя учетной записи базы данных. Пример: testaccount | ||
| primary_master_key строка | при запросе | Основной мастер-ключ. Пример: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw== | ||
| primary_readonly_master_key строка | при запросе | Основной мастер-ключ. Пример: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw== | ||
| provisioning_state строка | всегда | Состояние подготовки Cosmos DB. Пример: Успешно завершено | ||
| read_locations сложный | всегда | Расположения для чтения | ||
| document_endpoint строка | всегда | Конечная точка документа. Пример: https://testaccount-eastus.documents.azure.com:443/ | ||
| failover_priority целое число | всегда | Приоритет переключения. | ||
| id строка | всегда | Идентификатор расположения. Пример: testaccount-eastus | ||
| name строка | всегда | Имя расположения. Пример: eastus | ||
| provisioning_state строка | всегда | Состояние подготовки. Пример: Успешно | ||
| resource_group строка | всегда | Имя группы Azure ресурсов. Пример: myResourceGroup | ||
| secondary_master_key строка | при запросе | Основной мастер-ключ. Пример: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw== | ||
| secondary_readonly_master_key строка | при запросе | Основной мастер-ключ. Пример: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw== | ||
| tags сложный тип | всегда | Теги | ||
| virtual_network_rules список | Список правил Virtual Network ACL, настроенных для учетной записи Cosmos DB. | |||
| ignore_missing_vnet_service_endpoint логическое | Создать учетную запись Cosmos DB без существующего конечной точки службы виртуальной сети. | |||
| subnet строка | Идентификатор ресурса подсети. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNet works/testvnet/subnets/testsubnet1 | |||
| write_locations сложный тип | всегда | Расположения записи | ||
| document_endpoint строка | всегда | Конечная точка документа. Пример: https://testaccount-eastus.documents.azure.com:443/ | ||
| failover_priority целое число | всегда | Приоритет аварийного переключения. | ||
| id строка | всегда | Идентификатор расположения. Пример: testaccount-eastus | ||
| name строка | всегда | Имя расположения. Пример: eastus | ||
| provisioning_state строка | всегда | Состояние подготовки. Пример: Успешно | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом 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_facts_module.html
