azure.azcollection.azure_rm_webappslot 模块 – 管理 Azure Web 应用槽位

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要 

创建、更新和删除 Azure Web 应用槽位。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 中模块的主机上
完整的安装说明可在 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"`
app_settings 字典	配置 Web 应用槽位的应用程序设置。子选项采用键值对格式。
app_state 字符串	启动/停止/重启槽位。选项 `"started"` ← (默认) `"stopped"` `"restarted"`
append_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"`
auto_swap_slot_name 任意	用于配置目标槽位名称以自动交换或禁用自动交换。将其设置为目标槽位名称以进行自动交换。将其设置为 False 以禁用自动槽位交换。
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` 环境变量设置。
云环境字符串 azure.azcollection 0.0.1 中新增	对于美国公有云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 `AzureChinaCloud`、`AzureUSGovernment`）或元数据发现端点 URL（Azure Stack 需要）。也可以通过凭据文件配置文件或 `AZURE_CLOUD_ENVIRONMENT` 环境变量设置。默认值： `"AzureCloud"`
配置源字符串	创建槽位时从中克隆配置的源槽位。使用 webapp 的名称来引用生产槽位。
容器设置字典	Web 应用槽位容器设置。
名称字符串 / 必填	容器名称，例如 `imagename:tag`。
注册表服务器密码字符串	容器注册表服务器密码。
注册表服务器 URL 字符串	容器注册表服务器 URL，例如 `mydockerregistry.io`。
注册表服务器用户名字符串	容器注册表服务器用户名。
部署源字典	Git 的部署源。
分支字符串	存储库的分支名称。
URL 字符串	部署源的存储库 URL。
禁用实例发现布尔值在 azure.azcollection 2.3.0 中添加	确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 True 将禁用权限的验证。因此，务必确保已配置的权限主机有效且值得信赖。通过凭据文件配置文件或 `AZURE_DISABLE_INSTANCE_DISCOVERY` 环境变量设置。选项 `false` ← (默认) `true`
框架列表 / 元素=字典	运行时框架设置集。每个设置都是一个字典。有关详细信息，请参阅 https://docs.microsoft.com/en-us/azure/app-service/app-service-web-overview。
名称字符串 / 必填	框架的名称。 Windows Web 应用和 Linux Web 应用支持的框架列表不同。从 2018 年 6 月起，Windows Web 应用支持 `java`、`net_framework`、`php`、`python` 和 `node`。 Windows Web 应用同时支持多个框架。从 2018 年 6 月起，Linux Web 应用支持 `java`、`ruby`、`php`、`dotnetcore` 和 `node`。 Linux Web 应用仅支持一个框架。 Java 框架与其他框架互斥。选项 `"java"` `"net_framework"` `"php"` `"python"` `"ruby"` `"dotnetcore"` `"node"`
设置字典	框架设置列表。
Java 容器字符串 / 必填	Java 容器的名称。仅特定框架 `java` 支持，例如 `Tomcat`、`Jetty`。
Java 容器版本字符串 / 必填	Java 容器的版本。仅特定框架 `java` 支持。对于 `Tomcat`，例如 `8.0`、`8.5`、`9.0`。对于 `Jetty`，例如 `9.1`、`9.3`。
版本字符串 / 必填	框架的版本。有关 Linux Web 应用支持的值，请参阅 https://aka.ms/linux-stacks 以了解更多信息。 `net_framework` 支持的值示例：`v4.0` 用于 .NET 4.6，`v3.0` 用于 .NET 3.5。 `php` 支持的值示例：`5.5`、`5.6`、`7.0`。 `python` 支持的值示例：`5.5`、`5.6`、`7.0`。 `node` 支持的值示例：`6.6`、`6.9`。 `dotnetcore` 支持的值示例：`1.0`、`1.1`、`1.2`。 `ruby` 支持的值示例：2.3。 `java` 支持的值示例：Windows Web 应用为 `1.9`，Linux Web 应用为 `1.8`。
位置字符串	资源位置。如果未设置，则使用资源组中的位置作为默认值。
日志模式字符串	父参数。
日志路径字符串	父参数。
名称字符串 / 必填	要创建或更新的部署槽位的唯一名称。
密码字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
配置文件字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
清除应用设置布尔值	清除任何现有的应用程序设置。用 app_settings 替换槽位应用程序设置。选项 `false` ← (默认) `true`
资源组字符串 / 必填	资源所属的资源组的名称。
密钥字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
启动文件字符串	槽位启动文件。这仅适用于 Linux Web 应用槽位。
状态字符串	Web 应用部署槽位的状态。使用 `present` 创建或更新槽位，使用 `absent` 删除槽位。选项 `"absent"` `"present"` ← (默认)
订阅 ID 字符串	您的 Azure 订阅 ID。
交换字典	交换 Web 应用的部署槽位。
操作字符串	交换类型。 `preview` 是先将目标槽位设置应用于源槽位。 `swap` 是完成交换。 `reset` 是重置交换。选项 `"preview"` ← (默认) `"swap"` `"reset"`
保留虚拟网络布尔值	`True` 表示在交换期间将虚拟网络保留到槽位。否则为 `False`。选项 `false` `true` ← (默认)
目标槽位字符串	要交换的目标槽位的名称。如果设置为 None，则与生产槽位交换。
标签字典	要作为元数据分配给对象的字符串：字符串对的字典。对象的元数据标签将使用任何提供的值进行更新。要删除标签，请将 append_tags 选项设置为 false。目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。
租户字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
指纹字符串在 azure.azcollection 1.14.0 中添加	在 x509_certificate_path 中指定的私钥的指纹。使用服务主体进行身份验证时使用。如果定义了 x509_certificate_path，则需要此参数。
Web 应用名称字符串 / 必填	此部署槽位所属的 Web 应用名称。
x509 证书路径路径在 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: Create a webapp slot
  azure_rm_webappslot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    configuration_source: myJavaWebApp
    app_settings:
      testkey: testvalue

- name: swap the slot with production slot
  azure_rm_webappslot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    swap:
      action: swap

- name: stop the slot
  azure_rm_webappslot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    app_state: stopped

- name: udpate a webapp slot app settings
  azure_rm_webappslot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    app_settings:
      testkey: testvalue2

- name: udpate a webapp slot frameworks
  azure_rm_webappslot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    frameworks:
      - name: "node"
        version: "10.1"

返回值 

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

键	描述
id 字符串	当前槽位的ID。返回值：始终返回示例：`"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/testapp/slots/stage1"`

作者

朱韵歌(@yungezz)