Delen via

Definitieartefact weergeven in Azure Managed Applications

  • Artikel

Weergavedefinitie is een optioneel artefact in Azure Managed Applications. Hiermee kunt u de overzichtspagina aanpassen en meer weergaven toevoegen, zoals metrische gegevens en aangepaste resources.

Dit artikel bevat een overzicht van het weergavedefinitieartefact en de mogelijkheden ervan.

Definitie-artefact weergeven

Het artefact voor de weergavedefinitie moet de naam viewDefinition.json hebben en op hetzelfde niveau worden geplaatst als createUiDefinition.json en mainTemplate.json in het .zip-pakket waarmee een definitie van een beheerde toepassing wordt gemaakt. Zie quickstart: Een definitie van een beheerde toepassing maken en publiceren voor meer informatie over het maken van het .zip-pakket en het publiceren van een definitie van een beheerde toepassing

Definitieschema weergeven

Het bestand viewDefinition.json heeft slechts één eigenschap op het hoogste niveau views , een matrix met weergaven. Elke weergave wordt weergegeven in de gebruikersinterface van de beheerde toepassing als een afzonderlijk menu-item in de inhoudsopgave. Elke weergave heeft een kind eigenschap waarmee het type van de weergave wordt ingesteld. Deze moet worden ingesteld op een van de volgende waarden: Overzicht, Metrische gegevens, CustomResources, Koppelingen. Zie het huidige JSON-schema voor viewDefinition.json voor meer informatie.

Voorbeeld-JSON voor weergavedefinitie:

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

Overzicht

"kind": "Overview"

Wanneer u deze weergave opgeeft in viewDefinition.json, wordt de standaardpagina Overzicht in uw beheerde toepassing overschreven.

{
  "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"
      }
    ]
  }
}
Eigenschappen Vereist Beschrijving
header Nee De koptekst van de overzichtspagina.
description Nee De beschrijving van uw beheerde toepassing.
commands Nee De matrix met meer werkbalkknoppen van de overzichtspagina, zie opdrachten.

Schermopname van het overzicht voor een beheerde toepassing met een besturingselement Testactie om een demotoepassing uit te voeren.

Metrische gegevens

"kind": "Metrics"

Met de weergave metrische gegevens kunt u gegevens verzamelen en aggregeren uit uw beheerde toepassingsbronnen in Metrische gegevens van 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"
          }
        ]
      }
    ]
  }
}
Eigenschappen Vereist Beschrijving
displayName Nee De weergegeven titel van de weergave.
version Nee De versie van het platform dat wordt gebruikt om de weergave weer te geven.
charts Ja De matrix van grafieken van de pagina met metrische gegevens.

Grafiek

Eigenschappen Vereist Omschrijving
displayName Ja De weergegeven titel van de grafiek.
chartType Nee De visualisatie die voor deze grafiek moet worden gebruikt. Standaard wordt een lijndiagram gebruikt. Ondersteunde grafiektypen: Bar, Line, Area, Scatter.
metrics Ja De matrix met metrische gegevens die in deze grafiek moeten worden weergegeven. Zie Ondersteunde metrische gegevens met Azure Monitor voor meer informatie over metrische gegevens die worden ondersteund in Azure Portal.

Metrische gegevens

Eigenschappen Vereist Omschrijving
name Ja De naam van de metrische waarde.
aggregationType Ja Het aggregatietype dat moet worden gebruikt voor deze metrische waarde. Ondersteunde aggregatietypen: none, sum, min, max, avg, unique, percentile, count
namespace Nee Meer informatie die u kunt gebruiken bij het bepalen van de juiste provider voor metrische gegevens.
resourceTagFilter Nee De matrix met resourcetags wordt gescheiden door een or woord waarvoor metrische gegevens worden weergegeven. Is van toepassing op het filter van het resourcetype.
resourceType Ja Het resourcetype waarvoor metrische gegevens worden weergegeven.

Schermopname van een bewakingspagina met de naam This is my metrics view for a managed application.

Aangepaste resources

"kind": "CustomResources"

U kunt meerdere weergaven van dit type definiëren. Elke weergave vertegenwoordigt een uniek aangepast resourcetype van de aangepaste provider die u hebt gedefinieerd in mainTemplate.json. Zie het overzicht van azure Custom Providers Preview voor een inleiding tot aangepaste providers.

In deze weergave kunt u GET-, PUT-, DELETE- en POST-bewerkingen uitvoeren voor uw aangepaste resourcetype. POST-bewerkingen kunnen algemene aangepaste acties of aangepaste acties zijn in een context van uw aangepaste resourcetype.

{
  "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
      }
    ]
  }
}
Eigenschappen Vereist Omschrijving
displayName Ja De weergegeven titel van de weergave. De titel moet uniek zijn voor elke CustomResources-weergave in uw viewDefinition.json.
version Nee De versie van het platform dat wordt gebruikt om de weergave weer te geven.
resourceType Ja Het aangepaste resourcetype. Moet een uniek aangepast resourcetype van uw aangepaste provider zijn.
icon Nee Het pictogram van de weergave. De lijst met voorbeeldpictogrammen wordt gedefinieerd in het JSON-schema.
createUIDefinition Nee Maak een UI Definition-schema voor het maken van een aangepaste resourceopdracht. Zie Aan de slag met CreateUiDefinition voor een inleiding tot het maken van UI-definities.
commands Nee De matrix met meer werkbalkknoppen van de weergave CustomResources, zie opdrachten.
columns Nee De matrix met kolommen van de aangepaste resource. Als de name kolom niet is gedefinieerd, wordt standaard weergegeven. De kolom moet en "key" "displayName". Geef voor de sleutel de sleutel van de eigenschap op die in een weergave moet worden weergegeven. Als dit is genest, gebruikt u punt als scheidingsteken, bijvoorbeeld "key": "name" of "key": "properties.property1". Geef voor weergavenaam de weergavenaam van de eigenschap op die in een weergave moet worden weergegeven. U kunt ook een "optional" eigenschap opgeven. Als deze is ingesteld op true, wordt de kolom standaard verborgen in een weergave.

Schermopname van een pagina Resources met de naam Aangepast resourcetype testen en het besturingselement Aangepaste contextactie.

Opdracht

De commands eigenschap is een matrix met meer werkbalkknoppen die op de pagina worden weergegeven. Elke opdracht vertegenwoordigt een POST-actie van uw aangepaste Azure-provider die is gedefinieerd in mainTemplate.json. Zie het overzicht van aangepaste Azure-providers voor een inleiding tot aangepaste providers.

{
  "commands": [
    {
      "displayName": "Start Test Action",
      "path": "testAction",
      "icon": "Start",
      "createUIDefinition": {}
    },
  ]
}
Eigenschappen Vereist Omschrijving
displayName Ja De weergegeven naam van de opdrachtknop.
path Ja Moet een aangepaste provideractienaam zijn. De actie moet worden gedefinieerd in mainTemplate.json.

Accepteert geen dynamische waarden, zoals een URI die wordt uitgevoerd van mainTemplate.json.
icon Nee Het pictogram van de opdrachtknop. De lijst met voorbeeldpictogrammen wordt gedefinieerd in het JSON-schema.
createUIDefinition Nee Maak een UI Definition-schema voor opdracht. Zie Aan de slag met CreateUiDefinition voor een inleiding tot het maken van UI-definities.

Verenigingen

"kind": "Associations"

U kunt meerdere weergaven van dit type definiëren. Met deze weergave kunt u bestaande resources koppelen aan de beheerde toepassing via de aangepaste provider die u hebt gedefinieerd in mainTemplate.json. Zie het overzicht van azure Custom Providers Preview voor een inleiding tot aangepaste providers.

In deze weergave kunt u bestaande Azure-resources uitbreiden op basis van de targetResourceType. Wanneer een resource is geselecteerd, wordt er een onboardingaanvraag gemaakt voor de openbare aangepaste provider, die een neveneffect op de resource kan toepassen.

{
  "kind": "Associations",
  "properties": {
    "displayName": "Test association resource type",
    "version": "1.0.0",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "createUIDefinition": {}
  }
}
Eigenschappen Vereist Omschrijving
displayName Ja De weergegeven titel van de weergave. De titel moet uniek zijn voor elke koppelingenweergave in uw viewDefinition.json.
version Nee De versie van het platform dat wordt gebruikt om de weergave weer te geven.
targetResourceType Ja Het doelresourcetype. Dit resourcetype wordt weergegeven voor onboarding van resources.
createUIDefinition Nee Maak een UI Definition-schema voor het maken van de opdracht koppelingsresource. Zie Aan de slag met CreateUiDefinition voor een inleiding tot het maken van UI-definities.

Hulp nodig?

Als u vragen hebt of een antwoord nodig hebt over Azure Managed Applications, kunt u het vragen stellen op Stack Overflow. Gebruik de tag azure-managed-app wanneer u een vraag plaatst.

Volgende stappen