azure.azcollection.azure_rm_storageaccount_info 模块 – 获取存储帐户信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 获取一个存储帐户或资源组中所有存储帐户的信息。

要求

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

  • 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_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（如果存在多个订阅 ID），否则将使用默认的 az cli 订阅。

当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果该资源被授予对多个订阅的访问权限），否则将选择第一个订阅。

msi 在 Ansible 2.6 中添加。

选项

  • "auto" ← (默认)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

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"

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

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

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

选项

  • false ← (默认)

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

仅显示特定帐户的结果。

password

字符串

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

profile

字符串

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

resource_group

别名: resource_group_name

字符串

将结果限制为资源组。当按名称筛选时是必需的。

secret

字符串

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

show_blob_cors

布尔值

显示与存储帐户相关的每个 blob 的 blob CORS 设置。

查询所有存储帐户将需要很长时间。

选项

  • false

  • true

show_connection_string

布尔值

显示每个存储帐户端点的连接字符串。

为了方便使用，show_connection_string 还会显示每个存储帐户端点的访问密钥。

请注意，列出所有存储帐户而不是查询单个帐户会花费大量时间。

选项

  • false

  • true

show_georeplication_stats

布尔值

显示每个存储帐户的异地复制统计信息。

在不支持异地复制的帐户上使用此选项会导致获取结果时出现延迟。

选项

  • false

  • true

subscription_id

字符串

您的 Azure 订阅 ID。

tags

list / elements=string

通过提供标签列表来限制结果。将标签格式化为“key”或“key:value”。

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 facts for one account
  azure_rm_storageaccount_info:
    resource_group: myResourceGroup
    name: clh0002

- name: Get facts for all accounts in a resource group
  azure_rm_storageaccount_info:
    resource_group: myResourceGroup

- name: Get facts for all accounts by tags
  azure_rm_storageaccount_info:
    tags:
      - testing
      - foo:bar

返回值

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

键

描述

azure_storageaccounts

list / elements=string

存储帐户字典列表。

返回: 始终

示例: [{"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/myResourceGroups/testing/providers/Microsoft.Storage/storageAccounts/testaccount001", "location": "eastus2", "name": "testaccount001", "properties": {"accountType": "Standard_LRS", "creationTime": "2016-03-28T02:46:58.290113Z", "primaryEndpoints": {"blob": "https://testaccount001.blob.core.windows.net/", "file": "https://testaccount001.file.core.windows.net/", "queue": "https://testaccount001.queue.core.windows.net/", "table": "https://testaccount001.table.core.windows.net/"}, "primaryLocation": "eastus2", "provisioningState": "Succeeded", "statusOfPrimary": "Available"}, "tags": {}, "type": "Microsoft.Storage/storageAccounts"}]

storageaccounts

复杂

资源模块参数格式的存储帐户字典列表。

返回: 始终

access_tier

字符串

此存储帐户的访问层。

返回: 始终

示例: "Hot"

account_type

字符串

存储帐户的类型。

Standard_ZRS 和 Premium_LRS 帐户无法更改为其他帐户类型。

其他帐户类型无法更改为 Standard_ZRS 或 Premium_LRS。

返回: 始终

示例: "Standard_ZRS"

allow_blob_public_access

布尔值

允许或不允许对存储帐户中的所有 blob 或容器进行公共访问。

返回: 始终

示例: true

allow_cross_tenant_replication

布尔值

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

返回: 始终

示例: true

allow_shared_key_access

布尔值

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

返回: 始终

示例: true

custom_domain

复杂

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

必须是具有 name 和 use_sub_domain 键的字典，其中 name 是 CNAME 源。

返回: 始终

name

字符串

CNAME 源。

返回: 始终

示例: "testaccount"

use_sub_domain

布尔值

是否使用子域。

返回: 始终

示例: true

default_to_o_auth_authentication

布尔值

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

此属性的默认解释为 false。

返回: 始终

示例: true

enable_nfs_v3

布尔值

NFS 3.0 协议。

返回: 始终

示例: false

encryption

复杂

存储帐户上的加密设置。

返回: 始终

key_source

字符串

加密 keySource（提供程序）。

返回: 始终

示例: "Microsoft.Storage"

require_infrastructure_encryption

布尔值

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

返回: 始终

示例: false

services

字典

支持加密的服务列表。

返回: 始终

blob

字典

blob 存储服务的加密功能。

返回: 始终

示例: {"enabled": true}

file

字典

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

返回: 始终

示例: {"enabled": true}

queue

字典

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

返回: 始终

示例: {"enabled": true}

table

字典

表存储服务的加密功能。

返回: 始终

示例: {"enabled": true}

failover_in_progress

布尔值

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

返回: 始终

示例: false

georeplication_stats

复杂

与异地复制状态相关的参数。

在不支持异地复制的帐户上，此值将为 null。

返回: 始终

can_failover

布尔值

指示帐户是否支持故障转移的属性。

返回: 成功

示例: true

last_sync_time

字符串

保证在此时间之前写入主区域的数据已复制到辅助区域。

返回: 成功

示例: "2023-04-10T21:22:15+00:00"

sync_status

字符串

显示辅助区域状态的属性。

已知值为“Live”、“Bootstrap”和“Unavailable”。

返回: 成功

示例: "Live"

https_only

布尔值

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

返回: 始终

示例: false

id

字符串

资源 ID。

返回: 始终

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

is_hns_enabled

布尔值

如果设置为 true，则启用帐户 HierarchicalNamespace。

返回: 始终

示例: true

kind

字符串

存储的类型。

返回: 始终

示例: "Storage"

large_file_shares_state

字符串

如果设置为“已启用”，则允许大型文件共享。

返回: 始终

示例: "Enabled"

location

字符串

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

返回: 始终

示例: "eastus"

minimum_tls_version

字符串

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

返回: 始终

示例: "TLS1_2"

name

字符串

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

返回: 始终

示例: "testaccount001"

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、文件、队列 或 表 对象的 URL。

请注意，Standard_ZRS 和 Premium_LRS 帐户仅返回 blob 终结点。

返回: 始终

blob

复杂

主 blob 终结点和连接字符串。

返回: 始终

连接字符串

字符串

blob 终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X"

终结点

字符串

主 blob 终结点。

返回: 始终

示例： "https://testaccount001.blob.core.windows.net/"

file

复杂

主文件终结点和连接字符串。

返回: 始终

连接字符串

字符串

文件终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X"

终结点

字符串

主文件终结点。

返回: 始终

示例： "https://testaccount001.file.core.windows.net/"

密钥

字符串

primary_endpoints 的帐户密钥

返回: 始终

示例： "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

queue

复杂

主队列终结点和连接字符串。

返回: 始终

连接字符串

字符串

队列终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X"

终结点

字符串

主队列终结点。

返回: 始终

示例： "https://testaccount001.queue.core.windows.net/"

table

复杂

主表终结点和连接字符串。

返回: 始终

连接字符串

字符串

表终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X"

终结点

字符串

主表终结点。

返回: 始终

示例： "https://testaccount001.table.core.windows.net/"

primary_location

字符串

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

返回: 始终

示例: "eastus"

provisioning_state

字符串

调用操作时存储帐户的状态。

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

返回: 始终

示例： "Succeeded"

public_network_access

字符串

允许或不允许公共网络访问存储帐户。

返回: 始终

示例: "Enabled"

secondary_endpoints

复杂

从辅助位置检索公共 blob、文件、队列 或 表 对象的 URL。

仅当 SKU name=Standard_RAGRS 时可用。

返回: 始终

blob

复杂

辅助 blob 终结点和连接字符串。

返回: 始终

连接字符串

字符串

blob 终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X"

终结点

字符串

辅助 blob 终结点。

返回: 始终

示例： "https://testaccount001.blob.core.windows.net/"

file

复杂

辅助文件终结点和连接字符串。

返回: 始终

连接字符串

字符串

文件终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X"

终结点

字符串

辅助文件终结点。

返回: 始终

示例： "https://testaccount001.file.core.windows.net/"

密钥

字符串

secondary_endpoints 的帐户密钥

返回: 成功

示例： "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

queue

复杂

辅助队列终结点和连接字符串。

返回: 始终

连接字符串

字符串

队列终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X"

终结点

字符串

辅助队列终结点。

返回: 始终

示例： "https://testaccount001.queue.core.windows.net/"

table

复杂

辅助表终结点和连接字符串。

返回: 始终

连接字符串

字符串

表终结点的连接字符串。

返回: 始终

示例： "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X"

终结点

字符串

辅助表终结点。

返回: 始终

示例： "https://testaccount001.table.core.windows.net/"

secondary_location

字符串

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

仅当 account_type=Standard_GRS 或 account_type=Standard_RAGRS 时可用。

返回: 始终

示例： "westus"

static_website

复杂

在 azure.azcollection 1.13.0 中添加

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

返回: 始终

enabled

布尔值

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

返回: 始终

示例: true

error_document404_path

字符串

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

返回: 始终

示例： "error.html"

index_document

字符串

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

返回: 始终

示例： "index.html"

status_of_primary

字符串

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

返回: 始终

示例： "available"

status_of_secondary

字符串

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

返回: 始终

示例： "available"

tags

字典

资源标签。

返回: 始终

示例： {"tag1": "abc"}

作者

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)