azure.azcollection.azure_rm_storageblob 模块 – 管理 Blob 容器和 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。

azure.azcollection 0.0.1 中的新增功能

概要

  • 创建、更新和删除 Blob 容器和 Blob 对象。

  • 用于上传文件并将其存储为 Blob 对象，或将 Blob 对象下载到文件（上传和下载模式）

  • 用于上传给定目录下的批量文件（批量上传模式）

  • 在批量上传模式下，如果要创建具有相同名称的 Blob 对象，则现有 Blob 对象将被覆盖。

  • 该模块可以在三种模式下独占工作，当设置 batch_upload_src 时，它以批量上传模式工作；当设置 src 时，它以上传模式工作；当设置 dst 时，它以下载模式工作。

要求

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

  • 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"

append_tags

布尔值

用于控制 tags 字段是规范的还是仅追加到现有 tags。

当为规范时，tags 参数中找不到的任何 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 来标识订阅 ID，否则将使用默认的 az cli 订阅。

当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。如果该资源被授予访问多个订阅的权限，可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 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 客户端 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

别名：container_name

字符串 / 必需

存储帐户中 blob 容器的名称。

content_disposition

字符串

设置 blob 内容处置标头。

content_encoding

字符串

设置 blob 编码标头。

content_language

字符串

设置 blob 内容语言标头。

content_md5

字符串

设置 blob md5 哈希值。

content_type

字符串

设置 blob 内容类型标头。例如 image/png。

dest

别名：destination

路径

目标文件路径。与状态 present 一起使用以下载 blob。

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点（例如在私有云或 Azure Stack 中）的场景。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 **True**，将禁用授权验证。因此，至关重要的是确保配置的授权主机有效且值得信赖。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量进行设置。

选项

  • false ←（默认）

  • true

force

布尔值

在上传或下载时覆盖现有的 blob 或文件。强制删除包含 blob 的容器。

选项

  • false ←（默认）

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

password

字符串

Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

public_access

字符串

容器的公共访问级别。默认情况下，容器是私有的。

只能在创建容器时设置。

不应为私有访问设置 public_access 参数。

如果未配置 public_access，则访问级别默认为私有。它不能显式设置为私有。

选项

  • "container"

  • "blob"

resource_group

别名：resource_group_name

字符串 / 必需

要使用的资源组的名称。

secret

字符串

Azure 客户端密钥。在通过服务主体进行身份验证时使用。

src

别名：source

字符串

源文件路径。与状态 present 一起使用以上传 blob。

standard_blob_tier

字符串

指定要将 blob 设置到的 blob 层。

这仅适用于标准存储帐户上的块 blob。

选项

  • "Archive"

  • "Cool"

  • "Cold"

  • "Hot"

state

字符串

容器或 blob 的状态。

仅使用容器值并使用状态 absent 来删除容器。包含 blob 值以删除特定的 blob。如果容器包含 blob，则不会被删除。使用 force 选项来覆盖，删除容器和所有关联的 blob。

使用状态 present 来创建或更新容器并上传或下载 blob。如果容器不存在，则将创建它。如果它存在，将使用配置选项更新它。提供 blob 名称以及 src 或 dest 以上传或下载。提供 src 路径以进行上传，并提供 dest 路径以进行下载。如果 blob（上传）或文件（下载）已存在，则除非 force=true，否则不会被覆盖。

选项

  • "absent"

  • "present" ←（默认）

storage_account_name

别名：account_name, storage_account

字符串 / 必需

要使用的存储帐户的名称。

subscription_id

字符串

您的 Azure 订阅 ID。

tags

字典

要作为元数据分配给对象的字符串：字符串对的字典。

对象上的元数据标签将使用任何提供的值进行更新。

要删除标签，请将 append_tags 选项设置为 false。

目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。

Azure Front Door 不支持使用

Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。

tenant

字符串

Azure 租户 ID。在通过服务主体进行身份验证时使用。

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

在通过服务主体进行身份验证时使用。

如果定义了 x509_certificate_path，则为必需。

x509_certificate_path

路径

在 azure.azcollection 1.14.0 中添加

用于以 PEM 格式创建服务主体的 X509 证书的路径。

必须将证书附加到私钥。

在通过服务主体进行身份验证时使用。

注释

注意

  • 要通过 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": 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", "standard_blob_tier": "Hot", "tags": {}, "type": "BlockBlob"}

container

字典

关于所选容器当前状态的事实。

返回: 总是

示例: {"last_modified": "09-Mar-2016 19:28:26 +0000", "name": "foo", "tags": {}}

作者

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)