Tableaux de bord Microsoft.Portal

  • Article

Définition de ressource Bicep

Le type de ressource des tableaux de bord peut être déployé sur :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Remarques

Pour plus d’informations sur la création de tableaux de bord, consultez La structure des tableaux de bord Azure.

Format des ressources

Pour créer une ressource Microsoft.Portal/dashboards, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Portal/dashboards@2020-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    lenses: [
      {
        metadata: {}
        order: int
        parts: [
          {
            metadata: {
              type: 'string'
              // For remaining properties, see DashboardPartMetadata objects
            }
            position: {
              colSpan: int
              metadata: {}
              rowSpan: int
              x: int
              y: int
            }
          }
        ]
      }
    ]
    metadata: {}
  }
}

Objets DashboardPartMetadata

Définissez la propriété type pour spécifier le type d’objet.

Pour Extension/HubsExtension/PartType/MarkdownPart, utilisez :

  type: 'Extension/HubsExtension/PartType/MarkdownPart'
  inputs: [
    any
  ]
  settings: {
    content: {
      settings: {
        content: 'string'
        markdownSource: int
        markdownUri: 'string'
        subtitle: 'string'
        title: 'string'
      }
    }
  }

Valeurs de propriétés

dashboards

Nom Description Valeur
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 3-160

Caractères valides :
Caractères alphanumériques et traits d’union.

Pour utiliser des caractères interdits, ajoutez une balise nommée hidden-title avec le nom du tableau de bord que vous souhaitez utiliser. Le portail affiche ce nom lors de l'affichage du tableau de bord.
location Emplacement de la ressource chaîne (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés du tableau de bord partagé. Tableau de bordPropriétés

Tableau de bordPropriétés

Nom Description Valeur
Lentilles Objectifs du tableau de bord. DashboardLens[]
metadata Métadonnées du tableau de bord. object

Tableau de bordLens

Nom Description Valeur
metadata Métadonnées du tableau de bord. object
order Ordre des lentilles. int (obligatoire)
parties Parties du tableau de bord. DashboardParts[] (obligatoire)

Tableau de bordParts

Nom Description Valeur
metadata Métadonnées de la partie tableau de bord. DashboardPartMetadata
position Position de partie du tableau de bord. DashboardPartsPosition (obligatoire)

DashboardPartMetadata

Nom Description Valeur
type Définir le type d’objet Extension/HubsExtension/PartType/MarkdownPart (obligatoire)

MarkdownPartMetadata

Nom Description Valeur
type Type de partie de tableau de bord. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)
inputs Entrez dans la partie tableau de bord. any[]
paramètres Paramètres de partie Markdown. MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

Nom Description Valeur
content Contenu de la partie markdown. MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

Nom Description Valeur
paramètres Paramètre du contenu de la partie markdown. MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

Nom Description Valeur
content Contenu de la partie markdown. string
markdownSource Source du contenu de la partie markdown. int
markdownUri URI du contenu markdown. string
subtitle Sous-titre de la partie markdown. string
title Titre de la partie markdown. string

DashboardPartsPosition

Nom Description Valeur
colSpan Étendue de colonne de partie du tableau de bord. int (obligatoire)
metadata Métadonnées de la partie tableau de bord. object
Rowspan Étendue de ligne de partie du tableau de bord. int (obligatoire)
x Coordonnée part x du tableau de bord. int (obligatoire)
y Coordonnée de partie y du tableau de bord. int (obligatoire)

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Déployer une application de microservice Azure Spring Apps simple

Déployer sur Azure		 Ce modèle déploie une application de microservice Azure Spring Apps simple pour s’exécuter sur Azure.
Créer un tableau de bord de supervision Azure ML

Déployer sur Azure		 Ce modèle crée un tableau de bord AML au-dessus des espaces de travail Log Analytics existants diagnostics données
Créer un tableau de bord Portail Azure

Déployer sur Azure		 Ce modèle crée un exemple de tableau de bord dans le Portail Azure, montrant les performances d’une machine virtuelle existante dans votre abonnement, ainsi que des informations statiques et des liens.
Tableau de bord par défaut partagé

Déployer sur Azure		 Pour rendre une application opérationnelle, il est utile d’avoir un tableau de bord partagé des services qui composent le système. Ce tableau de bord fournit un démarrage rapide pour la personnalisation et le partage avec d’autres membres de l’équipe.

Définition de ressources de modèle ARM

Le type de ressource des tableaux de bord peut être déployé sur :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Remarques

Pour plus d’informations sur la création de tableaux de bord, consultez La structure des tableaux de bord Azure.

Format des ressources

Pour créer une ressource Microsoft.Portal/dashboards, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Portal/dashboards",
  "apiVersion": "2020-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "lenses": [
      {
        "metadata": {},
        "order": "int",
        "parts": [
          {
            "metadata": {
              "type": "string"
              // For remaining properties, see DashboardPartMetadata objects
            },
            "position": {
              "colSpan": "int",
              "metadata": {},
              "rowSpan": "int",
              "x": "int",
              "y": "int"
            }
          }
        ]
      }
    ],
    "metadata": {}
  }
}

Objets DashboardPartMetadata

Définissez la propriété type pour spécifier le type d’objet.

Pour Extension/HubsExtension/PartType/MarkdownPart, utilisez :

  "type": "Extension/HubsExtension/PartType/MarkdownPart",
  "inputs": [ object ],
  "settings": {
    "content": {
      "settings": {
        "content": "string",
        "markdownSource": "int",
        "markdownUri": "string",
        "subtitle": "string",
        "title": "string"
      }
    }
  }

Valeurs de propriétés

dashboards

Nom Description Valeur
type Type de ressource « Microsoft.Portal/dashboards »
apiVersion Version de l’API de ressource « 2020-09-01-preview »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 3-160

Caractères valides :
Caractères alphanumériques et traits d’union.

Pour utiliser des caractères interdits, ajoutez une balise nommée hidden-title avec le nom du tableau de bord que vous souhaitez utiliser. Le portail affiche ce nom lors de l'affichage du tableau de bord.
location Emplacement de la ressource chaîne (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés du tableau de bord partagé. Tableau de bordPropriétés

Tableau de bordPropriétés

Nom Description Valeur
Lentilles Objectifs du tableau de bord. DashboardLens[]
metadata Métadonnées du tableau de bord. object

Tableau de bordLens

Nom Description Valeur
metadata Métadonnées du tableau de bord. object
order Ordre des lentilles. int (obligatoire)
parties Parties du tableau de bord. DashboardParts[] (obligatoire)

Tableau de bordParts

Nom Description Valeur
metadata Métadonnées de la partie tableau de bord. DashboardPartMetadata
position Position de partie du tableau de bord. DashboardPartsPosition (obligatoire)

DashboardPartMetadata

Nom Description Valeur
type Définir le type d’objet Extension/HubsExtension/PartType/MarkdownPart (obligatoire)

MarkdownPartMetadata

Nom Description Valeur
type Type de partie de tableau de bord. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)
inputs Entrez dans la partie tableau de bord. any[]
paramètres Paramètres de partie Markdown. MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

Nom Description Valeur
content Contenu de la partie markdown. MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

Nom Description Valeur
paramètres Paramètre du contenu de la partie markdown. MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

Nom Description Valeur
content Contenu de la partie markdown. string
markdownSource Source du contenu de la partie markdown. int
markdownUri URI du contenu markdown. string
subtitle Sous-titre de la partie markdown. string
title Titre de la partie markdown. string

DashboardPartsPosition

Nom Description Valeur
colSpan Étendue de colonne de partie du tableau de bord. int (obligatoire)
metadata Métadonnées de la partie tableau de bord. object
Rowspan Étendue de ligne de partie du tableau de bord. int (obligatoire)
x Coordonnée part x du tableau de bord. int (obligatoire)
y Coordonnée de partie y du tableau de bord. int (obligatoire)

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Déployer une application de microservice Azure Spring Apps simple

Déployer sur Azure		 Ce modèle déploie une application de microservice Azure Spring Apps simple pour s’exécuter sur Azure.
Créer un tableau de bord de supervision Azure ML

Déployer sur Azure		 Ce modèle crée un tableau de bord AML au-dessus des espaces de travail Log Analytics existants diagnostics données
Créer un tableau de bord Portail Azure

Déployer sur Azure		 Ce modèle crée un exemple de tableau de bord dans le Portail Azure, montrant les performances d’une machine virtuelle existante dans votre abonnement, ainsi que des informations statiques et des liens.
Tableau de bord par défaut partagé

Déployer sur Azure		 Pour rendre une application opérationnelle, il est utile d’avoir un tableau de bord partagé des services qui composent le système. Ce tableau de bord fournit un démarrage rapide pour la personnalisation et le partage avec d’autres membres de l’équipe.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource des tableaux de bord peut être déployé sur :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Portal/dashboards, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Portal/dashboards@2020-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      lenses = [
        {
          metadata = {}
          order = int
          parts = [
            {
              metadata = {
                type = "string"
                // For remaining properties, see DashboardPartMetadata objects
              }
              position = {
                colSpan = int
                metadata = {}
                rowSpan = int
                x = int
                y = int
              }
            }
          ]
        }
      ]
      metadata = {}
    }
  })
}

Objets DashboardPartMetadata

Définissez la propriété type pour spécifier le type d’objet.

Pour Extension/HubsExtension/PartType/MarkdownPart, utilisez :

  type = "Extension/HubsExtension/PartType/MarkdownPart"
  inputs = [ object ]
  settings = {
    content = {
      settings = {
        content = "string"
        markdownSource = int
        markdownUri = "string"
        subtitle = "string"
        title = "string"
      }
    }
  }

Valeurs de propriétés

dashboards

Nom Description Valeur
type Type de ressource « Microsoft.Portal/dashboards@2020-09-01-preview »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 3-160

Caractères valides :
Caractères alphanumériques et traits d’union.

Pour utiliser des caractères interdits, ajoutez une balise nommée hidden-title avec le nom du tableau de bord que vous souhaitez utiliser. Le portail affiche ce nom lors de l'affichage du tableau de bord.
location Emplacement de la ressource chaîne (obligatoire)
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
properties Propriétés du tableau de bord partagé. Tableau de bordPropriétés

Tableau de bordPropriétés

Nom Description Valeur
Lentilles Objectifs du tableau de bord. DashboardLens[]
metadata Métadonnées du tableau de bord. object

Tableau de bordLens

Nom Description Valeur
metadata Métadonnées du tableau de bord. object
order Ordre des lentilles. int (obligatoire)
parties Parties du tableau de bord. DashboardParts[] (obligatoire)

Tableau de bordParts

Nom Description Valeur
metadata Métadonnées de la partie tableau de bord. DashboardPartMetadata
position Position de partie du tableau de bord. DashboardPartsPosition (obligatoire)

DashboardPartMetadata

Nom Description Valeur
type Définir le type d’objet Extension/HubsExtension/PartType/MarkdownPart (obligatoire)

MarkdownPartMetadata

Nom Description Valeur
type Type de partie de tableau de bord. « Extension/HubsExtension/PartType/MarkdownPart » (obligatoire)
inputs Entrez dans la partie tableau de bord. any[]
paramètres Paramètres de partie Markdown. MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

Nom Description Valeur
content Contenu de la partie markdown. MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

Nom Description Valeur
paramètres Paramètre du contenu de la partie markdown. MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

Nom Description Valeur
content Contenu de la partie markdown. string
markdownSource Source du contenu de la partie markdown. int
markdownUri URI du contenu markdown. string
subtitle Sous-titre de la partie markdown. string
title Titre de la partie markdown. string

DashboardPartsPosition

Nom Description Valeur
colSpan Étendue de colonne de partie du tableau de bord. int (obligatoire)
metadata Métadonnées de la partie tableau de bord. object
Rowspan Étendue de ligne de partie du tableau de bord. int (obligatoire)
x Coordonnée part x du tableau de bord. int (obligatoire)
y Coordonnée de partie y du tableau de bord. int (obligatoire)