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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_storageblob.

Добавлен в azure.azcollection 0.0.1

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

Описание

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

Требования

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

python >= 2.7
На хосте, который выполняет этот модуль, должна быть установлена коллекция azure.azcollection через Galaxy.
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес авторитета Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
append_tags логическое	Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. В каноническом случае любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_mode строка добавлено в azure.azcollection 1.19.0	Режим выполнения команды. Режим `login` напрямую использует ваши учетные данные для аутентификации. Режим `key` (старый) попытается запросить ключ учетной записи, если параметры аутентификации для учетной записи не указаны. Также можно установить через переменную среды `AZURE_STORAGE_AUTH_MODE`. Варианты: `"key"` ← (по умолчанию) `"login"`
auth_source строка добавлено в azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также можно установить через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет имеет: параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных среды. При значении `credential_file`, профиль будет считан из `~/.azure/credentials`. При значении `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для указания идентификатора подписки, если их несколько, иначе используется по умолчанию. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для указания идентификатора подписки, если ресурсу разрешен доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` добавлено в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
batch_upload_dst путь	Базовая директория в контейнере при пакетной загрузке файлов.
batch_upload_src путь	Директория источника для пакетной загрузки. Используется со состоянием `present` для пакетной загрузки файлов в директории.
blob псевдонимы: blob_name строка	Имя объекта blob внутри контейнера.
blob_type строка добавлено в azure.azcollection 0.0.1	Тип объекта blob. Варианты: `"block"` ← (по умолчанию) `"page"`
cache_control строка	Установите заголовок кэширования blob.
cert_validation_mode строка добавлено в azure.azcollection 0.0.1	Управляет поведением проверки сертификата для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью служебного принципала или управляемой идентичности (msi). Также можно установить через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облаков, отличных от общедоступного облака США, имя окружения (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки доступа к метаданным (необходим для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
container псевдонимы: container_name строка / обязательно	Имя контейнера blob в хранилище.

content_disposition string	Установите заголовок blob content-disposition.
content_encoding string	Установите заголовок кодирования blob.
content_language string	Установите заголовок blob content-language.
content_md5 string	Установите значение хэша md5 blob.
content_type string	Установите заголовок blob content-type. Например `image/png`.
dest aliases: destination path	Путь к целевому файлу. Используйте со значением состояния `present` для загрузки blob.
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, будет ли выполнено обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит как обнаружение экземпляра, так и проверку подлинности авторитета. Эта функция предназначена для использования в сценариях, где метаданные конечной точки недоступны, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает извлечение метаданных авторитета из https://login.microsoft.com/ для проверки авторитета. Установив это значение в True, проверка подлинности авторитета отключается. В результате крайне важно убедиться, что настроенный хост авторитета является действительным и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
force boolean	Перезаписывать существующий blob или файл при загрузке или скачивании. Принудительно удалять контейнер, содержащий blobs. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы принципала.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
public_access string	Уровень публичного доступа к контейнеру. По умолчанию контейнеры являются частными. Может быть установлен только при создании контейнера. Параметр public_access не должен быть установлен для частного доступа. Если public_access не настроен, уровень доступа по умолчанию — частный. Его явно нельзя установить на частный. Варианты: `"container"` `"blob"`
resource_group aliases: resource_group_name string / обязательно	Имя группы ресурсов для использования.
secret string	Секретный ключ клиента Azure. Используйте при аутентификации с помощью службы принципала.
src aliases: source string	Путь к исходному файлу. Используйте со значением состояния `present` для загрузки blob.
state string	Состояние контейнера или blob. Используйте состояние `absent` со значением контейнера только для удаления контейнера. Укажите значение blob, чтобы удалить определённый blob. Контейнер не будет удален, если он содержит blobs. Используйте параметр force для переопределения, удалив контейнер и все связанные blobs. Используйте состояние `present` для создания или обновления контейнера и загрузки или скачивания blob. Если контейнер не существует, он будет создан. Если он существует, он будет обновлён с параметрами конфигурации. Укажите имя blob и либо src, либо dest для загрузки или скачивания. Укажите путь src для загрузки и путь dest для скачивания. Если blob (загрузка) или файл (скачивание) уже существуют, они не будут перезаписаны, если force=true. Варианты: `"absent"` `"present"` ← (по умолчанию)
storage_account_name aliases: account_name, storage_account string / обязательно	Имя хранилища для использования.
subscription_id string	Ваш идентификатор подписки Azure.

метки словарь	Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток для ресурсов.
арендатор строка	Идентификатор аренды Azure. Используйте при аутентификации с помощью принципала службы.
отпечаток строка добавлен в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью принципала службы. Требуется, если определён x509_certificate_path.
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509-сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть добавлен к частному ключу. Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации с 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 словарь	Информация о текущем состоянии blob. Возвращается: при работе с blob Пример: `{"content_length": 136532, "content_settings": {"cache_control": null, "content_disposition": null, "content_encoding": null, "content_language": null, "content_md5": null, "content_type": "application/image"}, "last_modified": "09-Mar-2016 22:08:25 +0000", "name": "graylog.png", "tags": {}, "type": "BlockBlob"}`
контейнер словарь	Информация о текущем состоянии выбранного контейнера. Возвращается: всегда Пример: `{"last_modified": "09-Mar-2016 19:28:26 +0000", "name": "foo", "tags": {}}`

Ключ

Описание

blob

словарь

Информация о текущем состоянии blob.

Возвращается: при работе с blob

Пример: {"content_length": 136532, "content_settings": {"cache_control": null, "content_disposition": null, "content_encoding": null, "content_language": null, "content_md5": null, "content_type": "application/image"}, "last_modified": "09-Mar-2016 22:08:25 +0000", "name": "graylog.png", "tags": {}, "type": "BlockBlob"}

контейнер

словарь

Информация о текущем состоянии выбранного контейнера.

Возвращается: всегда

Пример: {"last_modified": "09-Mar-2016 19:28:26 +0000", "name": "foo", "tags": {}}

Авторы

Крис Хаузекнект (@chouseknecht)
Мэтт Дэвис (@nitzmahone)

Ссылки на сборку

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