Azure yönetilen uygulamalarında tanım yapıtı görüntüleme

  • Makale
  • Okumak için 5 dakika

Görünüm tanımı, Azure yönetilen uygulamalarında isteğe bağlı bir yapıdır. Genel Bakış sayfasını özelleştirmeye ve ölçümler ve özel kaynaklar gibi daha fazla görünüm eklemenize olanak tanır.

Bu makale, görünüm tanımı yapıtı ve özelliklerine genel bir bakış sağlar.

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

Görünüm tanımı yapıtı viewDefinition.js olarak adlandırılmalıdır ve bir yönetilen uygulama tanımı oluşturan. zip paketindeki mainTemplate.js ve üzerinde createUiDefinition.js aynı düzeye yerleştirilmelidir. . Zip paketini oluşturma ve yönetilen uygulama tanımını yayımlama hakkında bilgi edinmek için bkz. Azure yönetilen uygulama tanımı yayımlama

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

viewDefinition.jsdosyadaki , bir görünüm dizisi olan yalnızca bir top Level views özelliğine sahiptir. 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, kind görünümün türünü ayarlayan bir özelliğe sahiptir. Şu değerlerden birine ayarlanmalıdır: genel bakış, ölçümler, customresources, ilişkilendirmeler. Daha fazla bilgi için bkz. viewDefinition.jsiç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ü üzerindeviewDefinition.js sağladığınızda, yönetilen uygulamanızda 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 ek araç çubuğu düğmelerinin dizisi, bkz. Komutlar.

Ekran görüntüsü, bir demo uygulamasını çalıştırmak için test eylemi denetimi olan bir yönetilen uygulamanın genel görünümünü gösterir.

Ölçümler

"kind": "Metrics"

Ölçüm görünümü, Azure Izleyici ölçümlerindeyönetilen uygulama kaynaklarınızdan veri toplamanıza ve bunları 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ülenmiş başlığı.
sürüm No Görünümü işlemek için kullanılan platformun sürümü.
charts Yes Ölçümler sayfasının grafik dizisi.

Grafik

Özellik Gerekli Açıklama
displayName Yes Grafiğin görüntülenmekte olan başlığı.
chartType No Bu grafik için kullanılacak görselleştirme. Varsayılan olarak, bir çizgi grafik kullanır. Desteklenen grafik türleri: Bar, Line, Area, Scatter .
metrics Yes Bu grafiğe çizilecek ölçüm dizisi. Azure portal desteklenen ölçümler hakkında daha fazla bilgi edinmek için bkz. Azure izleyici Ile desteklenen ölçümler

Metric

Özellik Gerekli Açıklama
name Yes Ölçümün adı.
Toplamatürü 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ı belirlenirken kullanılacak ek bilgiler.
resourceTagFilter No Ölçümlerin gösterileceği kaynak etiketleri dizisi (Word ile ayrılacaktır or ). Kaynak türü filtresinin üzerine uygulanır.
resourceType Yes Ölçümlerin gösterileceği kaynak türü.

Ekran görüntüsü, yönetilen bir uygulama için ölçüm görünümmy bu adlı bir Izleme sayfasını gösterir.

Özel kaynaklar

"kind": "CustomResources"

Bu türde birden çok görünüm tanımlayabilirsiniz. Her görünüm, üzerindemainTemplate.js 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 önizlemeye genel bakış.

Bu görünümde, özel kaynak türü için al, koy, SIL ve POST işlemleri gerçekleştirebilirsiniz. POST işlemleri genel özel eylemler veya özel eylemler özel kaynak türü bağlamında 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ülenmiş başlığı. Başlık, üzerindeviewDefinition.js 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ılarınızın benzersiz bir özel kaynak türü olması gerekir.
simg No Görünümün simgesi. Örnek simgelerin listesi JSON şemasındatanımlanmıştır.
createUIDefinition No Özel kaynak Oluştur komutu için UI tanımı şeması oluşturun. UI tanımları oluşturmaya giriş için bkz. Createuıdefinition ile çalışmaya başlama
komutlar No CustomResources görünümündeki ek araç çubuğu düğmelerinin dizisi, bkz. Komutlar.
sütunlar No Özel kaynağın sütun dizisi. Tanımlanmamışsa, name sütun varsayılan olarak gösterilir. Sütun "key" ve içermelidir "displayName" . Anahtar için, bir görünümde görüntülenecek özelliğin anahtarını sağlayın. İç içe ise, veya gibi nokta sınırlayıcı olarak kullanın "key": "name" "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ı sağlayın. Bir özellik de sağlayabilirsiniz "optional" . True olarak ayarlandığında, sütun varsayılan olarak bir görünümde gizlenir.

Ekran görüntüsü, test özel kaynak türü ve denetim özel bağlam eylemi adlı bir kaynak sayfasını gösterir.

Komutlar

Komutlar, sayfada görüntülenen ek araç çubuğu düğmelerinin bir dizisidir. Her komut, mainTemplate.jsüzerinde 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ünen adı.
path Yes Özel sağlayıcı eylem adı. Eylem üzerindemainTemplate.js tanımlanmış olmalıdır.
simg No Komut düğmesinin simgesi. Örnek simgelerin listesi JSON şemasındatanımlanmıştır.
createUIDefinition No Komut için UI tanımı şeması oluştur. UI tanımları oluşturmaya giriş için bkz. Createuıdefinition ile çalışmaya başlama.

İçermektedir

"kind": "Associations"

Bu türde birden çok görünüm tanımlayabilirsiniz. Bu görünüm, mainTemplate.jsüzerinde tanımladığınız özel sağlayıcı aracılığıyla mevcut kaynakları yönetilen uygulamaya bağlayabilmeniz için izin verir. Özel sağlayıcılara giriş için bkz. Azure özel sağlayıcılar önizlemeye genel bakış.

Bu görünümde, mevcut Azure kaynaklarını öğesine göre genişletebilirsiniz targetResourceType . Bir kaynak seçildiğinde, genel özel sağlayıcıya bir ekleme isteği oluşturur ve bu, 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ülenmiş başlığı. Başlık, üzerindeviewDefinition.js her iliş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 ekleme için görüntülenecek kaynak türüdür.
createUIDefinition No İlişki kaynağı oluşturma komutu için UI tanımı şeması oluşturun. UI tanımları oluşturmaya giriş için bkz. Createuıdefinition ile çalışmaya başlama

Yardım aranıyor

Azure yönetilen uygulamalar hakkında sorularınız varsa Stack Overflowyapmayı deneyin. Benzer bir soru zaten istendi ve yanıtlamış olabilir, bu nedenle göndermeden önce kontrol edin. azure-managedappsHızlı bir yanıt almak için etiketi ekleyin!

Sonraki adımlar