チュートリアル:カスタムアクションおよびリソースを備えたマネージドアプリケーションを作成する

[アーティクル]
06/01/2023

このチュートリアルでは、カスタムアクションおよびリソースを備えた独自のマネージドアプリケーションを作成します。このマネージドアプリケーションは、Overview ページ上でのカスタムアクション、Table of Content 内で独立したメニュー項目として表示されるカスタムのリソースの種類、カスタムリソースページ上のカスタムコンテキストアクションを備えたものになります。

このチュートリアルに含まれる手順は次のとおりです。

マネージドアプリケーションインスタンスを作成するためのユーザーインターフェイス定義ファイルを作成する
Azure カスタムプロバイダー、Azure ストレージアカウント、Azure 関数を指定したデプロイテンプレートを作成する
カスタムアクションとリソースを指定したビュー定義アーティファクトを作成する
マネージドアプリケーションの定義をデプロイする
マネージドアプリケーションのインスタンスをデプロイする
カスタムアクションを実行し、カスタムリソースを作成する

前提条件

このチュートリアルを完了するには、以下に関する知識が必要です。

ユーザーインターフェイスの定義

このチュートリアルでは、マネージドアプリケーションを作成します。アプリケーションのマネージドリソースグループには、カスタムプロバイダーインスタンス、ストレージアカウント、関数を含めます。この例で使用する Azure 関数は、アクションとリソースに関するカスタムプロバイダーの操作を処理する 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 Managed Applications のビュー定義アーティファクト」を参照してください。

このチュートリアルでは、次のものを定義します。

基本的な入力テキストを使ってカスタムアクション TestAction を表したツールバーボタンを備えた [概要] ページ。
カスタムのリソースの種類 users を表示する [ユーザー] ページ。
種類が users のカスタムリソースのコンテキストで実行される、 [ユーザー] ページ内のカスタムリソースアクション users/contextAction。

次の例は、[概要] ページのビュー構成を示したものです。

{
    "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"
      }]
    }
  }

以下の例には、カスタムリソースアクションを備えた [ユーザー] リソースページの構成が含まれています。

{
    "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 portal で手順に従って、サービスカタログマネージドアプリケーションの定義をデプロイします。

このサンプルを実行するには、最新バージョンの Azure CLI をインストールします。開始するには、az login を実行して、Azure との接続を作成します。

Azure CLI のサンプルは、bash シェル用に記述されています。このサンプルを 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 portal で手順に従って、カスタムプロバイダーを備えたマネージドアプリケーションインスタンスをデプロイします。

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\"}}"

カスタムアクションとリソース

サービスカタログアプリケーションインスタンスをデプロイした後には、2 つの新しいリソースグループが作成されています。 1 つめのリソースグループ applicationGroup にはマネージドアプリケーションのインスタンスが含まれます。2 つめのリソースグループ managedResourceGroup は、そのマネージドアプリケーションのためのリソース (カスタムプロバイダーなど) を保持するものです。

Application resource groups

マネージドアプリケーションインスタンスに移動すると、[概要] ページではカスタムアクションの実行、[ユーザー] ページでは users カスタムリソースの作成、カスタムリソースではカスタムコンテキストアクションの実行ができます。

[概要] ページに移動し、[Ping Action](Ping アクション) ボタンをクリックします。

Perform custom action

[ユーザー] ページに移動し、[追加] ボタンをクリックします。リソースを作成するための入力を指定し、フォームを送信します。

Screenshot shows the Add button selected from Users.

[ユーザー] ページに移動し、"users" リソースを選択して [Custom Context Action](カスタムコンテキストアクション) をクリックします。

Screenshot shows Custom Context Action selected.

リソースをクリーンアップする

前の手順では、リソースグループ内に Azure リソースを作成しました。これらのリソースが将来必要になると思わない場合は、リソースグループを削除してリソースを削除できます。

Azure portal メニューまたは [ホーム] ページから、 [リソースグループ] を選択します。次に、 [リソースグループ] ページで [myResourceGroup] を選択します。

[myResourceGroup] ページで、一覧表示されたリソースが、削除しようとするリソースであることを確認します。

[リソースグループの削除] を選択し、確認のためテキストボックスに「myResourceGroup」と入力して、 [削除] を選択します。

ヘルプを探しています

Azure Managed Applications に関して不明な点がある場合には、azure-managed-app というタグを使用して Stack Overflow で質問するか、azure-managed-application というタグを使用して Microsoft Q&A で質問してみてください。同様の質問が既に質問され回答されているため、投稿する前にまず確認してください。回答が得られるまでの時間を短縮するために、それぞれのタグを使用してください。

次のステップ

マネージドアプリケーションを Microsoft Azure Marketplace に発行するには、「Marketplace の Azure マネージドアプリケーション」を参照してください。

Azure カスタムプロバイダーについて学習します。

チュートリアル:カスタム アクションおよびリソースを備えたマネージド アプリケーションを作成する

前提条件

ユーザー インターフェイスの定義

カスタム プロバイダーを指定したテンプレート