Microsoft.Insights-arbetsböcker
Bicep-resursdefinition
Resurstypen arbetsböcker kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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@2023-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'shared'
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'
}
}
Egenskapsvärden
Arbetsböcker
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng (krävs) |
| plats | Den geo-plats där resursen finns | sträng (krävs) |
| Taggar | Resurstaggar. | Ordlista med taggnamn och värden. Se taggar i mallar |
| sort | Typ av arbetsbok. Endast giltigt värde delas. | "delad" |
| etag | Resursetaggar | sträng |
| identitet | Identitet som används för BYOS | WorkbookResourceIdentity |
| Egenskaper | Metadata som beskriver en arbetsbok för en Azure-resurs. | ArbetsbokEgenskaper |
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 |
UserAssignedIdentiteter
| Namn | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | UserAssignedIdentity |
UserAssignedIdentity
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
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 |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
FinOps toolkit-arbetsbok
|
Den här mallen skapar en ny Azure Monitor-arbetsbok för styrning. |
|
Arbetsbok för kostnadsoptimering
|
Den här mallen skapar en ny Azure Monitor-arbetsbok för kostnadsoptimering baserat på Well-Architected Framework. |
Resursdefinition för ARM-mall
Resurstypen arbetsböcker kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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": "2023-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "shared",
"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"
}
}
Egenskapsvärden
Arbetsböcker
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Insights/arbetsböcker" |
| apiVersion | Resurs-API-versionen | '2023-06-01' |
| Namn | Resursnamnet | sträng (krävs) |
| plats | Den geo-plats där resursen finns | sträng (krävs) |
| Taggar | Resurstaggar. | Ordlista med taggnamn och värden. Se taggar i mallar |
| sort | Typ av arbetsbok. Endast giltigt värde delas. | "delad" |
| etag | Resursetaggar | sträng |
| identitet | Identitet som används för BYOS | WorkbookResourceIdentity |
| Egenskaper | Metadata som beskriver en arbetsbok för en Azure-resurs. | ArbetsbokEgenskaper |
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 |
UserAssignedIdentiteter
| Namn | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | UserAssignedIdentity |
UserAssignedIdentity
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
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 |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
|
FinOps toolkit-arbetsbok
|
Den här mallen skapar en ny Azure Monitor-arbetsbok för styrning. |
|
Arbetsbok för kostnadsoptimering
|
Den här mallen skapar en ny Azure Monitor-arbetsbok för kostnadsoptimering baserat på Well-Architected Framework. |
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@2023-06-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 = "shared"
etag = "string"
})
}
Egenskapsvärden
Arbetsböcker
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.Insights/workbooks@2023-06-01" |
| Namn | Resursnamnet | sträng (krävs) |
| plats | Den geo-plats där resursen finns | sträng (krävs) |
| parent_id | Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. | sträng (krävs) |
| Taggar | Resurstaggar. | Ordlista med taggnamn och värden. |
| sort | Typ av arbetsbok. Endast giltigt värde delas. | "delad" |
| etag | Resursetaggar | sträng |
| identitet | Identitet som används för BYOS | WorkbookResourceIdentity |
| Egenskaper | Metadata som beskriver en arbetsbok för en Azure-resurs. | ArbetsbokEgenskaper |
WorkbookResourceIdentity
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts). | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (krävs) |
| identity_ids | 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. | Matris med användaridentitets-ID:t. |
UserAssignedIdentiteter
| Namn | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | UserAssignedIdentity |
UserAssignedIdentity
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
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 |