azure_rm_sqldatabase - Управление экземпляром SQL Database.
Новое в версии 2.5.
Обзор
- Создание, обновление и удаление экземпляра SQL Database.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | По умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменных окружения -> профилю по умолчанию в файле учетных данных ~/.azure/credentials.При установке значения cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id | По умолчанию: None | Идентификатор клиента 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 |
| SQL Database будет обновлен, если заданные параметры отличаются от текущего состояния ресурса. Чтобы принудительно обновить SQL Database в любом случае, установите этот параметр в значение True. |
| location | Расположение ресурса. Если не задано, расположение из группы ресурсов будет использовано как default. | |
| max_size_bytes | Максимальный размер базы данных в байтах. Если create_mode не default, это значение игнорируется. Чтобы увидеть возможные значения, запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) по operationId: 'Capabilities_ListByLocation.' | |
| name обязательно | Имя базы данных, с которой будет выполняться операция (обновление или создание). | |
| password | По умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. |
| profile | По умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| read_scale |
| Если база данных является гео-вторичной, указывает, разрешены ли только что читаемые подключения к этой базе данных или нет. Не поддерживается для версии 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 | По умолчанию: None | Секретный ключ клиента Azure. Используется при аутентификации с сервисным принципалом. |
| server_name обязательно | Имя сервера. | |
| source_database_deletion_date | Требуется, если create_mode равен restore и source_database_id является исходным идентификатором ресурса удаленной базы данных при её существовании (в отличие от текущего идентификатора отмененной базы данных для восстановления), тогда это значение обязательно. Указывает время удаления базы данных. | |
| source_database_id | Требуется, за исключением случаев, когда create_mode равен default или restore_long_term_retention_backup.Указывает идентификатор ресурса исходной базы данных | |
| state |
| Утверждает состояние SQL Database. Используйте 'present' для создания или обновления SQL Database и 'absent' для её удаления. |
| subscription_id | По умолчанию: None | Ваш идентификатор подписки Azure. |
| tenant | По умолчанию: None | Идентификатор арендатора Azure. Используется при аутентификации с сервисным принципалом. |
| zone_redundant |
| Является ли эта база данных зонально-избыточной? Это означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. |
Примечания
Примечание
- Для аутентификации с 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"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| database_id str | всегда | Идентификатор базы данных. Пример: database_id |
| id str | всегда | Идентификатор ресурса. Пример: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb |
| status str | всегда | Статус базы данных. Пример: Online |
Статус
Данный модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/azure_rm_sqldatabase_module.html
