@azure/arm-cloudhealth package

Classes

CloudHealthClient

Interfaces

AlertConfiguration	Alert configuration details
ApplicationInsightsTopologySpecification	Discovery rule specification for an Application Insights topology query
AuthenticationSetting	An authentication setting in a health model
AuthenticationSettingProperties	Authentication setting properties
AuthenticationSettingsCreateOrUpdateOptionalParams	Optional parameters.
AuthenticationSettingsDeleteOptionalParams	Optional parameters.
AuthenticationSettingsGetOptionalParams	Optional parameters.
AuthenticationSettingsListByHealthModelOptionalParams	Optional parameters.
AuthenticationSettingsOperations	Interface representing a AuthenticationSettings operations.
AzureMonitorWorkspaceSignals	A grouping of Azure Monitor workspace signals.
AzureResourceSignal	An Azure Resource Metric signal instance assigned to an entity.
AzureResourceSignals	A grouping of Azure resource signals
CloudHealthClientOptionalParams	Optional parameters for the client.
DependenciesSignalGroupV2	Properties for dependent entities, i.e. child entities
DiscoveryError	Error details for a failed discovery operation
DiscoveryRule	A discovery rule which automatically finds entities and relationships in a health model based on an Azure Resource Graph query
DiscoveryRuleProperties	Discovery rule properties
DiscoveryRulePropertiesCreate	Discovery rule properties for create/update operations, omitting server-side read-only fields (entityName is required+read-only in the canonical model).
DiscoveryRuleResourceCreate	Discovery rule resource for create/update operations.
DiscoveryRuleSpecification	Base model for discovery rule specifications
DiscoveryRulesCreateOrUpdateOptionalParams	Optional parameters.
DiscoveryRulesDeleteOptionalParams	Optional parameters.
DiscoveryRulesGetOptionalParams	Optional parameters.
DiscoveryRulesListByHealthModelOptionalParams	Optional parameters.
DiscoveryRulesOperations	Interface representing a DiscoveryRules operations.
EntitiesCreateOrUpdateOptionalParams	Optional parameters.
EntitiesDeleteOptionalParams	Optional parameters.
EntitiesGetHistoryOptionalParams	Optional parameters.
EntitiesGetOptionalParams	Optional parameters.
EntitiesGetSignalHistoryOptionalParams	Optional parameters.
EntitiesIngestHealthReportOptionalParams	Optional parameters.
EntitiesListByHealthModelOptionalParams	Optional parameters.
EntitiesOperations	Interface representing a Entities operations.
Entity	An entity (aka node) of a health model
EntityAlerts	Alert configuration for an entity
EntityCoordinates	Visual position of the entity
EntityHistoryRequest	Request body for getting entity health history
EntityHistoryResponse	Response containing entity health state transitions
EntityProperties	Properties which are common across all kinds of entities
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
EvaluationRule	Evaluation rule for a signal definition
ExternalSignal	An externally submitted signal instance assigned to an entity.
ExternalSignalGroup	A grouping of externally submitted signals.
HealthModel	A HealthModel resource
HealthModelProperties	HealthModel properties
HealthModelUpdate	The type used for update operations of the HealthModel.
HealthModelsCreateOptionalParams	Optional parameters.
HealthModelsDeleteOptionalParams	Optional parameters.
HealthModelsGetOptionalParams	Optional parameters.
HealthModelsListByResourceGroupOptionalParams	Optional parameters.
HealthModelsListBySubscriptionOptionalParams	Optional parameters.
HealthModelsOperations	Interface representing a HealthModels operations.
HealthModelsUpdateOptionalParams	Optional parameters.
HealthReportEvaluationRule	Evaluation rules for the health report
HealthReportRequest	Health report that's submitted for a specific signal
HealthStateTransition	A health state transition record
IconDefinition	Visual icon definition of an entity
LogAnalyticsQuerySignalDefinitionProperties	Log Analytics Query Signal Definition properties
LogAnalyticsSignal	A Log Analytics Query signal instance assigned to an entity.
LogAnalyticsSignals	A grouping of Log Analytics workspace signals.
ManagedIdentityAuthenticationSettingProperties	Authentication setting properties for Azure Managed Identity
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrometheusMetricsSignal	A Prometheus Metrics Query signal instance assigned to an entity.
PrometheusMetricsSignalDefinitionProperties	Prometheus Metrics Signal Definition properties
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Relationship	A relationship (aka edge) between two entities in a health model
RelationshipProperties	Relationship properties
RelationshipsCreateOrUpdateOptionalParams	Optional parameters.
RelationshipsDeleteOptionalParams	Optional parameters.
RelationshipsGetOptionalParams	Optional parameters.
RelationshipsListByHealthModelOptionalParams	Optional parameters.
RelationshipsOperations	Interface representing a Relationships operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceGraphQuerySpecification	Discovery rule specification for an Azure Resource Graph query
ResourceMetricSignalDefinitionProperties	Azure Resource Metric Signal Definition properties
RestorePollerOptions
SignalDefinition	A signal definition in a health model
SignalDefinitionProperties	SignalDefinition properties
SignalDefinitionsCreateOrUpdateOptionalParams	Optional parameters.
SignalDefinitionsDeleteOptionalParams	Optional parameters.
SignalDefinitionsGetOptionalParams	Optional parameters.
SignalDefinitionsListByHealthModelOptionalParams	Optional parameters.
SignalDefinitionsOperations	Interface representing a SignalDefinitions operations.
SignalGroups	Contains various signal groups that can be assigned to an entity
SignalHistoryDataPoint	A data point in the signal time series
SignalHistoryRequest	Request body for getting signal history
SignalHistoryResponse	Response containing signal history
SignalInstanceProperties	Additional properties for signal instances assigned to an entity
SignalStatus	Status of a signal
SystemData	Metadata pertaining to creation and last modification of the resource.
ThresholdRuleV2	Threshold-based evaluation rule for a signal definition
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserAssignedIdentity	User assigned identity properties

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AlertSeverity	Severity of an alert KnownAlertSeverity can be used interchangeably with AlertSeverity, this enum contains the known values that the service supports. Known values supported by the service Sev0: Critical Sev1: Error Sev2: Warning Sev3: Informational Sev4: Verbose
AuthenticationKind	Supported kinds of authentication settings as discriminator KnownAuthenticationKind can be used interchangeably with AuthenticationKind, this enum contains the known values that the service supports. Known values supported by the service ManagedIdentity
AuthenticationSettingPropertiesUnion	Alias for AuthenticationSettingPropertiesUnion
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DependenciesAggregationType	Aggregation type for child dependencies. KnownDependenciesAggregationType can be used interchangeably with DependenciesAggregationType, this enum contains the known values that the service supports. Known values supported by the service WorstOf: Default behavior: Worst child health state is propagated. MinHealthy: Healthy if the count/percentage of healthy children meets the threshold. MaxNotHealthy: Healthy if the count/percentage of not-healthy children stays below the threshold.
DependenciesAggregationUnit	Unit type for dependency aggregation thresholds. KnownDependenciesAggregationUnit can be used interchangeably with DependenciesAggregationUnit, this enum contains the known values that the service supports. Known values supported by the service Absolute: Threshold is an absolute count of entities. Percentage: Threshold is a percentage of entities (0-100).
DiscoveryRuleKind	Discovery rule specification kind discriminator KnownDiscoveryRuleKind can be used interchangeably with DiscoveryRuleKind, this enum contains the known values that the service supports. Known values supported by the service ResourceGraphQuery: Azure Resource Graph query based discovery ApplicationInsightsTopology: Application Insights topology based discovery
DiscoveryRuleRecommendedSignalsBehavior	Discovery rule recommended signal behavior KnownDiscoveryRuleRecommendedSignalsBehavior can be used interchangeably with DiscoveryRuleRecommendedSignalsBehavior, this enum contains the known values that the service supports. Known values supported by the service Enabled: Automatically add recommended signals Disabled: Do not automatically add recommended signals
DiscoveryRuleRelationshipDiscoveryBehavior	Discovery rule relationship discovery behavior KnownDiscoveryRuleRelationshipDiscoveryBehavior can be used interchangeably with DiscoveryRuleRelationshipDiscoveryBehavior, this enum contains the known values that the service supports. Known values supported by the service Enabled: Automatically attempt to discover relationships Disabled: Do not automatically attempt to discover relationships
DiscoveryRuleSpecificationUnion	Alias for DiscoveryRuleSpecificationUnion
EntityImpact	Type of impact an entity has on health state propagation KnownEntityImpact can be used interchangeably with EntityImpact, this enum contains the known values that the service supports. Known values supported by the service Standard: Standard impact Limited: Limited impact Suppressed: Suppressed impact
HealthModelProvisioningState	Health Model provisioning states KnownHealthModelProvisioningState can be used interchangeably with HealthModelProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Creating Deleting
HealthState	Health state of an entity KnownHealthState can be used interchangeably with HealthState, this enum contains the known values that the service supports. Known values supported by the service Healthy: Healthy status Degraded: Degraded status Unhealthy: Unhealthy status Unknown: Unknown status Deleted: Deleted status
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
MetricAggregationType	Metric aggregation type KnownMetricAggregationType can be used interchangeably with MetricAggregationType, this enum contains the known values that the service supports. Known values supported by the service None Average Count Minimum Maximum Total
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
RefreshInterval	Refresh interval in ISO duration format KnownRefreshInterval can be used interchangeably with RefreshInterval, this enum contains the known values that the service supports. Known values supported by the service PT1M: One Minute PT5M: Five Minutes PT10M: Ten Minutes PT30M: Thirty Minutes PT1H: One Hour PT2H: Two Hours
SignalDefinitionPropertiesUnion	Alias for SignalDefinitionPropertiesUnion
SignalInstancePropertiesUnion	Alias for SignalInstancePropertiesUnion
SignalKind	Supported signal kinds as discriminator KnownSignalKind can be used interchangeably with SignalKind, this enum contains the known values that the service supports. Known values supported by the service AzureResourceMetric LogAnalyticsQuery PrometheusMetricsQuery External
SignalOperator	Signal operator KnownSignalOperator can be used interchangeably with SignalOperator, this enum contains the known values that the service supports. Known values supported by the service GreaterThan: Greater than LessThan: Less than LessThanOrEqual: Less than or equal to GreaterThanOrEqual: Greater than or equal to Equal: Equal to NotEqual: Not equal to

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAlertSeverity	Severity of an alert
KnownAuthenticationKind	Supported kinds of authentication settings as discriminator
KnownCreatedByType	The kind of entity that created the resource.
KnownDependenciesAggregationType	Aggregation type for child dependencies.
KnownDependenciesAggregationUnit	Unit type for dependency aggregation thresholds.
KnownDiscoveryRuleKind	Discovery rule specification kind discriminator
KnownDiscoveryRuleRecommendedSignalsBehavior	Discovery rule recommended signal behavior
KnownDiscoveryRuleRelationshipDiscoveryBehavior	Discovery rule relationship discovery behavior
KnownEntityImpact	Type of impact an entity has on health state propagation
KnownHealthModelProvisioningState	Health Model provisioning states
KnownHealthState	Health state of an entity
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMetricAggregationType	Metric aggregation type
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownRefreshInterval	Refresh interval in ISO duration format
KnownSignalKind	Supported signal kinds as discriminator
KnownSignalOperator	Signal operator
KnownVersions	API Versions

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(CloudHealthClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

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

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

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

Parameters

client

CloudHealthClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor