Spec-Zone.ru › Ansible 2.11

azure.azcollection.azure_rm_cosmosdbaccount_info – Получение фактов о счете Azure Cosmos DB

Примечание

Этот плагин входит в состав коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_cosmosdbaccount_info.

Новый в версии 0.1.2: из azure.azcollection

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Получение фактов о счете Azure Cosmos DB.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • 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.
auth_source
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задано через переменную среды 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
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для точек входа 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.
name
строка
Имя учетной записи базы данных Cosmos DB.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Имя группы ресурсов Azure.
retrieve_connection_strings
логический тип
    Варианты:
  • no
  • yes
Получить строки подключения.
retrieve_keys
строка
    Варианты:
  • all
  • readonly
Получить ключи и строки подключения.
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_info:
    resource_group: myResourceGroup
    name: testaccount

- name: List instances of Database Account
  azure_rm_cosmosdbaccount_info:
    resource_group: myResourceGroup

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ Возвращаемое значение Описание
accounts
complex
всегда
Список словарей, содержащих данные для учетной записи базы данных.
connection_strings
list / elements=string
при запросе
Список строк подключения.
connection_string
string
всегда
Описание строки подключения.

Пример:
Основная строка подключения SQL
description
string
всегда
Строка подключения.

Пример:
AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=xxxxx
consistency_policy
complex
всегда
Политика согласованности.
default_consistency_level
string
всегда
Уровень согласованности по умолчанию.

Пример:
сессия
max_interval_in_seconds
integer
всегда
Максимальный интервал в секундах.

Пример:
5
max_staleness_prefix
integer
всегда
Максимальный префикс устаревания.

Пример:
100
database_account_offer_type
string
всегда
Тип предложения.

Пример:
Стандартный
document_endpoint
string
всегда
Конечная точка документа.

Пример:
https://testaccount.documents.azure.com:443/
enable_automatic_failover
boolean
всегда
Включить автоматическое переключение.

Пример:
True
enable_cassandra
boolean
всегда
Включить Cassandra.

Пример:
True
enable_gremlin
boolean
всегда
Включить Gremlin.

Пример:
True
enable_multiple_write_locations
boolean
всегда
Включить несколько мест записи.

Пример:
True
enable_table
boolean
всегда
Включить таблицу.

Пример:
True
failover_policies
complex
всегда
Список новых политик переключения для изменения приоритета переключения.
failover_priority
integer
всегда
Приоритет переключения.
id
string
всегда
Идентификатор места чтения.

Пример:
testaccount-eastus
name
string
всегда
Название места расположения.

Пример:
eastus
id
string
всегда
Уникальный идентификатор ресурса учетной записи базы данных.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccount s/testaccount
ip_range_filter
string
всегда
Включить фильтр диапазонов IP-адресов.

Пример:
10.10.10.10
is_virtual_network_filter_enabled
boolean
всегда
Включить фильтр виртуальной сети.

Пример:
True
kind
string
всегда
Указывает тип учетной записи базы данных.

Пример:
global_document_db
location
string
всегда
Расположение группы ресурсов, к которой принадлежит ресурс.

Пример:
westus
name
string
всегда
Имя учетной записи базы данных.

Пример:
testaccount
primary_master_key
string
при запросе
Основной мастер-ключ.

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
primary_readonly_master_key
string
при запросе
Основной мастер-ключ.

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
provisioning_state
string
всегда
Состояние подготовки Cosmos DB.

Пример:
Успешно
read_locations
complex
всегда
Места чтения.
document_endpoint
string
всегда
Конечная точка документа.

Пример:
https://testaccount-eastus.documents.azure.com:443/
failover_priority
integer
всегда
Приоритет переключения.
id
string
всегда
Идентификатор места чтения.

Пример:
testaccount-eastus
name
string
всегда
Название места расположения.

Пример:
eastus
provisioning_state
string
всегда
Состояние подготовки.

Пример:
Успешно
resource_group
string
всегда
Имя группы Azure ресурсов.

Пример:
myResourceGroup
secondary_master_key
string
при запросе
Основной мастер-ключ.

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
secondary_readonly_master_key
string
при запросе
Основной мастер-ключ.

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
tags
dictionary
всегда
Метки, назначенные ресурсу. Словарь пар "строка":"строка".

Пример:
{'tag1': 'abc'}
virtual_network_rules
list / elements=string
успех
Список правил виртуальной сети, настроенных для учетной записи Cosmos DB.
ignore_missing_vnet_service_endpoint
boolean
успех
Создать учетную запись Cosmos DB без существующей конечной точки виртуальной сети.
subnet
string
успех
Идентификатор ресурса подсети.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNet works/testvnet/subnets/testsubnet1
write_locations
complex
всегда
Места записи.
document_endpoint
string
всегда
Конечная точка документа.

Пример:
https://testaccount-eastus.documents.azure.com:443/
failover_priority
integer
always
Приоритет резервного копирования.
id
string
always
Идентификатор расположения для чтения.

Пример:
testaccount-eastus
name
string
always
Имя расположения.

Пример:
eastus
provisioning_state
string
always
Состояние подготовки.

Пример:
Успешно


Авторы

  • 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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API