azure_rm_storageblob - Управление контейнерами и объектами blob.
Новая версия с 2.1.
Описание
- Создание, обновление и удаление контейнеров и объектов blob. Используется для загрузки файла и сохранения его как объекта blob, или загрузки объекта blob в файл.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят работать с Azure Stack. |
| append_tags | Значение по умолчанию: yes | Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| auth_source (добавлен в 2.5) |
| Определяет источник используемых учетных данных для аутентификации. auto будет следовать умолчанию по приоритету параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно установить через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. |
| blob | Значение по умолчанию: None | Имя объекта blob в контейнере. псевдонимы: blob_name |
| blob_type (добавлен в 2.5) |
| Тип объекта Blob. |
| cache_control | Значение по умолчанию: None | Устанавливает заголовок кеширования blob. |
| cert_validation_mode (добавлен в 2.5) |
None | Контролирует поведение проверки сертификата для Azure-эндпоинтов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Можно также установить через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом. |
| cloud_environment (добавлен в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (определенное Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (необходимый для Azure Stack). Можно также установить через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| container обязательно | Имя контейнера blob в учетной записи хранения. псевдонимы: container_name | |
| content_disposition | Значение по умолчанию: None | Устанавливает заголовок расположения содержимого blob. |
| content_encoding | Значение по умолчанию: None | Устанавливает заголовок кодирования содержимого blob. |
| content_language | Значение по умолчанию: None | Устанавливает заголовок языка содержимого blob. |
| content_md5 | Значение по умолчанию: None | Устанавливает значение хэша md5 blob. |
| content_type | Значение по умолчанию: None | Устанавливает заголовок типа содержимого blob. Например, 'image/png'. |
| dest | Значение по умолчанию: None | Путь к целевому файлу. Используется при состоянии 'present' для загрузки blob. псевдонимы: destination |
| force | Значение по умолчанию: no | Перезаписывать существующий blob или файл при загрузке или загрузке. Принудительно удалять контейнер, содержащий blob. |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| public_access |
None | Определяет уровень публичного доступа к контейнеру. По умолчанию контейнеры приватны. Может быть установлен только при создании контейнера. |
| resource_group обязательно | Имя группы ресурсов для использования. псевдонимы: resource_group_name | |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с сервисным принципалом. |
| src | Значение по умолчанию: None | Путь к исходному файлу. Используется при состоянии 'present' для загрузки blob. псевдонимы: source |
| state |
| Утверждение состояния контейнера или blob. Используйте state 'absent' только с контейнером, чтобы удалить контейнер. Включите значение blob, чтобы удалить конкретный blob. Контейнер не будет удален, если он содержит blob. Используйте параметр force для переопределения, удаляя контейнер и все связанные blob. Используйте state 'present' для создания или обновления контейнера и загрузки или загрузки blob. Если контейнер не существует, он будет создан. Если он существует, он будет обновлен с конфигурационными параметрами. Укажите имя blob и либо src, либо dest для загрузки или загрузки. Укажите путь src для загрузки и путь dest для загрузки. Если blob (загрузка) или файл (загрузка) уже существуют, они не будут перезаписаны, если параметр force не является истинным. |
| storage_account_name обязательно | Имя учетной записи хранения для использования. псевдонимы: account_name, storage_account | |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | Значение по умолчанию: None | Словарь пар строка:строка, которые нужно назначить как метаданные объекту. Метаданные тегов объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в false. |
| tenant | Значение по умолчанию: None | Идентификатор 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 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 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': {}} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/azure_rm_storageblob_module.html
