Visa definitionsartefakt i Azure Managed Applications

Artikel
06/24/2024

Vydefinition är en valfri artefakt i Azure Managed Applications. Det gör att du kan anpassa översiktssidan och lägga till fler vyer, till exempel mått och anpassade resurser.

Den här artikeln innehåller en översikt över artefakten för vydefinition och dess funktioner.

Visa definitionsartefakt

Artefakten för vydefinitionen måste namnges viewDefinition.json och placeras på samma nivå som createUiDefinition.json och mainTemplate.json i det .zip paket som skapar en definition för ett hanterat program. Information om hur du skapar .zip-paketet och publicerar en definition för hanterat program finns i Snabbstart: Skapa och publicera en Azure Managed Application-definition

Visa definitionsschema

Filen viewDefinition.json har bara en egenskap på den översta nivån views , vilket är en matris med vyer. Varje vy visas i användargränssnittet för det hanterade programmet som ett separat menyalternativ i innehållsförteckningen. Varje vy har en kind egenskap som anger typ av vy. Det måste anges till något av följande värden: Översikt, Mått, CustomResources, Associationer . Mer information finns i aktuellt JSON-schema för viewDefinition.json.

Exempel på JSON för vydefinition:

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

Översikt

"kind": "Overview"

När du anger den här vyn i viewDefinition.json åsidosätter den standardsidan Översikt i ditt hanterade program.

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

Property	Obligatoriskt	Beskrivning
`header`	Nej	Rubriken på översiktssidan.
`description`	Nej	Beskrivningen av ditt hanterade program.
`commands`	Nej	Matrisen med fler verktygsfältsknappar på översiktssidan finns i kommandon.

Skärmbild som visar översikten för ett hanterat program med en teståtgärdskontroll för att köra ett demoprogram.

Mått

"kind": "Metrics"

Med måttvyn kan du samla in och aggregera data från dina hanterade programresurser i Azure Monitor Metrics.

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

Property	Obligatoriskt	Beskrivning
`displayName`	Nej	Visningsrubriken för vyn.
`version`	Nej	Den version av plattformen som används för att återge vyn.
`charts`	Ja	Matrisen med diagram på måttsidan.

Diagram

Property	Obligatoriskt	Beskrivning
`displayName`	Ja	Diagrammets rubrik visas.
`chartType`	Nej	Visualiseringen som ska användas för det här diagrammet. Som standard används ett linjediagram. Diagramtyper som stöds: `Bar, Line, Area, Scatter`.
`metrics`	Ja	Matrisen med mått som ska ritas i det här diagrammet. Mer information om mått som stöds i Azure Portal finns i Mått som stöds med Azure Monitor.

Metric

Property	Obligatoriskt	Beskrivning
`name`	Ja	Namnet på måttet.
`aggregationType`	Ja	Den aggregeringstyp som ska användas för det här måttet. Sammansättningstyper som stöds: `none, sum, min, max, avg, unique, percentile, count`
`namespace`	Nej	Mer information att använda när du fastställer rätt måttprovider.
`resourceTagFilter`	Nej	Resurstaggarmatrisen avgränsas med ett `or` ord som måtten ska visas för. Gäller ovanpå resurstypsfiltret.
`resourceType`	Ja	Den resurstyp som måtten ska visas för.

Skärmbild som visar en övervakningssida med namnet This is my metrics view for a managed application (Det här är min måttvy för ett hanterat program).

Anpassade resurser

"kind": "CustomResources"

Du kan definiera flera vyer av den här typen. Varje vy representerar en unik anpassad resurstyp från den anpassade provider som du definierade i mainTemplate.json. En introduktion till anpassade leverantörer finns i Översikt över förhandsversionen av Azure Custom Providers.

I den här vyn kan du utföra get-, PUT-, DELETE- och POST-åtgärder för din anpassade resurstyp. POST-åtgärder kan vara globala anpassade åtgärder eller anpassade åtgärder i en kontext av din anpassade resurstyp.

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

Property	Obligatoriskt	Beskrivning
`displayName`	Ja	Visningsrubriken för vyn. Rubriken ska vara unik för varje CustomResources-vy i din viewDefinition.json.
`version`	Nej	Den version av plattformen som används för att återge vyn.
`resourceType`	Ja	Den anpassade resurstypen. Måste vara en unik anpassad resurstyp för din anpassade provider.
`icon`	Nej	Ikonen för vyn. Lista över exempelikoner definieras i JSON-schema.
`createUIDefinition`	Nej	Skapa UI Definition-schema för att skapa ett anpassat resurskommando. En introduktion till hur du skapar användargränssnittsdefinitioner finns i Komma igång med CreateUiDefinition.
`commands`	Nej	Matrisen med fler verktygsfältsknappar i CustomResources-vyn finns i kommandon.
`columns`	Nej	Matrisen med kolumner för den anpassade resursen. Om den `name` inte har definierats visas kolumnen som standard. Kolumnen måste ha `"key"` och `"displayName"`. För nyckel anger du nyckeln för egenskapen som ska visas i en vy. Om den är kapslad använder du punkt som avgränsare, `"key": "name"` till exempel eller `"key": "properties.property1"`. För visningsnamn anger du visningsnamnet för egenskapen som ska visas i en vy. Du kan också ange en `"optional"` egenskap. När värdet är true döljs kolumnen i en vy som standard.

Skärmbild som visar sidan Resurser med namnet Testa anpassad resurstyp och kontrollen Anpassad kontextåtgärd.

Kommandon

Egenskapen commands är en matris med fler verktygsfältsknappar som visas på sidan. Varje kommando representerar en POST-åtgärd från din anpassade Azure-provider som definierats i mainTemplate.json. En introduktion till anpassade leverantörer finns i Översikt över anpassade Azure-leverantörer.

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

Property	Obligatoriskt	Beskrivning
`displayName`	Ja	Det visade namnet på kommandoknappen.
`path`	Ja	Måste vara ett anpassat provideråtgärdsnamn. Åtgärden måste definieras i mainTemplate.json. Accepterar inte dynamiska värden som en URI som är utdata från mainTemplate.json.
`icon`	Nej	Ikonen för kommandoknappen. Lista över exempelikoner definieras i JSON-schema.
`createUIDefinition`	Nej	Skapa UI-definitionsschema för kommando. En introduktion till hur du skapar användargränssnittsdefinitioner finns i Komma igång med CreateUiDefinition.

Associationer

"kind": "Associations"

Du kan definiera flera vyer av den här typen. Med den här vyn kan du länka befintliga resurser till det hanterade programmet via den anpassade provider som du definierade i mainTemplate.json. En introduktion till anpassade leverantörer finns i Översikt över förhandsversionen av Azure Custom Providers.

I den här vyn kan du utöka befintliga Azure-resurser baserat på targetResourceType. När en resurs har valts skapar den en registreringsbegäran till den offentliga anpassade providern, som kan tillämpa en sidoeffekt på resursen.

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

Property	Obligatoriskt	Beskrivning
`displayName`	Ja	Visningsrubriken för vyn. Rubriken ska vara unik för varje associationsvy i din viewDefinition.json.
`version`	Nej	Den version av plattformen som används för att återge vyn.
`targetResourceType`	Ja	Målresurstypen. Den här resurstypen visas för resursregistrering.
`createUIDefinition`	Nej	Skapa UI Definition-schema för att skapa associationens resurskommando. En introduktion till hur du skapar användargränssnittsdefinitioner finns i Komma igång med CreateUiDefinition.

Söker hjälp

Om du har frågor eller behöver ett svar om Azure Managed Applications kan du prova att fråga på Stack Overflow. Använd taggen azure-managed-app när du skickar en fråga.

Nästa steg

En introduktion till hanterade program finns i Azure Managed Application overview (Översikt över Azure Managed Application).
En introduktion till anpassade leverantörer finns i Översikt över anpassade Azure-leverantörer.
Information om hur du skapar ett Azure-hanterat program med anpassade Azure-leverantörer finns i Självstudie: Skapa hanterat program med anpassade provideråtgärder och resurstyper

Dela via