Microsoft.CloudHealth ヘルスモデル/エンティティ

• 最新
• 2025-05-01-プレビュー

Bicep リソース定義

healthmodels/entities リソースの種類は、以下を対象とする操作でデプロイできます。

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

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

リソース形式

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

resource symbolicname 'Microsoft.CloudHealth/healthmodels/entities@2025-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alerts: {
      degraded: {
        actionGroupIds: [
          'string'
        ]
        description: 'string'
        severity: 'string'
      }
      unhealthy: {
        actionGroupIds: [
          'string'
        ]
        description: 'string'
        severity: 'string'
      }
    }
    canvasPosition: {
      x: int
      y: int
    }
    displayName: 'string'
    healthObjective: int
    icon: {
      customData: 'string'
      iconName: 'string'
    }
    impact: 'string'
    kind: 'string'
    labels: {
      {customized property}: 'string'
    }
    signals: {
      azureLogAnalytics: {
        authenticationSetting: 'string'
        logAnalyticsWorkspaceResourceId: 'string'
        signalAssignments: [
          {
            signalDefinitions: [
              'string'
            ]
          }
        ]
      }
      azureMonitorWorkspace: {
        authenticationSetting: 'string'
        azureMonitorWorkspaceResourceId: 'string'
        signalAssignments: [
          {
            signalDefinitions: [
              'string'
            ]
          }
        ]
      }
      azureResource: {
        authenticationSetting: 'string'
        azureResourceId: 'string'
        signalAssignments: [
          {
            signalDefinitions: [
              'string'
            ]
          }
        ]
      }
      dependencies: {
        aggregationType: 'string'
        degradedThreshold: 'string'
        unhealthyThreshold: 'string'
      }
    }
  }
}

プロパティ値

Microsoft.CloudHealth/healthmodels/entities

名前	説明	価値
名前	リソース名	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	リソースの種類の記号名: healthmodels
プロパティ	このリソースのリソース固有のプロパティ。	エンティティプロパティ

警告設定

名前	説明	価値
アクショングループID	アラートがトリガーされたときに通知されるアクション グループ リソース ID の省略可能な一覧。	文字列[]
説明	アラート ルールの説明。	糸 制約： 最小長 = 1 最大長 = 1000
深刻さ	トリガーされたアラートの重大度。	'Sev0' 「Sev1」 「Sev2」 「Sev3」 'Sev4' (必須)

AzureMonitorWorkspaceSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
azureMonitorWorkspaceResourceId	Azure Monitor ワークスペース リソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

AzureResourceSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
azureResourceId	Azure リソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

依存関係シグナルグループ

名前	説明	価値
アグリゲーションタイプ	子依存関係の集計タイプ。	「しきい値」 'WorstOf' (必須)
劣化しきい値	子依存関係の伝達された正常性状態を集計するための低下したしきい値。 0 より大きい絶対数、または 1 から 100%までのパーセンテージを指定できます。 エンティティは、健康でない子供の扶養家族 (不健康、低下、不明) の数がしきい値以上である場合、低下していると見なされます。 AggregationType が 'Thresholds' の場合にのみ設定する必要があります。	ひも
不健康なしきい値	子依存関係の伝達された正常性状態を集計するための異常しきい値。 0 より大きい絶対数、または 1 から 100%までのパーセンテージを指定できます。 健康でない子供の扶養家族 (異常、劣化、不明) の数がしきい値以上の場合、エンティティは異常であると見なされます。 AggregationType が 'Thresholds' の場合にのみ設定する必要があります。	ひも

エンティティアラート

名前	説明	価値
劣化	状態が劣化に変化したときにトリガーされるアラート	アラート構成
不健康	状態が異常に変化したときにトリガーされるアラート	アラート構成

エンティティ座標

名前	説明	価値
x	X 座標	int (必須)
y	Y 座標	int (必須)

エンティティプロパティ

名前	説明	価値
アラート	このエンティティのアラート構成	エンティティアラート
キャンバスポジション	モデルキャンバス上のエンティティの配置	エンティティ座標
ディスプレイ名	[表示名]	糸 制約： 最小長 = 1 最大長 = 260
健康の目的	エンティティが健康である必要がある時間の割合としての正常性目標。	int 制約： 最小値 = 0 最大値 = 100
アイコン	ビジュアル アイコンの定義。 設定されていない場合は、デフォルトのアイコンが使用されます。	アイコン定義
インパクト	正常性状態の伝達におけるエンティティの影響	「リミテッド」 「スタンダード」 「抑圧された」
種類	エンティティの種類	糸 制約： 最小長 = 1 最大長 = 260
ラベル	ラベルのオプション セット (キーと値のペア)	エンティティプロパティラベル
信号	このエンティティに割り当てられている信号グループ	シグナルグループ

エンティティプロパティラベル

名前	説明	価値

アイコン定義

名前	説明	価値
カスタムデータ	カスタム データ。 Base64 でエンコードされた SVG データ。 設定されている場合、これは組み込みアイコンを上書きします。	糸 制約： 最小長 = 1 最大長 = 5000
アイコン名	組み込みアイコンの名前、または customData を使用する場合は 'Custom'	糸 制約： 最小長 = 1 最大長 = 100 (必須)

LogAnalyticsSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
logAnalyticsWorkspaceResourceId	Log Analytics ワークスペースのリソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

シグナルアサイン

名前	説明	価値
シグナル定義	名前で参照される信号定義。 すべての定義は AND 演算子で組み合わされます。	糸 制約： Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$[] (必須)

シグナルグループ

名前	説明	価値
azureLogAnalytics の	Log Analytics シグナル グループ	LogAnalyticsSignalGroup
azureMonitorWorkspace	Azure Monitor ワークスペース信号グループ	AzureMonitorWorkspaceSignalGroup
azureResource の	Azure リソース信号グループ	AzureResourceSignalGroup
依存関係	子エンティティの正常性状態が親エンティティの正常性状態にどのように影響するかを制御するための依存関係シグナルの設定。	依存関係シグナルグループ

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

healthmodels/entities リソースの種類は、以下を対象とする操作でデプロイできます。

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

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

リソース形式

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

{
  "type": "Microsoft.CloudHealth/healthmodels/entities",
  "apiVersion": "2025-05-01-preview",
  "name": "string",
  "properties": {
    "alerts": {
      "degraded": {
        "actionGroupIds": [ "string" ],
        "description": "string",
        "severity": "string"
      },
      "unhealthy": {
        "actionGroupIds": [ "string" ],
        "description": "string",
        "severity": "string"
      }
    },
    "canvasPosition": {
      "x": "int",
      "y": "int"
    },
    "displayName": "string",
    "healthObjective": "int",
    "icon": {
      "customData": "string",
      "iconName": "string"
    },
    "impact": "string",
    "kind": "string",
    "labels": {
      "{customized property}": "string"
    },
    "signals": {
      "azureLogAnalytics": {
        "authenticationSetting": "string",
        "logAnalyticsWorkspaceResourceId": "string",
        "signalAssignments": [
          {
            "signalDefinitions": [ "string" ]
          }
        ]
      },
      "azureMonitorWorkspace": {
        "authenticationSetting": "string",
        "azureMonitorWorkspaceResourceId": "string",
        "signalAssignments": [
          {
            "signalDefinitions": [ "string" ]
          }
        ]
      },
      "azureResource": {
        "authenticationSetting": "string",
        "azureResourceId": "string",
        "signalAssignments": [
          {
            "signalDefinitions": [ "string" ]
          }
        ]
      },
      "dependencies": {
        "aggregationType": "string",
        "degradedThreshold": "string",
        "unhealthyThreshold": "string"
      }
    }
  }
}

プロパティ値

Microsoft.CloudHealth/healthmodels/entities

名前	説明	価値
apiVersion (英語)	API のバージョン	「2025-05-01-プレビュー」
名前	リソース名	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
プロパティ	このリソースのリソース固有のプロパティ。	エンティティプロパティ
種類	リソースの種類	'Microsoft.CloudHealth/healthmodels/entities'

警告設定

名前	説明	価値
アクショングループID	アラートがトリガーされたときに通知されるアクション グループ リソース ID の省略可能な一覧。	文字列[]
説明	アラート ルールの説明。	糸 制約： 最小長 = 1 最大長 = 1000
深刻さ	トリガーされたアラートの重大度。	'Sev0' 「Sev1」 「Sev2」 「Sev3」 'Sev4' (必須)

AzureMonitorWorkspaceSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
azureMonitorWorkspaceResourceId	Azure Monitor ワークスペース リソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

AzureResourceSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
azureResourceId	Azure リソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

依存関係シグナルグループ

名前	説明	価値
アグリゲーションタイプ	子依存関係の集計タイプ。	「しきい値」 'WorstOf' (必須)
劣化しきい値	子依存関係の伝達された正常性状態を集計するための低下したしきい値。 0 より大きい絶対数、または 1 から 100%までのパーセンテージを指定できます。 エンティティは、健康でない子供の扶養家族 (不健康、低下、不明) の数がしきい値以上である場合、低下していると見なされます。 AggregationType が 'Thresholds' の場合にのみ設定する必要があります。	ひも
不健康なしきい値	子依存関係の伝達された正常性状態を集計するための異常しきい値。 0 より大きい絶対数、または 1 から 100%までのパーセンテージを指定できます。 健康でない子供の扶養家族 (異常、劣化、不明) の数がしきい値以上の場合、エンティティは異常であると見なされます。 AggregationType が 'Thresholds' の場合にのみ設定する必要があります。	ひも

エンティティアラート

名前	説明	価値
劣化	状態が劣化に変化したときにトリガーされるアラート	アラート構成
不健康	状態が異常に変化したときにトリガーされるアラート	アラート構成

エンティティ座標

名前	説明	価値
x	X 座標	int (必須)
y	Y 座標	int (必須)

エンティティプロパティ

名前	説明	価値
アラート	このエンティティのアラート構成	エンティティアラート
キャンバスポジション	モデルキャンバス上のエンティティの配置	エンティティ座標
ディスプレイ名	[表示名]	糸 制約： 最小長 = 1 最大長 = 260
健康の目的	エンティティが健康である必要がある時間の割合としての正常性目標。	int 制約： 最小値 = 0 最大値 = 100
アイコン	ビジュアル アイコンの定義。 設定されていない場合は、デフォルトのアイコンが使用されます。	アイコン定義
インパクト	正常性状態の伝達におけるエンティティの影響	「リミテッド」 「スタンダード」 「抑圧された」
種類	エンティティの種類	糸 制約： 最小長 = 1 最大長 = 260
ラベル	ラベルのオプション セット (キーと値のペア)	エンティティプロパティラベル
信号	このエンティティに割り当てられている信号グループ	シグナルグループ

エンティティプロパティラベル

名前	説明	価値

アイコン定義

名前	説明	価値
カスタムデータ	カスタム データ。 Base64 でエンコードされた SVG データ。 設定されている場合、これは組み込みアイコンを上書きします。	糸 制約： 最小長 = 1 最大長 = 5000
アイコン名	組み込みアイコンの名前、または customData を使用する場合は 'Custom'	糸 制約： 最小長 = 1 最大長 = 100 (必須)

LogAnalyticsSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
logAnalyticsWorkspaceResourceId	Log Analytics ワークスペースのリソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

シグナルアサイン

名前	説明	価値
シグナル定義	名前で参照される信号定義。 すべての定義は AND 演算子で組み合わされます。	糸 制約： Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$[] (必須)

シグナルグループ

名前	説明	価値
azureLogAnalytics の	Log Analytics シグナル グループ	LogAnalyticsSignalGroup
azureMonitorWorkspace	Azure Monitor ワークスペース信号グループ	AzureMonitorWorkspaceSignalGroup
azureResource の	Azure リソース信号グループ	AzureResourceSignalGroup
依存関係	子エンティティの正常性状態が親エンティティの正常性状態にどのように影響するかを制御するための依存関係シグナルの設定。	依存関係シグナルグループ

使用例

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

healthmodels/entities リソースの種類は、以下を対象とする操作でデプロイできます。

• リソース・グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CloudHealth/healthmodels/entities@2025-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      alerts = {
        degraded = {
          actionGroupIds = [
            "string"
          ]
          description = "string"
          severity = "string"
        }
        unhealthy = {
          actionGroupIds = [
            "string"
          ]
          description = "string"
          severity = "string"
        }
      }
      canvasPosition = {
        x = int
        y = int
      }
      displayName = "string"
      healthObjective = int
      icon = {
        customData = "string"
        iconName = "string"
      }
      impact = "string"
      kind = "string"
      labels = {
        {customized property} = "string"
      }
      signals = {
        azureLogAnalytics = {
          authenticationSetting = "string"
          logAnalyticsWorkspaceResourceId = "string"
          signalAssignments = [
            {
              signalDefinitions = [
                "string"
              ]
            }
          ]
        }
        azureMonitorWorkspace = {
          authenticationSetting = "string"
          azureMonitorWorkspaceResourceId = "string"
          signalAssignments = [
            {
              signalDefinitions = [
                "string"
              ]
            }
          ]
        }
        azureResource = {
          authenticationSetting = "string"
          azureResourceId = "string"
          signalAssignments = [
            {
              signalDefinitions = [
                "string"
              ]
            }
          ]
        }
        dependencies = {
          aggregationType = "string"
          degradedThreshold = "string"
          unhealthyThreshold = "string"
        }
      }
    }
  }
}

プロパティ値

Microsoft.CloudHealth/healthmodels/entities

名前	説明	価値
名前	リソース名	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
parent_id	このリソースの親であるリソースの ID。	リソースの種類 : healthmodels の ID
プロパティ	このリソースのリソース固有のプロパティ。	エンティティプロパティ
種類	リソースの種類	"Microsoft.CloudHealth/healthmodels/entities@2025-05-01-preview" (英語)

警告設定

名前	説明	価値
アクショングループID	アラートがトリガーされたときに通知されるアクション グループ リソース ID の省略可能な一覧。	文字列[]
説明	アラート ルールの説明。	糸 制約： 最小長 = 1 最大長 = 1000
深刻さ	トリガーされたアラートの重大度。	'Sev0' 「Sev1」 「Sev2」 「Sev3」 'Sev4' (必須)

AzureMonitorWorkspaceSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
azureMonitorWorkspaceResourceId	Azure Monitor ワークスペース リソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

AzureResourceSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
azureResourceId	Azure リソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

依存関係シグナルグループ

名前	説明	価値
アグリゲーションタイプ	子依存関係の集計タイプ。	「しきい値」 'WorstOf' (必須)
劣化しきい値	子依存関係の伝達された正常性状態を集計するための低下したしきい値。 0 より大きい絶対数、または 1 から 100%までのパーセンテージを指定できます。 エンティティは、健康でない子供の扶養家族 (不健康、低下、不明) の数がしきい値以上である場合、低下していると見なされます。 AggregationType が 'Thresholds' の場合にのみ設定する必要があります。	ひも
不健康なしきい値	子依存関係の伝達された正常性状態を集計するための異常しきい値。 0 より大きい絶対数、または 1 から 100%までのパーセンテージを指定できます。 健康でない子供の扶養家族 (異常、劣化、不明) の数がしきい値以上の場合、エンティティは異常であると見なされます。 AggregationType が 'Thresholds' の場合にのみ設定する必要があります。	ひも

エンティティアラート

名前	説明	価値
劣化	状態が劣化に変化したときにトリガーされるアラート	アラート構成
不健康	状態が異常に変化したときにトリガーされるアラート	アラート構成

エンティティ座標

名前	説明	価値
x	X 座標	int (必須)
y	Y 座標	int (必須)

エンティティプロパティ

名前	説明	価値
アラート	このエンティティのアラート構成	エンティティアラート
キャンバスポジション	モデルキャンバス上のエンティティの配置	エンティティ座標
ディスプレイ名	[表示名]	糸 制約： 最小長 = 1 最大長 = 260
健康の目的	エンティティが健康である必要がある時間の割合としての正常性目標。	int 制約： 最小値 = 0 最大値 = 100
アイコン	ビジュアル アイコンの定義。 設定されていない場合は、デフォルトのアイコンが使用されます。	アイコン定義
インパクト	正常性状態の伝達におけるエンティティの影響	「リミテッド」 「スタンダード」 「抑圧された」
種類	エンティティの種類	糸 制約： 最小長 = 1 最大長 = 260
ラベル	ラベルのオプション セット (キーと値のペア)	エンティティプロパティラベル
信号	このエンティティに割り当てられている信号グループ	シグナルグループ

エンティティプロパティラベル

名前	説明	価値

アイコン定義

名前	説明	価値
カスタムデータ	カスタム データ。 Base64 でエンコードされた SVG データ。 設定されている場合、これは組み込みアイコンを上書きします。	糸 制約： 最小長 = 1 最大長 = 5000
アイコン名	組み込みアイコンの名前、または customData を使用する場合は 'Custom'	糸 制約： 最小長 = 1 最大長 = 100 (必須)

LogAnalyticsSignalGroup

名前	説明	価値
認証設定	データ ソースのクエリに使用される認証設定の名前への参照	糸 制約： パターン = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (必須)
logAnalyticsWorkspaceResourceId	Log Analytics ワークスペースのリソース ID	string (必須)
シグナルアサインメント	この信号グループに割り当てられている信号定義。 すべての割り当ては OR 演算子で結合されます。	シグナルアサインメント[]

シグナルアサイン

名前	説明	価値
シグナル定義	名前で参照される信号定義。 すべての定義は AND 演算子で組み合わされます。	糸 制約： Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$[] (必須)

シグナルグループ

名前	説明	価値
azureLogAnalytics の	Log Analytics シグナル グループ	LogAnalyticsSignalGroup
azureMonitorWorkspace	Azure Monitor ワークスペース信号グループ	AzureMonitorWorkspaceSignalGroup
azureResource の	Azure リソース信号グループ	AzureResourceSignalGroup
依存関係	子エンティティの正常性状態が親エンティティの正常性状態にどのように影響するかを制御するための依存関係シグナルの設定。	依存関係シグナルグループ