azure.azcollection.azure_rm_storageblob – Управление контейнерами и объектами blob

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_storageblob.

Новое в версии 0.0.1: из azure.azcollection

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление и удаление контейнеров и объектов blob.
Используется для загрузки файла и сохранения его как объекта blob или скачивания объекта blob в файл (режимы загрузки и скачивания).
Используется для загрузки пакета файлов из заданного каталога (режим пакетной загрузки).
В режиме пакетной загрузки существующий объект blob будет перезаписан, если необходимо создать объект blob с тем же именем.
Модуль может работать исключительно в трех режимах: при установке batch_upload_src, он работает в режиме пакетной загрузки; при установке src, он работает в режиме загрузки, а при установке dst, он работает в режиме скачивания.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы.
adfs_authority_url строка добавлен в 0.0.1 модуля azure.azcollection		URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлен в 0.0.1 модуля azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево	Варианты: no yes ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 модуля azure.azcollection	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную окружения `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (значение по умолчанию) приоритет имеет: параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных окружения. При значении `credential_file`, профиль будет считываться из `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az cli. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
batch_upload_dst строка		Базовая директория в контейнере при пакетном загрузке файлов.
batch_upload_src строка		Директория источника пакетной загрузки. Используйте со состоянием `present` для загрузки пакета файлов в указанной директории.
blob строка		Имя объекта blob в контейнере. псевдонимы: blob_name
blob_type строка добавлен в 0.0.1 модуля azure.azcollection	Варианты: block ← page	Тип объекта blob.
cache_control строка		Установите заголовок кэша blob.
cert_validation_mode строка добавлен в 0.0.1 модуля azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-точек доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную окружения `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор Azure клиента. Используйте при аутентификации с главным принципом службы.
cloud_environment строка добавлен в 0.0.1 модуля azure.azcollection	По умолчанию: "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 булево	Варианты: no ← yes	Перезаписывать существующий blob или файл при загрузке или скачивании. Вынужденное удаление контейнера, содержащего blobs.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
public_access строка	Варианты: container blob	Уровень публичного доступа к контейнеру. По умолчанию контейнеры являются частными. Может быть установлен только при создании контейнера.
resource_group строка / обязательно		Имя группы ресурсов для использования. псевдонимы: resource_group_name
secret строка		Секрет Azure клиента. Используйте при аутентификации с главным принципом службы.
src строка		Путь к исходному файлу. Используйте со состоянием `present` для загрузки blob. псевдонимы: source
state строка	Варианты: absent 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. Используйте при аутентификации с главным принципом службы.

Примечания

Примечание

Для аутентификации в Azure можно передать параметры, установить переменные окружения, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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 словарь	при обработке объекта 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_modified': '09-Mar-2016 19:28:26 +0000', 'name': 'foo', 'tags': {}}

Авторы

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_storageblob_module.html