Partager via


Tableaux de bord Microsoft.Portal

Remarques

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

Définition de ressource Bicep

Le type de ressource des tableaux de bord peut être déployé avec des opérations qui ciblent :

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

Format de ressource

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

resource symbolicname 'Microsoft.Portal/dashboards@2022-12-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    lenses: [
      {
        metadata: any(Azure.Bicep.Types.Concrete.AnyType)
        order: int
        parts: [
          {
            metadata: {
              type: 'string'
              // For remaining properties, see DashboardPartMetadata objects
            }
            position: {
              colSpan: int
              metadata: any(Azure.Bicep.Types.Concrete.AnyType)
              rowSpan: int
              x: int
              y: int
            }
          }
        ]
      }
    ]
    metadata: any(Azure.Bicep.Types.Concrete.AnyType)
  }
  tags: {
    {customized property}: 'string'
  }
}

Objets DashboardPartMetadata

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

Pour extension/HubsExtension/PartType/MarkdownPart, utilisez :

{
  inputs: [
    any(Azure.Bicep.Types.Concrete.AnyType)
  ]
  settings: {
    content: {
      settings: {
        content: 'string'
        markdownSource: int
        markdownUri: 'string'
        subtitle: 'string'
        title: 'string'
      }
    }
  }
  type: 'Extension/HubsExtension/PartType/MarkdownPart'
}

Valeurs de propriété

DashboardLens

Nom Description Valeur
métadonnées Métadonnées du tableau de bord. quelconque
commande L’ordre des lentilles. int (obligatoire)
Pièces Parties du tableau de bord. DashboardParts[] (obligatoire)

DashboardPartMetadata

Nom Description Valeur
type Défini sur « Extension/HubsExtension/PartType/MarkdownPart » pour le type MarkdownPartMetadata. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)

DashboardParts

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

DashboardPartsPosition

Nom Description Valeur
colSpan Plage de colonnes de partie du tableau de bord. int (obligatoire)
métadonnées Métadonnées du composant tableau de bord. quelconque
rowSpan Étendue de ligne de partie du tableau de bord. int (obligatoire)
x Coordonnée x partie du tableau de bord. int (obligatoire)
y Coordonnée de la partie y du tableau de bord. int (obligatoire)

DashboardPropertiesWithProvisioningState

Nom Description Valeur
Lentilles Les lentilles du tableau de bord. DashboardLens[]
métadonnées Métadonnées du tableau de bord. quelconque

MarkdownPartMetadata

Nom Description Valeur
Entrées Entrée dans la partie tableau de bord. any[]
Paramètres Paramètres de partie Markdown. MarkdownPartMetadataSettings
type Type de métadonnées de partie de tableau de bord. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)

MarkdownPartMetadataSettings

Nom Description Valeur
contenu 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
contenu Contenu de la partie Markdown. corde
MarkdownSource Source du contenu de la partie Markdown. Int
markdownUri URI du contenu markdown. corde
sous-titre Sous-titre de la partie Markdown. corde
titre Titre de la partie markdown. corde

Microsoft.Portal/dashboards

Nom Description Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
Modèle = ^[a-zA-Z0-9-]{3,24}$ (obligatoire)
Propriétés Propriétés spécifiques à la ressource pour cette ressource. DashboardPropertiesWithProvisioningState
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

TrackedResourceTags

Nom Description Valeur

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
Créer un tableau de bord du portail 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.
Déployer une application de microservice Azure Spring Apps simple Ce modèle déploie une application de microservice Azure Spring Apps simple à exécuter sur Azure.

Définition de ressource de modèle ARM

Le type de ressource des tableaux de bord peut être déployé avec des opérations qui ciblent :

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

Format de ressource

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

{
  "type": "Microsoft.Portal/dashboards",
  "apiVersion": "2022-12-01-preview",
  "name": "string",
  "location": "string",
  "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": {}
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objets DashboardPartMetadata

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

Pour extension/HubsExtension/PartType/MarkdownPart, utilisez :

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

Valeurs de propriété

DashboardLens

Nom Description Valeur
métadonnées Métadonnées du tableau de bord. quelconque
commande L’ordre des lentilles. int (obligatoire)
Pièces Parties du tableau de bord. DashboardParts[] (obligatoire)

DashboardPartMetadata

Nom Description Valeur
type Défini sur « Extension/HubsExtension/PartType/MarkdownPart » pour le type MarkdownPartMetadata. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)

DashboardParts

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

DashboardPartsPosition

Nom Description Valeur
colSpan Plage de colonnes de partie du tableau de bord. int (obligatoire)
métadonnées Métadonnées du composant tableau de bord. quelconque
rowSpan Étendue de ligne de partie du tableau de bord. int (obligatoire)
x Coordonnée x partie du tableau de bord. int (obligatoire)
y Coordonnée de la partie y du tableau de bord. int (obligatoire)

DashboardPropertiesWithProvisioningState

Nom Description Valeur
Lentilles Les lentilles du tableau de bord. DashboardLens[]
métadonnées Métadonnées du tableau de bord. quelconque

MarkdownPartMetadata

Nom Description Valeur
Entrées Entrée dans la partie tableau de bord. any[]
Paramètres Paramètres de partie Markdown. MarkdownPartMetadataSettings
type Type de métadonnées de partie de tableau de bord. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)

MarkdownPartMetadataSettings

Nom Description Valeur
contenu 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
contenu Contenu de la partie Markdown. corde
MarkdownSource Source du contenu de la partie Markdown. Int
markdownUri URI du contenu markdown. corde
sous-titre Sous-titre de la partie Markdown. corde
titre Titre de la partie markdown. corde

Microsoft.Portal/dashboards

Nom Description Valeur
apiVersion Version de l’API '2022-12-01-preview'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
Modèle = ^[a-zA-Z0-9-]{3,24}$ (obligatoire)
Propriétés Propriétés spécifiques à la ressource pour cette ressource. DashboardPropertiesWithProvisioningState
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Portal/dashboards'

TrackedResourceTags

Nom Description Valeur

Modèles de démarrage rapide

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

Modèle Description
Créer un tableau de bord de supervision Azure ML

Déployer sur Azure
Ce modèle crée un tableau de bord AML en plus des données de diagnostic des espaces de travail Log Analytics existants
Créer un tableau de bord du 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.
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 à exécuter sur Azure.
tableau de bord partagé par défaut

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

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource des tableaux de bord peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

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

Format de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Portal/dashboards@2022-12-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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 le type propriété pour spécifier le type d’objet.

Pour extension/HubsExtension/PartType/MarkdownPart, utilisez :

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

Valeurs de propriété

DashboardLens

Nom Description Valeur
métadonnées Métadonnées du tableau de bord. quelconque
commande L’ordre des lentilles. int (obligatoire)
Pièces Parties du tableau de bord. DashboardParts[] (obligatoire)

DashboardPartMetadata

Nom Description Valeur
type Défini sur « Extension/HubsExtension/PartType/MarkdownPart » pour le type MarkdownPartMetadata. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)

DashboardParts

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

DashboardPartsPosition

Nom Description Valeur
colSpan Plage de colonnes de partie du tableau de bord. int (obligatoire)
métadonnées Métadonnées du composant tableau de bord. quelconque
rowSpan Étendue de ligne de partie du tableau de bord. int (obligatoire)
x Coordonnée x partie du tableau de bord. int (obligatoire)
y Coordonnée de la partie y du tableau de bord. int (obligatoire)

DashboardPropertiesWithProvisioningState

Nom Description Valeur
Lentilles Les lentilles du tableau de bord. DashboardLens[]
métadonnées Métadonnées du tableau de bord. quelconque

MarkdownPartMetadata

Nom Description Valeur
Entrées Entrée dans la partie tableau de bord. any[]
Paramètres Paramètres de partie Markdown. MarkdownPartMetadataSettings
type Type de métadonnées de partie de tableau de bord. 'Extension/HubsExtension/PartType/MarkdownPart' (obligatoire)

MarkdownPartMetadataSettings

Nom Description Valeur
contenu 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
contenu Contenu de la partie Markdown. corde
MarkdownSource Source du contenu de la partie Markdown. Int
markdownUri URI du contenu markdown. corde
sous-titre Sous-titre de la partie Markdown. corde
titre Titre de la partie markdown. corde

Microsoft.Portal/dashboards

Nom Description Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
Modèle = ^[a-zA-Z0-9-]{3,24}$ (obligatoire)
Propriétés Propriétés spécifiques à la ressource pour cette ressource. DashboardPropertiesWithProvisioningState
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Portal/dashboards@2022-12-01-preview »

TrackedResourceTags

Nom Description Valeur