Partilhar via


Microsoft.CloudHealth healthmodels/entidades 2025-05-01-preview

Definição de recursos do bíceps

O tipo de recurso healthmodels/entities pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.CloudHealth/healthmodels/entities, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

Microsoft.CloudHealth/healthmodels/entities

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: healthmodels
propriedades As propriedades específicas do recurso para este recurso. EntityProperties

AlertConfiguration

Nome Descrição Valor
açãoGroupIds Lista opcional de IDs de recursos do grupo de ações a serem notificados quando o alerta for acionado. string[]
descrição A descrição da regra de alerta. cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1000
gravidade A gravidade do alerta acionado. 'Sev0'
'Sev1'
«Sev2»
«Sev3»
'Sev4' (obrigatório)

AzureMonitorWorkspaceSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
azureMonitorWorkspaceResourceId ID do recurso do espaço de trabalho do Azure Monitor string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

AzureResourceSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
azureResourceId ID de recurso do Azure string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

DependênciasSignalGroup

Nome Descrição Valor
tipo de agregação Tipo de agregação para dependências filhas. «Limiares»
'WorstOf' (obrigatório)
degradedThreshold Limiar degradado para agregar o estado de saúde propagado das dependências infantis. Pode ser um número absoluto maior que 0 ou uma porcentagem entre 1-100%. A entidade será considerada degradada quando o número de filhos dependentes não saudáveis (insalubres, degradados, desconhecidos) for igual ou superior ao valor limite. Só deve ser definido quando AggregationType é 'Limiares'. corda
unhealthyThreshold Limiar insalubre para agregar o estado de saúde propagado das dependências infantis. Pode ser um número absoluto maior que 0 ou uma porcentagem entre 1-100%. A entidade será considerada insalubre quando o número de filhos dependentes não saudáveis (insalubres, degradados, desconhecidos) for igual ou superior ao valor limite. Só deve ser definido quando AggregationType é 'Limiares'. corda

EntityAlerts

Nome Descrição Valor
degradado Alerta a ser acionado na mudança de estado para degradado AlertConfiguration
insalubre Alerta a ser acionado na mudança de estado para não íntegro AlertConfiguration

EntityCoordinates

Nome Descrição Valor
x Coordenada X int (obrigatório)
y Coordenada Y int (obrigatório)

EntityProperties

Nome Descrição Valor
alertas Configuração de alerta para esta entidade EntityAlerts
canvasPosição Posicionamento da entidade na tela do modelo EntityCoordinates
nome de exibição Nome de exibição cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 260
saúdeObjectivo Objetivo de saúde em percentagem de tempo que a entidade deve estar saudável. Int

Restrições:
Valor mínimo = 0
Valor máximo = 100
ícone Definição de ícone visual. Se não estiver definido, um ícone padrão será usado. IconDefinition
impacto Impacto da entidade na propagação do estado de saúde 'Limitado'
'Padrão'
'Suprimido'
tipo Tipo de entidade cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 260
rótulos Conjunto opcional de etiquetas (pares chave-valor) EntityPropertiesLabels
sinais Grupos de sinais atribuídos a esta entidade Grupo de Sinais

EntityPropertiesLabels

Nome Descrição Valor

IconDefinition

Nome Descrição Valor
customData Dados personalizados. Dados SVG codificados em Base64. Se definido, isso substitui o ícone interno. cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 5000
iconName Nome do ícone incorporado ou 'Personalizado' para utilizar customData cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100 (obrigatório)

LogAnalyticsSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
logAnalyticsWorkspaceResourceId ID do recurso do espaço de trabalho do Log Analytics string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

SignalAssignment

Nome Descrição Valor
signalDefinitions Definições de sinal referenciadas pelos seus nomes. Todas as definições são combinadas com um operador AND. cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$[] (obrigatório)

Grupo de Sinais

Nome Descrição Valor
azureLogAnalytics Grupo de Sinais do Log Analytics LogAnalyticsSignalGroup
azureMonitorWorkspace Grupo de Sinais do Espaço de Trabalho do Azure Monitor AzureMonitorWorkspaceSignalGroup
azureResource Azure Resource Signal Group AzureResourceSignalGroup
dependências Configurações para sinais de dependência para controlar como o estado de integridade de entidades filhas influencia o estado de integridade da entidade pai. DependênciasSignalGroup

Definição de recurso de modelo ARM

O tipo de recurso healthmodels/entities pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.CloudHealth/healthmodels/entities, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

Microsoft.CloudHealth/healthmodels/entities

Nome Descrição Valor
Versão da API A versão api '2025-05-01-pré-visualização'
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
propriedades As propriedades específicas do recurso para este recurso. EntityProperties
tipo O tipo de recurso 'Microsoft.CloudHealth/healthmodels/entities'

AlertConfiguration

Nome Descrição Valor
açãoGroupIds Lista opcional de IDs de recursos do grupo de ações a serem notificados quando o alerta for acionado. string[]
descrição A descrição da regra de alerta. cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1000
gravidade A gravidade do alerta acionado. 'Sev0'
'Sev1'
«Sev2»
«Sev3»
'Sev4' (obrigatório)

AzureMonitorWorkspaceSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
azureMonitorWorkspaceResourceId ID do recurso do espaço de trabalho do Azure Monitor string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

AzureResourceSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
azureResourceId ID de recurso do Azure string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

DependênciasSignalGroup

Nome Descrição Valor
tipo de agregação Tipo de agregação para dependências filhas. «Limiares»
'WorstOf' (obrigatório)
degradedThreshold Limiar degradado para agregar o estado de saúde propagado das dependências infantis. Pode ser um número absoluto maior que 0 ou uma porcentagem entre 1-100%. A entidade será considerada degradada quando o número de filhos dependentes não saudáveis (insalubres, degradados, desconhecidos) for igual ou superior ao valor limite. Só deve ser definido quando AggregationType é 'Limiares'. corda
unhealthyThreshold Limiar insalubre para agregar o estado de saúde propagado das dependências infantis. Pode ser um número absoluto maior que 0 ou uma porcentagem entre 1-100%. A entidade será considerada insalubre quando o número de filhos dependentes não saudáveis (insalubres, degradados, desconhecidos) for igual ou superior ao valor limite. Só deve ser definido quando AggregationType é 'Limiares'. corda

EntityAlerts

Nome Descrição Valor
degradado Alerta a ser acionado na mudança de estado para degradado AlertConfiguration
insalubre Alerta a ser acionado na mudança de estado para não íntegro AlertConfiguration

EntityCoordinates

Nome Descrição Valor
x Coordenada X int (obrigatório)
y Coordenada Y int (obrigatório)

EntityProperties

Nome Descrição Valor
alertas Configuração de alerta para esta entidade EntityAlerts
canvasPosição Posicionamento da entidade na tela do modelo EntityCoordinates
nome de exibição Nome de exibição cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 260
saúdeObjectivo Objetivo de saúde em percentagem de tempo que a entidade deve estar saudável. Int

Restrições:
Valor mínimo = 0
Valor máximo = 100
ícone Definição de ícone visual. Se não estiver definido, um ícone padrão será usado. IconDefinition
impacto Impacto da entidade na propagação do estado de saúde 'Limitado'
'Padrão'
'Suprimido'
tipo Tipo de entidade cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 260
rótulos Conjunto opcional de etiquetas (pares chave-valor) EntityPropertiesLabels
sinais Grupos de sinais atribuídos a esta entidade Grupo de Sinais

EntityPropertiesLabels

Nome Descrição Valor

IconDefinition

Nome Descrição Valor
customData Dados personalizados. Dados SVG codificados em Base64. Se definido, isso substitui o ícone interno. cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 5000
iconName Nome do ícone incorporado ou 'Personalizado' para utilizar customData cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100 (obrigatório)

LogAnalyticsSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
logAnalyticsWorkspaceResourceId ID do recurso do espaço de trabalho do Log Analytics string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

SignalAssignment

Nome Descrição Valor
signalDefinitions Definições de sinal referenciadas pelos seus nomes. Todas as definições são combinadas com um operador AND. cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$[] (obrigatório)

Grupo de Sinais

Nome Descrição Valor
azureLogAnalytics Grupo de Sinais do Log Analytics LogAnalyticsSignalGroup
azureMonitorWorkspace Grupo de Sinais do Espaço de Trabalho do Azure Monitor AzureMonitorWorkspaceSignalGroup
azureResource Azure Resource Signal Group AzureResourceSignalGroup
dependências Configurações para sinais de dependência para controlar como o estado de integridade de entidades filhas influencia o estado de integridade da entidade pai. DependênciasSignalGroup

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso healthmodels/entities pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.CloudHealth/healthmodels/entities, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

Microsoft.CloudHealth/healthmodels/entities

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: healthmodels
propriedades As propriedades específicas do recurso para este recurso. EntityProperties
tipo O tipo de recurso "Microsoft.CloudHealth/healthmodels/entities@2025-05-01-preview"

AlertConfiguration

Nome Descrição Valor
açãoGroupIds Lista opcional de IDs de recursos do grupo de ações a serem notificados quando o alerta for acionado. string[]
descrição A descrição da regra de alerta. cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1000
gravidade A gravidade do alerta acionado. 'Sev0'
'Sev1'
«Sev2»
«Sev3»
'Sev4' (obrigatório)

AzureMonitorWorkspaceSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
azureMonitorWorkspaceResourceId ID do recurso do espaço de trabalho do Azure Monitor string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

AzureResourceSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
azureResourceId ID de recurso do Azure string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

DependênciasSignalGroup

Nome Descrição Valor
tipo de agregação Tipo de agregação para dependências filhas. «Limiares»
'WorstOf' (obrigatório)
degradedThreshold Limiar degradado para agregar o estado de saúde propagado das dependências infantis. Pode ser um número absoluto maior que 0 ou uma porcentagem entre 1-100%. A entidade será considerada degradada quando o número de filhos dependentes não saudáveis (insalubres, degradados, desconhecidos) for igual ou superior ao valor limite. Só deve ser definido quando AggregationType é 'Limiares'. corda
unhealthyThreshold Limiar insalubre para agregar o estado de saúde propagado das dependências infantis. Pode ser um número absoluto maior que 0 ou uma porcentagem entre 1-100%. A entidade será considerada insalubre quando o número de filhos dependentes não saudáveis (insalubres, degradados, desconhecidos) for igual ou superior ao valor limite. Só deve ser definido quando AggregationType é 'Limiares'. corda

EntityAlerts

Nome Descrição Valor
degradado Alerta a ser acionado na mudança de estado para degradado AlertConfiguration
insalubre Alerta a ser acionado na mudança de estado para não íntegro AlertConfiguration

EntityCoordinates

Nome Descrição Valor
x Coordenada X int (obrigatório)
y Coordenada Y int (obrigatório)

EntityProperties

Nome Descrição Valor
alertas Configuração de alerta para esta entidade EntityAlerts
canvasPosição Posicionamento da entidade na tela do modelo EntityCoordinates
nome de exibição Nome de exibição cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 260
saúdeObjectivo Objetivo de saúde em percentagem de tempo que a entidade deve estar saudável. Int

Restrições:
Valor mínimo = 0
Valor máximo = 100
ícone Definição de ícone visual. Se não estiver definido, um ícone padrão será usado. IconDefinition
impacto Impacto da entidade na propagação do estado de saúde 'Limitado'
'Padrão'
'Suprimido'
tipo Tipo de entidade cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 260
rótulos Conjunto opcional de etiquetas (pares chave-valor) EntityPropertiesLabels
sinais Grupos de sinais atribuídos a esta entidade Grupo de Sinais

EntityPropertiesLabels

Nome Descrição Valor

IconDefinition

Nome Descrição Valor
customData Dados personalizados. Dados SVG codificados em Base64. Se definido, isso substitui o ícone interno. cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 5000
iconName Nome do ícone incorporado ou 'Personalizado' para utilizar customData cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100 (obrigatório)

LogAnalyticsSignalGroup

Nome Descrição Valor
authenticationSetting Referência ao nome da configuração de autenticação usada para consultar a fonte de dados cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$ (obrigatório)
logAnalyticsWorkspaceResourceId ID do recurso do espaço de trabalho do Log Analytics string (obrigatório)
signalAssignments Definições de sinal que são atribuídas a este grupo de sinais. Todas as atribuições são combinadas com um operador OR. SignalAssignment[]

SignalAssignment

Nome Descrição Valor
signalDefinitions Definições de sinal referenciadas pelos seus nomes. Todas as definições são combinadas com um operador AND. cadeia de caracteres

Restrições:
Padrão = ^[a-zA-Z0-9][a-zA-Z0-9-]{1,258}[a-zA-Z0-9]$[] (obrigatório)

Grupo de Sinais

Nome Descrição Valor
azureLogAnalytics Grupo de Sinais do Log Analytics LogAnalyticsSignalGroup
azureMonitorWorkspace Grupo de Sinais do Espaço de Trabalho do Azure Monitor AzureMonitorWorkspaceSignalGroup
azureResource Azure Resource Signal Group AzureResourceSignalGroup
dependências Configurações para sinais de dependência para controlar como o estado de integridade de entidades filhas influencia o estado de integridade da entidade pai. DependênciasSignalGroup