Udostępnij za pośrednictwem


Skoroszyty Microsoft.Insights 2023-06-01

Definicja zasobu Bicep

Typ zasobu skoroszytów można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Insights/workbooks, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Insights/workbooks@2023-06-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'
  }
}

Wartości właściwości

Microsoft.Insights/skoroszyty

Nazwa Opis Wartość
etag Zasób etag struna
tożsamość Tożsamość używana w usłudze BYOS WorkbookResourceIdentity
rodzaj Rodzaj skoroszytu. Udostępniono tylko prawidłową wartość. "udostępnione"
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Metadane opisujące skoroszyt dla zasobu platformy Azure. WorkbookProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

TrackedResourceTags

Nazwa Opis Wartość

UserAssignedIdentities

Nazwa Opis Wartość

UserAssignedIdentity

Nazwa Opis Wartość

Właściwości skoroszytu

Nazwa Opis Wartość
kategoria Kategoria skoroszytu zdefiniowana przez użytkownika w czasie tworzenia. ciąg (wymagany)
opis Opis skoroszytu. struna
displayName Nazwa zdefiniowana przez użytkownika (nazwa wyświetlana) skoroszytu. ciąg (wymagany)
serializedData Konfiguracja tego konkretnego skoroszytu. Dane konfiguracji to ciąg zawierający prawidłowy kod JSON ciąg (wymagany)
sourceId ResourceId dla zasobu źródłowego. struna
storageUri Identyfikator resourceId na koncie magazynu, gdy jest używany własny magazyn struna
Tagi Przestarzałe, użyj innego pola tagów string[]
Wersja Format wersji schematu skoroszytu, taki jak "Notebook/1.0", który powinien być zgodny ze skoroszytem w serializedData struna

WorkbookResourceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Skoroszyt optymalizacji kosztów Ten szablon tworzy nowy skoroszyt usługi Azure Monitor na potrzeby optymalizacji kosztów na podstawie platformy Well-Architected Framework.
skoroszytu zestawu narzędzi FinOps Ten szablon tworzy nowy skoroszyt usługi Azure Monitor na potrzeby ładu.

Definicja zasobu szablonu usługi ARM

Typ zasobu skoroszytów można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Insights/workbooks, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Insights/workbooks",
  "apiVersion": "2023-06-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"
  }
}

Wartości właściwości

Microsoft.Insights/skoroszyty

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-06-01'
etag Zasób etag struna
tożsamość Tożsamość używana w usłudze BYOS WorkbookResourceIdentity
rodzaj Rodzaj skoroszytu. Udostępniono tylko prawidłową wartość. "udostępnione"
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Metadane opisujące skoroszyt dla zasobu platformy Azure. WorkbookProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Insights/workbooks"

TrackedResourceTags

Nazwa Opis Wartość

UserAssignedIdentities

Nazwa Opis Wartość

UserAssignedIdentity

Nazwa Opis Wartość

Właściwości skoroszytu

Nazwa Opis Wartość
kategoria Kategoria skoroszytu zdefiniowana przez użytkownika w czasie tworzenia. ciąg (wymagany)
opis Opis skoroszytu. struna
displayName Nazwa zdefiniowana przez użytkownika (nazwa wyświetlana) skoroszytu. ciąg (wymagany)
serializedData Konfiguracja tego konkretnego skoroszytu. Dane konfiguracji to ciąg zawierający prawidłowy kod JSON ciąg (wymagany)
sourceId ResourceId dla zasobu źródłowego. struna
storageUri Identyfikator resourceId na koncie magazynu, gdy jest używany własny magazyn struna
Tagi Przestarzałe, użyj innego pola tagów string[]
Wersja Format wersji schematu skoroszytu, taki jak "Notebook/1.0", który powinien być zgodny ze skoroszytem w serializedData struna

WorkbookResourceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Skoroszyt optymalizacji kosztów

Wdróż na platformie Azure
Ten szablon tworzy nowy skoroszyt usługi Azure Monitor na potrzeby optymalizacji kosztów na podstawie platformy Well-Architected Framework.
skoroszytu zestawu narzędzi FinOps

Wdróż na platformie Azure
Ten szablon tworzy nowy skoroszyt usługi Azure Monitor na potrzeby ładu.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu skoroszytów można wdrożyć przy użyciu operacji docelowych:

  • Grupa zasobów:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Insights/workbooks, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooks@2023-06-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"
    }
  })
}

Wartości właściwości

Microsoft.Insights/skoroszyty

Nazwa Opis Wartość
etag Zasób etag struna
tożsamość Tożsamość używana w usłudze BYOS WorkbookResourceIdentity
rodzaj Rodzaj skoroszytu. Udostępniono tylko prawidłową wartość. "udostępnione"
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Metadane opisujące skoroszyt dla zasobu platformy Azure. WorkbookProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Insights/workbooks@2023-06-01"

TrackedResourceTags

Nazwa Opis Wartość

UserAssignedIdentities

Nazwa Opis Wartość

UserAssignedIdentity

Nazwa Opis Wartość

Właściwości skoroszytu

Nazwa Opis Wartość
kategoria Kategoria skoroszytu zdefiniowana przez użytkownika w czasie tworzenia. ciąg (wymagany)
opis Opis skoroszytu. struna
displayName Nazwa zdefiniowana przez użytkownika (nazwa wyświetlana) skoroszytu. ciąg (wymagany)
serializedData Konfiguracja tego konkretnego skoroszytu. Dane konfiguracji to ciąg zawierający prawidłowy kod JSON ciąg (wymagany)
sourceId ResourceId dla zasobu źródłowego. struna
storageUri Identyfikator resourceId na koncie magazynu, gdy jest używany własny magazyn struna
Tagi Przestarzałe, użyj innego pola tagów string[]
Wersja Format wersji schematu skoroszytu, taki jak "Notebook/1.0", który powinien być zgodny ze skoroszytem w serializedData struna

WorkbookResourceIdentity

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned). "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach. UserAssignedIdentities