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 | URL-адрес источника Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственном источнике ADFS. | |
| api_profile строка добавлено в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags логический тип |
| Управляет тем, будет ли поле тегов каноническим или просто добавляться к существующим тегам. В каноническом режиме любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| 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 или create_mode=online_secondary, это значение игнорируется. Чтобы увидеть возможные значения, запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities), на который ссылается операция:'Capabilities_ListByLocation'. |
| elastic_pool_name - | Имя эластичного пула, в котором находится база данных. Не поддерживается для edition=data_warehouse. | |
| force_update логический тип |
| База данных SQL будет обновлена, если заданные параметры отличаются от текущего состояния ресурса. Для принудительного обновления базы данных SQL в любых обстоятельствах установите этот параметр в значение True. |
| location - | Расположение ресурса. Если не задано, расположение из группы ресурсов будет использоваться по умолчанию. | |
| 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 логический тип |
| Если база данных является вторичной, указывает, разрешены ли только чтение подключения к этой базе данных. Не поддерживается для edition=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, это значение игнорируется. Не поддерживается для edition=data_warehouse. |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с главным принципом службы. |
| server_name - / обязательно | Имя сервера. | |
| source_database_deletion_date - | Требуется, если create_mode=restore и source_database_id — это оригинальный идентификатор ресурса удалённой базы данных при её существовании (в отличие от текущего идентификатора базы данных, которая была удалена и подлежит восстановлению), тогда это значение обязательно. Указывает время удаления базы данных. | |
| source_database_id - | Требуется, если не create_mode=default или create_mode=restore_long_term_retention_backup. Указывает идентификатор ресурса исходной базы данных. | |
| state - |
| Утвердить состояние базы данных SQL. Используйте present для создания или обновления базы данных SQL и absent для её удаления. |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags словарь | Словарь пар «строка:строка» для назначения тегов в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. | |
| tenant строка | Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала. | |
| zone_redundant логическое |
| Является ли эта база данных зонально-избыточной? Это означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. |
Примечания
Примечание
- Для аутентификации в Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или выполнить вход перед запуском задач или книги команд с помощью
az login. - Аутентификация также возможна с помощью службы-принципала или пользователя 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 в среде.
См. также
См. также
- Вход в Azure CLI
- Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Create (or update) SQL Database
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: testdb
location: eastus
- name: Restore SQL Database
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: restoreddb
location: eastus
create_mode: restore
restorable_dropped_database_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/s
ervers/testsvr/restorableDroppedDatabases/testdb2,131444841315030000"
- name: Create SQL Database in Copy Mode
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: copydb
location: eastus
create_mode: copy
source_database_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/tests
vr/databases/testdb"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| database_id строка | всегда | Идентификатор базы данных. Пример: database_id |
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb |
| status строка | всегда | Статус базы данных. Пример: Online |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/azure_rm_sqldatabase_module.html
