azure_rm_storageblob – Управление контейнерами и объектами BLOB
Обзор
- Создание, обновление и удаление контейнеров и объектов 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 логический тип |
| Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом режиме любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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 - | Установите заголовок content-language blob. | |
| content_md5 - | Установите значение хэша md5 blob. | |
| content_type - | Установите заголовок content-type blob. Например, image/png. | |
| dest - | Путь к целевому файлу. Используйте со состоянием present для скачивания blob.псевдонимы: destination | |
| force логический тип |
| Перезаписать существующий 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, или войти в систему перед выполнением задач или 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_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.9/modules/azure_rm_storageblob_module.html
