Модуль azure.azcollection.azure_rm_sqldatabase – Управление экземпляром базы данных SQL

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"

collation

string

Сортировка базы данных. Если не create_mode=default, это значение игнорируется.

create_mode

string

Указывает режим создания базы данных.

default, обычное создание базы данных.

copy, создает базу данных как копию существующей базы данных.

online_secondary/non_readable_secondary, создает базу данных как (читаемую или нечитаемую) вторичную реплику существующей базы данных.

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

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

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

restore_long_term_retention_backup, Создает базу данных путем восстановления из хранилища долгосрочного хранения.

copy, non_readable_secondary, online_secondary и restore_long_term_retention_backup не поддерживаются для издания data_warehouse.

Choices:

• "copy"
• "default"
• "non_readable_secondary"
• "online_secondary"
• "point_in_time_restore"
• "recovery"
• "restore"
• "restore_long_term_retention_backup"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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

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

Choices:

• false ← (default)
• true

edition

string

(Устаревший)Издание базы данных. Перечисление DatabaseEditions содержит все допустимые издания.

Этот параметр будет устаревшим в версии 2.11, используйте sku вместо него.

Нельзя задать sku при установке этого поля.

Варианты:

• "web"
• "business"
• "basic"
• "standard"
• "premium"
• "free"
• "stretch"
• "data_warehouse"
• "system"
• "system2"

elastic_pool_name

string

Имя гибкого пула, в котором находится база данных. Не поддерживается для edition=data_warehouse.

force_update

boolean

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

Чтобы принудительно обновить базу данных SQL в любых обстоятельствах, установите этот параметр в значение True.

Варианты:

• false
• true

location

string

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

log_mode

string

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

log_path

string

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

max_size_bytes

string

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

Если create_mode не равно default, это значение игнорируется.

Возможные значения можно получить, обратившись к API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities). Ссылка по идентификатору операции:’Capabilities_ListByLocation’.

name

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

Имя базы данных, над которой будет выполняться операция (обновление или создание).

password

string

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

profile

string

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

read_scale

boolean

Если база данных является гео-вторичной, указывает, разрешены ли чтениые соединения с этой базой данных или нет.

Не поддерживается для edition=data_warehouse.

Варианты:

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

recovery_services_recovery_point_resource_id

string

Требуется, если create_mode=restore_long_term_retention_backup, тогда это значение обязательно.

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

resource_group

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

Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.

restore_point_in_time

string

Требуется, если create_mode=point_in_time_restore, это значение обязательно. Если create_mode=restore, это значение необязательно.

Указывает момент времени (в формате ISO8601) исходной базы данных, которая будет восстановлена для создания новой базы данных.

Должно быть больше или равно значению earliestRestoreDate исходной базы данных.

sample_name

string

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

Если create_mode не равно default, это значение игнорируется.

Не поддерживается для edition=data_warehouse.

Варианты:

• "adventure_works_lt"

secret

string

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

server_name

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

Имя сервера.

sku

dictionary

Sku базы данных. Перечисление DatabaseEditions содержит все допустимые sku.

Если create_mode равно non_readable_secondary или create_mode=online_secondary, это значение игнорируется.

Возможные значения можно получить, обратившись к API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities), ссылка по идентификатору операции:’Capabilities_ListByLocation’.

Нельзя установить edition при установке этого поля.

capacity

integer

Ёмкость конкретного SKU.

family

string

Если у службы есть разные поколения оборудования для одного SKU, это можно использовать здесь.

имя

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

Имя SKU базы данных, обычно код из буквы + цифры, например P3

размер

строка

Размер конкретного SKU

уровень

строка

Уровень или издание конкретного SKU, например Basic, Premium

source_database_deletion_date

строка

Требуется, если create_mode=restore и source_database_id — это исходный идентификатор ресурса удаленной базы данных, когда она существовала (в отличие от ее текущего идентификатора восстановленной удаленной базы данных), тогда это значение требуется. Указывает время удаления базы данных.

source_database_id

строка

Необязательно, если create_mode=default или create_mode=restore_long_term_retention_backup.

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

состояние

строка

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

Варианты:

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

идентификатор_подписки

строка

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

метки

словарь

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

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

Для удаления меток установите параметр append_tags в false.

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

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

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

арендатор

строка

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

отпечаток

строка

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

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

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

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

x509_certificate_path

путь

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

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

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

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

zone_redundant

логический

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

Варианты:

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