azure.azcollection.azure_rm_rediscache 模块 – 管理 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。

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"`
append_tags 布尔值	用于控制 tags 字段是规范的还是仅附加到现有标签。当为规范时，tags 参数中未找到的任何标签都将从对象的元数据中删除。选择 `false` `true` ← (默认)
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`
enable_non_ssl_port 布尔值	当设置 enable_non_ssl_port=true 时，将启用非 SSL Redis 服务器端口 6379。选择 `false` ← (默认) `true`
identity 字典	对象的标识
type 字符串	托管标识的类型选择 `"SystemAssigned"` `"UserAssigned"` `"SystemAssigned, UserAssigned"` `"None"` ← (默认)
user_assigned_identities 字典	用户分配的托管标识及其选项默认值: `{}`
追加布尔值	如果身份列表需要追加到当前身份 (true)，或者需要替换当前身份 (false) 选择 `false` `true` ← (默认)
id 列表 / 元素类型=字符串	与对象关联的用户分配的身份 ID 列表默认值: `[]`
location 字符串	资源位置。如果未设置，将使用资源组的位置作为默认值。
log_mode 字符串	父参数。
log_path 字符串	父参数。
maxfragmentationmemory_reserved 整数	配置为容纳内存碎片而保留的内存量，单位为 MB。有关更多详细信息，请参阅 https://docs.microsoft.com/zh-cn/azure/redis-cache/cache-configure#advanced-settings。
maxmemory_policy 字符串	配置缓存的逐出策略。有关更多详细信息，请参阅 https://docs.microsoft.com/zh-cn/azure/redis-cache/cache-configure#advanced-settings。选择 `"volatile_lru"` `"allkeys_lru"` `"volatile_random"` `"allkeys_random"` `"volatile_ttl"` `"noeviction"`
maxmemory_reserved 整数	配置为非缓存操作保留的内存量，单位为 MB。有关更多详细信息，请参阅 https://docs.microsoft.com/zh-cn/azure/redis-cache/cache-configure#advanced-settings。
minimum_tls_version 字符串在 azure.azcollection 1.10.0 中添加	要求客户端使用指定的 TLS 版本。选择 `"1.0"` `"1.1"` `"1.2"`
name 字符串 / 必填	要创建或更新的 Azure Redis 缓存的唯一名称。
notify_keyspace_events 字符串	允许客户端在发生某些事件时接收通知。有关更多详细信息，请参阅 https://docs.microsoft.com/zh-cn/azure/redis-cache/cache-configure#advanced-settings。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
public_network_access 字符串在 azure.azcollection 1.10.0 中添加	是否允许此缓存的公共终结点访问。选择 `"Enabled"` ← (默认) `"Disabled"`
reboot 字典	重新启动指定的 Redis 节点。可能会有潜在的数据丢失。
reboot_type 字符串	要重新启动的 Redis 节点。选择 `"primary"` `"secondary"` `"all"`
shard_id 字符串	如果启用了群集，则为要重新启动的分片的 ID。
redis_version 字符串在 azure.azcollection 1.10.0 中添加	Redis 的主要版本。选择 `"4"` `"6"` ← (默认)
regenerate_key 字典	重新生成 Redis 缓存的访问密钥。
key_type 字符串	要重新生成的 Redis 密钥。选择 `"primary"` `"secondary"`
resource_group 字符串 / 必填	资源所属的资源组的名称。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
shard_count 整数	当 sku=premium 时，要创建的分片数。
sku 字典 / 必填	Azure Redis 缓存的 SKU 信息。
name 字符串 / 必填	要部署的 Azure Redis 缓存的类型。选择 `"basic"` `"standard"` `"premium"`
size 字符串 / 必填	要部署的 Azure Redis 缓存的大小。当 sku=basic 或 sku=standard 时，允许的值为 `C0`, `C1`, `C2`, `C3`, `C4`, `C5`, `C6`。当 sku=premium 时，允许的值为 `P1`, `P2`, `P3`, `P4`。有关允许的值，请参阅 https://docs.microsoft.com/zh-cn/rest/api/redis/redis/create#sku。选择 `"C0"` `"C1"` `"C2"` `"C3"` `"C4"` `"C5"` `"C6"` `"P1"` `"P2"` `"P3"` `"P4"`
state 字符串	声明 Azure Redis 缓存的状态。使用 `present` 创建或更新 Azure Redis 缓存，使用 `absent` 删除它。选择 `"absent"` `"present"` ← (默认)
static_ip 字符串	静态 IP 地址。当在现有 Azure 虚拟网络内部署 Azure Redis 缓存时是必需的。
subnet 任意	要在其中部署 Azure Redis 缓存的虚拟网络中的子网。它可以是子网的资源 ID，例如 /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network\|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1。它可以是一个字典，其中包含 name、virtual_network_name 和 resource_group。 name。子网的名称。 resource_group。子网的资源组名称。 virtual_network_name。此子网所属的虚拟网络的名称。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串:字符串对的字典。对象的元数据标记将使用提供的任何值进行更新。要删除标签，请将 append_tags 选项设置为 false。目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
tenant_settings 字典	租户设置字典。
thumbprint 字符串在 azure.azcollection 1.14.0 中添加	在 x509_certificate_path 中指定的私钥的指纹。当使用服务主体进行身份验证时使用。如果定义了 x509_certificate_path，则为必需。
wait_for_provisioning 布尔值	等待 Azure Redis 缓存实例的 provisioning_state 为 Succeeded。在创建/更新/重新启动后，Azure Redis 缓存需要几分钟才能完成预配并准备好使用。将此选项设置为 `true` 以等待 provisioning_state。如果您不关心 provisioning_state，请设置为 `false`。轮询等待超时时间为 60 分钟。选择 `false` `true` ← (默认)
x509_certificate_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: Create an Azure Cache for Redis
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: basic
      size: C1

- name: Scale up the Azure Cache for Redis
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: standard
      size: C1
    tags:
      testing: foo

- name: Force reboot the redis cache
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedisCache
    reboot:
      reboot_type: all

- name: Create Azure Cache for Redis with subnet
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: premium
      size: P1
    subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirt
                ualNetwork/subnets/mySubnet"

- name: Regenerate primary Redis key
  azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    regenerate_key:
      key_type: primary

返回值 

通用返回值记录在这里，以下是此模块特有的字段

键	描述
host_name 字符串	Azure Redis 缓存的主机名。返回: 当 state=present 时示例: `"myredis.redis.cache.windows.net"`
id 字符串	Azure Redis 缓存的 ID。返回: 总是示例: `"/subscriptions/xxxxxxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis"`

作者

Yunge Zhu(@yungezz)