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		URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в 2.5	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое	Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Когда каноническое, любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: авто 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	Варианты: блочный ← страничный	Тип объекта 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 -		Путь к целевому файлу. Используйте со state `present` для загрузки blob. псевдонимы: destination
force логическое	Варианты: нет ← да	Перезаписать существующий blob или файл при загрузке или скачивании. Принудительно удалить контейнер, содержащий blob.
password -		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile строка		Профиль безопасности в файле ~/.azure/credentials.
public_access -	Варианты: контейнер blob	Определите уровень публичного доступа к контейнеру. По умолчанию контейнеры являются закрытыми. Может быть установлен только при создании контейнера.
resource_group - / обязательно		Имя группы ресурсов, которую следует использовать. псевдонимы: resource_group_name
secret строка		Секретный ключ Azure-клиента. Используйте при аутентификации с сервисным принципалом.
src -		Путь к исходному файлу. Используйте со state `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, или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с помощью сервисного принципала или пользователя 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 в среде.

См. также

Вход с помощью Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Remove container foo
  azure_rm_storageblob:
    resource_group: myResourceGroup
    storage_account_name: clh0002
    container: foo
    state: absent

- name: Create container foo and upload a file
  azure_rm_storageblob:
    resource_group: myResourceGroup
    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: myResourceGroup
    storage_account_name: clh0002
    container: foo
    blob: graylog.png
    dest: ~/tmp/images/graylog.png

Значения возврата

Общие значения возврата документированы здесь, ниже приведены поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
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': {}}

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [бета-версия]
Данный модуль поддерживается сообществом Ansible. [community]

Авторы

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