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 bool |
| База данных 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 bool |
| Если база данных является гео-вторичной, указывает, разрешены ли чтение-только соединения с этой базой данных. Не поддерживается для версии 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 обязательно | Имя сервера. | |
| source_database_deletion_date | Требуется, если create_mode restore и source_database_id — оригинальный идентификатор ресурса удалённой базы данных при её существовании (в отличие от текущего идентификатора удалённой восстанавливаемой базы данных), то это значение требуется. Указывает время удаления базы данных. | |
| source_database_id | Требуется, за исключением случаев, когда create_mode default или restore_long_term_retention_backup.Указывает идентификатор ресурса исходной базы данных. | |
| state |
| Утверждает состояние базы данных SQL. Используйте 'present' для создания или обновления базы данных SQL и 'absent' для её удаления. |
| subscription_id | Ваш идентификатор подписки Azure. | |
| tenant | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. | |
| zone_redundant bool |
| Является ли эта база данных зонально-избыточной? Это означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. |
Примечания
Примечание
- Для аутентификации в 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 |
Статус
Этот модуль помечен как предварительная версия, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_sqldatabase_module.html
