你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

教程：创建包含自定义操作和资源的托管应用程序

项目
06/26/2024

在本教程中，你将创建自己的包含自定义操作和资源的托管应用程序。该托管应用程序在 Overview 页上包含一个自定义操作、在 Table of Content 中包含一个显示为独立菜单项的自定义资源类型，并在自定义资源页上包含一个自定义上下文操作。

本教程包括以下步骤：

创作用于创建托管应用程序实例的用户界面定义文件
使用 Azure 自定义提供程序、Azure 存储帐户和 Azure Functions 创作部署模板
创作包含自定义操作和资源的视图定义项目
部署托管应用程序定义
部署托管应用程序的实例
执行自定义操作并创建自定义资源

先决条件

若要完成本教程，需要知道：

用户界面定义

在本教程中，你将创建一个托管应用程序，其受管理资源组包含自定义提供程序实例、存储帐户和函数。本示例中使用的 Azure 函数实现了一个 API，该 API 可以处理用于执行操作和创建资源的自定义提供程序操作。 Azure 存储帐户用作自定义提供程序资源的基本存储。

用于创建托管应用程序实例的用户界面定义包括 funcname 和 storagename 输入元素。存储帐户名称和函数名称必须全局唯一。默认情况下，会从示例函数包部署函数文件，但你可以通过以下方式更改此部署方式：为 createUiDefinition.json 中的包链接添加一个输入元素：

{
  "name": "funcname",
  "type": "Microsoft.Common.TextBox",
  "label": "Name of the function to be created",
  "toolTip": "Name of the function to be created",
  "visible": true,
  "constraints": {
    "required": true
  }
},
{
  "name": "storagename",
  "type": "Microsoft.Common.TextBox",
  "label": "Name of the storage to be created",
  "toolTip": "Name of the storage to be created",
  "visible": true,
  "constraints": {
    "required": true
  }
},
{
  "name": "zipFileBlobUri",
  "type": "Microsoft.Common.TextBox",
  "defaultValue": "https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.customproviders/custom-rp-with-function/artifacts/functionzip/functionpackage.zip",
  "label": "The Uri to the uploaded function zip file",
  "toolTip": "The Uri to the uploaded function zip file",
  "visible": true
}

并在 createUiDefinition.json 中添加一个输出元素：

"funcname": "[steps('applicationSettings').funcname]",
"storageName": "[steps('applicationSettings').storagename]",
"zipFileBlobUri": "[steps('applicationSettings').zipFileBlobUri]"

完整的 createUiDefinition.json 示例可在参考：用户界面元素项目中找到。

带有自定义提供程序的模板

若要使用自定义提供程序创建托管应用程序实例，需要在 mainTemplate.json 中使用名称 public 和类型 Microsoft.CustomProviders/resourceProviders 定义自定义提供程序资源。在该资源中，定义服务的资源类型和操作。若要部署 Azure 函数和 Azure 存储帐户实例，请分别定义 Microsoft.Web/sites 和 Microsoft.Storage/storageAccounts 类型的资源。

在本教程中，你将创建一个 users 资源类型、ping 自定义操作，以及在 users 自定义资源的上下文中执行的 users/contextAction 自定义操作。对于每个资源类型和操作，请提供一个终结点，该终结点指向名称为 createUiDefinition.json 中所提供名称的函数。将资源类型的 routingType 指定为 Proxy,Cache，将操作的指定为 Proxy：

{
  "apiVersion": "[variables('customrpApiversion')]",
  "type": "Microsoft.CustomProviders/resourceProviders",
  "name": "[variables('customProviderName')]",
  "location": "[parameters('location')]",
  "properties": {
    "actions": [
      {
        "name": "ping",
        "routingType": "Proxy",
        "endpoint": "[listSecrets(resourceId('Microsoft.Web/sites/functions', parameters('funcname'), 'HttpTrigger1'), '2018-02-01').trigger_url]"
      },
      {
        "name": "users/contextAction",
        "routingType": "Proxy",
        "endpoint": "[listSecrets(resourceId('Microsoft.Web/sites/functions', parameters('funcname'), 'HttpTrigger1'), '2018-02-01').trigger_url]"
      }
    ],
    "resourceTypes": [
      {
        "name": "users",
        "routingType": "Proxy,Cache",
        "endpoint": "[listSecrets(resourceId('Microsoft.Web/sites/functions', parameters('funcname'), 'HttpTrigger1'), '2018-02-01').trigger_url]"
      }
    ]
  },
  "dependsOn": [
    "[concat('Microsoft.Web/sites/',parameters('funcname'))]"
  ]
}

完整的 mainTemplate.json 示例可在参考：部署模板项目中找到。

视图定义项目

若要在托管应用程序中定义包含自定义操作和自定义资源的用户界面，需要创作 viewDefinition.json 项目。有关视图定义项目的详细信息，请参阅 Azure 托管应用程序中的视图定义项目。

在本教程中，你将定义：

一个带有工具栏按钮“概述”页，该按钮代表使用基本文本输入的自定义操作 TestAction。
一个代表自定义资源类型 users 的“用户”页。
“用户”页中的一个自定义资源操作 users/contextAction，该操作将在类型为 users 的自定义资源的上下文中执行。

以下示例显示了“概述”页的视图配置：

{
  "kind": "Overview",
  "properties": {
    "header": "Welcome to your Demo Azure Managed Application",
    "description": "This Managed application with Custom Provider is for demo purposes only.",
    "commands": [
      {
        "displayName": "Ping Action",
        "path": "/customping",
        "icon": "LaunchCurrent"
      }
    ]
  }
}

以下示例包含具有自定义资源操作的“Users”资源页配置：

{
  "kind": "CustomResources",
  "properties": {
    "displayName": "Users",
    "version": "1.0.0.0",
    "resourceType": "users",
    "createUIDefinition": {},
    "commands": [
      {
        "displayName": "Custom Context Action",
        "path": "users/contextAction",
        "icon": "Start"
      }
    ],
    "columns": [
      {
        "key": "properties.FullName",
        "displayName": "Full Name"
      },
      {
        "key": "properties.Location",
        "displayName": "Location",
        "optional": true
      }
    ]
  }
}

完整的 viewDefinition.json 示例可在参考：视图定义项目中找到。

托管应用程序定义

将以下托管应用程序项目打包为 zip 存档，并将其上传到存储：

createUiDefinition.json
mainTemplate.json
viewDefinition.json

所有文件必须位于根级别。包含项目的包可以存储在任何存储中，例如 GitHub Blob 或 Azure 存储帐户 Blob。下面是用于将应用程序包上传到存储帐户的脚本：

$resourceGroup="appResourcesGroup"
$storageName="mystorageaccount$RANDOM"

# Sign in to your Azure subscription
Connect-AzAccount
# Create resource group for managed application definition and application package
New-AzResourceGroup -Name $resourceGroup -Location eastus

# Create storage account for a package with application artifacts
$storageAccount=New-AzStorageAccount `
  -ResourceGroupName $resourceGroup `
  -Name $storageName `
  -SkuName Standard_LRS `
  -Location eastus `
$ctx=$storageAccount.Context

# Create storage container and upload zip to blob
New-AzStorageContainer -Name appcontainer -Context $ctx -Permission blob
Set-AzStorageBlobContent `
  -File "path_to_your_zip_package" `
  -Container appcontainer `
  -Blob app.zip `
  -Context $ctx

# Get blob absolute uri
$blobUri=(Get-AzureStorageBlob -Container appcontainer -Blob app.zip -Context $ctx).ICloudBlob.uri.AbsoluteUri

运行以下 Azure CLI 脚本，或遵循 Azure 门户中的步骤部署服务目录托管应用程序定义：

若要运行此示例，请安装最新版本的 Azure CLI。若要开始，请运行 az login 以创建与 Azure 的连接。

适用于 Azure CLI 的示例是针对 bash shell 编写的。若要在 Windows PowerShell 或命令提示符中运行此示例，可能需要更改脚本的元素。

Azure CLI
门户

resourceGroup="appResourcesGroup"
# Select subscription and create resource group (if you have not created yet)
az account set --subscription <subscriptionID>
az group create --name $resourceGroup --location eastus

# Get object ID of your identity
userid=$(az ad user list --upn example@contoso.org --query [0].id --output tsv)
# Get role definition ID for the Owner role
roleid=$(az role definition list --name Owner --query [].name --output tsv)

# Create managed application definition resource
az managedapp definition create \
  --name "ManagedUsersAppDefinition" \
  --location "eastus" \
  --resource-group $resourceGroup \
  --lock-level ReadOnly \
  --display-name "Managed users app definition" \
  --description "Managed application with Azure Custom Provider" \
  --authorizations "$userid:$roleid" \
  --package-file-uri "path to your app.zip package"

托管应用程序实例

部署托管应用程序定义时，请运行以下脚本，或遵循 Azure 门户中的步骤，使用自定义提供程序来部署托管应用程序实例：

Azure CLI
门户

appResourcesGroup="appResourcesGroup"
applicationGroup="usersApplicationGroup"

# Create resource group for managed application instance
az group create --name $applicationGroup --location eastus

# Get ID of managed application definition
appid=$(az managedapp definition show --name ManagedUsersAppDefinition --resource-group $appResourcesGroup --query id --output tsv)

# Create the managed application
az managedapp create \
  --name ManagedUsersApp \
  --location "eastus" \
  --kind "Servicecatalog" \
  --resource-group $applicationGroup \
  --managedapp-definition-id $appid \
  --managed-rg-id "managedResourcesGroup" \
  --parameters "{\"funcname\": {\"value\": \"managedusersappfunction\"}, \"storageName\": {\"value\": \"managedusersappstorage\"}}"