Модуль azure.azcollection.azure_rm_cosmosdbaccount — управление экземпляром учетной записи базы данных Azure

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"

append_tags

boolean

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

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

Варианты:

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

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; в противном случае будет использоваться подписка Azure 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"

consistency_policy

dictionary

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

default_consistency_level

string

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

Обязательно, если state=present.

Варианты:

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

max_interval_in_seconds

integer

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

Допустимый диапазон значений: 5–86400. Обязательно, если default_consistency_policy=bounded_staleness.

max_staleness_prefix

integer

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

Допустимый диапазон значений: 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=<resource ID of the user-assigned identity>’.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

enable_gremlin

boolean

Включить Gremlin.

Варианты:

• false
• true

enable_multiple_write_locations

boolean

Разрешает учетной записи выполнять запись в нескольких расположениях.

Варианты:

• false
• true

enable_table

boolean

Включить Table.

Варианты:

• 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

list / elements=string

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

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

is_virtual_network_filter_enabled

boolean

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

Варианты:

• false
• true

kind

string

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

Варианты:

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

location

string

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

Обязательно, если state=present.

log_mode

string

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

log_path

string

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

mongo_version

string

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

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

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

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.

public_network_access

string

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

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

Варианты:

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

resource_group

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

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

secret

string

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

state

string

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

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

Варианты:

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

subscription_id

string

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

tags

dictionary

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

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

Чтобы удалить теги, установите для параметра append_tags значение false.

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

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

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

tenant

string

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

thumbprint

string

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

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

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

Обязательный параметр, если задан x509_certificate_path.

virtual_network_rules

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

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

ignore_missing_v_net_service_endpoint

boolean

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

Варианты:

• false
• true

subnet

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

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

Это может быть словарь, содержащий ‘resource_group’, ‘virtual_network_name’ и ‘subnet_name’

x509_certificate_path

path

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

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

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

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

id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/myData baseAccount"