azure.azcollection.azure_rm_functionapp 模块 – 管理 Azure 函数应用

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

• 创建、更新或删除 Azure 函数应用。

要求

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

• 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 字典	包含应用程序设置的字典。
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（如果资源被授予访问多个订阅的权限），否则将选择第一个订阅。 Ansible 2.6 中添加了 msi。 选项 "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"
container_settings 字典	Web 应用容器设置。
名称 字符串 / 必需	容器的名称。例如 “imagename:tag”。
registry_server_password 字符串	容器注册服务器密码。
registry_server_url 字符串	容器注册服务器 URL。例如 mydockerregistry.io。
registry_server_user 字符串	容器注册服务器用户名。
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定在尝试身份验证时是否执行实例发现。 将此设置为 true 将完全禁用实例发现和授权验证。 此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。 实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。 通过将此设置为 **True**，将禁用授权验证。 因此，至关重要的是确保配置的授权主机有效且可信。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ←（默认） true
identity 字典	对象的标识
type 字符串	托管标识的类型 选项 "SystemAssigned" "UserAssigned" "SystemAssigned, UserAssigned" "None" ←（默认）
user_assigned_identities 字典	用户分配的托管标识及其选项 默认值： {}
append 布尔值	如果标识列表必须附加到当前标识 (true)，或者必须替换当前标识 (false) 选项 false true ←（默认）
id 列表 / 元素=字符串	与对象关联的用户分配的标识 ID 列表 默认值： []
location 字符串	有效的 Azure 位置。 默认为资源组的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
名称 字符串 / 必需	Azure 函数应用的名称。
password 字符串	Active Directory 用户密码。 使用 Active Directory 用户而不是服务主体进行身份验证时使用。
plan 任何	应用服务计划。 它可以是与函数应用位于同一资源组中的现有应用服务计划的名称。 它可以是现有应用服务计划的资源 ID。 资源 ID。例如 /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>。 它可以是一个包含 name 和 resource_group 的字典。 name。应用服务计划的名称。 resource_group。应用服务计划的资源组名称。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 别名：resource_group_name 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端密钥。 使用服务主体进行身份验证时使用。
state 字符串	断言函数应用的状态。使用 present 创建或更新函数应用，使用 absent 删除。 选项 "absent" "present" ←（默认）
storage_account 别名：storage，storage_account_name 字符串	要使用的存储帐户的名称。 创建时需要。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要分配为对象元数据的字符串：字符串对的字典。 将使用提供的任何值更新对象上的元数据标记。 要删除标记，请将 append_tags 选项设置为 false。 当前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。 Azure 前门不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标记。
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 中的配置文件，或者在运行任务或手册之前使用 az login 登录。

• 也可以使用服务主体或 Active Directory 用户进行身份验证。

• 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或者设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

• 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和密码，或者在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

• 或者，凭据可以存储在 ~/.azure/credentials 中。 这是一个 ini 文件，其中包含 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和密码。 也可以添加其他配置文件。 通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Create a function app
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    storage_account: myStorageAccount

- name: Create a function app with app settings
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    storage_account: myStorageAccount
    app_settings:
      setting1: value1
      setting2: value2

- name: Create container based function app
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    storage_account: myStorageAccount
    plan:
      resource_group: myResourceGroup
      name: myAppPlan
    container_settings:
      name: httpd
      registry_server_url: index.docker.io

- name: Delete a function app
  azure_rm_functionapp:
    resource_group: myResourceGroup
    name: myFunctionApp
    state: absent

返回值

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

键

描述

state 字典

Azure 函数应用的当前状态。 返回：成功 示例： {"availability_state": "Normal", "client_affinity_enabled": true, "client_cert_enabled": false, "container_size": 1536, "daily_memory_time_quota": 0, "default_host_name": "myfunctionapp.azurewebsites.net", "enabled": true, "enabled_host_names": ["myfunctionapp.azurewebsites.net", "myfunctionapp.scm.azurewebsites.net"], "host_name_ssl_states": [{"host_type": "Standard", "name": "myfunctionapp.azurewebsites.net", "ssl_state": "Disabled"}, {"host_type": "Repository", "name": "myfunctionapp.scm.azurewebsites.net", "ssl_state": "Disabled"}], "host_names": ["myfunctionapp.azurewebsites.net"], "host_names_disabled": false, "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myFunctionApp", "kind": "functionapp", "last_modified_time_utc": "2017-08-22T18:54:01.190Z", "location": "East US", "name": "myfunctionapp", "outbound_ip_addresses": "............", "repository_site_name": "myfunctionapp", "reserved": false, "resource_group": "myResourceGroup", "scm_site_also_stopped": false, "server_farm_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/EastUSPlan", "state": "Running", "type": "Microsoft.Web/sites", "usage_state": "Normal"}

作者

• Thomas Stringer (@trstringer)

集合链接

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