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 boolean	Варианты: no да ←	Используйте для управления тем, является ли поле тегов стандартным или просто добавляется к существующим тегам. При использовании стандартного значения любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source - добавлен в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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	Варианты: block ← page	Тип объекта Blob.
cache_control -		Установите заголовок кэша blob.
cert_validation_mode - добавлен в 2.5	Варианты: validate ignore	Управляет поведением проверки сертификатов для 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 -		Путь к файлу назначения. Используйте со state 'present' для загрузки blob. алиасы: destination
force boolean	Варианты: нет ← да	Перезаписывать существующий blob или файл при загрузке или скачивании. Принудительно удалять контейнер, содержащий blob.
password -		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным сервисом.
profile -		Профиль безопасности, найденный в файле ~/.azure/credentials.
public_access -	Варианты: container blob	Определение уровня общедоступного доступа к контейнеру. По умолчанию контейнеры закрыты. Может быть задано только при создании контейнера.
resource_group - / обязательно		Имя используемой группы ресурсов. алиасы: resource_group_name
secret -		Секрет клиента Azure. Используйте при аутентификации с главным сервисом.
src -		Путь к исходному файлу. Используйте со state 'present' для загрузки blob. алиасы: source
state -	Варианты: absent present ←	Утвердить состояние контейнера или 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 -		Ваш идентификатор подписки 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 словарь	при работе с объектом blob	Информация о текущем состоянии объекта blob. Пример: {'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 словарь	всегда	Информация о текущем состоянии выбранного контейнера. Пример: {'last_mdoified': '09-Mar-2016 19:28:26 +0000', 'name': 'foo', 'tags': {}}

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается партнером Ansible. [certified]

Авторы

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.7/modules/azure_rm_storageblob_module.html