azure_rm_storageaccount - Управление учетными записями Azure Storage.
Новая в версии 2.1.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создание, обновление или удаление учетной записи хранилища.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязателен | по умолчанию | выбор | примечания |
|---|---|---|---|---|
| access_tier (добавлен в 2.4)
| нет | Storage |
| Уровень доступа для этой учетной записи хранилища. Требуется для учетной записи хранилища типа 'BlobStorage'. |
| account_type | нет |
| Тип учетной записи хранилища. Требуется при создании учетной записи хранилища. ПРИМЕЧАНИЕ: учетные записи Standard_ZRS и Premium_LRS не могут быть изменены на другие типы учетных записей, и другие типы учетных записей не могут быть изменены на Standard_ZRS или Premium_LRS. псевдонимы: type | |
| ad_user | нет | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| append_tags | нет | True | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре tags, будут удалены из метаданных объекта. | |
| client_id | нет | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. | ||
| cloud_environment | нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| custom_domain | нет | Домен пользователя, назначенный учетной записи хранилища. Должен быть словарем с ключами 'name' и 'use_sub_domain', где 'name' — источник CNAME. В настоящее время поддерживается только один пользовательский домен на одну учетную запись хранилища. Для удаления существующего пользовательского домена используйте пустую строку для свойства имени пользовательского домена. Может быть добавлен к существующей учетной записи хранилища. Будет проигнорирован при создании учетной записи хранилища. | ||
| kind (добавлен в 2.2)
| нет | Storage |
| Тип хранилища. |
| location | нет | местоположение группы ресурсов | Допустимое расположение azure. По умолчанию используется расположение группы ресурсов. | |
| name | нет | Имя учетной записи хранилища для обновления или создания. | ||
| password | нет | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group | да | Имя группы ресурсов для использования. псевдонимы: resource_group_name | ||
| secret | нет | Секрет клиента Azure. Используйте при аутентификации с принципалом службы. | ||
| state | нет | present |
| Утверждение состояния учетной записи хранилища. Используйте 'present' для создания или обновления учетной записи хранилища и 'absent' для удаления учетной записи. |
| subscription_id | нет | Ваш идентификатор подписки Azure. | ||
| tags | нет | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | ||
| tenant | нет | Идентификатор арендатора Azure. Используйте при аутентификации с принципалом службы. |
Примеры
- name: remove account, if it exists
azure_rm_storageaccount:
resource_group: Testing
name: clh0002
state: absent
- name: create an account
azure_rm_storageaccount:
resource_group: Testing
name: clh0002
type: Standard_RAGRS
tags:
- testing: testing
- delete: on-exit
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| state | Текущее состояние учетной записи хранилища. | всегда | словарь | {'secondary_location': 'centralus', 'account_type': 'Standard_RAGRS', 'custom_domain': None, 'resource_group': 'Testing', 'tags': None, 'primary_location': 'eastus2', 'secondary_endpoints': {'queue': 'https://clh0003-secondary.queue.core.windows.net/', 'table': 'https://clh0003-secondary.table.core.windows.net/', 'blob': 'https://clh0003-secondary.blob.core.windows.net/'}, 'provisioning_state': 'Succeeded', 'primary_endpoints': {'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/', 'blob': 'https://clh0003.blob.core.windows.net/'}, 'location': 'eastus2', 'status_of_primary': 'Available', 'status_of_secondary': 'Available', 'type': 'Microsoft.Storage/storageAccounts', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/testing/providers/Microsoft.Storage/storageAccounts/clh0003', 'name': 'clh0003'} |
Примечания
Примечание
- Для аутентификации в 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 в среде.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для помощи в разработке модулей, если вам это интересно, пожалуйста, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_storageaccount_module.html