azure.azcollection.azure_rm_backupazurevm 模块 – 使用 Azure 备份备份 Azure 虚拟机

注意

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

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

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

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

azure.azcollection 1.1.0 中的新增功能

概要 

使用 Azure 备份备份 Azure VM。
启用/更新 Azure VM 的保护。
为受保护的 Azure VM 触发按需备份。
停止保护但保留现有数据。
停止保护并删除数据。

要求 

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

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 (如果存在多个订阅 ID)，否则将使用默认的 az cli 订阅。当设置为 `msi` 时，主机必须是启用了 MSI 扩展的 Azure 资源。`subscription_id` 或环境变量 `AZURE_SUBSCRIPTION_ID` 可用于标识订阅 ID (如果资源被授予访问多个订阅的权限)，否则将选择第一个订阅。 `msi` 是在 Ansible 2.6 中添加的。选项 `"auto"` ← (默认) `"cli"` `"credential_file"` `"env"` `"msi"`
backup_policy_id 字符串 / 必需	在 recovery_vault_name 字段中提到的恢复服务保管库下的备份策略 ID。
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 字符串	父参数。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
recovery_point_expiry_time 字符串在 azure.azcollection 1.15.0 中添加	UTC 中的恢复点过期时间。如果 `state` 参数为 `backup`，则使用此参数。
recovery_vault_name 字符串 / 必需	Azure 恢复服务保管库的名称。
resource_group 字符串 / 必需	资源组的名称。
resource_id 字符串 / 必需	Azure 虚拟机资源 ID。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
state 字符串	断言保护项的状态。使用 `create` 为 Azure VM 启用保护。使用 `update` 更改保护策略。使用 `stop` 停止保护但保留现有数据。使用 `delete` 停止保护并删除数据。使用 `backup` 进行按需备份。选项 `"create"` ← (默认) `"update"` `"delete"` `"stop"` `"backup"`
subscription_id 字符串	您的 Azure 订阅 ID。
tags dictionary	要作为元数据分配给对象的 string:string 对的字典。对象上的元数据标签将使用任何提供的值进行更新。要删除标签，请将 append_tags 选项设置为 false。目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。
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 中的配置文件，或者在运行任务或 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 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅 

另请参阅

使用 Azure CLI 登录: 如何使用 az login 命令进行身份验证。

示例 

- name: Enabling/Updating protection for the Azure VM
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/     resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    backup_policy_id: '/subscriptions/00000000-0000-0000-0000-000000000000/     resourceGroups/myResourceGroup/providers/microsoft.recoveryservices/vaults/testVault/backupPolicies/ProdPolicy'
    state: 'create'
- name: Stop protection but retain existing data
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/     resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    state: 'stop'
- name: Stop protection and delete data
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/                   resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    state: 'delete'
- name: Trigger an on-demand backup for a protected Azure VM
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/                   resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    backup_policy_id: '/subscriptions/00000000-0000-0000-0000-000000000000/                        resourceGroups/myResourceGroup/providers/microsoft.recoveryservices/vaults/testVault/backupPolicies/ProdPolicy'
    recovery_point_expiry_time: '2023-02-09T06:00:00Z'
    state: 'backup'

返回值 

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

键	描述
id 字符串	VM 备份保护详细信息。返回：始终示例： `"{\"response\":{\"id\":\"protection_id\",\"name\":\"protection_item_name\",\"properties\":{}}}"`

作者

Suyeb Ansari (@suyeb786)
Pallavi Chaudhari (@PallaviC2510)