Definícióösszetevő megtekintése az Azure Managed Applicationsben

Cikk
06/25/2024

A nézetdefiníció nem kötelező összetevő az Azure Managed Applicationsben. Lehetővé teszi az áttekintési oldal testreszabását, és további nézetek, például metrikák és egyéni erőforrások hozzáadását.

Ez a cikk áttekintést nyújt a nézetdefiníció összetevőjéről és képességeiről.

Meghatározás megtekintése összetevő

A nézetdefiníció összetevőjének viewDefinition.json kell lennie, és a felügyelt alkalmazásdefiníciót létrehozó .zip csomag createUiDefinition.json és mainTemplate.json szintjén kell elhelyezni. A .zip csomag létrehozásának és a felügyelt alkalmazásdefiníció közzétételének módjáról a rövid útmutatóban olvashat: Azure Managed Application-definíció létrehozása és közzététele

Definíciós séma megtekintése

A viewDefinition.json fájlnak csak egy legfelső szintű views tulajdonsága van, amely nézetek tömbje. A felügyelt alkalmazás felhasználói felületén minden nézet külön menüelemként jelenik meg a tartalomjegyzékben. Minden nézethez tartozik egy kind tulajdonság, amely beállítja a nézet típusát. A következő értékek egyikére kell beállítani: Áttekintés, Metrikák, CustomResources, Társítások. További információ: viewDefinition.json aktuális JSON-sémája.

Minta JSON a nézetdefinícióhoz:

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

Áttekintés

"kind": "Overview"

Ha ezt a nézetet viewDefinition.json adja meg, az felülírja a felügyelt alkalmazás alapértelmezett Áttekintés lapját.

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

Tulajdonság	Kötelező	Leírás
`header`	Nem	Az áttekintési oldal fejléce.
`description`	Nem	A felügyelt alkalmazás leírása.
`commands`	Nem	Az áttekintési oldal további eszköztárgombjainak tömbje, lásd a parancsokat.

Képernyőkép egy felügyelt alkalmazás áttekintéséről egy tesztművelet-vezérlővel egy bemutató alkalmazás futtatásához.

Mérőszámok

"kind": "Metrics"

A metrikák nézet lehetővé teszi, hogy adatokat gyűjtsön és összesítsen a felügyelt alkalmazás erőforrásaiból az Azure Monitor Metricsben.

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

Tulajdonság	Kötelező	Leírás
`displayName`	Nem	A nézet megjelenített címe.
`version`	Nem	A nézet megjelenítéséhez használt platform verziója.
`charts`	Igen	A metrikák lap diagramjainak tömbje.

Diagram

Tulajdonság	Kötelező	Leírás
`displayName`	Igen	A diagram megjelenített címe.
`chartType`	Nem	A diagramhoz használandó vizualizáció. Alapértelmezés szerint vonaldiagramot használ. Támogatott diagramtípusok: `Bar, Line, Area, Scatter`.
`metrics`	Igen	A diagramon ábrázolni kívánt metrikák tömbje. Az Azure Portalon támogatott metrikákkal kapcsolatos további információkért lásd : Támogatott metrikák az Azure Monitorral.

Metrika

Tulajdonság	Kötelező	Leírás
`name`	Igen	A metrika neve.
`aggregationType`	Igen	A metrikához használandó összesítési típus. Támogatott összesítési típusok: `none, sum, min, max, avg, unique, percentile, count`
`namespace`	Nem	További információ a megfelelő metrikák szolgáltatójának meghatározásakor.
`resourceTagFilter`	Nem	Az erőforráscímkék tömbje egy `or` olyan szóval van elválasztva, amelynek metrikái megjelennek. Az erőforrástípus-szűrőre vonatkozik.
`resourceType`	Igen	Az az erőforrástípus, amelynél a metrikák megjelennek.

Képernyőkép egy Felügyelt alkalmazás metrikanézete nevű monitorozási oldalról.

Egyéni erőforrások

"kind": "CustomResources"

Ehhez a típushoz több nézet is megadható. Minden nézet egy egyedi egyéni erőforrástípust jelöl a mainTemplate.json definiált egyéni szolgáltatótól. Az egyéni szolgáltatókról az Azure Custom Providers előzetes verziójának áttekintésében olvashat.

Ebben a nézetben get, PUT, DELETE és POST műveleteket hajthat végre az egyéni erőforrástípushoz. A POST-műveletek lehetnek globális egyéni műveletek vagy egyéni műveletek az egyéni erőforrástípus kontextusában.

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

Tulajdonság	Kötelező	Leírás
`displayName`	Igen	A nézet megjelenített címe. A címnek egyedinek kell lennie a viewDefinition.json minden CustomResources nézetéhez.
`version`	Nem	A nézet megjelenítéséhez használt platform verziója.
`resourceType`	Igen	Az egyéni erőforrástípus. Az egyéni szolgáltató egyedi egyéni erőforrástípusának kell lennie.
`icon`	Nem	A nézet ikonja. A példaikonok listája a JSON-sémában van definiálva.
`createUIDefinition`	Nem	Felhasználói felület definíciós sémájának létrehozása egyéni erőforrásparancs létrehozásához. A felhasználói felületi definíciók létrehozásának bemutatása: A CreateUiDefinition használatának első lépései.
`commands`	Nem	A CustomResources nézet további eszköztárgombjainak tömbje, lásd a parancsokat.
`columns`	Nem	Az egyéni erőforrás oszlopainak tömbje. Ha nincs definiálva, az `name` oszlop alapértelmezés szerint megjelenik. Az oszlopnak rendelkeznie `"key"` kell és `"displayName"`. Kulcs esetén adja meg a tulajdonság nézetben megjelenítendő kulcsát. Ha beágyazott, használjon pontelválasztót, például `"key": "name"` `"key": "properties.property1"`. Megjelenítendő névként adja meg a nézetben megjelenítendő tulajdonság megjelenítendő nevét. Tulajdonságot `"optional"` is megadhat. Ha igaz értékre van állítva, az oszlop alapértelmezés szerint rejtett a nézetben.

Képernyőkép az Egyéni erőforrástípus tesztelése és a vezérlő Egyéni környezet művelete nevű Erőforrások lapról.

Parancsok

A commands tulajdonság az oldalon megjelenő eszköztárgombok tömbje. Minden parancs egy POST-műveletet jelöl a mainTemplate.json definiált Azure Custom Providerből. Az egyéni szolgáltatókról az Azure Custom Providers áttekintésében olvashat.

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

Tulajdonság	Kötelező	Leírás
`displayName`	Igen	A parancsgomb megjelenített neve.
`path`	Igen	Egyéni szolgáltatói műveletnévnek kell lennie. A műveletet mainTemplate.json kell definiálni. Nem fogad el olyan dinamikus értékeket, mint az URI, amely mainTemplate.json kimenete.
`icon`	Nem	A parancsgomb ikonja. A példaikonok listája a JSON-sémában van definiálva.
`createUIDefinition`	Nem	Hozzon létre felhasználói felületi definíciós sémát a parancshoz. A felhasználói felületi definíciók létrehozásának bemutatása: A CreateUiDefinition használatának első lépései.

Egyesületek

"kind": "Associations"

Ehhez a típushoz több nézet is megadható. Ez a nézet lehetővé teszi, hogy meglévő erőforrásokat csatoljon a felügyelt alkalmazáshoz a mainTemplate.json definiált egyéni szolgáltatón keresztül. Az egyéni szolgáltatókról az Azure Custom Providers előzetes verziójának áttekintésében olvashat.

Ebben a nézetben a meglévő Azure-erőforrásokat targetResourceTypea . Amikor kijelöl egy erőforrást, létrehoz egy előkészítési kérelmet a nyilvános egyéni szolgáltatóhoz, amely hatással lehet az erőforrásra.

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

Tulajdonság	Kötelező	Leírás
`displayName`	Igen	A nézet megjelenített címe. A címnek egyedinek kell lennie a viewDefinition.json minden Társítás nézethez.
`version`	Nem	A nézet megjelenítéséhez használt platform verziója.
`targetResourceType`	Igen	A célerőforrás típusa. Ez az erőforrástípus megjelenik az erőforrás-előkészítéshez.
`createUIDefinition`	Nem	Felhasználói felület definíciós sémájának létrehozása társítási erőforrásparancs létrehozásához. A felhasználói felületi definíciók létrehozásának bemutatása: A CreateUiDefinition használatának első lépései.

Segítségre van szüksége

Ha kérdései vannak, vagy választ szeretne adni az Azure Managed Applications szolgáltatásról, próbálja meg megkérdezni a Stack Overflow-t. Kérdés közzétételekor használja a címkét azure-managed-app .

Következő lépések

A felügyelt alkalmazásokra vonatkozó részleteket az Azure felügyelt alkalmazásokat áttekintő cikk ismerteti.
Az egyéni szolgáltatókról az Azure Custom Providers áttekintésében olvashat.
Felügyelt Azure-alkalmazás azure-beli egyéni szolgáltatókkal való létrehozásáról lásd : Oktatóanyag: Felügyelt alkalmazás létrehozása egyéni szolgáltatói műveletekkel és erőforrástípusokkal

Megosztás a következőn keresztül: