Definitie artefact in Azure Managed Applications weer geven

  • Artikel
  • 7 minuten om te lezen

Weergave definitie is een optioneel artefact in Azure Managed Applications. Hiermee kunt u de overzichts pagina aanpassen en meer weer gaven toevoegen, zoals metrische gegevens en aangepaste resources.

Dit artikel bevat een overzicht van het weer geven van definitie artefacten en de mogelijkheden ervan.

Definitie-artefact weergeven

De weergave definitie artefact moet viewDefinition.js worden genoemd en op hetzelfde niveau worden geplaatst als createUiDefinition.jsop en mainTemplate.js in het zip-pakket dat een definitie van een beheerde toepassing maakt. Zie een definitie van een door Azure beheerde toepassing publiceren voor meer informatie over het maken van een zip-pakket en het publiceren van een definitie van een beheerde toepassing.

Definitie schema weer geven

De viewDefinition.jsvoor het bestand heeft slechts één eigenschap op het hoogste niveau views . Dit is een matrix met weer gaven. Elke weer gave wordt weer gegeven in de gebruikers interface van de beheerde toepassing als een afzonderlijke menu opdracht in de inhouds opgave. Elke weer gave heeft een kind eigenschap waarmee het type weer gave wordt ingesteld. Deze moet worden ingesteld op een van de volgende waarden: overzicht, metrische gegevens, CustomResources, Associations. Zie het huidige JSON-schema voor viewDefinition.jsopvoor meer informatie.

Voor beeld van JSON voor weergave definitie:

{
    "$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 weer gave in viewDefinition.js opgeeft, wordt de standaard overzichts pagina 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 pagina overzicht.
beschrijving No De beschrijving van de beheerde toepassing.
opdrachten No De matrix met aanvullende werkbalk knoppen van de overzichts pagina, Zie opdrachten.

Scherm afbeelding toont het overzicht voor een beheerde toepassing met een besturings element test actie voor het uitvoeren van een demo-toepassing.

Metrische gegevens

"kind": "Metrics"

Met de weer gave metrieken kunt u gegevens verzamelen en samen voegen uit uw beheerde toepassings resources in Azure monitor metrieken.

{
    "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 weer gegeven titel van de weer gave.
versie No De versie van het platform waarmee de weer gave wordt weer gegeven.
grafieken Yes De matrix van grafieken van de pagina metrische gegevens.

Grafiek

Eigenschap Vereist Beschrijving
displayName Yes De weer gegeven titel van de grafiek.
chartType No De visualisatie die moet worden gebruikt voor deze grafiek. Standaard wordt een lijn diagram gebruikt. Ondersteunde grafiek typen: Bar, Line, Area, Scatter .
metrics Yes De matrix met metrische gegevens die in deze grafiek moeten worden getekend. 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 metriek.
aggregationType Yes Het aggregatie type dat moet worden gebruikt voor deze metriek. Ondersteunde aggregatie typen: none, sum, min, max, avg, unique, percentile, count
naamruimte No Aanvullende informatie die moet worden gebruikt bij het bepalen van de juiste metrics-provider.
resourceTagFilter No De matrix van de bron Tags (wordt gescheiden met or Word) waarvoor metrische gegevens worden weer gegeven. Is boven op het resource type filter.
resourceType Yes Het resource type waarvoor metrische gegevens worden weer gegeven.

Scherm afbeelding toont een bewakings pagina met de naam dit is mijn metrische weer gave voor een beheerde toepassing.

Aangepaste resources

"kind": "CustomResources"

U kunt meerdere weer gaven van dit type definiëren. Elke weer gave vertegenwoordigt een uniek aangepast resource type van de aangepaste provider die u hebt gedefinieerd in mainTemplate.jsop. Zie Preview-versie van Azure Custom providersvoor een inleiding tot aangepaste providers.

In deze weer gave kunt u GET-, PUT-, DELETE-en POST-bewerkingen uitvoeren voor uw aangepaste resource type. POST-bewerkingen kunnen globale aangepaste acties of aangepaste acties zijn in een context van uw aangepaste resource type.

{
    "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 weer gegeven titel van de weer gave. De titel moet uniek zijn voor elke CustomResources-weer gave in uw viewDefinition.jsop.
versie No De versie van het platform waarmee de weer gave wordt weer gegeven.
resourceType Yes Het aangepaste resource type. Moet een uniek aangepast resource type van uw aangepaste provider zijn.
diapictogram No Het pictogram van de weer gave. Lijst met voorbeeld pictogrammen wordt gedefinieerd in het JSON-schema.
createUIDefinition No Maak een UI-definitie schema voor het maken van een aangepaste resource opdracht. Zie aan de slag met CreateUiDefinition voor een inleiding tot het maken van UI-definities.
opdrachten No De matrix met aanvullende werkbalk knoppen van de weer gave CustomResources Zie Commands.
kolommen No De matrix van kolommen van de aangepaste resource. Indien niet gedefinieerd name , wordt de kolom standaard weer gegeven. De kolom moet "key" en bevatten "displayName" . Geef bij sleutel de sleutel van de eigenschap op die in een weer gave moet worden weer gegeven. Als genest, gebruikt u punt als scheidings teken, bijvoorbeeld "key": "name" of "key": "properties.property1" . Geef bij weergave naam de weergave naam op van de eigenschap die in een weer gave moet worden weer gegeven. U kunt ook een "optional" eigenschap opgeven. Als deze eigenschap is ingesteld op True, wordt de kolom standaard verborgen in een weer gave.

Scherm afbeelding toont een pagina Resources met de naam aangepast resource type testen en de actie aangepaste context besturings element.

Opdracht

Opdrachten is een matrix met aanvullende werkbalk knoppen die op de pagina worden weer gegeven. Elke opdracht vertegenwoordigt een bericht actie van uw aangepaste Azure-provider die is gedefinieerd in mainTemplate.jsop. Zie overzicht van aangepaste Azure-providersvoor een inleiding tot aangepaste providers.

{
    "commands": [
        {
            "displayName": "Start Test Action",
            "path": "testAction",
            "icon": "Start",
            "createUIDefinition": { }
        },
    ]
}
Eigenschap Vereist Beschrijving
displayName Yes De weer gegeven naam van de opdracht knop.
leertraject Yes De actie naam van de aangepaste provider. De actie moet worden gedefinieerd in mainTemplate.jsop.
diapictogram No Het pictogram van de opdracht knop. Lijst met voorbeeld pictogrammen wordt gedefinieerd in het JSON-schema.
createUIDefinition No Het definitie schema voor de gebruikers interface maken voor de opdracht. Zie aan de slag met CreateUiDefinitionvoor een inleiding tot het maken van UI-definities.

Lidkoppelingen

"kind": "Associations"

U kunt meerdere weer gaven van dit type definiëren. Met deze weer gave kunt u bestaande resources koppelen aan de beheerde toepassing via de aangepaste provider die u hebt gedefinieerd in mainTemplate.jsop. Zie Preview-versie van Azure Custom providersvoor een inleiding tot aangepaste providers.

In deze weer gave kunt u bestaande Azure-resources uitbreiden op basis van de targetResourceType . Wanneer een resource wordt geselecteerd, wordt er een voorbereidings aanvraag voor de open bare aangepaste provider gemaakt, waarmee een neven effect kan worden toegepast op de resource.

{
    "kind": "Associations",
    "properties": {
        "displayName": "Test association resource type",
        "version": "1.0.0",
        "targetResourceType": "Microsoft.Compute/virtualMachines",
        "createUIDefinition": { }
    }
}
Eigenschap Vereist Beschrijving
displayName Yes De weer gegeven titel van de weer gave. De titel moet uniek zijn voor elke weer gave van koppelingen in uw viewDefinition.jsop.
versie No De versie van het platform waarmee de weer gave wordt weer gegeven.
targetResourceType Yes Het doel bron type. Dit is het resource type dat wordt weer gegeven voor de onboarding van resources.
createUIDefinition No Maak een UI-definitie schema voor het maken van de koppelings bron opdracht. 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-managedapps toe om snel antwoord te krijgen.

Volgende stappen