Zobrazení artefaktu definice ve spravovaných aplikacích Azure

Definice zobrazení je volitelný artefakt ve spravovaných aplikacích Azure. Umožňuje přizpůsobit stránku přehledu a přidat další zobrazení, jako jsou metriky a vlastní prostředky.

Tento článek obsahuje přehled artefaktu definice zobrazení a jeho možností.

Zobrazení definičních artefaktů

Artefakt definice zobrazení musí mít název viewDefinition.json a musí být umístěn na stejné úrovni jako createUiDefinition.json a mainTemplate.json v balíčku .zip , který vytvoří definici spravované aplikace. Informace o vytvoření balíčku .zip a publikování definice spravované aplikace najdete v tématu Rychlý start: Vytvoření a publikování definice spravované aplikace Azure

Zobrazení schématu definice

Soubor viewDefinition.json má pouze jednu vlastnost nejvyšší úrovně views , což je pole zobrazení. Každé zobrazení se zobrazí v uživatelském rozhraní spravované aplikace jako samostatná položka nabídky v obsahu. Každé zobrazení má kind vlastnost, která nastavuje typ zobrazení. Musí být nastavená na jednu z následujících hodnot: Přehled, Metriky, CustomResources, Přidružení. Další informace najdete v aktuálním schématu JSON pro viewDefinition.json.

Ukázkový JSON pro definici zobrazení:

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

Přehled

"kind": "Overview"

Když toto zobrazení zadáte v viewDefinition.json, přepíše výchozí stránku Přehled ve spravované aplikaci.

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

Metriky

"kind": "Metrics"

Zobrazení metrik umožňuje shromažďovat a agregovat data z prostředků spravovaných aplikací v metrikách služby Azure Monitor.

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

Graf

Metrika

Vlastní prostředky

"kind": "CustomResources"

Můžete definovat více zobrazení tohoto typu. Každé zobrazení představuje jedinečný vlastní typ prostředku od vlastního poskytovatele, který jste definovali v mainTemplate.json. Úvod k vlastním poskytovatelům najdete v přehledu Azure Custom Providers Preview.

V tomto zobrazení můžete pro vlastní typ prostředku provádět operace GET, PUT, DELETE a POST. Operace POST můžou být globální vlastní akce nebo vlastní akce v kontextu vašeho vlastního typu prostředku.

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

Příkazy

Vlastnost commands je pole dalších tlačítek panelu nástrojů, které jsou zobrazeny na stránce. Každý příkaz představuje akci POST od vlastního zprostředkovatele Azure definovaného v mainTemplate.json. Úvod k vlastním poskytovatelům najdete v přehledu vlastních poskytovatelů Azure.

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

Sdružení

"kind": "Associations"

Můžete definovat více zobrazení tohoto typu. Toto zobrazení umožňuje propojit existující prostředky se spravovanou aplikací prostřednictvím vlastního poskytovatele, který jste definovali v mainTemplate.json. Úvod k vlastním poskytovatelům najdete v přehledu Azure Custom Providers Preview.

V tomto zobrazení můžete rozšířit existující prostředky Azure na základě tohoto targetResourceType. Když je prostředek vybraný, vytvoří žádost o onboarding veřejnému vlastnímu poskytovateli, který může u prostředku použít vedlejší efekt.

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

Hledáte nápovědu

Pokud máte dotazy nebo potřebujete odpověď na spravované aplikace Azure, zkuste se zeptat na Stack Overflow. Značku azure-managed-app použijte, když publikujete otázku.

Další kroky

• Úvod ke spravovaným aplikacím najdete v přehledu spravovaných aplikací Azure.
• Úvod k vlastním poskytovatelům najdete v přehledu vlastních poskytovatelů Azure.
• Pokud chcete vytvořit spravovanou aplikaci Azure s vlastními poskytovateli Azure, přečtěte si kurz : Vytvoření spravované aplikace s vlastními akcemi poskytovatele a typy prostředků.