azure_rm_storageblob — Управление контейнерами и объектами blob.
Новое в версии 2.1.
Описание
- Создание, обновление и удаление контейнеров и объектов blob. Используется для загрузки файла и сохранения его как объекта blob, или загрузки объекта blob в файл.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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. |
| blob | Имя объекта blob в контейнере. псевдонимы: blob_name | |
| blob_type (добавлено в 2.5) |
| Тип объекта Blob. |
| cache_control | Устанавливает заголовок кэша blob. | |
| 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. |
| 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 bool |
| Перезаписывать существующий blob или файл при загрузке или выгрузке. Принудительно удалять контейнер, содержащий blob. |
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| public_access |
| Определяет уровень открытого доступа к контейнеру. По умолчанию контейнеры приватные. Может быть установлен только во время создания контейнера. |
| resource_group обязательно | Имя группы ресурсов для использования. псевдонимы: resource_group_name | |
| secret | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |
| src | Путь к исходному файлу. Используется со значением состояния 'present' для загрузки blob. псевдонимы: source | |
| state |
| Утверждение состояния контейнера или blob. Используйте состояние 'absent' только с контейнером, чтобы удалить контейнер. Включите значение blob, чтобы удалить определенный blob. Контейнер не будет удален, если он содержит blob. Используйте параметр force для переопределения, удаляя контейнер и все связанные blob. Используйте состояние '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-арендатора. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с 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, 'content_settings': {'cache_control': None, 'content_disposition': None, 'content_encoding': None, 'content_language': None, 'content_md5': None, 'content_type': 'application/image'}, 'last_modified': '09-Mar-2016 22:08:25 +0000', 'name': 'graylog.png', 'tags': {}, 'type': 'BlockBlob'} |
| container dict | всегда | Информация о текущем состоянии выбранного контейнера. Пример: {'last_mdoified': '09-Mar-2016 19:28:26 +0000', 'name': 'foo', 'tags': {}} |
Статус
Этот модуль помечен как превью, что означает, что совместимость с предыдущими версиями не гарантируется.
Техническое обслуживание
Этот модуль помечен как сертифицированный, что означает, что он поддерживается партнёром 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_storageblob_module.html
