Struktura řídicích panelů Azure
Tento dokument vás provede strukturou řídicího panelu Azure pomocí následujícího řídicího panelu jako příklad:
Vzhledem k tomu, že sdílené řídicí panely Azure jsou prostředky, může být tento řídicí panel reprezentován jako JSON. Reprezentaci JSON řídicího panelu si můžete stáhnout tak, že vyberete Exportovat a pak ji stáhnete na webu Azure Portal.
Příklad KÓDU JSON řídicího panelu
Následující JSON představuje ukázkový řídicí panel zobrazený v předchozí části.
{
"properties": {
"lenses": [
{
"order": 0,
"parts": [
{
"position": {
"x": 0,
"y": 0,
"colSpan": 3,
"rowSpan": 2
},
"metadata": {
"inputs": [],
"type": "Extension/HubsExtension/PartType/MarkdownPart",
"settings": {
"content": {
"settings": {
"content": "## Azure Virtual Machines Overview\r\nNew team members should watch this video to get familiar with Azure Virtual Machines.",
"markdownUri": null
}
}
}
}
},
{
"position": {
"x": 3,
"y": 0,
"colSpan": 8,
"rowSpan": 4
},
"metadata": {
"inputs": [],
"type": "Extension/HubsExtension/PartType/MarkdownPart",
"settings": {
"content": {
"settings": {
"content": "This is the team dashboard for the test VM we use on our team. Here are some useful links:\r\n\r\n1. [Create a Linux virtual machine](https://docs.microsoft.com/azure/virtual-machines/linux/quick-create-portal)\r\n1. [Create a Windows virtual machine](https://docs.microsoft.com/azure/virtual-machines/windows/quick-create-portal)\r\n1. [Create a virtual machine scale set](https://docs.microsoft.com/azure/virtual-machine-scale-sets/quick-create-portal)",
"title": "Test VM Dashboard",
"subtitle": "Contoso",
"markdownUri": null
}
}
}
}
},
{
"position": {
"x": 0,
"y": 2,
"colSpan": 3,
"rowSpan": 2
},
"metadata": {
"inputs": [],
"type": "Extension/HubsExtension/PartType/VideoPart",
"settings": {
"content": {
"settings": {
"src": "https://www.youtube.com/watch?v=rOiSRkxtTeU",
"autoplay": false
}
}
}
}
},
{
"position": {
"x": 0,
"y": 4,
"colSpan": 11,
"rowSpan": 3
},
"metadata": {
"inputs": [
{
"name": "queryInputs",
"value": {
"timespan": {
"duration": "PT1H"
},
"id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
"chartType": 0,
"metrics": [
{
"name": "Percentage CPU",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
}
]
}
}
],
"type": "Extension/Microsoft_Azure_Monitoring/PartType/MetricsChartPart"
}
},
{
"position": {
"x": 0,
"y": 7,
"colSpan": 3,
"rowSpan": 2
},
"metadata": {
"inputs": [
{
"name": "queryInputs",
"value": {
"timespan": {
"duration": "PT1H"
},
"id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
"chartType": 0,
"metrics": [
{
"name": "Disk Read Operations/Sec",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
},
{
"name": "Disk Write Operations/Sec",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
}
]
}
}
],
"type": "Extension/Microsoft_Azure_Monitoring/PartType/MetricsChartPart"
}
},
{
"position": {
"x": 3,
"y": 7,
"colSpan": 3,
"rowSpan": 2
},
"metadata": {
"inputs": [
{
"name": "queryInputs",
"value": {
"timespan": {
"duration": "PT1H"
},
"id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
"chartType": 0,
"metrics": [
{
"name": "Disk Read Bytes",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
},
{
"name": "Disk Write Bytes",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
}
]
}
}
],
"type": "Extension/Microsoft_Azure_Monitoring/PartType/MetricsChartPart"
}
},
{
"position": {
"x": 6,
"y": 7,
"colSpan": 3,
"rowSpan": 2
},
"metadata": {
"inputs": [
{
"name": "queryInputs",
"value": {
"timespan": {
"duration": "PT1H"
},
"id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
"chartType": 0,
"metrics": [
{
"name": "Network In Total",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
},
{
"name": "Network Out Total",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
}
]
}
}
],
"type": "Extension/Microsoft_Azure_Monitoring/PartType/MetricsChartPart"
}
},
{
"position": {
"x": 9,
"y": 7,
"colSpan": 2,
"rowSpan": 2
},
"metadata": {
"inputs": [
{
"name": "id",
"value": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
}
],
"type": "Extension/Microsoft_Azure_Compute/PartType/VirtualMachinePart",
"asset": {
"idInputName": "id",
"type": "VirtualMachine"
}
}
}
]
}
],
"metadata": {
"model": {}
}
},
"name": "Simple VM Dashboard",
"type": "Microsoft.Portal/dashboards",
"location": "INSERT LOCATION",
"tags": {
"hidden-title": "Simple VM Dashboard"
},
"apiVersion": "2022-12-01-preview"
}
Běžné vlastnosti prostředků
Pojďme rozdělit relevantní oddíly JSON. Běžné vlastnosti prostředků se zobrazí na konci ukázkového kódu JSON. Tyto vlastnosti se sdílejí napříč všemi typy prostředků Azure a nesouvisí konkrétně s obsahem řídicího panelu.
ID
Představuje ID ID prostředku Azure řídicího panelu , které podléhá zásadám vytváření názvů prostředků Azure. Když portál vytvoří řídicí panel, obvykle zvolí ID ve formě identifikátoru GUID, ale při vytváření řídicího panelu můžete použít libovolný platný název.
Při exportu řídicího panelu z webu Azure Portal id se toto pole nezahrne. Pokud vytvoříte nový řídicí panel importem souboru JSON, který obsahuje id toto pole, bude hodnota ignorována a každému novému řídicímu panelu se přiřadí nová hodnota ID.
Název
Název prostředku, který Azure Portal používá pro řídicí panel.
Typ
Všechny řídicí panely mají typ Microsoft.Portal/dashboards.
Umístění
Na rozdíl od jiných prostředků nemají řídicí panely komponentu modulu runtime. U řídicích panelů označuje primární geografické umístění, location ve které je uložená reprezentace JSON řídicího panelu. Hodnota by měla být jednou z kódů umístění, které je možné načíst pomocí rozhraní API pro umístění prostředku předplatných.
Značky
Značky jsou běžnou funkcí prostředků Azure, které umožňují uspořádat prostředek podle dvojic hodnot libovolných názvů. Řídicí panely obsahují jednu speciální značku s názvem hidden-title. Pokud má řídicí panel tuto vlastnost vyplněnou, použije se tato hodnota jako zobrazovaný název řídicího panelu na portálu. Tato značka poskytuje způsob, jak mít zobrazovaný název řídicího panelu s možností renamable.
Vlastnosti
Objekt properties obsahuje dvě vlastnosti lenses a metadata. Vlastnost lenses obsahuje informace o dlaždicích na řídicím panelu. Vlastnost metadata je vyhrazena pro potenciální budoucí funkce.
Čočky
Vlastnost lenses obsahuje řídicí panel.
Součástky
Vlastnost lenses obsahuje dvě vlastnosti order a parts. order V současné době je vždy nastavená hodnota 0. Vlastnost parts obsahuje objekt, který definuje jednotlivé části (označované také jako dlaždice) na řídicím panelu.
Objekt parts obsahuje vlastnost pro každou část, kde název vlastnosti je číslo. Číslo není významné.
Každý jednotlivý objekt části obsahuje position a metadata.
Position
Vlastnost position obsahuje informace o velikosti a umístění pro část vyjádřenou jako x, y, rowSpana colSpan. Hodnoty jsou z hlediska jednotek mřížky. Tyto jednotky mřížky jsou viditelné, když je řídicí panel v režimu úprav, jak je znázorněno zde.
Pokud například chcete, aby dlaždice měla šířku dvou jednotek mřížky, výšku jedné mřížky a umístění v levém horním rohu řídicího panelu, pak objekt pozice vypadá takto:
position: { x: 0, y: 0, rowSpan: 2, colSpan: 1 }
Metadata
Každá část má vlastnost metadat. Objekt má pouze jednu požadovanou vlastnost v rámci metadat: type. Tento řetězec říká portálu, který typ dlaždice se má zobrazit. Náš ukázkový řídicí panel používá tyto typy dlaždic:
Extension/Microsoft_Azure_Monitoring/PartType/MetricsChartPart– Slouží k zobrazení metrik monitorování.Extension[azure]/HubsExtension/PartType/MarkdownPart– Slouží k zobrazení přizpůsobeného obsahu markdownu, jako je text nebo obrázky, se základním formátováním seznamů, odkazů atd.Extension[azure]/HubsExtension/PartType/VideoPart– Slouží k zobrazení videí z YouTube, Channel 9 a jakéhokoli jiného typu videa, které funguje ve značce videa HTML.
Každý typ části má vlastní možnosti konfigurace. Možné vlastnosti konfigurace se nazývají inputs, settingsa asset.
Vstupy
Objekt vstupů obecně obsahuje informace, které sváže dlaždici s instancí prostředku.
Každý MetricsChartPart v našem příkladu má jeden vstup, který vyjadřuje prostředek, ke kterému se má vytvořit vazba, představující ID prostředku Azure virtuálního počítače a informace o zobrazených datech. Tady je inputs například objekt pro dlaždici, který zobrazuje metriky Celkový součet sítě a Celkový počet síťových odchozích dat .
"inputs":
[
{
"name": "queryInputs",
"value": {
"timespan": {
"duration": "PT1H"
},
"id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
"chartType": 0,
"metrics": [
{
"name": "Network In Total",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
},
{
"name": "Network Out Total",
"resourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/SimpleWinVMResourceGroup/providers/Microsoft.Compute/virtualMachines/myVirtualMachine"
}
]
}
}
]
Nastavení
Objekt nastavení obsahuje konfigurovatelné prvky části. V našem ukázkovém řídicím panelu MarkdownPart se pomocí nastavení uloží vlastní obsah Markdownu spolu s konfigurovatelným názvem a podnadpisem.
"settings": {
"content": {
"settings": {
"content": "This is the team dashboard for the test VM we use on our team. Here are some useful links:\r\n\r\n1. [Create a Linux virtual machine](https://docs.microsoft.com/azure/virtual-machines/linux/quick-create-portal)\r\n1. [Create a Windows virtual machine](https://docs.microsoft.com/azure/virtual-machines/windows/quick-create-portal)\r\n1. [Create a virtual machine scale set](https://docs.microsoft.com/azure/virtual-machine-scale-sets/quick-create-portal)",
"title": "Test VM Dashboard",
"subtitle": "Contoso",
"markdownUri": null
}
}
}
Podobně má vlastní nastavení, VideoPart která obsahují ukazatel na video, který se má přehrát, nastavení automatického přehrávání a volitelné informace o názvu.
"settings": {
"content": {
"settings": {
"src": "https://www.youtube.com/watch?v=rOiSRkxtTeU",
"autoplay": false
}
}
}
Majetek
Dlaždice vázané na objekty portálu s možností správy první třídy (označované jako prostředky) mají tento vztah vyjádřený objektem asset . Na našem ukázkovém řídicím panelu obsahuje dlaždice virtuálního počítače tento popis prostředku. Vlastnost idInputName říká portálu, že vstup ID obsahuje jedinečný identifikátor prostředku, v tomto případě ID prostředku. Většina typů prostředků Azure má prostředky definované na portálu.
"asset": {
"idInputName": "id",
"type": "VirtualMachine"
}
Další kroky
- Zjistěte, jak vytvořit řídicí panel na webu Azure Portal nebo programově.
- Naučte se používat dlaždice Markdownu na řídicích panelech Azure k zobrazení vlastního obsahu.