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

ad_user

string

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

adfs_authority_url

string

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

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

api_profile

string

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

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

По умолчанию: "latest"

auth_source

string

добавлен в 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

добавлен в 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

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

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

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлен в 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.

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Этот токен обменивается на токен Azure AD с помощью федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

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

list / элементы=string

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

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

x509_certificate_path

path

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

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

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

Используйте при аутентификации с помощью субъекта-службы.

accounts

complex

Список словарей с фактами об учетной записи базы данных.

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

connection_strings

list / elements=string

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

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

connection_string

string

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

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

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

description

string

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

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

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

consistency_policy

complex

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

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

default_consistency_level

string

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

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

Пример: "session"

max_interval_in_seconds

integer

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

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

Пример: 5

max_staleness_prefix

integer

Максимальный префикс устаревания.

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

Пример: 100

database_account_offer_type

string

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

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

Пример: "Standard"

document_endpoint

string

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

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

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

enable_automatic_failover

boolean

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

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

Пример: true

enable_cassandra

boolean

Включить Cassandra.

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

Пример: true

enable_free_tier

boolean

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

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

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

Пример: true

enable_gremlin

boolean

Включить Gremlin.

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

Пример: true

enable_multiple_write_locations

boolean

Включить несколько расположений для записи.

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

Пример: true

enable_table

boolean

Включить Table.

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

Пример: true

failover_policies

complex

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

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

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

добавлено в 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

добавлено в 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

добавлено в 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"