Sdílet prostřednictvím


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"
      }
    ]
  }
}
Vlastnost Požadováno Popis
header No Záhlaví stránky přehledu
description No Popis spravované aplikace.
commands No Pole dalších tlačítek panelu nástrojů na stránce přehledu najdete v příkazech.

Snímek obrazovky znázorňující přehled spravované aplikace s ovládacím prvku Testovací akce pro spuštění ukázkové aplikace

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"
          }
        ]
      }
    ]
  }
}
Vlastnost Požadováno Popis
displayName No Zobrazený název zobrazení.
version No Verze platformy, která se používá k vykreslení zobrazení.
charts Ano Pole grafů stránky metrik.

Graf

Vlastnost Požadováno Popis
displayName Ano Zobrazený název grafu.
chartType No Vizualizace, která se má použít pro tento graf. Ve výchozím nastavení používá spojnicový graf. Podporované typy grafů: Bar, Line, Area, Scatter.
metrics Ano Pole metrik, které se mají v grafu vykreslit. Další informace o metrikách podporovaných na webu Azure Portal najdete v tématu Podporované metriky ve službě Azure Monitor.

Metrika

Vlastnost Požadováno Popis
name Ano Název metriky
aggregationType Ano Typ agregace, který se má použít pro tuto metriku. Podporované typy agregace: none, sum, min, max, avg, unique, percentile, count
namespace No Další informace, které se mají použít při určování správného poskytovatele metrik.
resourceTagFilter No Pole značek prostředků je oddělené slovem or , pro které se budou zobrazovat metriky. Platí pro filtr typů prostředků.
resourceType Ano Typ prostředku, pro který se zobrazí metriky.

Snímek obrazovky ukazuje stránku Monitorování s názvem Toto je zobrazení metrik pro spravovanou aplikaci.

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
      }
    ]
  }
}
Vlastnost Požadováno Popis
displayName Ano Zobrazený název zobrazení. Název by měl být jedinečný pro každé zobrazení CustomResources ve vašem viewDefinition.json.
version No Verze platformy, která se používá k vykreslení zobrazení.
resourceType Ano Vlastní typ prostředku. Musí to být jedinečný vlastní typ prostředku vašeho vlastního poskytovatele.
icon No Ikona zobrazení Seznamukázkových
createUIDefinition No Vytvoření schématu definice uživatelského rozhraní pro příkaz vytvořit vlastní prostředek Úvod k vytváření definic uživatelského rozhraní najdete v tématu Začínáme s CreateUiDefinition.
commands No Pole dalších tlačítek panelu nástrojů zobrazení CustomResources viz příkazy.
columns No Pole sloupců vlastního prostředku. Pokud není definovaný name sloupec, zobrazí se ve výchozím nastavení. Sloupec musí obsahovat "key" a "displayName". Pro klíč zadejte klíč vlastnosti, která se má zobrazit v zobrazení. Pokud je vnořený, použijte tečku jako oddělovač, například "key": "name" nebo "key": "properties.property1". Pro zobrazovaný název zadejte zobrazovaný název vlastnosti, která se má zobrazit v zobrazení. Můžete také zadat "optional" vlastnost. Pokud je nastavená hodnota true, sloupec je ve výchozím nastavení skrytý v zobrazení.

Snímek obrazovky se stránkou Zdroje s názvem Testovat vlastní typ prostředku a akcí vlastního kontextu ovládacího prvku

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": {}
    },
  ]
}
Vlastnost Požadováno Popis
displayName Ano Zobrazovaný název příkazového tlačítka.
path Ano Musí to být vlastní název akce poskytovatele. Akce musí být definována v mainTemplate.json.

Nepřijímá dynamické hodnoty, jako je identifikátor URI, který je výstupem z mainTemplate.json.
icon No Ikona příkazového tlačítka Seznamukázkových
createUIDefinition No Vytvoření schématu definice uživatelského rozhraní pro příkaz Úvod k vytváření definic uživatelského rozhraní najdete v tématu Začínáme s 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": {}
  }
}
Vlastnost Požadováno Popis
displayName Ano Zobrazený název zobrazení. Název by měl být jedinečný pro každé zobrazení přidružení ve vašem viewDefinition.json.
version No Verze platformy, která se používá k vykreslení zobrazení.
targetResourceType Ano Typ cílového prostředku. Tento typ prostředku se zobrazí pro onboarding prostředků.
createUIDefinition No Vytvoření schématu definice uživatelského rozhraní pro příkaz create association resource Úvod k vytváření definic uživatelského rozhraní najdete v tématu Začínáme s 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