Spec-Zone.ru › Ansible 2.9

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

Новая версия с 2.9.

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

Описание

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

Псевдонимы: azure_rm_cosmosdbaccount_facts

Требования

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

  • 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
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использоваться переменная среды 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
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для 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
логическое
    Варианты:
  • 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_cosmosdbaccousnt_info:
    resource_group: myResourceGroup

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

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

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

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

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

Пример:
session
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
при запросе
Основной мастер-ключ.

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

Пример:
UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw==
provisioning_state
string
всегда
Состояние подготовки 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
сложный тип
всегда
Расположения записи.
document_endpoint
строка
всегда
Конечная точка документа.

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

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

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

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


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • 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.9/modules/azure_rm_cosmosdbaccount_info_module.html

Spec-Zone.ru

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