@azure/arm-cloudhealth package
Classes
| CloudHealthClient |
Interfaces
| AlertConfiguration |
Detalhes da configuração do alerta |
| ApplicationInsightsTopologySpecification |
Especificação da regra de descoberta para uma consulta de topologia Application Insights |
| AuthenticationSetting |
Uma definição de autenticação num modelo de saúde |
| AuthenticationSettingProperties |
Propriedades das definições de autenticação |
| AuthenticationSettingsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| AuthenticationSettingsDeleteOptionalParams |
Parâmetros opcionais. |
| AuthenticationSettingsGetOptionalParams |
Parâmetros opcionais. |
| AuthenticationSettingsListByHealthModelOptionalParams |
Parâmetros opcionais. |
| AuthenticationSettingsOperations |
Interface representando uma operação AuthenticationSettings. |
| AzureMonitorWorkspaceSignals |
Um agrupamento de sinais de espaço de trabalho do Azure Monitor. |
| AzureResourceSignal |
Uma instância de sinal do Azure Resource Metric atribuída a uma entidade. |
| AzureResourceSignals |
Um agrupamento de sinais de recursos do Azure |
| CloudHealthClientOptionalParams |
Parâmetros opcionais para o cliente. |
| DependenciesSignalGroupV2 |
Propriedades para entidades dependentes, ou seja, entidades filhas |
| DiscoveryError |
Detalhes do erro para uma operação de descoberta falhada |
| DiscoveryRule |
Uma regra de descoberta que encontra automaticamente entidades e relações num modelo de saúde com base numa consulta do Azure Resource Graph |
| DiscoveryRuleProperties |
Propriedades da regra de descoberta |
| DiscoveryRulePropertiesCreate |
Propriedades da regra de descoberta para operações de criação/atualização, omitindo campos de apenas leitura do lado do servidor (entityName é obrigatório+apenas leitura no modelo canónico). |
| DiscoveryRuleResourceCreate |
Recurso de regras de descoberta para operações de criação/atualização. |
| DiscoveryRuleSpecification |
Modelo base para especificações de regras de descoberta |
| DiscoveryRulesCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| DiscoveryRulesDeleteOptionalParams |
Parâmetros opcionais. |
| DiscoveryRulesGetOptionalParams |
Parâmetros opcionais. |
| DiscoveryRulesListByHealthModelOptionalParams |
Parâmetros opcionais. |
| DiscoveryRulesOperations |
Interface representando operações de DiscoveryRules. |
| EntitiesCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| EntitiesDeleteOptionalParams |
Parâmetros opcionais. |
| EntitiesGetHistoryOptionalParams |
Parâmetros opcionais. |
| EntitiesGetOptionalParams |
Parâmetros opcionais. |
| EntitiesGetSignalHistoryOptionalParams |
Parâmetros opcionais. |
| EntitiesIngestHealthReportOptionalParams |
Parâmetros opcionais. |
| EntitiesListByHealthModelOptionalParams |
Parâmetros opcionais. |
| EntitiesOperations |
Interface representando as operações de uma Entidade. |
| Entity |
Uma entidade (também conhecida como nó) de um modelo de saúde |
| EntityAlerts |
Configuração de alertas para uma entidade |
| EntityCoordinates |
Posição visual da entidade |
| EntityHistoryRequest |
Solicite ao órgão para obter o histórico de saúde da entidade |
| EntityHistoryResponse |
Resposta contendo transições de estado de saúde da entidade |
| EntityProperties |
Propriedades que são comuns a todos os tipos de entidades |
| ErrorAdditionalInfo |
Informações adicionais sobre o erro de gestão de recursos. |
| ErrorDetail |
O detalhe do erro. |
| ErrorResponse |
Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. |
| EvaluationRule |
Regra de avaliação para uma definição de sinal |
| ExternalSignal |
Uma instância de sinal submetida externamente atribuída a uma entidade. |
| ExternalSignalGroup |
Um agrupamento de sinais submetidos externamente. |
| HealthModel |
Um recurso do HealthModel |
| HealthModelProperties |
Propriedades do HealthModel |
| HealthModelUpdate |
O tipo usado para operações de atualização do HealthModel. |
| HealthModelsCreateOptionalParams |
Parâmetros opcionais. |
| HealthModelsDeleteOptionalParams |
Parâmetros opcionais. |
| HealthModelsGetOptionalParams |
Parâmetros opcionais. |
| HealthModelsListByResourceGroupOptionalParams |
Parâmetros opcionais. |
| HealthModelsListBySubscriptionOptionalParams |
Parâmetros opcionais. |
| HealthModelsOperations |
Interface representando uma operação HealthModels. |
| HealthModelsUpdateOptionalParams |
Parâmetros opcionais. |
| HealthReportEvaluationRule |
Regras de avaliação para o relatório de saúde |
| HealthReportRequest |
Relatório de saúde submetido para um sinal específico |
| HealthStateTransition |
Um registo de transição de estado de saúde |
| IconDefinition |
Definição visual de ícone de uma entidade |
| LogAnalyticsQuerySignalDefinitionProperties |
Log Analytics Propriedades de Definição do Sinal de Consulta |
| LogAnalyticsSignal |
Uma instância de sinal de consulta Log Analytics atribuída a uma entidade. |
| LogAnalyticsSignals |
Um agrupamento de sinais de espaço de trabalho Log Analytics. |
| ManagedIdentityAuthenticationSettingProperties |
Propriedades das definições de autenticação para Azure Managed Identity |
| ManagedServiceIdentity |
Identidade do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário) |
| Operation |
Detalhes de uma operação da API REST, retornados da API de Operações do Provedor de Recursos |
| OperationDisplay |
Informação de visualização localizada para uma operação. |
| OperationsListOptionalParams |
Parâmetros opcionais. |
| OperationsOperations |
Interface que representa uma operação de Operações. |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável até a conclusão e por página. |
| PrometheusMetricsSignal |
Uma instância de sinal de Consulta de Métricas Prometheus atribuída a uma entidade. |
| PrometheusMetricsSignalDefinitionProperties |
Propriedades da definição de sinal das Métricas Prometheus |
| ProxyResource |
A definição de modelo de recurso para um recurso de proxy do Azure Resource Manager. Ele não terá tags e um local |
| Relationship |
Uma relação (também conhecida como aresta) entre duas entidades num modelo de saúde |
| RelationshipProperties |
Propriedades de relacionamento |
| RelationshipsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| RelationshipsDeleteOptionalParams |
Parâmetros opcionais. |
| RelationshipsGetOptionalParams |
Parâmetros opcionais. |
| RelationshipsListByHealthModelOptionalParams |
Parâmetros opcionais. |
| RelationshipsOperations |
Interface representando operações de Relações. |
| Resource |
Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager |
| ResourceGraphQuerySpecification |
Especificação da regra de descoberta para uma consulta do Azure Resource Graph |
| ResourceMetricSignalDefinitionProperties |
Propriedades de definição do sinal da métrica de recursos do Azure |
| RestorePollerOptions | |
| SignalDefinition |
Uma definição de sinal num modelo de saúde |
| SignalDefinitionProperties |
Propriedades SignalDefinition |
| SignalDefinitionsCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| SignalDefinitionsDeleteOptionalParams |
Parâmetros opcionais. |
| SignalDefinitionsGetOptionalParams |
Parâmetros opcionais. |
| SignalDefinitionsListByHealthModelOptionalParams |
Parâmetros opcionais. |
| SignalDefinitionsOperations |
Interface que representa operações de Definições de Sinal. |
| SignalGroups |
Contém vários grupos de sinais que podem ser atribuídos a uma entidade |
| SignalHistoryDataPoint |
Um ponto de dados na série temporal do sinal |
| SignalHistoryRequest |
Órgão do pedido para obter o histórico do sinal |
| SignalHistoryResponse |
Resposta contendo o histórico do sinal |
| SignalInstanceProperties |
Propriedades adicionais para instâncias de sinal atribuídas a uma entidade |
| SignalStatus |
Estado de um sinal |
| SystemData |
Metadados referentes à criação e última modificação do recurso. |
| ThresholdRuleV2 |
Regra de avaliação baseada em limiares para definição de sinal |
| TrackedResource |
A definição do modelo de recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' e um 'local' |
| UserAssignedIdentity |
Propriedades de identidade atribuídas pelo usuário |
Aliases de Tipo
| ActionType |
Enum extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas. Valores conhecidos suportados pelo serviçoInterna: as ações são apenas para APIs internas. |
| AlertSeverity |
Gravidade de um alerta Valores conhecidos suportados pelo serviço
Sev0: Crítico |
| AuthenticationKind |
Tipos suportados de definições de autenticação como discriminador Valores conhecidos suportados pelo serviçoManagedIdentity |
| AuthenticationSettingPropertiesUnion |
Alias para AuthenticationSettingPropertiesUnion |
| AzureSupportedClouds |
Os valores suportados para a configuração de nuvem como um tipo literal de cadeia de caracteres |
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| CreatedByType |
O tipo de entidade que criou o recurso. Valores conhecidos suportados pelo serviço
User: A entidade foi criada por um usuário. |
| DependenciesAggregationType |
Tipo de agregação para dependências filhas. Valores conhecidos suportados pelo serviço
WorstOf: Comportamento padrão: O pior estado de saúde infantil é propagado. |
| DependenciesAggregationUnit |
Tipo de unidade para limiares de agregação de dependências. Valores conhecidos suportados pelo serviço
Absoluto: Limiar é uma contagem absoluta de entidades. |
| DiscoveryRuleKind |
Discriminador de tipo de especificação da regra de descoberta Valores conhecidos suportados pelo serviço
ResourceGraphQuery: Azure Resource Graph baseada na descoberta de consultas |
| DiscoveryRuleRecommendedSignalsBehavior |
Regra de descoberta recomendado comportamento do sinal Valores conhecidos suportados pelo serviço
Ativado: Adicionar automaticamente sinais recomendados |
| DiscoveryRuleRelationshipDiscoveryBehavior |
Comportamento de descoberta entre regras de descoberta e relação de descoberta Valores conhecidos suportados pelo serviço
Ativado: Tentar automaticamente descobrir relações |
| DiscoveryRuleSpecificationUnion |
Alias para DiscoveryRuleSpecificationUnion |
| EntityImpact |
Tipo de impacto que uma entidade tem na propagação do estado de saúde Valores conhecidos suportados pelo serviço
Padrão: Impacto padrão |
| HealthModelProvisioningState |
Estados que fornecem o Modelo de Saúde Valores conhecidos suportados pelo serviço
Êxito: O recurso foi criado. |
| HealthState |
Estado de saúde de uma entidade Valores conhecidos suportados pelo serviço
Saudável: Estado saudável |
| ManagedServiceIdentityType |
Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). Valores conhecidos suportados pelo serviço
Nenhuma: Nenhuma identidade gerenciada. |
| MetricAggregationType |
Tipo de agregação métrica Valores conhecidos suportados pelo serviço
Nenhum |
| Origin |
O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system" Valores conhecidos suportados pelo serviço
user: indica que a operação é iniciada por um usuário. |
| RefreshInterval |
Intervalo de atualização em formato de duração ISO Valores conhecidos suportados pelo serviço
PT1M: Um Minuto |
| SignalDefinitionPropertiesUnion |
Alias para SinalDefiniçãoPropriedadesUnião |
| SignalInstancePropertiesUnion |
Alias para SignalInstancePropertiesUnion |
| SignalKind |
Tipos de sinal suportados como discriminador Valores conhecidos suportados pelo serviço
AzureResourceMetric |
| SignalOperator |
Operador de sinal Valores conhecidos suportados pelo serviço
GreaterThan: Maior que |
Enumerações
| AzureClouds |
Um enum para descrever ambientes Azure Cloud. |
| KnownActionType |
Enum extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas. |
| KnownAlertSeverity |
Gravidade de um alerta |
| KnownAuthenticationKind |
Tipos suportados de definições de autenticação como discriminador |
| KnownCreatedByType |
O tipo de entidade que criou o recurso. |
| KnownDependenciesAggregationType |
Tipo de agregação para dependências filhas. |
| KnownDependenciesAggregationUnit |
Tipo de unidade para limiares de agregação de dependências. |
| KnownDiscoveryRuleKind |
Discriminador de tipo de especificação da regra de descoberta |
| KnownDiscoveryRuleRecommendedSignalsBehavior |
Regra de descoberta recomendado comportamento do sinal |
| KnownDiscoveryRuleRelationshipDiscoveryBehavior |
Comportamento de descoberta entre regras de descoberta e relação de descoberta |
| KnownEntityImpact |
Tipo de impacto que uma entidade tem na propagação do estado de saúde |
| KnownHealthModelProvisioningState |
Estados que fornecem o Modelo de Saúde |
| KnownHealthState |
Estado de saúde de uma entidade |
| KnownManagedServiceIdentityType |
Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). |
| KnownMetricAggregationType |
Tipo de agregação métrica |
| KnownOrigin |
O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system" |
| KnownRefreshInterval |
Intervalo de atualização em formato de duração ISO |
| KnownSignalKind |
Tipos de sinal suportados como discriminador |
| KnownSignalOperator |
Operador de sinal |
| KnownVersions |
Versões da API |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes de Função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parâmetros
- e
-
unknown
Algo apanhado por uma cláusula de captura.
Devoluções
e
restorePoller<TResponse, TResult>(CloudHealthClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.
function restorePoller<TResponse, TResult>(client: CloudHealthClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parâmetros
- client
- CloudHealthClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluções
PollerLike<OperationState<TResult>, TResult>
Detalhes das variáveis
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor