Spec-Zone.ru › Ansible 2.11

community.azure.azure_rm_cosmosdbaccount_info – Получение сведений об учетной записи Azure Cosmos DB

Примечание

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

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

Для использования в playbook, укажите: community.azure.azure_rm_cosmosdbaccount_info.

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

Обзор

  • Получение данных об учетной записи Azure Cosmos DB.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
adfs_authority_url
строка
добавлено в 0.0.1 of azure.azcollection
URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile
строка
добавлено в 0.0.1 of azure.azcollection
По умолчанию:
"latest"
Выбор профиля API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлено в 0.0.1 of 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 of azure.azcollection
    Варианты:
  • ignore
  • validate
Управление поведением проверки сертификатов для 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.
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, или выполнить вход до запуска задач или playbook с 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
  community.azure.azure_rm_cosmosdbaccount_info:
    resource_group: myResourceGroup
    name: testaccount

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

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

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

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

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

Пример:
AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=fSEjathnk6ZeBTrXkud9j5kfhtSEQ q3dpJxJga76h9BZkK2BJJrDzSO6DDn6yKads017OZBZ1YZWyq1cW4iuvA==
consistency_policy
complex
всегда
Политика согласованности.
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
булево
всегда
Включить автоматическое резервирование.

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

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

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

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

Пример:
True
failover_policies
complex
всегда
Список новых политик резервного копирования для изменения приоритета резервного копирования.
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
булево
всегда
Включить фильтр виртуальной сети.

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

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

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

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

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

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

Пример:
Успешно
read_locations
complex
всегда
Расположения чтения.
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
словарь
всегда
Метки, назначенные ресурсу. Словарь пар «строка»:«строка».

Пример:
{'tag1': 'abc'}
virtual_network_rules
список / элементы=строка
успех
Список правил 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
complex
всегда
Расположения записи.
document_endpoint
строка
всегда
Конечная точка документов.

Пример:
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/community/azure/azure_rm_cosmosdbaccount_info_module.html

Spec-Zone.ru

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