Модуль azure.azcollection.azure_rm_cosmosdbaccount_info — Получение сведений об учетной записи Azure Cosmos DB

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Может быть также установлен через переменную среды 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.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Может быть также установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi).

Может быть также установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Может быть также установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Имя учетной записи базы данных Cosmos DB.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string

Имя группы ресурсов Azure.

retrieve_connection_strings

boolean

Получить строки подключения.

Варианты:

• false
• true

retrieve_keys

string

Получить ключи и строки подключения.

Варианты:

• "all"
• "readonly"

secret

string

Секретный ключ клиента Azure. Используется при аутентификации с помощью Служебного принципала.

subscription_id

string

Ваш идентификатор подписки Azure.

tags

список / элементы=строка

Ограничить результаты, предоставив список тегов. Формат тегов – ‘ключ’ или ‘ключ:значение’.

tenant

строка

Идентификатор Azure-аренды. Используется при аутентификации с помощью Служебного принципала.

thumbprint

строка

добавлен в azure.azcollection 1.14.0

Отпечаток цифрового сертификата для закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью Служебного принципала.

Требуется, если определён x509_certificate_path.

x509_certificate_path

путь

добавлен в azure.azcollection 1.14.0

Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используется при аутентификации с помощью Служебного принципала.

accounts

сложный

Список словарей, содержащих сведения о учетной записи базы данных.

Возвращается: всегда

connection_strings

список / элементы=строка

Список строк подключения.

Возвращается: при запросе

connection_string

строка

Описание строки подключения.

Возвращается: всегда

Пример: "Primary SQL Connection String"

description

строка

Строка подключения.

Возвращается: всегда

Пример: "AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=xxxxx"

consistency_policy

сложный

Политика согласованности.

Возвращается: всегда

default_consistency_level

строка

Уровень согласованности по умолчанию.

Возвращается: всегда

Пример: "session"

max_interval_in_seconds

целое число

Максимальный интервал в секундах.

Возвращается: всегда

Пример: 5

max_staleness_prefix

целое число

Максимальное отставание префикса.

Возвращается: всегда

Пример: 100

database_account_offer_type

строка

Тип предложения.

Возвращается: всегда

Пример: "Standard"

document_endpoint

строка

Точка входа к документам.

Возвращается: всегда

Пример: "https://testaccount.documents.azure.com:443/"

enable_automatic_failover

логический

Включить автоматическое резервное копирование.

Возвращается: всегда

Пример: true

enable_cassandra

логический

Включить Cassandra.

Возвращается: всегда

Пример: true

enable_free_tier

логический

добавлен в azure.azcollection 1.10.0

Если включено, учетная запись является бесплатной.

Возвращается: всегда

Пример: true

enable_gremlin

логический

Включить Gremlin.

Возвращается: всегда

Пример: true

enable_multiple_write_locations

логический

Включить несколько локаций записи.

Возвращается: всегда

Пример: true

enable_table

логический

Включить Таблицу.

Возвращается: всегда

Пример: true

failover_policies

сложный

Список новых политик резервного копирования для изменения приоритета резервного копирования.

Возвращается: всегда

failover_priority

integer

Приоритет отработки отказа.

Возвращается: всегда

Пример: 0

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-адресов.

Это значение устарело и будет удалено в более поздней версии. Используйте c(ip_rules) вместо этого.

Возвращается: всегда

Пример: "10.10.10.10"

ip_rules

list / elements=string

added in azure.azcollection 1.10.0

IP-адреса или диапазоны IP-адресов в формате CIDR, включенные в разрешенный список IP-адресов клиентов.

Возвращается: всегда

Пример: ["10.10.10.10", "20.20.20.20/28"]

is_virtual_network_filter_enabled

boolean

Включить фильтр виртуальной сети.

Возвращается: всегда

Пример: true

kind

string

Указывает тип учетной записи базы данных.

Возвращается: всегда

Пример: "global_document_db"

location

string

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

Возвращается: всегда

Пример: "westus"

mongo_version

string

added in azure.azcollection 1.10.0

Версия сервера для учетной записи MongoDB.

Используется только для c(kind) = i(mongo_db); в противном случае значение равно null/none.

Возвращается: всегда

Пример: "4.0"

name

string

Имя учетной записи базы данных.

Возвращается: всегда

Пример: "testaccount"

primary_master_key

string

Основной главный ключ.

Возвращается: по запросу

Пример: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

primary_readonly_master_key

string

Основной главный ключ только для чтения.

Возвращается: по запросу

Пример: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

provisioning_state

string

Состояние подготовки Cosmos DB.

Возвращается: всегда

Пример: "Succeeded"

public_network_access

string

added in azure.azcollection 1.10.0

Разрешен ли доступ к серверу из общедоступной сети.

Возвращается: всегда

Пример: "Enabled"

read_locations

complex

Расположения для чтения.

Возвращается: всегда

document_endpoint

string

Конечная точка документа.

Возвращается: всегда

Пример: "https://testaccount-eastus.documents.azure.com:443/"

failover_priority

integer

Приоритет отработки отказа.

Возвращается: всегда

Пример: 0

id

string

Идентификатор места чтения.

Возвращается: всегда

Пример: "testaccount-eastus"

name

string

Имя расположения.

Возвращается: всегда

Пример: "eastus"

provisioning_state

string

Состояние подготовки.

Возвращается: всегда

Пример: "Succeeded"

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

Список правил ACL виртуальной сети, настроенных для учетной записи Cosmos DB.

Возвращается: успешно

ignore_missing_v_net_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

Приоритет отработки отказа.

Возвращается: всегда

Пример: 0

id

string

Идентификатор места чтения.

Возвращается: всегда

Пример: "testaccount-eastus"

name

string

Имя расположения.

Возвращается: всегда

Пример: "eastus"

provisioning_state

string

Состояние подготовки.

Возвращается: всегда

Пример: "Succeeded"