azure.azcollection.azure_rm_webappslot 模块 – 管理 Azure Web App 插槽

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

• 创建、更新和删除 Azure Web App 插槽。

要求

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

• 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"
app_settings 字典	配置 Web 应用程序插槽应用程序设置。子选项采用键值对格式。
app_state 字符串	启动/停止/重新启动插槽。 选项 "started" ← （默认） "stopped" "restarted"
append_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 环境变量设置。
cloud_environment 字符串 在 azure.azcollection 0.0.1 中添加	对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如，AzureChinaCloud、AzureUSGovernment）或元数据发现端点 URL（Azure Stack 所必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
configuration_source 字符串	在创建插槽时从中克隆配置的源插槽。使用 Web 应用程序的名称来引用生产插槽。
container_settings 字典	Web 应用程序插槽容器设置。
name 字符串 / 必填	容器名称，例如 镜像名称:标签。
registry_server_password 字符串	容器注册服务器密码。
registry_server_url 字符串	容器注册服务器 URL，例如 mydockerregistry.io。
registry_server_user 字符串	容器注册服务器用户名。
deployment_source 字典	Git 的部署源。
branch 字符串	存储库的分支名称。
url 字符串	部署源的存储库 URL。
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情景，例如私有云或 Azure Stack。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此项设置为 **True**，将禁用授权的验证。因此，确保配置的授权主机有效且值得信任至关重要。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← (默认) true
frameworks 列表 / 元素=字典	运行时框架设置的集合。每个设置都是一个字典。 有关更多信息，请参见 https://docs.microsoft.com/en-us/azure/app-service/app-service-web-overview。
name 字符串 / 必填	框架的名称。 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"
settings 字典	框架的设置列表。
java_container 字符串 / 必填	Java 容器的名称。这仅受特定框架 java 支持，例如 Tomcat、Jetty。
java_container_version 字符串 / 必填	Java 容器的版本。这仅受特定框架 java 支持。 对于 Tomcat，例如 8.0、8.5、9.0。对于 Jetty，例如 9.1、9.3。
version 字符串 / 必填	框架的版本。对于 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。
location 字符串	资源位置。如果未设置，将使用资源组的位置作为默认值。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必填	要创建或更新的部署槽的唯一名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
purge_app_settings 布尔值	清除任何现有的应用程序设置。使用 app_settings 替换槽的应用程序设置。 选项 false ← (默认) true
resource_group 字符串 / 必填	资源所属的资源组的名称。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
startup_file 字符串	槽的启动文件。 这仅适用于 Linux Web 应用槽。
state 字符串	Web 应用部署槽的状态。 使用 present 创建或更新槽，使用 absent 删除槽。 选项 "absent" "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
swap 字典	交换 Web 应用的部署槽。
action 字符串	交换类型。 preview 是首先在源槽上应用目标槽设置。 swap 是完成交换。 reset 是重置交换。 选项 "preview" ← (默认) "swap" "reset"
preserve_vnet 布尔值	True 在交换期间将虚拟网络保留到槽。否则为 False。 选项 false true ← （默认）
target_slot 字符串	要交换的目标槽的名称。如果设置为 None，则与生产槽交换。
tags 字典	要作为元数据分配给对象的字符串:字符串对的字典。 对象的元数据标记将使用任何提供的值进行更新。 要删除标记，请将 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，则为必需项。
webapp_name 字符串 / 必填	此部署槽所属的 Web 应用名称。
x509_certificate_path path 在 azure.azcollection 1.14.0 中添加	用于以 PEM 格式创建服务主体的 X509 证书的路径。 证书必须附加到私钥。 当使用服务主体进行身份验证时使用。

注意

注意

• 对于使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或 Ansible 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: 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"

作者

• Yunge Zhu(@yungezz)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）