azure.azcollection.azure_rm_rediscache_info 模块 – 获取 Azure 缓存 Redis 实例信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

• 获取 Azure 缓存 Redis 实例的信息。

要求

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

• python >= 2.7

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

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

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

参数

参数	注释
ad_user 字符串	活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。
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，否则将使用默认的 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 字符串	将结果限制为特定的 Azure 缓存 Redis。
password 字符串	活动目录用户密码。在使用活动目录用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必填	搜索所需 Azure 缓存 Redis 实例的资源组。
return_access_keys 布尔值	指示是否返回 Azure 缓存 Redis 实例的访问密钥。 选项 false ← (默认值) true
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 列表 / 元素=字符串	通过提供标签列表来限制结果。标签格式为“键”或“键:值”。
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 中的配置文件，或者在运行任务或剧本之前使用 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 Azure Cache for Redis by name
  azure_rm_rediscache_info:
    resource_group: myResourceGroup
    name: myRedis

- name: Get Azure Cache for Redis with access keys by name
  azure_rm_rediscache_info:
    resource_group: myResourceGroup
    name: myRedis
    return_access_keys: true

- name: Get Azure Cache for Redis in specific resource group
  azure_rm_rediscache_info:
    resource_group: myResourceGroup

返回值

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

键	描述
rediscaches 复杂类型	Azure 缓存 Redis 实例列表。 返回值：始终返回
access_keys 字典	Azure 缓存 Redis 实例的访问密钥。 返回值：当 *return_access_keys=true* 时返回
primary 字符串	客户端用来验证 Redis 缓存的当前主密钥。 返回值：始终返回 示例： "X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx="
secondary 字符串	客户端用来验证 Redis 缓存的当前辅助密钥。 返回值：始终返回 示例： "X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx="
configuration 字典	Redis 配置的字典。 返回值：始终返回 示例： "maxmeory_reserved"
enable_non_ssl_port 布尔值	指定是否启用非 SSL Redis 服务器端口 (6379)。 返回值：始终返回 示例： false
host_name 字符串	Redis 主机名。 返回值：始终返回 示例： "testRedis.redis.cache.windows.net"
id 字符串	Azure 缓存 Redis 实例的 ID。 返回值：始终返回 示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis"
location 字符串	Azure 缓存 Redis 实例的位置。 返回值：始终返回 示例： "WestUS"
minimum_tls_version 字符串 azure.azcollection 1.10.0 版本中新增	客户端必须连接的 TLS 版本。 返回值：始终返回 示例： "1.2"
name 字符串	Azure 缓存 Redis 实例的名称。 返回值：始终返回 示例： "myRedis"
provisioning_state 字符串	Redis 缓存的预配状态。 返回值：始终返回 示例： "Creating"
public_network_access 字符串 azure.azcollection 1.10.0 版本中新增	此缓存是否允许公共端点访问。 返回值：始终返回 示例： "Enabled"
redis_version 字符串 azure.azcollection 1.10.0 版本中新增	Redis 的版本。 返回值：始终返回 示例： "6.0.14"
resource_group 字符串	Azure 缓存 Redis 实例所属的资源组名称。 返回值：始终返回 示例： "myResourceGroup"
shard_count 整数	高级群集缓存上的分片数量。 返回值：始终返回 示例： 1
sku 字典	SKU 信息的字典。 返回值：始终返回
name 字符串	SKU 的名称。 返回值：始终返回 示例： "standard"
size 字符串	Azure 缓存 Redis 实例的大小。 返回值：始终返回 示例： "C1"
static_ip 字符串	静态 IP 地址。 返回值：始终返回 示例： "10.75.0.11"
subnet 字符串	在虚拟网络中部署 Azure 缓存 Redis 实例的子网的完整资源 ID。 返回值：始终返回 示例： "['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Network/VirtualNetworks/myVirtualNetwo rk/subnets/mySubnet']"
tags 字典	资源标签。 返回值：始终返回 示例： {"key1": "value1"}
tenant_settings 字典	租户设置的字典。 返回值：始终返回 示例： {"key1": "value1"}

作者

• 朱云歌 (@yungezz)

资源链接

• 问题跟踪器
• 主页
• 代码仓库