Share via

Tampilkan artefak definisi di Azure Managed Applications

  • Artikel

Menampilkan definisi adalah artefak opsional di Azure Managed Applications. Ini memungkinkan Anda untuk menyesuaikan halaman gambaran umum dan menambahkan lebih banyak tampilan seperti Metrik dan sumber daya Kustom.

Artikel ini menyediakan gambaran umum artefak definisi tampilan dan kemampuannya.

Lihat artefak definisi

Artefak definisi tampilan harus diberi nama viewDefinition.jsdan dan ditempatkan pada tingkat yang sama dengan createUiDefinition.json dan mainTemplate.json dalam paket .zip yang membuat definisi aplikasi terkelola. Untuk mempelajari cara membuat paket .zip dan menerbitkan definisi aplikasi terkelola, lihat Menerbitkan definisi Azure Managed Application

Lihat artefak definisi

File viewDefinition.json memiliki satu properti tingkat views atas, yang merupakan berbagai tampilan. Setiap tampilan ditampilkan di antarmuka pengguna aplikasi terkelola sebagai item menu terpisah dalam daftar isi. Setiap tampilan kind memiliki properti yang mengatur tipe tampilan. Ini harus diatur ke salah satu nilai berikut: Ikhtisar,Metrik,CustomResources,Asosiasi. Untuk informasi selengkapnya, lihat skema JSON saat ini viewDefinition.jsdi.

Contoh JSON untuk definisi tampilan:

{
  "$schema": "https://schema.management.azure.com/schemas/viewdefinition/0.0.1-preview/ViewDefinition.json#",
  "contentVersion": "0.0.0.1",
  "views": [
    {
      "kind": "Overview",
      "properties": {
        "header": "Welcome to your Azure Managed Application",
        "description": "This managed application is for demo purposes only.",
        "commands": [
          {
            "displayName": "Test Action",
            "path": "testAction"
          }
        ]
      }
    },
    {
      "kind": "Metrics",
      "properties": {
        "displayName": "This is my metrics view",
        "version": "1.0.0",
        "charts": [
          {
            "displayName": "Sample chart",
            "chartType": "Bar",
            "metrics": [
              {
                "name": "Availability",
                "aggregationType": "avg",
                "resourceTagFilter": [
                  "tag1"
                ],
                "resourceType": "Microsoft.Storage/storageAccounts",
                "namespace": "Microsoft.Storage/storageAccounts"
              }
            ]
          }
        ]
      }
    },
    {
      "kind": "CustomResources",
      "properties": {
        "displayName": "Test custom resource type",
        "version": "1.0.0",
        "resourceType": "testCustomResource",
        "createUIDefinition": {},
        "commands": [
          {
            "displayName": "Custom Context Action",
            "path": "testCustomResource/testContextAction",
            "icon": "Stop",
            "createUIDefinition": {}
          }
        ],
        "columns": [
          {
            "key": "name",
            "displayName": "Name"
          },
          {
            "key": "properties.myProperty1",
            "displayName": "Property 1"
          },
          {
            "key": "properties.myProperty2",
            "displayName": "Property 2",
            "optional": true
          }
        ]
      }
    },
    {
      "kind": "Associations",
      "properties": {
        "displayName": "Test association resource type",
        "version": "1.0.0",
        "targetResourceType": "Microsoft.Compute/virtualMachines",
        "createUIDefinition": {}
      }
    }
  ]
}

Gambaran Umum

"kind": "Overview"

Saat Anda menyediakan tampilan ini viewDefinition.json, tampilantersebut akan menggantikan halaman Gambaran Umum default di aplikasi terkelola Anda.

{
  "kind": "Overview",
  "properties": {
    "header": "Welcome to your Azure Managed Application",
    "description": "This managed application is for demo purposes only.",
    "commands": [
      {
        "displayName": "Test Action",
        "path": "testAction"
      }
    ]
  }
}
Properti Wajib Deskripsi
{i>header No Header halaman gambaran umum.
description No Penjabaran dari aplikasi terkelola Anda.
perintah No Array tombol bilah alat tambahan dari halaman gambaran umum, lihat perintah.

Cuplikan layar yang menunjukkan Ringkasan untuk aplikasi terkelola dengan kontrol Tindakan Pengujian untuk menjalankan aplikasi demo.

Metrik

"kind": "Metrics"

Tampilan metrik memungkinkan Anda mengumpulkan dan menggabungkan data dari sumber daya aplikasi terkelola Anda di Azure Monitor Metrics.

{
  "kind": "Metrics",
  "properties": {
    "displayName": "This is my metrics view",
    "version": "1.0.0",
    "charts": [
      {
        "displayName": "Sample chart",
        "chartType": "Bar",
        "metrics": [
          {
            "name": "Availability",
            "aggregationType": "avg",
            "resourceTagFilter": [
              "tag1"
            ],
            "resourceType": "Microsoft.Storage/storageAccounts",
            "namespace": "Microsoft.Storage/storageAccounts"
          }
        ]
      }
    ]
  }
}
Properti Wajib Deskripsi
displayName No Judul tampilan yang ditampilkan.
versi No Versi platform yang digunakan untuk merender tampilan.
Bagan Ya Array bagan halaman metrik.

Grafik

Properti Wajib Deskripsi
displayName Ya Judul tampilan yang ditampilkan.
chartType No Visualisasi yang digunakan untuk bagan ini. Secara default, ia menggunakan bagan garis. Tipe bagan yang didukung: Bar, Line, Area, Scatter.
Metrik Ya Array metrik yang akan diplot pada bagan ini. Untuk mempelajari selengkapnya tentang metrik yang didukung di portal Microsoft Azure, lihat Metrik yang didukung dengan Azure Monitor

Metric

Properti Wajib Deskripsi
nama Ya Nama metrik.
aggregationType Ya Tipe agregasi yang digunakan untuk metrik ini. Tipe agregasi yang didukung: none, sum, min, max, avg, unique, percentile, count
namespace No Informasi tambahan yang digunakan saat menentukan penyedia metrik yang benar.
sumber dayaTagFilter No Array tag sumber daya (akan dipisahkan dengan or kata) di mana metrik akan ditampilkan. Berlaku di atas filter tipe sumber daya.
resourceType Ya Tipe sumber daya yang metriknya akan ditampilkan.

Cuplikan layar yang menunjukkan halaman Pemantauan yang disebut Ini tampilan metrik saya untuk aplikasi terkelola.

Sumber daya kustom

"kind": "CustomResources"

Anda dapat menentukan beberapa tampilan tipe ini. Setiap tampilan mewakili tipe sumber daya kustom unik dari penyedia kustom yang Anda tetapkan mainTemplate.json. Untuk pengenalan penyedia kustom, lihat Gambaran umum Pratinjau Penyedia Kustom Azure.

Dalam tampilan ini Anda dapat melakukan operasi GET, PUT, DELETE, dan POST untuk jenis sumber daya kustom Anda. Operasi POST bisa menjadi tindakan kustom global atau tindakan kustom dalam konteks jenis sumber daya kustom Anda.

{
  "kind": "CustomResources",
  "properties": {
    "displayName": "Test custom resource type",
    "version": "1.0.0",
    "resourceType": "testCustomResource",
    "icon": "Polychromatic.ResourceList",
    "createUIDefinition": {},
    "commands": [
      {
        "displayName": "Custom Context Action",
        "path": "testCustomResource/testContextAction",
        "icon": "Stop",
        "createUIDefinition": {},
      }
    ],
    "columns": [
      {
        "key": "name",
        "displayName": "Name"
      },
      {
        "key": "properties.myProperty1",
        "displayName": "Property 1"
      },
      {
        "key": "properties.myProperty2",
        "displayName": "Property 2",
        "optional": true
      }
    ]
  }
}
Properti Wajib Deskripsi
displayName Ya Judul tampilan yang ditampilkan. Judul harus unik untuk setiap tampilan CustomResources di viewDefinition.json.
versi No Versi platform yang digunakan untuk merender tampilan.
resourceType Ya Tipe sumber daya kustom. Harus merupakan tipe sumber daya kustom yang unik dari penyedia kustom Anda.
ikon No Ikon tampilan. Daftar contoh ikon didefinisikan dalam JSON Schema.
Masalah CreateUIDefinition.json No Buat skema Definisi UI untuk membuat perintah sumber daya kustom. Untuk pengantar mengenai cara membuat definisi UI, lihat Mulai menggunakan CreateUiDefinition
perintah No Array tombol bilah alat tambahan dari tampilan CustomResources, lihat perintah.
columns No Array kolom sumber daya kustom. Jika tidak name ditentukan, kolom akan ditampilkan secara default. Kolom harus memiliki "key" dan "displayName". Untuk kunci, sediakan kunci properti untuk ditampilkan dalam tampilan. Jika ditumpuk, gunakan titik sebagai pembatas, misalnya, "key": "name" atau "key": "properties.property1". Untuk kunci, sediakan kunci properti untuk ditampilkan dalam tampilan. Anda juga dapat menyediakan "optional" properti. Saat diatur ke true, kolom disembunyikan dalam tampilan secara default.

Cuplikan layar yang menunjukkan halaman Sumber Daya yang disebut Uji jenis sumber daya kustom dan kontrol Tindakan Konteks Kustom.

Perintah

Properti commands adalah array tombol bilah alat tambahan yang ditampilkan di halaman. Setiap perintah mewakili tindakan POST dari Penyedia Kustom Azure Anda yang didefinisikan mainTemplate.json. Untuk pengenalan penyedia kustom, lihat Gambaran umum Pratinjau Penyedia Kustom Azure.

{
  "commands": [
    {
      "displayName": "Start Test Action",
      "path": "testAction",
      "icon": "Start",
      "createUIDefinition": {}
    },
  ]
}
Properti Wajib Deskripsi
displayName Ya Nama tombol perintah yang ditampilkan.
jalan Ya Nama tindakan penyedia harus kustom. Tindakan harus didefinisikan dalam mainTemplate.json.

Tidak menerima nilai dinamis seperti URI yang merupakan output dari mainTemplate.json.
ikon No Ikon tombol perintah. Daftar contoh ikon didefinisikan dalam JSON Schema.
Masalah CreateUIDefinition.json No Buat skema Definisi UI untuk perintah. Untuk pengantar mengenai cara membuat definisi antarmuka pengguna, lihat Mulai menggunakan CreateUiDefinition.

Asosiasi

"kind": "Associations"

Anda dapat menentukan beberapa tampilan tipe ini. Tampilan ini memungkinkan Anda untuk menautkan sumber daya yang ada ke aplikasi terkelola melalui penyedia kustom yang Anda mainTemplate.json. Untuk pengenalan penyedia kustom, lihat Gambaran umum Pratinjau Penyedia Kustom Azure.

Dalam tampilan ini, Anda dapat memperluas sumber daya Azure yang sudah ada berdasarkan targetResourceType. Ketika sumber daya dipilih, sumber daya akan membuat permintaan orientasi ke penyedia kustom publik, yang dapat menerapkan efek samping ke sumber daya.

{
  "kind": "Associations",
  "properties": {
    "displayName": "Test association resource type",
    "version": "1.0.0",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "createUIDefinition": {}
  }
}
Properti Wajib Deskripsi
displayName Ya Judul tampilan yang ditampilkan. Judul harus unik untuk setiap tampilan CustomResources di viewDefinition.json.
versi No Versi platform yang digunakan untuk merender tampilan.
targetResourceType Ya Jenis sumber daya target. Jenis sumber daya ini akan ditampilkan untuk onboarding sumber daya.
Masalah CreateUIDefinition.json No Buat skema Definisi UI untuk membuat perintah sumber daya kustom. Untuk pengantar mengenai cara membuat definisi UI, lihat Mulai menggunakan CreateUiDefinition

Cari bantuan

Jika Anda memiliki pertanyaan tentang Azure Managed Applications, coba tanyakan di Stack Overflow. Pertanyaan serupa mungkin sudah dijawab, jadi periksa terlebih dulu sebelum memposting. Tambahkan tag azure-managed-app untuk mendapatkan respons cepat!

Langkah berikutnya