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 集合

  • 必须通过 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，如果存在多个订阅，则使用默认的 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

字符串

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

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 中的配置文件，或者在运行任务或 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: 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"}

作者

  • Yunge Zhu (@yungezz)