@azure/arm-cloudhealth package

Request body for adding a data annotation.

Alert configuration details

Discovery rule specification for an Application Insights topology query

An authentication setting in a health model

Authentication setting properties

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a AuthenticationSettings operations.

A grouping of Azure Monitor workspace signals.

Azure resource health signal configuration

Status of an Azure Resource Health signal, including availability information reported by Azure Resource Health.

An Azure Resource Metric signal instance assigned to an entity.

A grouping of Azure resource signals

Optional parameters for the client.

A single data annotation on an entity

Properties for dependent entities, i.e. child entities

Error details for a failed discovery operation

A discovery rule which automatically finds entities and relationships in a health model based on an Azure Resource Graph query

Discovery rule properties

Discovery rule properties for create/update operations, omitting server-side read-only fields (entityName is required+read-only in the canonical model).

Discovery rule resource for create/update operations.

Base model for discovery rule specifications

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DiscoveryRules operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Entities operations.

An entity (aka node) of a health model

Alert configuration for an entity

Visual position of the entity

Request body for getting entity health history

Response containing entity health state transitions

Properties which are common across all kinds of entities

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Evaluation rule for a signal definition

An externally submitted signal instance assigned to an entity.

A grouping of externally submitted signals.

Request body for querying data annotations

Response containing data annotations for an entity

Response from getSignalRecommendations containing two independent suggestion streams for the Azure resource type represented by the target Entity. recommendedSignals lists signals broadly recommended to be enabled by default; recommendedConfigurations lists additional metrics that are not broadly applicable but, if a caller chooses to monitor one of them, ship with suggested starting-point thresholds. The two arrays are independent — items are not paired by index, and callers should treat them as two separate suggestion streams.

A HealthModel resource

HealthModel properties

The type used for update operations of the HealthModel.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a HealthModels operations.

Optional parameters.

Evaluation rules for the health report

Health report that's submitted for a specific signal

A health state transition record

Visual icon definition of an entity

Log Analytics Query Signal Definition properties

A Log Analytics Query signal instance assigned to an entity.

A grouping of Log Analytics workspace signals.

Authentication setting properties for Azure Managed Identity

Managed service identity (system assigned and/or user assigned identities)

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for an operation.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

A Prometheus Metrics Query signal instance assigned to an entity.

Prometheus Metrics Signal Definition properties

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

A relationship (aka edge) between two entities in a health model

Relationship properties

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Relationships operations.

Common fields that are returned in the response for all Azure Resource Manager resources

Discovery rule specification for an Azure Resource Graph query

Azure Resource Metric Signal Definition properties

A logical group of signals on an entity, evaluated under a configurable aggregation strategy. Groups are independent even when they share members. Each group's aggregated state is one of the inputs to the entity's composite health computation alongside any signals not declared in any group's members[].

A signal configuration for an Azure resource type

A signal definition in a health model

SignalDefinition properties

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a SignalDefinitions operations.

Contains various signal groups that can be assigned to an entity

A data point in the signal time series

Request body for getting signal history

Response containing signal history

Additional properties for signal instances assigned to an entity

Status of a signal

Metadata pertaining to creation and last modification of the resource.

Threshold-based evaluation rule for a signal definition

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

User assigned identity properties

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.

Aggregation strategy for combining a set of health states into one.
KnownAggregationType can be used interchangeably with AggregationType, this enum contains the known values that the service supports.

Known values supported by the service

WorstOf: Worst health state across members is propagated. Default behavior.
BestOf: Best (least severe) health state across the non-Unknown members is propagated. Unknown members are excluded from the selection; if every member is Unknown the group resolves to Unknown. The 'ignoreUnknown' flag has no observable effect for this strategy and is documented as such.
MinHealthy: Healthy if the count/percentage of healthy members meets the threshold.
MaxNotHealthy: Healthy if the count/percentage of not-healthy members stays below the threshold.

Unit type for the thresholds used by threshold-bearing aggregation strategies.
KnownAggregationUnit can be used interchangeably with AggregationUnit, this enum contains the known values that the service supports.

Known values supported by the service

Absolute: Threshold is an absolute count of members.
Percentage: Threshold is a percentage of members (0-100).

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

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

Alias for AuthenticationSettingPropertiesUnion

The supported values for cloud setting as a string literal type

An interface that describes a page of results.

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.

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

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

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

Alias for DiscoveryRuleSpecificationUnion

Sensitivity level for dynamic threshold detection
KnownDynamicThresholdSensitivity can be used interchangeably with DynamicThresholdSensitivity, this enum contains the known values that the service supports.

Known values supported by the service

Low: Low sensitivity — fewer anomalies detected, wider threshold band
Medium: Medium sensitivity — balanced detection
High: High sensitivity — more anomalies detected, tighter threshold band

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

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

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

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.

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

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.

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
PT15M: Fifteen Minutes
PT30M: Thirty Minutes
PT1H: One Hour
PT2H: Two Hours

Availability state of an Azure resource as reported by Azure Resource Health.
KnownResourceHealthAvailabilityState can be used interchangeably with ResourceHealthAvailabilityState, this enum contains the known values that the service supports.

Known values supported by the service

Available: The resource is available.
Unavailable: The resource is unavailable.
Degraded: The resource is degraded.
Unknown: The resource availability state is unknown.

Resource health availability state signal behavior
KnownResourceHealthAvailabilityStateSignalBehavior can be used interchangeably with ResourceHealthAvailabilityStateSignalBehavior, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Automatically add resource health availability state signal
Disabled: Do not automatically add resource health availability state signal

Whether an Azure Resource Health status changing event was planned or unplanned.
KnownResourceHealthCategory can be used interchangeably with ResourceHealthCategory, this enum contains the known values that the service supports.

Known values supported by the service

Planned: The event was planned.
Unplanned: The event was unplanned.

Whether the current Azure Resource Health availability state is persistent or transient.
KnownResourceHealthReasonChronicity can be used interchangeably with ResourceHealthReasonChronicity, this enum contains the known values that the service supports.

Known values supported by the service

Persistent: Persistent state.
Transient: Transient state.

Reason type for the current Azure Resource Health availability state.
KnownResourceHealthReasonType can be used interchangeably with ResourceHealthReasonType, this enum contains the known values that the service supports.

Known values supported by the service

Unplanned: Unplanned reason.
Planned: Planned reason.
UserInitiated: User-initiated reason.

Alias for SignalDefinitionPropertiesUnion

Alias for SignalInstancePropertiesUnion

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

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
Dynamic: Dynamic threshold — uses deviation from a ML-computed baseline to determine health state transitions. Only valid for the unhealthy threshold rule. Requires sensitivity and lookBackWindow on the rule; threshold is ignored.

An enum to describe Azure Cloud environments.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

Aggregation strategy for combining a set of health states into one.

Unit type for the thresholds used by threshold-bearing aggregation strategies.

Severity of an alert

Supported kinds of authentication settings as discriminator

The kind of entity that created the resource.

Discovery rule specification kind discriminator

Discovery rule recommended signal behavior

Discovery rule relationship discovery behavior

Sensitivity level for dynamic threshold detection

Type of impact an entity has on health state propagation

Health Model provisioning states

Health state of an entity

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Metric aggregation type

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Refresh interval in ISO duration format

Availability state of an Azure resource as reported by Azure Resource Health.

Resource health availability state signal behavior

Whether an Azure Resource Health status changing event was planned or unplanned.

Whether the current Azure Resource Health availability state is persistent or transient.

Reason type for the current Azure Resource Health availability state.

Supported signal kinds as discriminator

Signal operator

API Versions

Typeguard for RestError

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.

A custom error type for failed pipeline requests.