@azure/arm-resourcehealth package

Classes

MicrosoftResourceHealth

Interfaces

AvailabilityStatus	availabilityStatus of a resource.
AvailabilityStatusProperties	Properties of availability state.
AvailabilityStatusPropertiesRecentlyResolved	An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned
AvailabilityStatusesGetByResourceOptionalParams	Optional parameters.
AvailabilityStatusesListByResourceGroupOptionalParams	Optional parameters.
AvailabilityStatusesListBySubscriptionIdOptionalParams	Optional parameters.
AvailabilityStatusesListOptionalParams	Optional parameters.
AvailabilityStatusesOperations	Interface representing a AvailabilityStatuses operations.
ChildAvailabilityStatusesGetByResourceOptionalParams	Optional parameters.
ChildAvailabilityStatusesListOptionalParams	Optional parameters.
ChildAvailabilityStatusesOperations	Interface representing a ChildAvailabilityStatuses operations.
ChildResourcesListOptionalParams	Optional parameters.
ChildResourcesOperations	Interface representing a ChildResources operations.
CustomizedProxyResource	ARM proxy resource.
EmergingIssue	On-going emerging issue from azure status.
EmergingIssueImpact	Object of the emerging issue impact on services and regions.
EmergingIssuesGetOptionalParams	Optional parameters.
EmergingIssuesGetResult	The Get EmergingIssues operation response.
EmergingIssuesListOptionalParams	Optional parameters.
EmergingIssuesOperations	Interface representing a EmergingIssues operations.
ErrorResponse	Error details.
Event	Service health event
EventFetchBilllingCommunicationDetailsBySubscriptionIdAndTrackingIdOptionalParams	Optional parameters.
EventFetchDetailsBySubscriptionIdAndTrackingIdOptionalParams	Optional parameters.
EventFetchDetailsByTenantIdAndTrackingIdOptionalParams	Optional parameters.
EventGetBySubscriptionIdAndTrackingIdOptionalParams	Optional parameters.
EventGetByTenantIdAndTrackingIdOptionalParams	Optional parameters.
EventImpactedResource	Impacted resource for an event.
EventImpactedResourceProperties	Properties of impacted resource.
EventOperations	Interface representing a Event operations.
EventProperties	Properties of event.
EventPropertiesAdditionalInformation	Additional information
EventPropertiesArticle	Article of event.
EventPropertiesRecommendedActions	Recommended actions of event.
EventPropertiesRecommendedActionsItem	Recommended action for the service health event.
EventsListBySingleResourceOptionalParams	Optional parameters.
EventsListBySubscriptionIdOptionalParams	Optional parameters.
EventsListByTenantIdOptionalParams	Optional parameters.
EventsOperations	Interface representing a Events operations.
Faq	Frequently asked question for the service health event
Impact	Azure service impacted by the service health event.
ImpactedRegion	Object of impacted region.
ImpactedResourcesGetByTenantIdOptionalParams	Optional parameters.
ImpactedResourcesGetOptionalParams	Optional parameters.
ImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams	Optional parameters.
ImpactedResourcesListByTenantIdAndEventIdOptionalParams	Optional parameters.
ImpactedResourcesOperations	Interface representing a ImpactedResources operations.
ImpactedServiceRegion	Azure region impacted by the service health event.
KeyValueItem	Key value tuple.
Link	Useful links for service health event.
LinkDisplayText	Display text of link.
MetadataEntity	The metadata entity contract.
MetadataEntityProperties	The metadata entity properties
MetadataGetEntityOptionalParams	Optional parameters.
MetadataListOptionalParams	Optional parameters.
MetadataOperations	Interface representing a Metadata operations.
MetadataSupportedValueDetail	The metadata supported value detail.
MicrosoftResourceHealthOptionalParams	Optional parameters for the client.
Operation	Operation available in the Microsoft.ResourceHealth resource provider.
OperationDisplay	Properties of the operation.
OperationListResult	Lists the operations response.
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.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RecommendedAction	Lists actions the user can take based on the current availabilityState of the resource.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams	Optional parameters.
SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdOptionalParams	Optional parameters.
SecurityAdvisoryImpactedResourcesOperations	Interface representing a SecurityAdvisoryImpactedResources operations.
ServiceImpactingEvent	Lists the service impacting events that may be affecting the health of the resource.
ServiceImpactingEventIncidentProperties	Properties of the service impacting event.
ServiceImpactingEventStatus	Status of the service impacting event.
StatusActiveEvent	Active event type of emerging issue.
StatusBanner	Banner type of emerging issue.
SystemData	Metadata pertaining to creation and last modification of the resource.
Update	Update for service health event.

Type Aliases

AvailabilityStateValues	Impacted resource status of the resource. KnownAvailabilityStateValues can be used interchangeably with AvailabilityStateValues, this enum contains the known values that the service supports. Known values supported by the service Available: Available Unavailable: Unavailable Degraded: Degraded Unknown: Unknown
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.
EventLevelValues	Level of event. KnownEventLevelValues can be used interchangeably with EventLevelValues, this enum contains the known values that the service supports. Known values supported by the service Critical: Critical Error: Error Warning: Warning Informational: Informational
EventSourceValues	Source of event. KnownEventSourceValues can be used interchangeably with EventSourceValues, this enum contains the known values that the service supports. Known values supported by the service ResourceHealth: ResourceHealth ServiceHealth: ServiceHealth
EventStatusValues	Current status of event. KnownEventStatusValues can be used interchangeably with EventStatusValues, this enum contains the known values that the service supports. Known values supported by the service Active: Active Resolved: Resolved
EventSubTypeValues	Sub-type of event. KnownEventSubTypeValues can be used interchangeably with EventSubTypeValues, this enum contains the known values that the service supports. Known values supported by the service Retirement: Retirement ForeignExchangeRateChange: ForeignExchangeRateChange Underbilling: Underbilling Overbilling: Overbilling PriceChanges: PriceChanges TaxChanges: TaxChanges MeterIDChanges: MeterIDChanges UnauthorizedPartyAbuse: UnauthorizedPartyAbuse
EventTypeValues	Type of event. KnownEventTypeValues can be used interchangeably with EventTypeValues, this enum contains the known values that the service supports. Known values supported by the service ServiceIssue: ServiceIssue PlannedMaintenance: PlannedMaintenance HealthAdvisory: HealthAdvisory RCA: RCA EmergingIssues: EmergingIssues SecurityAdvisory: SecurityAdvisory Billing: Billing
IssueNameParameter	Type of IssueNameParameter
LevelValues	Level of insight. KnownLevelValues can be used interchangeably with LevelValues, this enum contains the known values that the service supports. Known values supported by the service Critical: Critical Warning: Warning
LinkTypeValues	Type of link. KnownLinkTypeValues can be used interchangeably with LinkTypeValues, this enum contains the known values that the service supports. Known values supported by the service Button: Button Hyperlink: Hyperlink
ReasonChronicityTypes	Chronicity of the availability transition. KnownReasonChronicityTypes can be used interchangeably with ReasonChronicityTypes, this enum contains the known values that the service supports. Known values supported by the service Transient: Transient Persistent: Persistent
Scenario	Type of Scenario
SeverityValues	The severity level of this active event. KnownSeverityValues can be used interchangeably with SeverityValues, this enum contains the known values that the service supports. Known values supported by the service Information: Information Warning: Warning Error: Error
StageValues	The stage of this active event. KnownStageValues can be used interchangeably with StageValues, this enum contains the known values that the service supports. Known values supported by the service Active: Active Resolve: Resolve Archived: Archived

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAvailabilityStateValues	Impacted resource status of the resource.
KnownCreatedByType	The kind of entity that created the resource.
KnownEventLevelValues	Level of event.
KnownEventSourceValues	Source of event.
KnownEventStatusValues	Current status of event.
KnownEventSubTypeValues	Sub-type of event.
KnownEventTypeValues	Type of event.
KnownIssueNameParameter	Known values of IssueNameParameter that the service accepts.
KnownLevelValues	Level of insight.
KnownLinkTypeValues	Type of link.
KnownReasonChronicityTypes	Chronicity of the availability transition.
KnownScenario	Known values of Scenario that the service accepts.
KnownSeverityValues	The severity level of this active event.
KnownStageValues	The stage of this active event.
KnownVersions	The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

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

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor