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。您需要其他要求才能使用此模块，请参阅要求获取详细信息。

要在剧本中使用它，请指定：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 集合
集合的 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 授权时使用。
选择与 Azure 服务通信时要使用的 API 配置文件。`latest` 的默认值适用于公共云；未来的值将允许与 Azure Stack 一起使用。字符串 azure.azcollection 0.0.1 中新增	api_profile 默认： `"latest"`
append_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（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。 Ansible 2.6 中添加了`msi`。选项 `"auto"` ← (默认) `"cli"` `"credential_file"` `"env"` `"msi"`
batch_upload_dst path	批量上传文件时容器中的基目录。
batch_upload_src path	批量上传源目录。与状态`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-disposition 标头。
content_encoding 字符串	设置 Blob 的编码标头。
content_language 字符串	设置 Blob 的内容语言标头。
content_md5 字符串	设置 Blob 的 MD5 哈希值。
content_type 字符串	设置 Blob 的 content-type 标头。例如`image/png`。
dest 别名：destination path	目标文件路径。与状态`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 前端门户不支持使用 Azure 自动化和 Azure CDN 资源上只支持 15 个标签。
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登录。
也可以使用服务主体或 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: 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"}

容器

字典

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

返回：始终

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

作者

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)