Dela via


Microsoft.Insights-arbetsböcker 2022-04-01

Bicep-resursdefinition

Resurstypen arbetsböcker kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Insights/arbetsboksresurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

Microsoft.Insights/arbetsböcker

Namn Beskrivning Värde
etag Resursetaggar sträng
identitet Identitet som används för BYOS WorkbookResourceIdentity
sort Typ av arbetsbok. Endast giltigt värde delas. "delad"
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Metadata som beskriver en arbetsbok för en Azure-resurs. ArbetsbokEgenskaper
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

TrackedResourceTags

Namn Beskrivning Värde

UserAssignedIdentiteter

Namn Beskrivning Värde

UserAssignedIdentity

Namn Beskrivning Värde

ArbetsbokEgenskaper

Namn Beskrivning Värde
kategori Arbetsbokskategori enligt definitionen av användaren vid skapandetillfället. sträng (krävs)
beskrivning Beskrivningen av arbetsboken. sträng
displayName Arbetsbokens användardefinierade namn (visningsnamn). sträng (krävs)
serializedData Konfiguration av den här arbetsboken. Konfigurationsdata är en sträng som innehåller giltig JSON sträng (krävs)
sourceId ResourceId för en källresurs. sträng
storageUri ResourceId till lagringskontot när bring your own storage används sträng
Taggar Om du är inaktuell använder du fältet andra taggar string[]
version Versionsformat för arbetsboksschema, till exempel Notebook/1.0, som ska matcha arbetsboken i serializedData sträng

WorkbookResourceIdentity

Namn Beskrivning Värde
typ Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (krävs)
userAssignedIdentities Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. UserAssignedIdentiteter

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Arbetsbok för kostnadsoptimering Den här mallen skapar en ny Azure Monitor-arbetsbok för kostnadsoptimering baserat på Well-Architected Framework.
FinOps toolkit-arbetsbok Den här mallen skapar en ny Azure Monitor-arbetsbok för styrning.

Resursdefinition för ARM-mall

Resurstypen arbetsböcker kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Insights/arbetsboksresurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

Microsoft.Insights/arbetsböcker

Namn Beskrivning Värde
apiVersion API-versionen '2022-04-01'
etag Resursetaggar sträng
identitet Identitet som används för BYOS WorkbookResourceIdentity
sort Typ av arbetsbok. Endast giltigt värde delas. "delad"
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Metadata som beskriver en arbetsbok för en Azure-resurs. ArbetsbokEgenskaper
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.Insights/arbetsböcker"

TrackedResourceTags

Namn Beskrivning Värde

UserAssignedIdentiteter

Namn Beskrivning Värde

UserAssignedIdentity

Namn Beskrivning Värde

ArbetsbokEgenskaper

Namn Beskrivning Värde
kategori Arbetsbokskategori enligt definitionen av användaren vid skapandetillfället. sträng (krävs)
beskrivning Beskrivningen av arbetsboken. sträng
displayName Arbetsbokens användardefinierade namn (visningsnamn). sträng (krävs)
serializedData Konfiguration av den här arbetsboken. Konfigurationsdata är en sträng som innehåller giltig JSON sträng (krävs)
sourceId ResourceId för en källresurs. sträng
storageUri ResourceId till lagringskontot när bring your own storage används sträng
Taggar Om du är inaktuell använder du fältet andra taggar string[]
version Versionsformat för arbetsboksschema, till exempel Notebook/1.0, som ska matcha arbetsboken i serializedData sträng

WorkbookResourceIdentity

Namn Beskrivning Värde
typ Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (krävs)
userAssignedIdentities Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. UserAssignedIdentiteter

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Arbetsbok för kostnadsoptimering

Distribuera till Azure
Den här mallen skapar en ny Azure Monitor-arbetsbok för kostnadsoptimering baserat på Well-Architected Framework.
FinOps toolkit-arbetsbok

Distribuera till Azure
Den här mallen skapar en ny Azure Monitor-arbetsbok för styrning.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen arbetsböcker kan distribueras med åtgärder som mål:

  • Resursgrupp

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Insights/arbetsboksresurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooks@2022-04-01"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      category = "string"
      description = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
  })
}

Egenskapsvärden

Microsoft.Insights/arbetsböcker

Namn Beskrivning Värde
etag Resursetaggar sträng
identitet Identitet som används för BYOS WorkbookResourceIdentity
sort Typ av arbetsbok. Endast giltigt värde delas. "delad"
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Metadata som beskriver en arbetsbok för en Azure-resurs. ArbetsbokEgenskaper
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.Insights/workbooks@2022-04-01"

TrackedResourceTags

Namn Beskrivning Värde

UserAssignedIdentiteter

Namn Beskrivning Värde

UserAssignedIdentity

Namn Beskrivning Värde

ArbetsbokEgenskaper

Namn Beskrivning Värde
kategori Arbetsbokskategori enligt definitionen av användaren vid skapandetillfället. sträng (krävs)
beskrivning Beskrivningen av arbetsboken. sträng
displayName Arbetsbokens användardefinierade namn (visningsnamn). sträng (krävs)
serializedData Konfiguration av den här arbetsboken. Konfigurationsdata är en sträng som innehåller giltig JSON sträng (krävs)
sourceId ResourceId för en källresurs. sträng
storageUri ResourceId till lagringskontot när bring your own storage används sträng
Taggar Om du är inaktuell använder du fältet andra taggar string[]
version Versionsformat för arbetsboksschema, till exempel Notebook/1.0, som ska matcha arbetsboken i serializedData sträng

WorkbookResourceIdentity

Namn Beskrivning Värde
typ Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (krävs)
userAssignedIdentities Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. UserAssignedIdentiteter