azure.azcollection.azure_rm_storageblob_info 模块 – 获取或列出容器 Blob 的信息

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_storageblob_info。

azure.azcollection 3.0.0 中的新增功能

概要

• 获取或列出指定容器下的 blob。

要求

执行此模块的主机需要满足以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 通过 pip 在执行 azure.azcollection 模块的主机上安装集合的 requirements.txt 中列出的所有 python 包

• 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数	注释
ad_user 字符串	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且拥有自己的 ADFS 授权时使用。
api_profile 字符串 在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。 默认： "latest"
auth_mode 字符串	运行命令的模式。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 来标识订阅 ID，否则将使用默认的 az cli 订阅。 当设置为 msi 时，主机必须是启用 MSI 扩展的 azure 资源。如果该资源被授予对多个订阅的访问权限，可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 ID，否则将选择第一个订阅。 msi 在 Ansible 2.6 中添加。 选择 "auto" ← (默认) "cli" "credential_file" "env" "msi"
blob_name 别名：blob 字符串	容器中 blob 对象的名称。
cert_validation_mode 字符串 在 azure.azcollection 0.0.1 中添加	控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理时，或者针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。 选择 "ignore" "validate"
client_id 字符串	Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment 字符串 在 azure.azcollection 0.0.1 中添加	对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现端点 URL（Azure Stack 所必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认： "AzureCloud"
container_name 别名：container 字符串 / 必需	存储帐户中 blob 容器的名称。
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。实例发现过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将其设置为 **True**，将禁用授权验证。因此，必须确保配置的授权主机有效且可信。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选择 false ← (默认) true
include list / elements=string	指定要包含在响应中的一个或多个其他数据集。 选择 "snapshots" "metadata" "uncommittedblobs" "copy" "deleted" "deletedwithversions" "tags" "versions" "immutabilitypolicy" "legalhold"
log_mode 字符串	父参数。
log_path 字符串	父参数。
name_starts_with 字符串	筛选结果，仅返回名称以指定前缀开头的 Blob。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 别名: resource_group_name 字符串 / 必需	要使用的资源组的名称。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
storage_account_name 别名: account_name, storage_account 字符串 / 必需	要使用的存储帐户的名称。
subscription_id 字符串	您的 Azure 订阅 ID。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需项。
x509_certificate_path path 在 azure.azcollection 1.14.0 中添加	用于创建 PEM 格式服务主体的 X509 证书的路径。 证书必须附加到私钥。 当使用服务主体进行身份验证时使用。

备注

注意

• 要使用 Azure 进行身份验证，您可以传递参数，设置环境变量，使用存储在 ~/.azure/credentials 中的配置文件，或者在使用 az login 运行任务或 playbook 之前登录。

• 也可以使用服务主体或 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: 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 字典

有关 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": "20-11-2024 22:08:25 +0000", "metadata": {"key1": "value1"}, "name": "graylog.png", "standard_blob_tier": "Hot", "tags": {}, "type": "BlockBlob"}

作者

• xuzhang3 (@xuzhang3)

• Fred-sun (@Fred-sun)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）