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 集合

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

• 完整的安装说明可在 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（如果该资源被授予对多个订阅的访问权限），否则选择第一个订阅。 Ansible 2.6 中添加了 msi。 选项 "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 环境变量设置。
云环境 字符串 azure.azcollection 0.0.1 中新增	对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud，AzureUSGovernment）或元数据发现端点 URL（Azure Stack 必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
容器名称 别名：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 列表 / 元素=字符串	指定要在响应中包含的一个或多个附加数据集。 选项 "快照" "元数据" "未提交的 Blob" "复制" "已删除" "已删除的版本" "标签" "版本" "不变性策略" "法律保留"
log_mode 字符串	父参数。
log_path 字符串	父参数。
name_starts_with 字符串	筛选结果，仅返回名称以指定前缀开头的 Blob。
密码 字符串	Active Directory 用户密码。使用服务主体进行身份验证时使用。
配置文件 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
资源组 别名：resource_group_name 字符串 / 必需	要使用的资源组的名称。
密钥 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
存储帐户名称 别名：account_name, storage_account 字符串 / 必需	要使用的存储帐户的名称。
订阅 ID 字符串	您的 Azure 订阅 ID。
租户 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
指纹 字符串 azure.azcollection 1.14.0 版本中添加	在 *x509_certificate_path* 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则需要此参数。
x509_certificate_path 路径 azure.azcollection 1.14.0 版本中添加	PEM 格式的服务主体创建中使用的 X509 证书的路径。 证书必须附加到私钥。 使用服务主体进行身份验证时使用。

注释

注意

• 对于使用 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 中。这是一个包含 [default] 部分和以下密钥的 ini 文件：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)

收藏链接

• 问题追踪器
• 主页
• 存储库（源代码）