Azure Yönetilen Uygulamaları'nda tanım yapıtlarını görüntüleme

Makale
06/01/2023

Görünüm tanımı, Azure Yönetilen Uygulamalar'da isteğe bağlı bir yapıttır. Genel bakış sayfasını özelleştirmenize ve Ölçümler ve Özel kaynaklar gibi daha fazla görünüm eklemenize olanak tanır.

Bu makalede görünüm tanımı yapıtına ve özelliklerine genel bir bakış sağlanır.

Tanım yapıtını görüntüleme

Görünüm tanımı yapıtı viewDefinition.json olarak adlandırılmalı ve yönetilen uygulama tanımı oluşturan .zip paketinde createUiDefinition.json ve mainTemplate.json ile aynı düzeyde yerleştirilmelidir. .zip paketini oluşturmayı ve yönetilen uygulama tanımını yayımlamayı öğrenmek için bkz. Azure Yönetilen Uygulama tanımı yayımlama

Tanım şemasını görüntüleme

viewDefinition.json dosyasının yalnızca bir üst düzey views özelliği vardır ve bu da bir görünüm dizisidir. Her görünüm, yönetilen uygulama kullanıcı arabiriminde içindekiler tablosunda ayrı bir menü öğesi olarak gösterilir. Her görünümün, görünümün türünü ayarlayan bir kind özelliği vardır. Şu değerlerden birine ayarlanmalıdır: Genel Bakış, Ölçümler, CustomResources, İlişkilendirmeler. Daha fazla bilgi için bkz. viewDefinition.json için geçerli JSON şeması.

Görünüm tanımı için örnek JSON:

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

Genel Bakış

"kind": "Overview"

Bu görünümü viewDefinition.json dosyasında sağladığınızda, yönetilen uygulamanızdaki varsayılan Genel Bakış sayfasını geçersiz kılar.

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

Özellik	Gerekli	Açıklama
üst bilgi	No	Genel bakış sayfasının üst bilgisi.
açıklama	No	Yönetilen uygulamanızın açıklaması.
komutlar	No	Genel bakış sayfasının diğer araç çubuğu düğmeleri dizisi, bkz. komutlar.

Bir tanıtım uygulamasını çalıştırmak için Test Eylemi denetimine sahip yönetilen bir uygulamaya Genel Bakış'ı gösteren ekran görüntüsü.

Ölçümler

"kind": "Metrics"

Ölçümler görünümü, Azure İzleyici Ölçümleri'nde yönetilen uygulama kaynaklarınızdan veri toplamanızı ve toplamanızı sağlar.

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

Özellik	Gerekli	Açıklama
displayName	No	Görünümün görüntülenen başlığı.
sürüm	No	Görünümü işlemek için kullanılan platformun sürümü.
charts	Yes	Ölçüm sayfasının grafik dizisi.

Grafik

Özellik	Gerekli	Açıklama
displayName	Yes	Grafiğin görüntülenen başlığı.
chartType	No	Bu grafik için kullanılacak görselleştirme. Varsayılan olarak çizgi grafik kullanır. Desteklenen grafik türleri: `Bar, Line, Area, Scatter`.
metrics	Yes	Bu grafikte çizecek ölçüm dizisi. Azure portal desteklenen ölçümler hakkında daha fazla bilgi edinmek için bkz. Azure İzleyici ile desteklenen ölçümler

Ölçüm

Özellik	Gerekli	Açıklama
name	Yes	Ölçümün adı.
Aggregationtype	Yes	Bu ölçüm için kullanılacak toplama türü. Desteklenen toplama türleri: `none, sum, min, max, avg, unique, percentile, count`
ad alanı	No	Doğru ölçüm sağlayıcısını belirlerken kullanılacak daha fazla bilgi.
resourceTagFilter	No	Ölçümlerin görüntüleneceği kaynak etiketleri dizisi (sözcükle `or` ayrılacaktır). Kaynak türü filtresinin üzerine uygulanır.
resourceType	Yes	Ölçümlerin görüntüleneceği kaynak türü.

Yönetilen bir uygulama için Ölçümler görünümüm adlı İzleme sayfasını gösteren ekran görüntüsü.

Özel kaynaklar

"kind": "CustomResources"

Bu tür birden çok görünüm tanımlayabilirsiniz. Her görünüm mainTemplate.json dosyasında tanımladığınız özel sağlayıcıdan benzersiz bir özel kaynak türünü temsil eder. Özel sağlayıcılara giriş için bkz. Azure Özel Sağlayıcılar Önizlemesine genel bakış.

Bu görünümde, özel kaynak türünüz için GET, PUT, DELETE ve POST işlemleri gerçekleştirebilirsiniz. POST işlemleri, özel kaynak türünüz bağlamında genel özel eylemler veya özel eylemler olabilir.

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

Özellik	Gerekli	Açıklama
displayName	Yes	Görünümün görüntülenen başlığı. Başlık, viewDefinition.json içindeki her CustomResources görünümü için benzersiz olmalıdır.
sürüm	No	Görünümü işlemek için kullanılan platformun sürümü.
resourceType	Yes	Özel kaynak türü. Özel sağlayıcınızın benzersiz bir özel kaynak türü olmalıdır.
Simge	No	Görünümün simgesi. Örnek simgelerin listesi JSON Şeması'nda tanımlanır.
createUIDefinition	No	Özel kaynak oluşturma komutu için UI Tanımı şeması oluşturma. Ui tanımları oluşturmaya giriş için bkz . CreateUiDefinition ile çalışmaya başlama
komutlar	No	CustomResources görünümünün diğer araç çubuğu düğmeleri dizisi, bkz. komutlar.
sütunlar	No	Özel kaynağın sütun dizisi. Tanımlanmadıysa `name` sütun varsayılan olarak gösterilir. Sütunda ve `"displayName"`olmalıdır`"key"`. anahtar için, bir görünümde görüntülenecek özelliğin anahtarını sağlayın. İç içe yerleştirilmişse, sınırlayıcı olarak nokta kullanın, örneğin, `"key": "name"` veya `"key": "properties.property1"`. Görünen ad için, bir görünümde görüntülenecek özelliğin görünen adını belirtin. Ayrıca bir `"optional"` özellik de sağlayabilirsiniz. True olarak ayarlandığında sütun varsayılan olarak bir görünümde gizlenir.

Özel kaynak türünü test et adlı Kaynaklar sayfasını ve Denetim Özel Bağlam Eylemi'ni gösteren ekran görüntüsü.

Komutlar

commands özelliği, sayfada görüntülenen daha fazla araç çubuğu düğmesi dizisidir. Her komut , mainTemplate.json dosyasında tanımlanan Azure Özel Sağlayıcınızdan bir POST eylemini temsil eder. Özel sağlayıcılara giriş için bkz. Azure Özel Sağlayıcılarına genel bakış.

{
  "commands": [
    {
      "displayName": "Start Test Action",
      "path": "testAction",
      "icon": "Start",
      "createUIDefinition": {}
    },
  ]
}

Özellik	Gerekli	Açıklama
displayName	Yes	Komut düğmesinin görüntülenen adı.
path	Yes	Özel bir sağlayıcı eylem adı olmalıdır. Eylem mainTemplate.json dosyasında tanımlanmalıdır. mainTemplate.json dosyasından alınan URI gibi dinamik değerleri kabul etmez.
Simge	No	Komut düğmesinin simgesi. Örnek simgelerin listesi JSON Şeması'nda tanımlanır.
createUIDefinition	No	komutu için UI Tanımı şeması oluşturun. Ui tanımları oluşturmaya giriş için bkz . CreateUiDefinition ile çalışmaya başlama.

Dernek

"kind": "Associations"

Bu tür birden çok görünüm tanımlayabilirsiniz. Bu görünüm , mainTemplate.json dosyasında tanımladığınız özel sağlayıcı aracılığıyla mevcut kaynakları yönetilen uygulamaya bağlamanızı sağlar. Özel sağlayıcılara giriş için bkz. Azure Özel Sağlayıcılar Önizlemesine genel bakış.

Bu görünümde, mevcut Azure kaynaklarını temel targetResourceTypealarak genişletebilirsiniz. Bir kaynak seçildiğinde, genel özel sağlayıcıya bir ekleme isteği oluşturur ve bu istek kaynağa bir yan etki uygulayabilir.

{
  "kind": "Associations",
  "properties": {
    "displayName": "Test association resource type",
    "version": "1.0.0",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "createUIDefinition": {}
  }
}

Özellik	Gerekli	Açıklama
displayName	Yes	Görünümün görüntülenen başlığı. Başlık, viewDefinition.json dosyasındaki her İlişkilendirme görünümü için benzersiz olmalıdır.
sürüm	No	Görünümü işlemek için kullanılan platformun sürümü.
targetResourceType	Yes	Hedef kaynak türü. Bu kaynak türü, kaynak ekleme için görüntülenir.
createUIDefinition	No	İlişkilendirme kaynağı oluştur komutu için UI Tanımı şeması oluşturun. Ui tanımları oluşturmaya giriş için bkz . CreateUiDefinition ile çalışmaya başlama

Yardım arama

Azure Yönetilen Uygulamalar hakkında sorularınız varsa Stack Overflow'da sormayı deneyin. Benzer bir soru zaten sorulmuş ve yanıtlanmış olabilir, bu nedenle göndermeden önce kontrol edin. Hızlı yanıt almak için etiketini azure-managed-app ekleyin!

Sonraki adımlar

Yönetilen uygulamalara giriş için Azure Yönetilen Uygulamalara genel bakış konusunu inceleyin.
Özel sağlayıcılara giriş için bkz. Azure Özel Sağlayıcılarına genel bakış.
Azure Özel Sağlayıcıları ile Azure Yönetilen Uygulaması oluşturmak için bkz . Öğretici: Özel sağlayıcı eylemleri ve kaynak türleriyle yönetilen uygulama oluşturma