azure_rm_storageblob - Управление контейнерами и объектами blob.
Новое в версии 2.1.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Создание, обновление и удаление контейнеров и объектов blob. Используется для загрузки файла и сохранения его в качестве объекта blob, или для загрузки объекта blob в файл.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязателен | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | ||
| append_tags | нет | True | Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. | |
| blob | нет | Имя объекта blob внутри контейнера. алиасы: blob_name | ||
| cache_control | нет | Устанавливает заголовок кэширования blob. | ||
| client_id | нет | Идентификатор Azure клиента. Используется при аутентификации с сервисным принципалом. | ||
| cloud_environment | нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| container | да | Имя контейнера blob в хранилище. алиасы: container_name | ||
| content_disposition | нет | Устанавливает заголовок content-disposition blob. | ||
| content_encoding | нет | Устанавливает заголовок кодирования blob. | ||
| content_language | нет | Устанавливает заголовок языка содержимого blob. | ||
| content_md5 | нет | Устанавливает значение хеша md5 blob. | ||
| content_type | нет | Устанавливает заголовок типа содержимого blob. Например, 'image/png'. | ||
| dest | нет | Путь к целевому файлу. Используется со значением 'present' для загрузки blob. алиасы: destination | ||
| force | нет | Перезаписать существующий blob или файл при загрузке или скачивании. Принудительно удалить контейнер, содержащий blobs. | ||
| password | нет | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | ||
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| public_access | нет |
| Определяет уровень публичного доступа к контейнеру. По умолчанию контейнеры являются приватными. Может быть установлен только при создании контейнера. | |
| resource_group | да | Имя группы ресурсов для использования. алиасы: resource_group_name | ||
| secret | нет | Секрет Azure клиента. Используется при аутентификации с сервисным принципалом. | ||
| src | нет | Путь к исходному файлу. Используется со значением 'present' для загрузки blob. алиасы: source | ||
| state | нет | present |
| Утвердить состояние контейнера или blob. Используйте значение 'absent' только для контейнера, чтобы удалить контейнер. Включите значение blob, чтобы удалить определенный blob. Контейнер не будет удален, если он содержит blobs. Используйте параметр force, чтобы переопределить, удалив контейнер и все связанные blobs. Используйте значение 'present' для создания или обновления контейнера и загрузки или загрузки blob. Если контейнер не существует, он будет создан. Если он существует, он будет обновлен с параметрами конфигурации. Укажите имя blob и либо src, либо dest для загрузки или загрузки. Укажите путь src для загрузки и путь dest для загрузки. Если blob (загрузка) или файл (скачивание) уже существуют, они не будут перезаписаны, если параметр force не равен true. |
| storage_account_name | да | Имя хранилища для использования. алиасы: account_name, storage_account | ||
| subscription_id | нет | Ваш идентификатор подписки Azure. | ||
| tags | нет | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | ||
| tenant | нет | Идентификатор Azure tenant. Используется при аутентификации с сервисным принципалом. |
Примеры
- name: Remove container foo
azure_rm_storageblob:
resource_group: testing
storage_account_name: clh0002
container: foo
state: absent
- name: Create container foo and upload a file
azure_rm_storageblob:
resource_group: Testing
storage_account_name: clh0002
container: foo
blob: graylog.png
src: ./files/graylog.png
public_access: container
content_type: 'application/image'
- name: Download the file
azure_rm_storageblob:
resource_group: Testing
storage_account_name: clh0002
container: foo
blob: graylog.png
dest: ~/tmp/images/graylog.png
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| blob | Факты о текущем состоянии blob. | при работе с blob | dict | {'content_length': 136532, 'last_modified': '09-Mar-2016 22:08:25 +0000', 'name': 'graylog.png', 'tags': {}, 'content_settings': {'content_language': None, 'content_encoding': None, 'content_type': 'application/image', 'content_md5': None, 'content_disposition': None, 'cache_control': None}, 'type': 'BlockBlob'} |
| container | Факты о текущем состоянии выбранного контейнера. | всегда | dict | {'last_mdoified': '09-Mar-2016 19:28:26 +0000', 'name': 'foo', 'tags': {}} |
Примечания
Примечание
- Для аутентификации с 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_storageblob_module.html