azure.azcollection.azure_rm_sqldatabase – Управление экземпляром базы данных SQL
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_sqldatabase.
Новое в версии 0.1.2: из azure.azcollection
Описание
- Создание, обновление и удаление экземпляра базы данных SQL.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| adfs_authority_url строка добавлено в 0.0.1 из azure.azcollection | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. | ||
| api_profile строка добавлено в 0.0.1 из azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags логическое |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлено в 0.0.1 из azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды 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. | |
| cert_validation_mode строка добавлено в 0.0.1 из azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или взаимодействии с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. | ||
| cloud_environment строка добавлено в 0.0.1 из azure.azcollection | По умолчанию: "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 содержит все допустимые издания. Этот параметр будет устаревшим в версии 2.11, используйте sku вместо него. Нельзя задать sku при установке этого поля. | |
| 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 строка / обязательно | Имя сервера. | ||
| sku строка | SKU базы данных. Перечисление DatabaseEditions содержит все допустимые SKU. Если create_mode=non_readable_secondary или create_mode=online_secondary, это значение игнорируется. Чтобы увидеть возможные значения, запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) относится к operationId:'Capabilities_ListByLocation'. Нельзя задать edition при установке этого поля. | ||
| capacity строка | Ёмкость данного SKU. | ||
| family строка | Если услуга имеет разные поколения аппаратного обеспечения для одного и того же SKU, то это можно использовать здесь. | ||
| name строка / обязательно | Имя SKU базы данных, как правило, буквенно-цифровой код, например P3. | ||
| size строка | Размер данного SKU. | ||
| tier string | Уровень или издание конкретного SKU, например, Basic, Premium | ||
| source_database_deletion_date string | Требуется, если create_mode=restore и source_database_id — это исходный идентификатор ресурса удаленной базы данных при её существовании (в отличие от текущего идентификатора восстанавливаемой удалённой базы данных), тогда это значение необходимо. Указывает время удаления базы данных. | ||
| source_database_id string | Требуется, если create_mode!=default и create_mode!=restore_long_term_retention_backup. Указывает идентификатор ресурса исходной базы данных. | ||
| state string |
| Установите состояние базы данных SQL. Используйте present для создания или обновления базы данных SQL и absent для её удаления. | |
| subscription_id string | Ваш идентификатор подписки Azure. | ||
| tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false. | ||
| tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью Служебного принципала. | ||
| zone_redundant boolean |
| Является ли эта база данных зонально избыточной? Это означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. | |
Примечания
Примечание
- Для аутентификации с 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"
- name: Create (or update) SQL Database with SKU
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: testdb
location: eastus
sku:
name: S0
Значения возврата
Общие значения возврата описаны здесь, следующие — это поля, уникальные для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| database_id string | всегда | Идентификатор базы данных. Пример: database_id |
| id string | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb |
| status string | всегда | Состояние базы данных. Пример: 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.10/collections/azure/azcollection/azure_rm_sqldatabase_module.html
