azure_rm_sqldatabase – Управление экземпляром SQL Database.
Новая версия с 2.5.
Обзор
- Создание, обновление и удаление экземпляра SQL Database.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| adfs_authority_url - добавлен в 2.6 | По умолчанию: null | URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS. |
| api_profile - добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source - добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию будет auto если переменная не определена.auto будет следовать стандартному порядку приоритетов параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. |
| cert_validation_mode - добавлен в 2.5 |
| Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или подключении к Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задан в профиле файла учетных данных или переменной среды AZURE_CERT_VALIDATION. |
| client_id - | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| cloud_environment - добавлен в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан в профиле файла учетных данных или переменной среды AZURE_CLOUD_ENVIRONMENT. |
| collation - | Кодировка базы данных. Если create_mode не default, это значение игнорируется. | |
| create_mode - |
| Указывает режим создания базы данных. 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. |
| edition - |
| Версия базы данных. Перечисление DatabaseEditions содержит все допустимые версии. Если create_mode non_readable_secondary или online_secondary, это значение игнорируется. Для просмотра возможных значений запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities), на который ссылается operationId: 'Capabilities_ListByLocation.' |
| elastic_pool_name - | Имя эластичного пула, в котором находится база данных. Не поддерживается для версии data_warehouse. | |
| force_update boolean |
| База данных SQL будет обновлена, если заданные параметры отличаются от состояния существующего ресурса. Для принудительного обновления базы данных SQL в любых обстоятельствах установите этот параметр в True. |
| location - | Расположение ресурса. Если не установлено, расположение из группы ресурсов будет использоваться как default. | |
| max_size_bytes - | Максимальный размер базы данных в байтах. Если create_mode не default, это значение игнорируется. Для просмотра возможных значений запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) по operationId: 'Capabilities_ListByLocation.' | |
| name - / обязательно | Имя базы данных, над которой будет выполняться операция (обновление или создание). | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| profile - | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| read_scale boolean |
| Если база данных является гео-вторичной, указывает, разрешены ли только чтение подключения к этой базе данных. Не поддерживается для версии data_warehouse. |
| recovery_services_recovery_point_resource_id - | Требуется, если create_mode restore_long_term_retention_backup, тогда это значение требуется. Указывает идентификатор ресурса точки восстановления для восстановления. | |
| resource_group - / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | |
| restore_point_in_time - | Требуется, если create_mode point_in_time_restore, это значение обязательно. Если create_mode restore, это значение необязательно. Указывает момент времени (формат ISO8601) исходной базы данных, которая будет восстановлена для создания новой базы данных. Должно быть больше или равно значению earliestRestoreDate исходной базы данных. | |
| sample_name - |
| Указывает имя образца схемы, которое нужно применить при создании этой базы данных. Если create_mode не default, это значение игнорируется. Не поддерживается для версии data_warehouse. |
| secret - | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| server_name - / обязательно | Имя сервера. |
| Дата удаления исходной базы данных - | Требуется, если create_mode равен restore и source_database_id — это исходный идентификатор ресурса удаленной базы данных (в отличие от текущего идентификатора восстанавливаемой базы данных), тогда это значение обязательно. Указывает время удаления базы данных. | |
| Идентификатор исходной базы данных - | Требуется, за исключением случаев, когда create_mode равен default или restore_long_term_retention_backup. Указывает идентификатор ресурса исходной базы данных | |
| Состояние - |
| Указывает состояние базы данных SQL. Используйте 'присутствует' для создания или обновления базы данных SQL и 'отсутствует' для ее удаления. |
| Идентификатор подписки - | Ваш идентификатор подписки Azure. | |
| Бренда - | Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы. | |
| zone_redundant boolean |
| Является ли эта база данных зонально избыточной? Это означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью принципала службы или пользователя Active Directory. Для аутентификации через принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы данные учетных данных могут быть сохранены в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.
Примеры
- name: Create (or update) SQL Database
azure_rm_sqldatabase:
resource_group: sqlcrudtest-4799
server_name: sqlcrudtest-5961
name: testdb
location: eastus
- name: Restore SQL Database
azure_rm_sqldatabase:
resource_group: sqlcrudtest-4799
server_name: sqlcrudtest-5961
name: restoreddb
location: eastus
create_mode: restore
restorable_dropped_database_id: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/s
ervers/testsvr/restorableDroppedDatabases/testdb2,131444841315030000"
- name: Create SQL Database in Copy Mode
azure_rm_sqldatabase:
resource_group: sqlcrudtest-4799
server_name: sqlcrudtest-5961
name: copydb
location: eastus
create_mode: copy
source_database_id: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/tests
vr/databases/testdb"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| идентификатор_базы_данных строка | всегда | Идентификатор базы данных. Пример: идентификатор_базы_данных |
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb |
| статус строка | всегда | Состояние базы данных. Пример: Онлайн |
Состояние
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- Zim Kalinowski (@zikalino)
Подсказка
Если вы заметите какие-либо проблемы в данном документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_sqldatabase_module.html
