Partager via


Classeurs Microsoft.Insights 2021-08-01

Définition de ressource Bicep

Le type de ressource classeurs 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.Insights/workbooks, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Insights/workbooks@2021-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    category: 'string'
    description: 'string'
    displayName: 'string'
    serializedData: 'string'
    sourceId: 'string'
    storageUri: 'string'
    tags: [
      'string'
    ]
    version: 'string'
  }
}

Valeurs de propriété

Classeurs

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
étiquettes Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
gentil Type de classeur. Seule la valeur valide est partagée. 'shared'
'user'
etag Etag de ressource corde
identité Identité utilisée pour BYOS WorkbookResourceIdentity
Propriétés Métadonnées décrivant un classeur pour une ressource Azure. WorkbookProperties

WorkbookResourceIdentity

Nom Description Valeur
type Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obligatoire)
userAssignedIdentities Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. UserAssignedIdentities

UserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserAssignedIdentity

UserAssignedIdentity

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

WorkbookProperties

Nom Description Valeur
catégorie Catégorie de classeur, telle que définie par l’utilisateur au moment de la création. chaîne (obligatoire)
description Description du classeur. corde
displayName Nom défini par l’utilisateur (nom complet) du classeur. chaîne (obligatoire)
serializedData Configuration de ce classeur particulier. Les données de configuration sont une chaîne contenant un JSON valide chaîne (obligatoire)
sourceId ResourceId pour une ressource source. corde
storageUri ResourceId vers le compte de stockage lorsque vous apportez votre propre stockage est utilisé corde
étiquettes En cours de dépréciation, utilisez le champ d’autres balises string[]
Version Format de version du schéma du classeur, tel que « Notebook/1.0 », qui doit correspondre au classeur dans serializedData corde

Modèles de démarrage rapide

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

Modèle Description
classeur finOps toolkit

Déployer sur Azure
Ce modèle crée un classeur Azure Monitor pour la gouvernance.

Définition de ressource de modèle ARM

Le type de ressource classeurs 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.Insights/workbooks, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Insights/workbooks",
  "apiVersion": "2021-08-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "category": "string",
    "description": "string",
    "displayName": "string",
    "serializedData": "string",
    "sourceId": "string",
    "storageUri": "string",
    "tags": [ "string" ],
    "version": "string"
  }
}

Valeurs de propriété

Classeurs

Nom Description Valeur
type Type de ressource 'Microsoft.Insights/workbooks'
apiVersion Version de l’API de ressource '2021-08-01'
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
étiquettes Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
gentil Type de classeur. Seule la valeur valide est partagée. 'shared'
'user'
etag Etag de ressource corde
identité Identité utilisée pour BYOS WorkbookResourceIdentity
Propriétés Métadonnées décrivant un classeur pour une ressource Azure. WorkbookProperties

WorkbookResourceIdentity

Nom Description Valeur
type Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (obligatoire)
userAssignedIdentities Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. UserAssignedIdentities

UserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserAssignedIdentity

UserAssignedIdentity

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

WorkbookProperties

Nom Description Valeur
catégorie Catégorie de classeur, telle que définie par l’utilisateur au moment de la création. chaîne (obligatoire)
description Description du classeur. corde
displayName Nom défini par l’utilisateur (nom complet) du classeur. chaîne (obligatoire)
serializedData Configuration de ce classeur particulier. Les données de configuration sont une chaîne contenant un JSON valide chaîne (obligatoire)
sourceId ResourceId pour une ressource source. corde
storageUri ResourceId vers le compte de stockage lorsque vous apportez votre propre stockage est utilisé corde
étiquettes En cours de dépréciation, utilisez le champ d’autres balises string[]
Version Format de version du schéma du classeur, tel que « Notebook/1.0 », qui doit correspondre au classeur dans serializedData corde

Modèles de démarrage rapide

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

Modèle Description
classeur finOps toolkit

Déployer sur Azure
Ce modèle crée un classeur Azure Monitor pour la gouvernance.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource classeurs 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.Insights/workbooks, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooks@2021-08-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      category = "string"
      description = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
    kind = "string"
    etag = "string"
  })
}

Valeurs de propriété

Classeurs

Nom Description Valeur
type Type de ressource « Microsoft.Insights/workbooks@2021-08-01 »
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement géographique où réside 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)
étiquettes Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
gentil Type de classeur. Seule la valeur valide est partagée. « partagé »
« user »
etag Etag de ressource corde
identité Identité utilisée pour BYOS WorkbookResourceIdentity
Propriétés Métadonnées décrivant un classeur pour une ressource Azure. WorkbookProperties

WorkbookResourceIdentity

Nom Description Valeur
type Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). « SystemAssigned »
« SystemAssigned,UserAssigned »
« UserAssigned » (obligatoire)
identity_ids Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes. Tableau d’ID d’identité utilisateur.

UserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserAssignedIdentity

UserAssignedIdentity

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

WorkbookProperties

Nom Description Valeur
catégorie Catégorie de classeur, telle que définie par l’utilisateur au moment de la création. chaîne (obligatoire)
description Description du classeur. corde
displayName Nom défini par l’utilisateur (nom complet) du classeur. chaîne (obligatoire)
serializedData Configuration de ce classeur particulier. Les données de configuration sont une chaîne contenant un JSON valide chaîne (obligatoire)
sourceId ResourceId pour une ressource source. corde
storageUri ResourceId vers le compte de stockage lorsque vous apportez votre propre stockage est utilisé corde
étiquettes En cours de dépréciation, utilisez le champ d’autres balises string[]
Version Format de version du schéma du classeur, tel que « Notebook/1.0 », qui doit correspondre au classeur dans serializedData corde