Definitie-artefact weergeven in Azure Managed Applications

Artikel
06/01/2023

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 weergavedefinitieartefacten en de mogelijkheden ervan.

Definitie-artefact weergeven

Het artefact van 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 Een definitie van een door Azure beheerde toepassing 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 , namelijk 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 weergave wordt ingesteld. Deze moet worden ingesteld op een van de volgende waarden: Overzicht, Metrische gegevens, CustomResources, Koppelingen. Zie huidig JSON-schema voor viewDefinition.json voor meer informatie.

Voorbeeld van 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"
      }
    ]
  }
}

Eigenschap	Vereist	Beschrijving
koptekst	No	De koptekst van de overzichtspagina.
beschrijving	No	De beschrijving van uw beheerde toepassing.
opdrachten	No	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 uit uw beheerde toepassingsresources verzamelen en aggregeren 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"
          }
        ]
      }
    ]
  }
}

Eigenschap	Vereist	Beschrijving
displayName	No	De weergegeven titel van de weergave.
versie	No	De versie van het platform dat wordt gebruikt om de weergave weer te geven.
grafieken	Yes	De matrix met grafieken van de pagina met metrische gegevens.

Grafiek

Eigenschap	Vereist	Beschrijving
displayName	Yes	De weergegeven titel van de grafiek.
chartType	No	De visualisatie die voor deze grafiek moet worden gebruikt. Standaard wordt een lijndiagram gebruikt. Ondersteunde grafiektypen: `Bar, Line, Area, Scatter`.
metrics	Yes	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

Metrisch

Eigenschap	Vereist	Beschrijving
naam	Yes	De naam van de metrische waarde.
aggregationType	Yes	Het aggregatietype dat moet worden gebruikt voor deze metrische waarde. Ondersteunde aggregatietypen: `none, sum, min, max, avg, unique, percentile, count`
naamruimte	No	Meer informatie die u kunt gebruiken bij het bepalen van de juiste provider van metrische gegevens.
resourceTagFilter	No	De matrix met resourcetags (wordt gescheiden door `or` woord) waarvoor metrische gegevens worden weergegeven. Is van toepassing boven op resourcetypefilter.
resourceType	Yes	Het resourcetype waarvoor metrische gegevens worden weergegeven.

Schermopname van een bewakingspagina met de naam Dit is mijn weergave voor metrische gegevens voor een beheerde toepassing.

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 Azure Custom Providers Preview-overzicht 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
      }
    ]
  }
}

Eigenschap	Vereist	Beschrijving
displayName	Yes	De weergegeven titel van de weergave. De titel moet uniek zijn voor elke CustomResources-weergave in uw viewDefinition.json.
versie	No	De versie van het platform dat wordt gebruikt om de weergave weer te geven.
resourceType	Yes	Het aangepaste resourcetype. Moet een uniek aangepast resourcetype van uw aangepaste provider zijn.
Pictogram	No	Het pictogram van de weergave. De lijst met voorbeeldpictogrammen is gedefinieerd in het JSON-schema.
createUIDefinition	No	Ui-definitieschema maken voor het maken van een aangepaste resourceopdracht. Zie Aan de slag met CreateUiDefinition voor een inleiding tot het maken van UI-definities.
opdrachten	No	De matrix met meer werkbalkknoppen van de weergave CustomResources, zie opdrachten.
kolommen	No	De matrix met kolommen van de aangepaste resource. Als deze niet is gedefinieerd, wordt de `name` kolom standaard weergegeven. De kolom moet en `"displayName"`bevatten`"key"`. Geef voor sleutel de sleutel op van de eigenschap die in een weergave moet worden weergegeven. Als deze is genest, gebruikt u een punt als scheidingsteken, `"key": "name"` bijvoorbeeld of `"key": "properties.property1"`. Geef bij weergavenaam de weergavenaam op van de eigenschap die in een weergave moet worden weergegeven. U kunt ook een `"optional"` eigenschap opgeven. Als deze optie is ingesteld op true, wordt de kolom standaard verborgen in een weergave.

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

Opdracht

De commands eigenschap is een matrix van 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 Overzicht van aangepaste Azure-providers voor een inleiding tot aangepaste providers.

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

Eigenschap	Vereist	Beschrijving
displayName	Yes	De weergegeven naam van de opdrachtknop.
leertraject	Yes	Moet een aangepaste provideractienaam zijn. De actie moet worden gedefinieerd in mainTemplate.json. Accepteert geen dynamische waarden zoals een URI die uitvoer is van mainTemplate.json.
Pictogram	No	Het pictogram van de opdrachtknop. De lijst met voorbeeldpictogrammen is gedefinieerd in het JSON-schema.
createUIDefinition	No	Ui-definitieschema maken 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 Azure Custom Providers Preview-overzicht 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 bij 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": {}
  }
}

Eigenschap	Vereist	Beschrijving
displayName	Yes	De weergegeven titel van de weergave. De titel moet uniek zijn voor elke weergave Koppelingen in uw viewDefinition.json.
versie	No	De versie van het platform dat wordt gebruikt om de weergave weer te geven.
targetResourceType	Yes	Het doelresourcetype. Dit resourcetype wordt weergegeven voor het onboarden van resources.
createUIDefinition	No	Maak een UI-definitieschema voor het maken van een koppelingsresourceopdracht. Zie Aan de slag met CreateUiDefinition voor een inleiding tot het maken van UI-definities.

Hulp nodig?

Als u vragen hebt over Azure Managed Applications, kunt u dit vragen op Stack Overflow. Misschien is er een soortgelijke vraag gesteld en beantwoord, dus controleer dit eerst vóór u een vraag stelt. Voeg de tag azure-managed-app toe om snel antwoord te krijgen.

Volgende stappen

Zie Overzicht van door Azure beheerde toepassingen voor algemene informatie over beheerde toepassingen.
Zie Overzicht van aangepaste Azure-providers voor een inleiding tot aangepaste providers.
Zie Zelfstudie: Beheerde toepassing maken met aangepaste provideracties en resourcetypen voor het maken van een beheerde Azure-toepassing met aangepaste Azure-providers