azure_rm_storageaccount - Управление учетными записями Azure Storage.
Новая версия 2.1.
Описание
- Создание, обновление или удаление учетной записи хранилища.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| access_tier (добавлен в 2.4) |
| Уровень доступа для этой учетной записи хранилища. Требуется для учетной записи хранилища типа 'BlobStorage'. |
| account_type |
| Тип учетной записи хранилища. Требуется при создании учетной записи хранилища. ПРИМЕЧАНИЕ: учетные записи Standard_ZRS и Premium_LRS не могут быть изменены на другие типы, а другие типы не могут быть изменены на Standard_ZRS или Premium_LRS. псевдонимы: type |
| 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. |
| append_tags bool |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При канонических значениях любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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. |
| custom_domain | Пользовательский домен, назначенный учетной записи хранилища. Должен быть словарем с ключами 'name' и 'use_sub_domain', где 'name' — исходник CNAME. В настоящее время поддерживается только один пользовательский домен на одну учетную запись хранилища. Для очистки существующего пользовательского домена используйте пустую строку для свойства имени пользовательского домена. Может быть добавлен к существующей учетной записи хранилища. Будет проигнорирован при создании учетной записи хранилища. | |
| force bool (добавлен в 2.6) |
| Попытаться удалить, если ресурс уже существует и не может быть обновлён |
| kind (добавлен в 2.2) |
| Тип хранилища. |
| location | Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. | |
| name | Имя учетной записи хранилища для обновления или создания. | |
| password | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group обязательно | Имя группы ресурсов для использования. псевдонимы: resource_group_name | |
| secret | Секрет клиента Azure. Используйте при аутентификации с помощью служебного принципала. | |
| state |
| Утверждение состояния учетной записи хранилища. Используйте 'present' для создания или обновления учетной записи хранилища и 'absent' для удаления учетной записи. |
| subscription_id | Идентификатор вашей подписки Azure. | |
| tags | Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |
| tenant | Идентификатор клиента Azure. Используйте при аутентификации с помощью служебного принципала. |
Примечания
Примечание
- Для аутентификации с 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: 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 dict | всегда | Текущее состояние учетной записи хранилища. Пример: {'account_type': 'Standard_RAGRS', 'custom_domain': None, 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/testing/providers/Microsoft.Storage/storageAccounts/clh0003', 'location': 'eastus2', 'name': 'clh0003', 'primary_endpoints': {'blob': 'https://clh0003.blob.core.windows.net/', 'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/'}, 'primary_location': 'eastus2', 'provisioning_state': 'Succeeded', 'resource_group': 'Testing', 'secondary_endpoints': {'blob': 'https://clh0003-secondary.blob.core.windows.net/', 'queue': 'https://clh0003-secondary.queue.core.windows.net/', 'table': 'https://clh0003-secondary.table.core.windows.net/'}, 'secondary_location': 'centralus', 'status_of_primary': 'Доступно', 'status_of_secondary': 'Доступно', 'tags': None, 'type': 'Microsoft.Storage/storageAccounts'} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сертифицированный, что означает, что он поддерживается партнёром Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых партнёрами Ansible, см. здесь.
Автор
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 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_storageaccount_module.html
