@azure/arm-resourcehealth package

Classes

MicrosoftResourceHealth

Interfaces

AvailabilityStatus	availabilityStatus of a resource.
AvailabilityStatusListResult	The List availabilityStatus operation response.
AvailabilityStatusProperties	Properties of availability state.
AvailabilityStatusPropertiesRecentlyResolved	An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned
AvailabilityStatuses	Interface representing a AvailabilityStatuses.
AvailabilityStatusesGetByResourceOptionalParams	Optional parameters.
AvailabilityStatusesListByResourceGroupNextOptionalParams	Optional parameters.
AvailabilityStatusesListByResourceGroupOptionalParams	Optional parameters.
AvailabilityStatusesListBySubscriptionIdNextOptionalParams	Optional parameters.
AvailabilityStatusesListBySubscriptionIdOptionalParams	Optional parameters.
AvailabilityStatusesListNextOptionalParams	Optional parameters.
AvailabilityStatusesListOptionalParams	Optional parameters.
ChildAvailabilityStatuses	Interface representing a ChildAvailabilityStatuses.
ChildAvailabilityStatusesGetByResourceOptionalParams	Optional parameters.
ChildAvailabilityStatusesListNextOptionalParams	Optional parameters.
ChildAvailabilityStatusesListOptionalParams	Optional parameters.
ChildResources	Interface representing a ChildResources.
ChildResourcesListNextOptionalParams	Optional parameters.
ChildResourcesListOptionalParams	Optional parameters.
EmergingIssueImpact	Object of the emerging issue impact on services and regions.
EmergingIssueListResult	The list of emerging issues.
EmergingIssues	Interface representing a EmergingIssues.
EmergingIssuesGetOptionalParams	Optional parameters.
EmergingIssuesGetResult	The Get EmergingIssues operation response.
EmergingIssuesListNextOptionalParams	Optional parameters.
EmergingIssuesListOptionalParams	Optional parameters.
ErrorResponse	Error details.
Event	Service health event
EventFetchDetailsBySubscriptionIdAndTrackingIdOptionalParams	Optional parameters.
EventFetchDetailsByTenantIdAndTrackingIdOptionalParams	Optional parameters.
EventGetBySubscriptionIdAndTrackingIdOptionalParams	Optional parameters.
EventGetByTenantIdAndTrackingIdOptionalParams	Optional parameters.
EventImpactedResource	Impacted resource for an event.
EventImpactedResourceListResult	The List of eventImpactedResources operation response.
EventOperations	Interface representing a EventOperations.
EventPropertiesAdditionalInformation	Additional information
EventPropertiesArticle	Article of event.
EventPropertiesRecommendedActions	Recommended actions of event.
EventPropertiesRecommendedActionsItem	Recommended action for the service health event.
Events	The List events operation response.
EventsListBySingleResourceNextOptionalParams	Optional parameters.
EventsListBySingleResourceOptionalParams	Optional parameters.
EventsListBySubscriptionIdNextOptionalParams	Optional parameters.
EventsListBySubscriptionIdOptionalParams	Optional parameters.
EventsListByTenantIdNextOptionalParams	Optional parameters.
EventsListByTenantIdOptionalParams	Optional parameters.
EventsOperations	Interface representing a EventsOperations.
Faq	Frequently asked question for the service health event
Impact	Azure service impacted by the service health event.
ImpactedRegion	Object of impacted region.
ImpactedResourceStatus	impactedResource with health status
ImpactedResources	Interface representing a ImpactedResources.
ImpactedResourcesGetByTenantIdOptionalParams	Optional parameters.
ImpactedResourcesGetOptionalParams	Optional parameters.
ImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams	Optional parameters.
ImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams	Optional parameters.
ImpactedResourcesListByTenantIdAndEventIdNextOptionalParams	Optional parameters.
ImpactedResourcesListByTenantIdAndEventIdOptionalParams	Optional parameters.
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.
Metadata	Interface representing a Metadata.
MetadataEntity	The metadata entity contract.
MetadataEntityListResult	The list of metadata entities
MetadataGetEntityOptionalParams	Optional parameters.
MetadataListNextOptionalParams	Optional parameters.
MetadataListOptionalParams	Optional parameters.
MetadataSupportedValueDetail	The metadata supported value detail.
MicrosoftResourceHealthOptionalParams	Optional parameters.
Operation	Operation available in the Microsoft.ResourceHealth resource provider.
OperationDisplay	Properties of the operation.
OperationListResult	Lists the operations response.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
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
SecurityAdvisoryImpactedResources	Interface representing a SecurityAdvisoryImpactedResources.
SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams	Optional parameters.
SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams	Optional parameters.
SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextOptionalParams	Optional parameters.
SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdOptionalParams	Optional parameters.
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	Defines values for AvailabilityStateValues. KnownAvailabilityStateValues can be used interchangeably with AvailabilityStateValues, this enum contains the known values that the service supports. Known values supported by the service Available Unavailable Degraded Unknown
AvailabilityStatusesGetByResourceResponse	Contains response data for the getByResource operation.
AvailabilityStatusesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
AvailabilityStatusesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
AvailabilityStatusesListBySubscriptionIdNextResponse	Contains response data for the listBySubscriptionIdNext operation.
AvailabilityStatusesListBySubscriptionIdResponse	Contains response data for the listBySubscriptionId operation.
AvailabilityStatusesListNextResponse	Contains response data for the listNext operation.
AvailabilityStatusesListResponse	Contains response data for the list operation.
ChildAvailabilityStatusesGetByResourceResponse	Contains response data for the getByResource operation.
ChildAvailabilityStatusesListNextResponse	Contains response data for the listNext operation.
ChildAvailabilityStatusesListResponse	Contains response data for the list operation.
ChildResourcesListNextResponse	Contains response data for the listNext operation.
ChildResourcesListResponse	Contains response data for the list operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
EmergingIssuesGetResponse	Contains response data for the get operation.
EmergingIssuesListNextResponse	Contains response data for the listNext operation.
EmergingIssuesListResponse	Contains response data for the list operation.
EventFetchDetailsBySubscriptionIdAndTrackingIdResponse	Contains response data for the fetchDetailsBySubscriptionIdAndTrackingId operation.
EventFetchDetailsByTenantIdAndTrackingIdResponse	Contains response data for the fetchDetailsByTenantIdAndTrackingId operation.
EventGetBySubscriptionIdAndTrackingIdResponse	Contains response data for the getBySubscriptionIdAndTrackingId operation.
EventGetByTenantIdAndTrackingIdResponse	Contains response data for the getByTenantIdAndTrackingId operation.
EventLevelValues	Defines values for EventLevelValues. KnownEventLevelValues can be used interchangeably with EventLevelValues, this enum contains the known values that the service supports. Known values supported by the service Critical Error Warning Informational
EventSourceValues	Defines values for EventSourceValues. KnownEventSourceValues can be used interchangeably with EventSourceValues, this enum contains the known values that the service supports. Known values supported by the service ResourceHealth ServiceHealth
EventStatusValues	Defines values for EventStatusValues. KnownEventStatusValues can be used interchangeably with EventStatusValues, this enum contains the known values that the service supports. Known values supported by the service Active Resolved
EventTypeValues	Defines values for EventTypeValues. KnownEventTypeValues can be used interchangeably with EventTypeValues, this enum contains the known values that the service supports. Known values supported by the service ServiceIssue PlannedMaintenance HealthAdvisory RCA EmergingIssues SecurityAdvisory
EventsListBySingleResourceNextResponse	Contains response data for the listBySingleResourceNext operation.
EventsListBySingleResourceResponse	Contains response data for the listBySingleResource operation.
EventsListBySubscriptionIdNextResponse	Contains response data for the listBySubscriptionIdNext operation.
EventsListBySubscriptionIdResponse	Contains response data for the listBySubscriptionId operation.
EventsListByTenantIdNextResponse	Contains response data for the listByTenantIdNext operation.
EventsListByTenantIdResponse	Contains response data for the listByTenantId operation.
ImpactedResourcesGetByTenantIdResponse	Contains response data for the getByTenantId operation.
ImpactedResourcesGetResponse	Contains response data for the get operation.
ImpactedResourcesListBySubscriptionIdAndEventIdNextResponse	Contains response data for the listBySubscriptionIdAndEventIdNext operation.
ImpactedResourcesListBySubscriptionIdAndEventIdResponse	Contains response data for the listBySubscriptionIdAndEventId operation.
ImpactedResourcesListByTenantIdAndEventIdNextResponse	Contains response data for the listByTenantIdAndEventIdNext operation.
ImpactedResourcesListByTenantIdAndEventIdResponse	Contains response data for the listByTenantIdAndEventId operation.
IssueNameParameter	Defines values for IssueNameParameter. KnownIssueNameParameter can be used interchangeably with IssueNameParameter, this enum contains the known values that the service supports. Known values supported by the service default
LevelValues	Defines values for LevelValues. KnownLevelValues can be used interchangeably with LevelValues, this enum contains the known values that the service supports. Known values supported by the service Critical Warning
LinkTypeValues	Defines values for LinkTypeValues. KnownLinkTypeValues can be used interchangeably with LinkTypeValues, this enum contains the known values that the service supports. Known values supported by the service Button Hyperlink
MetadataGetEntityResponse	Contains response data for the getEntity operation.
MetadataListNextResponse	Contains response data for the listNext operation.
MetadataListResponse	Contains response data for the list operation.
OperationsListResponse	Contains response data for the list operation.
ReasonChronicityTypes	Defines values for ReasonChronicityTypes. KnownReasonChronicityTypes can be used interchangeably with ReasonChronicityTypes, this enum contains the known values that the service supports. Known values supported by the service Transient Persistent
ReasonTypeValues	Defines values for ReasonTypeValues. KnownReasonTypeValues can be used interchangeably with ReasonTypeValues, this enum contains the known values that the service supports. Known values supported by the service Unplanned Planned UserInitiated
Scenario	Defines values for Scenario. KnownScenario can be used interchangeably with Scenario, this enum contains the known values that the service supports. Known values supported by the service Alerts
SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextResponse	Contains response data for the listBySubscriptionIdAndEventIdNext operation.
SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdResponse	Contains response data for the listBySubscriptionIdAndEventId operation.
SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextResponse	Contains response data for the listByTenantIdAndEventIdNext operation.
SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdResponse	Contains response data for the listByTenantIdAndEventId operation.
SeverityValues	Defines values for SeverityValues. KnownSeverityValues can be used interchangeably with SeverityValues, this enum contains the known values that the service supports. Known values supported by the service Information Warning Error
StageValues	Defines values for StageValues. KnownStageValues can be used interchangeably with StageValues, this enum contains the known values that the service supports. Known values supported by the service Active Resolve Archived

Enums

KnownAvailabilityStateValues	Known values of AvailabilityStateValues that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownEventLevelValues	Known values of EventLevelValues that the service accepts.
KnownEventSourceValues	Known values of EventSourceValues that the service accepts.
KnownEventStatusValues	Known values of EventStatusValues that the service accepts.
KnownEventTypeValues	Known values of EventTypeValues that the service accepts.
KnownIssueNameParameter	Known values of IssueNameParameter that the service accepts.
KnownLevelValues	Known values of LevelValues that the service accepts.
KnownLinkTypeValues	Known values of LinkTypeValues that the service accepts.
KnownReasonChronicityTypes	Known values of ReasonChronicityTypes that the service accepts.
KnownReasonTypeValues	Known values of ReasonTypeValues that the service accepts.
KnownScenario	Known values of Scenario that the service accepts.
KnownSeverityValues	Known values of SeverityValues that the service accepts.
KnownStageValues	Known values of StageValues that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.