Модуль azure.azcollection.azure_rm_storageblob_info — получение сведений о blob-объектах контейнера или их списка
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_storageblob_info.
Добавлено в azure.azcollection 3.0.0
Краткое описание
- Получение списка blob-объектов в указанном контейнере.
Требования
Следующие требования должны быть выполнены на хосте, где запускается этот модуль.
- python >= 2.7
- На хосте, где запускается этот модуль, должна быть установлена коллекция azure.azcollection из galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, где запускаются модули из azure.azcollection
- Полные инструкции по установке см. по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL центра сертификации Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас собственный центр сертификации ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_mode string | Режим выполнения команды. Режим В устаревшем режиме Также можно задать с помощью переменной среды Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
blob_name псевдонимы: blob string | Имя blob-объекта в контейнере. |
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (определенное в Azure Python SDK, например По умолчанию: |
container_name псевдонимы: container string / обязательный | Имя контейнера blob-объектов в учетной записи хранения. |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра сертификации будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому необходимо убедиться, что настроенный узел центра сертификации действителен и заслуживает доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
include list / элементы=string | Указывает один или несколько дополнительных наборов данных, которые нужно включить в ответ. Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name_starts_with string | Фильтрует результаты, возвращая только blob-объекты, имена которых начинаются с указанного префикса. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Этот токен обменивается на токен Azure AD с помощью федеративного удостоверения OIDC. Подходит для систем CI (например, GitHub Actions и Azure DevOps), где платформа предоставляет токен OIDC напрямую. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group псевдонимы: resource_group_name string / обязательный | Имя используемой группы ресурсов. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
storage_account_name псевдонимы: account_name, storage_account string / обязательный | Имя используемой учетной записи хранения. |
subscription_id string | Идентификатор вашей подписки Azure. |
tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, использованному для создания субъекта-службы. К сертификату должен быть добавлен закрытый ключ. Используйте при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью
az login. - Также можно выполнить аутентификацию с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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: Get the blob facts by name
azure_rm_storageblob_info:
resource_group: "{{ resource_group }}"
account_name: "{{ storage_account }}"
container_name: my-blobs
blob_name: blobname01
- name: List the blob facts in specify container
azure_rm_storageblob_info:
resource_group: "{{ resource_group }}"
account_name: "{{ storage_account }}"
container_name: my-blobs
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
blob dictionary | Сведения о текущем состоянии blob-объекта. Возвращается: при выполнении операции с blob-объектом Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_storageblob_info_module.html