azure.azcollection.azure_rm_storageaccount 模块 – 管理 Azure 存储帐户

注意

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

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

要安装它，请使用： ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定： azure.azcollection.azure_rm_storageaccount。

azure.azcollection 0.1.0 中的新增功能

概要

  • 创建、更新或删除存储帐户。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

access_tier

string

此存储帐户的访问层。当 kind=BlobStorage 时必需。

选择

  • "Hot"

  • "Cool"

account_type

别名: type

string

存储帐户的类型。创建存储帐户时必需。

Standard_ZRS 和 Premium_LRS 帐户不能更改为其他帐户类型。

其他帐户类型不能更改为 Standard_ZRS 或 Premium_LRS。

选择

  • "Premium_LRS"

  • "Standard_GRS"

  • "Standard_LRS"

  • "Standard_RAGRS"

  • "Standard_ZRS"

  • "Premium_ZRS"

  • "Standard_RAGZRS"

  • "Standard_GZRS"

ad_user

string

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

adfs_authority_url

string

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 url。当使用用户名/密码进行身份验证并且具有您自己的 ADFS 授权时使用。

allow_blob_public_access

boolean

在 azure.azcollection 1.1.0 中添加

允许将帐户中的 Blob 容器设置为匿名公共访问。

如果设置为 false，则此帐户中的任何容器都将无法允许匿名公共访问。

如果省略，则新帐户创建将默认为 null，当前解释为 True。现有帐户不会被修改。

选择

  • false

  • true

allow_cross_tenant_replication

boolean

允许或不允许跨 AAD 租户对象复制。

选择

  • false

  • true

allow_shared_key_access

boolean

指示存储帐户是否允许通过共享密钥使用帐户访问密钥授权请求。

如果为 false，则所有请求（包括共享访问签名）都必须使用 Azure Active Directory (Azure AD) 进行授权。

默认值为 null，相当于 true。

选择

  • false

  • true

api_profile

string

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时要使用的 API 配置文件。 latest 的默认值适用于公共云；未来的值将允许与 Azure Stack 一起使用。

默认值: "latest"

append_tags

boolean

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

当为规范时，在 tags 参数中未找到的任何 tags 将从对象的元数据中删除。

选择

  • false

  • true ← (默认)

auth_source

string

在 azure.azcollection 0.0.1 中添加

控制用于身份验证的凭据来源。

也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。

当设置为 auto （默认值）时，优先级为模块参数 -> env -> credential_file -> cli。

当设置为 env 时，凭据将从环境变量中读取

当设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。

当设置为 cli 时，凭据将来自 Azure CLI 配置文件。如果存在多个订阅 ID，则可以使用 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_cors

list / elements=dictionary

指定 Blob 服务的 CORS 规则。

您可以在请求中包含最多五个 CorsRule 元素。

如果参数列表中未包含任何 blob_cors 元素，则不会更改任何关于 CORS 的设置。

如果要删除所有 CORS 规则并禁用 Blob 服务的 CORS，请显式设置 blob_cors=[]。

allowed_headers

列表 / 元素=字符串 / 必需

允许作为跨域请求一部分的标头列表。

allowed_methods

列表 / 元素=字符串 / 必需

允许源执行的 HTTP 方法列表。

allowed_origins

列表 / 元素=字符串 / 必需

将允许通过 CORS 的来源域列表，或者使用“*”允许所有域。

exposed_headers

列表 / 元素=字符串 / 必需

要向 CORS 客户端公开的响应标头列表。

max_age_in_seconds

整数 / 必需

客户端/浏览器应缓存预检响应的秒数。

cert_validation_mode

string

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选择

  • "ignore"

  • "validate"

client_id

string

Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

string

在 azure.azcollection 0.0.1 中添加

对于美国公共云以外的云环境，可以使用环境名称（如 Azure Python SDK 所定义，例如 AzureChinaCloud，AzureUSGovernment），或者使用元数据发现端点 URL（Azure Stack 必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

custom_domain

别名: custom_dns_domain_suffix

字典

分配给存储帐户的用户域。

必须是一个包含 name 和 use_sub_domain 键的字典，其中 name 是 CNAME 源。

目前每个存储帐户仅支持一个自定义域。

要清除现有自定义域，请将自定义域名属性设置为空字符串。

可以添加到现有存储帐户。在存储帐户创建期间将被忽略。

default_to_o_auth_authentication

boolean

一个布尔标志，指示默认身份验证是否为 OAuth。

此属性的默认解释为 false。

选择

  • false

  • true

disable_instance_discovery

boolean

在 azure.azcollection 2.3.0 中添加

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

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

选择

  • false ← (默认)

  • true

enable_nfs_v3

boolean

NFS 3.0 协议。

选择

  • false

  • true

encryption

字典

存储帐户上的加密设置。

key_source

string

加密 keySource（提供程序）。

选择

  • "Microsoft.Storage" ← (默认)

  • "Microsoft.Keyvault"

require_infrastructure_encryption

boolean

一个布尔值，指示服务是否为静态数据应用具有平台托管密钥的第二层加密。

选择

  • false

  • true

services

字典

支持加密的服务列表。

blob

字典

blob 存储服务的加密功能。

enabled

boolean

是否加密 blob 类型。

选择

  • false

  • true

file

字典

文件存储服务的加密功能。

enabled

boolean

是否加密文件类型。

选择

  • false

  • true

queue

字典

队列存储服务的加密功能。

enabled

boolean

是否加密队列类型。

选择

  • false

  • true

table

字典

表存储服务的加密功能。

enabled

boolean

是否加密表类型。

选择

  • false

  • true

force_delete_nonempty

别名: force

boolean

如果资源已存在且无法更新，则尝试删除。

选择

  • false ← (默认)

  • true

https_only

boolean

设置为 True 时，仅允许 https 流量访问存储服务。

如果省略，则新帐户创建将默认为 True，而现有帐户将不会更改。

选择

  • false

  • true

identity

字典

此资源的标识。

type

string

托管标识的类型

选择

  • "SystemAssigned"

  • "UserAssigned"

  • "None" ← (默认)

user_assigned_identity

string

与此资源关联的用户分配的托管标识

is_hns_enabled

boolean

如果设置为 true，则启用帐户分层命名空间。

当 is_hns_enabled=True 时，kind 不能为 Storage。

选择

  • false

  • true

kind

string

存储的类型。

仅当 account_type=Premium_LRS 或 account_type=Premium_ZRS 时，才使用 FileStorage 和 (BlockBlobStorage)。

选择

  • "Storage" ← (默认)

  • "StorageV2"

  • "BlobStorage"

  • "BlockBlobStorage"

  • "FileStorage"

large_file_shares_state

string

如果设置为 Enabled，则允许大型文件共享。

选择

  • "Enabled"

  • "Disabled"

location

string

有效的 Azure 位置。默认为资源组的位置。

log_mode

string

父参数。

log_path

string

父参数。

minimum_tls_version

string

在 azure.azcollection 1.0.0 中添加

对存储帐户的请求所需的最低传输层安全性 (TLS) 版本。

如果省略，则新帐户创建将默认为 null，当前将其解释为 TLS1_0。现有帐户将不会修改。

选择

  • "TLS1_0"

  • "TLS1_1"

  • "TLS1_2"

name

字符串 / 必需

要更新或创建的存储帐户的名称。

network_acls

字典

管理存储帐户的防火墙和虚拟网络设置。

bypass

string

当 default_action=Deny 时，此项控制哪些 Azure 组件仍然可以访问存储帐户。

此列表以逗号分隔。

可以是示例 AzureServices、Logging、Metrics 的任意组合。

如果不允许任何 Azure 组件，请显式设置 bypass=””。

默认值： "AzureServices"

default_action

string

默认防火墙流量规则。

如果 default_action=Allow，则其他设置均无效。

选择

  • "Allow" ← (默认)

  • "Deny"

ip_rules

list / elements=dictionary

CIDR 格式的 IP 地址或范围列表。

action

string

唯一的逻辑 action=Allow，因为此设置仅在 default_action=Deny 时可访问。

默认值： "Allow"

value

string

IP 地址或范围。

virtual_network_rules

list / elements=dictionary

子网及其操作的列表。

action

string

唯一的逻辑 action=Allow，因为此设置仅在 default_action=Deny 时可访问。

默认值： "Allow"

id

string

子网的完整路径。

password

string

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

profile

string

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

public_network_access

string

在 azure.azcollection 1.12.0 中添加

允许或禁止对存储帐户的公共网络访问。

选择

  • "Enabled"

  • "Disabled"

resource_group

别名: resource_group_name

字符串 / 必需

要使用的资源组的名称。

secret

string

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

state

string

存储帐户的状态。使用 present 创建或更新存储帐户，使用 absent 删除帐户。

failover 用于将存储帐户故障转移到其辅助帐户。此过程可能需要长达一小时。

选择

  • "absent"

  • "present" ← (默认)

  • "failover"

static_website

字典

在 azure.azcollection 1.13.0 中添加

管理存储帐户的静态网站配置。

enabled

boolean

指示此帐户是否托管静态网站。

选择

  • false ← (默认)

  • true

error_document404_path

string

自定义 404 页面的绝对路径。

index_document

string

每个目录下索引页面的默认名称。

subscription_id

string

您的 Azure 订阅 ID。

tags

字典

要作为元数据分配给对象的 string:string 对的字典。

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

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

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

Azure Front Door 不支持使用

Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。

tenant

string

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

thumbprint

string

在 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 中。这是一个 ini 文件，包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递配置文件或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: remove account, if it exists
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: clh0002
    state: absent

- name: create an account
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: clh0002
    type: Standard_RAGRS
    tags:
      testing: testing
      delete: on-exit

- name: Create an account with kind of FileStorage
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: c1h0002
    type: Premium_LRS
    kind: FileStorage
    tags:
      testing: testing

- name: Create storage account with I(enable_nfs_v3=false)
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: c1h0002
    account_type: Premium_LRS
    kind: FileStorage
    enable_nfs_v3: false
    static_website:
      enabled: true

- name: configure firewall and virtual networks
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: clh0002
    type: Standard_RAGRS
    network_acls:
      bypass: AzureServices,Metrics
      default_action: Deny
      virtual_network_rules:
        - id: /subscriptions/mySubscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet
          action: Allow
      ip_rules:
        - value: 1.2.3.4
          action: Allow
        - value: 123.234.123.0/24
          action: Allow

- name: create an account with blob CORS
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: clh002
    type: Standard_RAGRS
    blob_cors:
      - allowed_origins:
          - http://www.example.com/
        allowed_methods:
          - GET
          - POST
        allowed_headers:
          - x-ms-meta-data*
          - x-ms-meta-target*
          - x-ms-meta-abc
        exposed_headers:
          - x-ms-meta-*
        max_age_in_seconds: 200

返回值

常见返回值记录在此处，以下是此模块独有的字段

键

描述

state

复杂

存储帐户的当前状态。

返回: 始终

account_type

string

存储帐户的类型。

返回: 始终

示例: "Standard_RAGRS"

allow_blob_public_access

boolean

是否允许或禁止对存储帐户中所有 Blob 或容器的公共访问。

返回: 始终

示例: true

allow_cross_tenant_replication

boolean

允许或不允许跨 AAD 租户对象复制。

返回: 始终

示例: true

allow_shared_key_access

boolean

指示存储帐户是否允许通过共享密钥使用帐户访问密钥授权请求。

返回: 始终

示例: true

custom_domain

复杂

分配给存储帐户的用户域。

返回: 始终

name

string

CNAME 源。

返回: 始终

示例: "testaccount"

use_sub_domain

boolean

是否使用子域名。

返回: 始终

示例: true

default_to_o_auth_authentication

boolean

一个布尔标志，指示默认身份验证是否为 OAuth。

此属性的默认解释为 false。

返回: 始终

示例: true

enable_nfs_v3

boolean

NFS 3.0 协议。

返回: 始终

示例: false

encryption

复杂

存储帐户上的加密设置。

返回: 始终

key_source

string

加密 keySource（提供程序）。

返回: 始终

示例: "Microsoft.Storage"

require_infrastructure_encryption

boolean

一个布尔值，指示服务是否为静态数据应用具有平台托管密钥的第二层加密。

返回: 始终

示例: false

services

字典

支持加密的服务列表。

返回: 始终

blob

字典

blob 存储服务的加密功能。

返回: 始终

示例: {"enabled": true}

file

字典

文件存储服务的加密功能。

返回: 始终

示例: {"enabled": true}

queue

字典

队列存储服务的加密功能。

返回: 始终

示例: {"enabled": true}

table

字典

表存储服务的加密功能。

返回: 始终

示例: {"enabled": true}

failover_in_progress

boolean

指示存储帐户当前正在故障转移到其辅助位置的状态。

返回: 始终

示例: false

https_only

boolean

当设置为 true 时，仅允许到存储服务的 https 流量。

返回: 始终

示例: false

id

string

资源 ID。

返回: 始终

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/clh0003"

is_hns_enabled

boolean

如果设置为 true，则启用帐户分层命名空间。

返回: 始终

示例: true

large_file_shares_state

string

如果设置为 Enabled，则允许大型文件共享。

返回: 始终

示例: "Enabled"

location

string

有效的 Azure 位置。默认为资源组的位置。

返回: 始终

示例: "eastus2"

minimum_tls_version

string

允许存储请求的最低 TLS 版本。

返回: 始终

示例: "TLS1_2"

name

string

要更新或创建的存储帐户的名称。

返回: 始终

示例: "clh0003"

network_acls

字典

一组防火墙和虚拟网络规则

返回: 始终

示例: {"bypass": "AzureServices", "default_action": "Deny", "ip_rules": [{"action": "Allow", "value": "1.2.3.4"}, {"action": "Allow", "value": "123.234.123.0/24"}], "virtual_network_rules": [{"action": "Allow", "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroup/                                    providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"}]}

primary_endpoints

字典

从主位置检索公共 *blob*、*queue* 或 *table* 对象的 URL。

返回: 始终

示例: {"blob": "https://clh0003.blob.core.windows.net/", "queue": "https://clh0003.queue.core.windows.net/", "table": "https://clh0003.table.core.windows.net/"}

primary_location

string

存储帐户的主数据中心的位置。

返回: 始终

示例: "eastus2"

provisioning_state

string

存储帐户的状态。

可能的值包括 Creating、ResolvingDNS、Succeeded。

返回: 始终

示例: "Succeeded"

public_network_access

string

允许或禁止对存储帐户的公共网络访问。

返回: 始终

示例: "Enabled"

resource_group

string

资源组的名称。

返回: 始终

示例: "Testing"

secondary_endpoints

字典

从辅助位置检索公共 *blob*、*queue* 或 *table* 对象的 URL。

返回: 始终

示例: {"blob": "https://clh0003-secondary.blob.core.windows.net/", "queue": "https://clh0003-secondary.queue.core.windows.net/", "table": "https://clh0003-secondary.table.core.windows.net/"}

secondary_location

string

存储帐户的异地复制辅助位置。

返回: 始终

示例: "centralus"

static_website

复杂

在 azure.azcollection 1.13.0 中添加

存储帐户的静态网站配置。

返回: 始终

enabled

boolean

此帐户是否托管静态网站。

返回: 始终

示例: true

error_document404_path

string

自定义 404 页面的绝对路径。

返回: 始终

示例: "error.html"

index_document

string

每个目录下索引页面的默认名称。

返回: 始终

示例: "index.html"

status_of_primary

string

存储帐户的主位置的状态；可以是 available 或 unavailable。

返回: 始终

示例: "available"

status_of_secondary

string

存储帐户的辅助位置的状态；可以是 available 或 unavailable。

返回: 始终

示例: "available"

tags

字典

资源标签。

返回: 始终

示例: {"tags1": "value1"}

type

string

存储帐户类型。

返回: 始终

示例: "Microsoft.Storage/storageAccounts"

作者

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)