@azure/arm-cloudhealth package

介面

AlertConfiguration

警報設定細節

ApplicationInsightsTopologySpecification

Application Insights 拓撲查詢的發現規則規範

AuthenticationSetting

健康模型中的認證設定

AuthenticationSettingProperties

認證設定屬性

AuthenticationSettingsCreateOrUpdateOptionalParams

選擇性參數。

AuthenticationSettingsDeleteOptionalParams

選擇性參數。

AuthenticationSettingsGetOptionalParams

選擇性參數。

AuthenticationSettingsListByHealthModelOptionalParams

選擇性參數。

AuthenticationSettingsOperations

介面代表 AuthenticationSettings 操作。

AzureMonitorWorkspaceSignals

一組 Azure 監視器 workspace signals.

AzureResourceSignal

一個指派給實體的 Azure 資源指標訊號實例。

AzureResourceSignals

Azure 資源訊號的群組

CloudHealthClientOptionalParams

用戶端的選擇性參數。

DependenciesSignalGroupV2

相依實體的屬性,即子實體

DiscoveryError

失敗發現操作的錯誤細節

DiscoveryRule

一個發現規則,根據 Azure Resource Graph 查詢自動在健康模型中尋找實體與關聯

DiscoveryRuleProperties

發現規則的性質

DiscoveryRulePropertiesCreate

建立/更新操作的發現規則屬性,省略伺服器端唯讀欄位(在典範模型中 entityName 為必讀+唯讀)。

DiscoveryRuleResourceCreate

用於建立/更新操作的發現規則資源。

DiscoveryRuleSpecification

發現規則規範的基礎模型

DiscoveryRulesCreateOrUpdateOptionalParams

選擇性參數。

DiscoveryRulesDeleteOptionalParams

選擇性參數。

DiscoveryRulesGetOptionalParams

選擇性參數。

DiscoveryRulesListByHealthModelOptionalParams

選擇性參數。

DiscoveryRulesOperations

介面代表 DiscoveryRules 操作。

EntitiesCreateOrUpdateOptionalParams

選擇性參數。

EntitiesDeleteOptionalParams

選擇性參數。

EntitiesGetHistoryOptionalParams

選擇性參數。

EntitiesGetOptionalParams

選擇性參數。

EntitiesGetSignalHistoryOptionalParams

選擇性參數。

EntitiesIngestHealthReportOptionalParams

選擇性參數。

EntitiesListByHealthModelOptionalParams

選擇性參數。

EntitiesOperations

介面代表實體操作。

Entity

健康模型中的一個實體(又稱節點)

EntityAlerts

實體的警報設定

EntityCoordinates

實體的視覺位置

EntityHistoryRequest

申請機構取得實體健康紀錄

EntityHistoryResponse

包含實體健康狀態轉換的回應

EntityProperties

各種實體中共有的性質

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細資料。

ErrorResponse

所有 Azure Resource Manager API 的常見錯誤回應,以傳回失敗作業的錯誤詳細數據。

EvaluationRule

訊號定義的評估規則

ExternalSignal

一個外部提交的訊號實例,指派給某個實體。

ExternalSignalGroup

一組外部提交的訊號。

HealthModel

HealthModel 資源

HealthModelProperties

HealthModel 屬性

HealthModelUpdate

用於 HealthModel 更新操作的類型。

HealthModelsCreateOptionalParams

選擇性參數。

HealthModelsDeleteOptionalParams

選擇性參數。

HealthModelsGetOptionalParams

選擇性參數。

HealthModelsListByResourceGroupOptionalParams

選擇性參數。

HealthModelsListBySubscriptionOptionalParams

選擇性參數。

HealthModelsOperations

代表 HealthModels 作業的介面。

HealthModelsUpdateOptionalParams

選擇性參數。

HealthReportEvaluationRule

健康報告評估規則

HealthReportRequest

針對特定訊號提交的健康報告

HealthStateTransition

健康狀態轉換紀錄

IconDefinition

實體的視覺圖示定義

LogAnalyticsQuerySignalDefinitionProperties

Log Analytics 查詢訊號定義屬性

LogAnalyticsSignal

指派給實體的 Log Analytics 查詢訊號實例。

LogAnalyticsSignals

一組 Log Analytics 工作空間訊號。

ManagedIdentityAuthenticationSettingProperties

Authentication settings properties for Azure Managed Identity

ManagedServiceIdentity

受控服務識別(系統指派和/或使用者指派的身分識別)

Operation

從資源提供者作業 API API 傳回的 REST API 作業詳細數據

OperationDisplay

操作的在地顯示資訊。

OperationsListOptionalParams

選擇性參數。

OperationsOperations

代表作業作業的介面。

PageSettings

byPage 方法的選項

PagedAsyncIterableIterator

介面,可讓異步反覆運算同時完成和逐頁執行。

PrometheusMetricsSignal

一個 Prometheus Metrics 查詢訊號實例被指派給一個實體。

PrometheusMetricsSignalDefinitionProperties

Prometheus 指標訊號定義特性

ProxyResource

Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置

Relationship

健康模型中兩個實體之間的關係(又稱邊緣)

RelationshipProperties

關聯性屬性

RelationshipsCreateOrUpdateOptionalParams

選擇性參數。

RelationshipsDeleteOptionalParams

選擇性參數。

RelationshipsGetOptionalParams

選擇性參數。

RelationshipsListByHealthModelOptionalParams

選擇性參數。

RelationshipsOperations

介面代表關係操作。

Resource

回應中針對所有 Azure Resource Manager 資源傳回的常見欄位

ResourceGraphQuerySpecification

Azure Resource Graph 查詢的 Discovery rule specification

ResourceMetricSignalDefinitionProperties

Azure Resource Metric Signal Definition properties

RestorePollerOptions
SignalDefinition

健康模型中的訊號定義

SignalDefinitionProperties

SignalDefinition 特性

SignalDefinitionsCreateOrUpdateOptionalParams

選擇性參數。

SignalDefinitionsDeleteOptionalParams

選擇性參數。

SignalDefinitionsGetOptionalParams

選擇性參數。

SignalDefinitionsListByHealthModelOptionalParams

選擇性參數。

SignalDefinitionsOperations

介面表示 SignalDefinitions 操作。

SignalGroups

包含可分配給實體的各種訊號群組

SignalHistoryDataPoint

訊號時間序列中的一個資料點

SignalHistoryRequest

請求機構取得訊號歷史

SignalHistoryResponse

包含訊號歷史的響應

SignalInstanceProperties

指派給實體的訊號實例的額外屬性

SignalStatus

訊號狀態

SystemData

與建立和上次修改資源相關的元數據。

ThresholdRuleV2

基於閾值的訊號定義評估規則

TrackedResource

Azure Resource Manager 的資源模型定義已追蹤最上層資源,其具有「標記」和「位置」

UserAssignedIdentity

使用者指派的身分識別屬性

類型別名

ActionType

可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。
KnownActionType 可以與 ActionType 交替使用,此列舉包含服務支援的已知值。

服務支援的已知值

內部:動作適用於僅限內部的 API。

AlertSeverity

警報的嚴重程度
KnownAlertSeverity 可與 AlertSeverity 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

Sev0:關鍵
Sev1:錯誤
Sev2:警告
Sev3:資訊性
第四季:冗長

AuthenticationKind

作為判別器所支援的認證設定類型
KnownAuthenticationKind 可與 AuthenticationKind 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

ManagedIdentity

AuthenticationSettingPropertiesUnion

認證別名SettingsPropertiesUnion

AzureSupportedClouds

雲端設定為字串常值類型的支援值

ContinuablePage

描述結果頁面的介面。

CreatedByType

建立資源的實體種類。
KnownCreatedByType 可以與 CreatedByType 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

使用者:實體是由使用者建立的。
應用程式:實體是由應用程式所建立。
ManagedIdentity:實體是由受控識別所建立。
金鑰:實體是由金鑰所建立。

DependenciesAggregationType

子依賴項的聚合類型。
KnownDependenciesAggregationType 可與 DependenciesAggregationType 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

最差:預設行為:最差兒童健康狀態被傳播。
MinHealthy:健康兒童的數量或百分比達到門檻。
MaxNotHealthy:健康是指不健康兒童的數量或百分比保持在門檻以下。

DependenciesAggregationUnit

依賴聚合閾值的單元類型。
KnownDependenciesAggregationUnit 可與 DependenciesAggregationUnit 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

絕對:門檻是實體的絕對數量。
百分比:門檻是實體的百分比(0-100)。

DiscoveryRuleKind

發現規則規範 類型判別器
KnownDiscoveryRuleKind 可與 DiscoveryRuleKind 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

ResourceGraphQuery:Azure Resource Graph 基於查詢的發現
應用洞察拓撲學:基於拓撲的應用洞察發現

DiscoveryRuleRecommendedSignalsBehavior

發現規則建議的訊號行為
KnownDiscoveryRuleRecommendedSignalsBehavior 可與 DiscoveryRuleRecommendedSignalsBehavior 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

啟用:自動新增推薦訊號
停用:請勿自動新增推薦訊號

DiscoveryRuleRelationshipDiscoveryBehavior

發現規則關係發現行為
KnownDiscoveryRuleRelationshipDiscoveryBehavior 可與 DiscoveryRuleRelationshipDiscoveryBehavior 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

啟用:自動嘗試發現關係
無法:請勿自動嘗試尋找關係

DiscoveryRuleSpecificationUnion

DiscoveryRuleSpecificationUnion 別名

EntityImpact

實體對健康狀態傳播的影響類型
KnownEntityImpact 可與 EntityImpact 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

標準:標準衝擊
有限:影響有限
抑制:抑制影響

HealthModelProvisioningState

健康模型供應狀態
KnownHealthModelProvisioningState 可與 HealthModelProvisioningState 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

成功:資源已建立。
失敗:資源建立失敗。
取消:已取消資源建立。
建立
刪除中

HealthState

實體的健康狀態
KnownHealthState 可以與 HealthState 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

健康:健康狀態
:降級狀態
不健康:不健康狀態
未知:狀態不明
已刪除:已刪除狀態

ManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。
KnownManagedServiceIdentityType 可以與 ManagedServiceIdentityType 交替使用,此列舉包含服務支援的已知值。

服務支援的已知值

:沒有受控識別。
SystemAssigned:系統指派的受控識別。
UserAssigned:使用者指派的受控識別。
SystemAssigned,UserAssigned:系統和使用者指派的受控識別。

MetricAggregationType

度量聚合類型
KnownMetricAggregationType 可以與 MetricAggregationType 交替使用,此列舉包含服務支援的已知值。

服務支援的已知值

沒有
平均值
數量
最低
最大值
總計

Origin

作業的預期執行程式;如同資源型 存取控制 (RBAC) 和稽核記錄 UX。 默認值為 “user,system”
KnownOrigin 可以與 Origin 互換使用,此列舉包含服務支援的已知值。

服務支援的已知值

user:表示作業是由使用者起始。
system:指出作業是由系統起始。
user,system:指出作業是由使用者或系統起始。

RefreshInterval

ISO 持續時間格式的刷新間隔
KnownRefreshInterval 可與 RefreshInterval 互換使用,此列舉包含服務所支援的已知值。

服務支援的已知值

PT1M:一分鐘
PT5M:五分鐘
PT10M:十分鐘
PT30M:三十分鐘
第一部分:一小時
PT2H:兩小時

SignalDefinitionPropertiesUnion

SignalDefinitionPropertiesUnion 的別名

SignalInstancePropertiesUnion

SignalInstancePropertiesUnion 的別名

SignalKind

作為判別器的支援訊號類型
KnownSignalKind 可與 SignalKind 互換使用,此列舉包含服務所支援的已知值。

服務支援的已知值

AzureResourceMetric
LogAnalyticsQuery
PrometheusMetricsQuery
External

SignalOperator

號誌操作員
KnownSignalOperator 可與 SignalOperator 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

GreaterThan:比Greater
不及:不及
小於或等:小於或等於
大於或等:大於或等於
於:等於
NotEqual:不等於

列舉

AzureClouds

一個用來描述 Azure Cloud 環境的 enum。

KnownActionType

可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。

KnownAlertSeverity

警報的嚴重程度

KnownAuthenticationKind

作為判別器所支援的認證設定類型

KnownCreatedByType

建立資源的實體種類。

KnownDependenciesAggregationType

子依賴項的聚合類型。

KnownDependenciesAggregationUnit

依賴聚合閾值的單元類型。

KnownDiscoveryRuleKind

發現規則規範 類型判別器

KnownDiscoveryRuleRecommendedSignalsBehavior

發現規則建議的訊號行為

KnownDiscoveryRuleRelationshipDiscoveryBehavior

發現規則關係發現行為

KnownEntityImpact

實體對健康狀態傳播的影響類型

KnownHealthModelProvisioningState

健康模型供應狀態

KnownHealthState

實體的健康狀態

KnownManagedServiceIdentityType

受控服務識別的類型(允許 SystemAssigned 和 UserAssigned 類型)。

KnownMetricAggregationType

度量聚合類型

KnownOrigin

作業的預期執行程式;如同資源型 存取控制 (RBAC) 和稽核記錄 UX。 默認值為 “user,system”

KnownRefreshInterval

ISO 持續時間格式的刷新間隔

KnownSignalKind

作為判別器的支援訊號類型

KnownSignalOperator

號誌操作員

KnownVersions

API 版本

函式

isRestError(unknown)

RestError 的 Typeguard

restorePoller<TResponse, TResult>(CloudHealthClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

從另一個輪詢器的序列化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或需要在原始輪詢器不在範圍內之後建構輪詢器時,這會很有用。

變數

RestError

失敗管線要求的自定義錯誤類型。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

參數

e

unknown

catch 子句攔截到的東西。

傳回

e

restorePoller<TResponse, TResult>(CloudHealthClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

從另一個輪詢器的序列化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或需要在原始輪詢器不在範圍內之後建構輪詢器時,這會很有用。

function restorePoller<TResponse, TResult>(client: CloudHealthClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

參數

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

傳回

PollerLike<OperationState<TResult>, TResult>

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型