Microsoft.Insights ブック

Bicep リソース定義

ブックのリソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Insights/workbooks リソースを作成するには、次の Bicep をテンプレートに追加します。

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'
  }
}

プロパティ値

ブック

名前 形容 価値
名前 リソース名 string (必須)
場所 リソースが存在する地理的な場所 string (必須)
タグ リソース タグ。 タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 ブックの種類。 有効な値のみが共有されます。 'shared'
etag リソース etag
同一性 BYOS に使用される ID WorkbookResourceIdentity の
プロパティ Azure リソースのブックを記述するメタデータ。 WorkbookProperties を する

WorkbookResourceIdentity

名前 形容 価値
種類 マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 UserAssignedIdentities の

UserAssignedIdentities

名前 形容 価値
{カスタマイズされたプロパティ} UserAssignedIdentity の

UserAssignedIdentity

このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

WorkbookProperties

名前 形容 価値
カテゴリ 作成時にユーザーが定義したブック カテゴリ。 string (必須)
形容 ブックの説明。
displayName ブックのユーザー定義名 (表示名)。 string (必須)
serializedData この特定のブックの構成。 構成データは、有効な JSON を含む文字列です string (必須)
sourceId ソース リソースの ResourceId。
storageUri 独自のストレージを持ち込むときにストレージ アカウントに対する resourceId が使用される
タグ 非推奨の場合は、他のタグ フィールドを使用してください string[]
バージョン 'Notebook/1.0' のようなブック スキーマのバージョン形式。serializedData 内のブックと一致する必要があります

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
FinOps ツールキット ブックの を する

Azure
にデプロイする
このテンプレートでは、ガバナンス用の新しい Azure Monitor ブックが作成されます。

ARM テンプレート リソース定義

ブックのリソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Insights/workbooks リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "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"
  }
}

プロパティ値

ブック

名前 形容 価値
種類 リソースの種類 'Microsoft.Insights/workbooks'
apiVersion リソース API のバージョン '2023-06-01'
名前 リソース名 string (必須)
場所 リソースが存在する地理的な場所 string (必須)
タグ リソース タグ。 タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 ブックの種類。 有効な値のみが共有されます。 'shared'
etag リソース etag
同一性 BYOS に使用される ID WorkbookResourceIdentity の
プロパティ Azure リソースのブックを記述するメタデータ。 WorkbookProperties を する

WorkbookResourceIdentity

名前 形容 価値
種類 マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 UserAssignedIdentities の

UserAssignedIdentities

名前 形容 価値
{カスタマイズされたプロパティ} UserAssignedIdentity の

UserAssignedIdentity

このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

WorkbookProperties

名前 形容 価値
カテゴリ 作成時にユーザーが定義したブック カテゴリ。 string (必須)
形容 ブックの説明。
displayName ブックのユーザー定義名 (表示名)。 string (必須)
serializedData この特定のブックの構成。 構成データは、有効な JSON を含む文字列です string (必須)
sourceId ソース リソースの ResourceId。
storageUri 独自のストレージを持ち込むときにストレージ アカウントに対する resourceId が使用される
タグ 非推奨の場合は、他のタグ フィールドを使用してください string[]
バージョン 'Notebook/1.0' のようなブック スキーマのバージョン形式。serializedData 内のブックと一致する必要があります

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
FinOps ツールキット ブックの を する

Azure
にデプロイする
このテンプレートでは、ガバナンス用の新しい Azure Monitor ブックが作成されます。

Terraform (AzAPI プロバイダー) リソース定義

ブックのリソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Insights/workbooks リソースを作成するには、次の Terraform をテンプレートに追加します。

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"
  })
}

プロパティ値

ブック

名前 形容 価値
種類 リソースの種類 "Microsoft.Insights/workbooks@2023-06-01"
名前 リソース名 string (必須)
場所 リソースが存在する地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
タグ リソース タグ。 タグ名と値のディクショナリ。
種類 ブックの種類。 有効な値のみが共有されます。 "shared"
etag リソース etag
同一性 BYOS に使用される ID WorkbookResourceIdentity の
プロパティ Azure リソースのブックを記述するメタデータ。 WorkbookProperties を する

WorkbookResourceIdentity

名前 形容 価値
種類 マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (必須)
identity_ids リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 ユーザー ID ID の配列。

UserAssignedIdentities

名前 形容 価値
{カスタマイズされたプロパティ} UserAssignedIdentity の

UserAssignedIdentity

このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

WorkbookProperties

名前 形容 価値
カテゴリ 作成時にユーザーが定義したブック カテゴリ。 string (必須)
形容 ブックの説明。
displayName ブックのユーザー定義名 (表示名)。 string (必須)
serializedData この特定のブックの構成。 構成データは、有効な JSON を含む文字列です string (必須)
sourceId ソース リソースの ResourceId。
storageUri 独自のストレージを持ち込むときにストレージ アカウントに対する resourceId が使用される
タグ 非推奨の場合は、他のタグ フィールドを使用してください string[]
バージョン 'Notebook/1.0' のようなブック スキーマのバージョン形式。serializedData 内のブックと一致する必要があります