Модуль azure.azcollection.azure_rm_cosmosdbaccount – Управление экземпляром учетной записи Azure Database Account

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"

append_tags

boolean

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

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

• false
• true ← (default)

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.

Choices:

• "auto" ← (default)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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

Choices:

• "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"

consistency_policy

dictionary

Политика согласованности для учетной записи Cosmos DB.

default_consistency_level

string

Уровень согласованности по умолчанию и параметры конфигурации учетной записи Cosmos DB.

Требуется, когда state=present.

Choices:

• "eventual"
• "session"
• "bounded_staleness"
• "strong"
• "consistent_prefix"

max_interval_in_seconds

integer

При использовании с уровнем согласованности Bounded Staleness это значение представляет собой допустимое время устаревания (в секундах).

Допустимый диапазон для этого значения составляет 5 - 86400. Требуется, когда default_consistency_policy=bounded_staleness.

max_staleness_prefix

integer

При использовании с уровнем согласованности Bounded Staleness это значение представляет собой количество допустимых устаревших запросов.

Допустимый диапазон для этого значения составляет 1 - 2,147,483,647. Требуется, когда default_consistency_policy=bounded_staleness.

database_account_offer_type

string

Тип предложения учетной записи базы данных, например Standard

Требуется, когда state=present.

default_identity

string

Основная идентификация для доступа к хранилищу ключей в функциях, связанных с CMK. Например, «FirstPartyIdentity», «SystemAssignedIdentity» и другие. Управляемые пользователем идентификаторы указываются в формате «UserAssignedIdentity=<идентификатор ресурса управляемой пользователем идентификации>».

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

enable_automatic_failover

boolean

Включает автоматическое переключение на резервный регион записи в редких случаях, когда регион недоступен из-за сбоя.

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

Варианты:

• false
• true

enable_cassandra

boolean

Включить Cassandra.

Варианты:

• false
• true

enable_free_tier

boolean

added in azure.azcollection 1.10.0

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

Варианты:

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

enable_gremlin

boolean

Включить Gremlin.

Варианты:

• false
• true

enable_multiple_write_locations

boolean

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

Варианты:

• false
• true

enable_table

boolean

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

Варианты:

• false
• true

geo_rep_locations

list / elements=dictionary

Массив, содержащий расположения георепликации, включенные для учетной записи Cosmos DB.

Требуется, когда state=present.

failover_priority

integer / обязательно

Приоритет переключения на резервный регион. Приоритет переключения на резервный регион 0 указывает регион записи.

Максимальное значение приоритета переключения = (общее количество регионов - 1).

Значения приоритета переключения должны быть уникальными для каждого региона, в котором существует база данных.

name

string / обязательно

Название региона.

identity

dictionary

Идентификатор объекта

type

string

Тип управляемого идентификатора.

Варианты:

• "SystemAssigned"
• "UserAssigned"
• "SystemAssigned, UserAssigned"
• "None" ← (по умолчанию)

user_assigned_identities

dictionary

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

По умолчанию: {}

append

boolean

Если список идентификаторов должен быть добавлен к текущим идентификаторам (true) или заменить текущие идентификаторы (false).

Варианты:

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

id

list / elements=string

Список идентификаторов управляемых идентификаторов пользователя, связанных с объектом.

По умолчанию: []

ip_range_filter

string

(устарело) Поддержка брандмауэра Cosmos DB. Это значение определяет набор IP-адресов или диапазонов IP-адресов.

В формате CIDR для включения разрешенного списка клиентских IP-адресов для данной учетной записи базы данных.

IP-адреса/диапазоны должны быть разделены запятыми и не должны содержать пробелов.

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

ip_rules

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

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

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

is_virtual_network_filter_enabled

логическое

Флаг, указывающий, следует ли включить/выключить правила Virtual Network ACL.

Варианты:

• false
• true

kind

строка

Указывает тип учетной записи базы данных. Это можно установить только при создании учетной записи базы данных.

Варианты:

• "global_document_db"
• "mongo_db"
• "parse"

location

строка

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

Требуется, когда state=present.

log_mode

строка

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

log_path

строка

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

mongo_version

строка

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

Версия сервера для учетной записи MongoDB, например, c(3.2) или c(4.0).

Используется только при c(kind) = i(mongo_db).

name

строка / обязательно

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

password

строка

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

profile

строка

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

public_network_access

строка

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

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

Варианты:

• "Enabled" ← (по умолчанию)
• "Disabled"

resource_group

строка / обязательно

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

secret

строка

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

state

строка

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

Используйте present для создания или обновления учетной записи базы данных и absent для ее удаления.

Варианты:

• "absent"
• "present" ← (по умолчанию)

subscription_id

строка

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

tags

словарь

Словарь пар «строка:строка», назначаемый в качестве метаданных объекту.

Метаданные-теги объекта будут обновлены любыми предоставленными значениями.

Для удаления тегов установите опцию append_tags в значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.

tenant

строка

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

thumbprint

строка

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

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

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

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

virtual_network_rules

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

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

ignore_missing_v_net_service_endpoint

логическое

Создать учетную запись Cosmos DB без существующего виртуального сетевого конечной точки.

Варианты:

• false
• true

subnet

любой / обязательно

Может быть строкой, содержащей идентификатор ресурса подсети.

Может быть словарем, содержащим «resource_group», «virtual_network_name» и «subnet_name»

x509_certificate_path

path

added in azure.azcollection 1.14.0

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

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

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