Skip to content

Latest commit

 

History

History

azure_resourcehealth_resourcehealth

Folders and files

NameName
Last commit message
Last commit date

parent directory

..

README.md

README.md

 
 

index.js

index.js

 
 

openapi.json

openapi.json

 
 

package.json

package.json

 
 

README.md

@datafire/azure_resourcehealth_resourcehealth

Client library for Microsoft.ResourceHealth

Installation and Usage

npm install --save @datafire/azure_resourcehealth_resourcehealth
let azure_resourcehealth_resourcehealth = require('@datafire/azure_resourcehealth_resourcehealth').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Resource Health Client.

Actions

EmergingIssues_List

Lists Azure services' emerging issues.

azure_resourcehealth_resourcehealth.EmergingIssues_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: Client Api Version.

Output

EmergingIssues_Get

Gets Azure services' emerging issues.

azure_resourcehealth_resourcehealth.EmergingIssues_Get({
  "issueName": "",
  "api-version": ""
}, context)

Input

  • input object
    • issueName required string (values: default): The name of the emerging issue.
    • api-version required string: Client Api Version.

Output

Metadata_List

Gets the list of metadata entities.

azure_resourcehealth_resourcehealth.Metadata_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: Client Api Version.

Output

Metadata_Get

Gets the metadata entity.

azure_resourcehealth_resourcehealth.Metadata_Get({
  "name": "",
  "api-version": ""
}, context)

Input

  • input object
    • name required string: Name of metadata entity.
    • api-version required string: Client Api Version.

Output

Operations_List

Lists available operations for the resourcehealth resource provider

azure_resourcehealth_resourcehealth.Operations_List({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string: Client Api Version.

Output

AvailabilityStatuses_ListBySubscriptionId

Lists the current availability status for all the resources in the subscription.

azure_resourcehealth_resourcehealth.AvailabilityStatuses_ListBySubscriptionId({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object
    • api-version required string: Client Api Version.
    • $filter string: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • $expand string: Setting $expand=recommendedactions in url query expands the recommendedactions in the response.

Output

Events_ListBySubscriptionId

Lists current service health events in the subscription.

azure_resourcehealth_resourcehealth.Events_ListBySubscriptionId({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object

Output

ImpactedResources_ListBySubscriptionId

Lists the current availability status for impacted resources in the subscription.

azure_resourcehealth_resourcehealth.ImpactedResources_ListBySubscriptionId({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

  • input object

Output

AvailabilityStatuses_ListByResourceGroup

Lists the current availability status for all the resources in the resource group.

azure_resourcehealth_resourcehealth.AvailabilityStatuses_ListByResourceGroup({
  "subscriptionId": "",
  "resourceGroupName": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • resourceGroupName required string: The name of the resource group.
    • api-version required string: Client Api Version.
    • $filter string: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
    • $expand string: Setting $expand=recommendedactions in url query expands the recommendedactions in the response.

Output

AvailabilityStatuses_List

Lists all historical availability transitions and impacting events for a single resource.

azure_resourcehealth_resourcehealth.AvailabilityStatuses_List({
  "resourceUri": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceUri required string: The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
    • api-version required string: Client Api Version.
    • $filter string: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
    • $expand string: Setting $expand=recommendedactions in url query expands the recommendedactions in the response.

Output

AvailabilityStatuses_GetByResource

Gets current availability status for a single resource

azure_resourcehealth_resourcehealth.AvailabilityStatuses_GetByResource({
  "resourceUri": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceUri required string: The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
    • api-version required string: Client Api Version.
    • $filter string: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
    • $expand string: Setting $expand=recommendedactions in url query expands the recommendedactions in the response.

Output

Events_ListBySingleResource

Lists current service health events for given resource.

azure_resourcehealth_resourcehealth.Events_ListBySingleResource({
  "resourceUri": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceUri required string: The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
    • api-version required string: Client Api Version.
    • $filter string: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Output

Definitions

ErrorResponse

  • ErrorResponse object: Error details.
    • code string: The error code.
    • details string: The error details.
    • message string: The error message.

MetadataEntity

  • MetadataEntity object: The metadata entity contract.
    • properties MetadataEntityProperties
    • id string: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    • name string: The name of the resource
    • type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

MetadataEntityListResult

  • MetadataEntityListResult object: The list of metadata entities
    • nextLink string: The link used to get the next page of metadata.
    • value array: The list of metadata entities.

MetadataEntityProperties

  • MetadataEntityProperties object: The metadata entity properties
    • applicableScenarios array: The list of scenarios applicable to this metadata entity.
      • items string (values: Alerts)
    • dependsOn array: The list of keys on which this entity depends on.
      • items string
    • displayName string: The display name.
    • supportedValues array: The list of supported values.

MetadataSupportedValueDetail

  • MetadataSupportedValueDetail object: The metadata supported value detail.
    • displayName string: The display name.
    • id string: The id.

availabilityStatus

  • availabilityStatus object: availabilityStatus of a resource.
    • id string: Azure Resource Manager Identity for the availabilityStatuses resource.
    • location string: Azure Resource Manager geo location of the resource.
    • name string: current.
    • properties object: Properties of availability state.
      • availabilityState string (values: Available, Unavailable, Degraded, Unknown): Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event
      • detailedStatus string: Details of the availability status.
      • healthEventCategory string: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc.
      • healthEventCause string: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc.
      • healthEventId string: It is a unique Id that identifies the event
      • healthEventType string: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc.
      • occuredTime string: Timestamp for when last change in health status occurred.
      • reasonChronicity string (values: Transient, Persistent): Chronicity of the availability transition.
      • reasonType string: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc.
      • recentlyResolved object: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned
        • resolvedTime string: Timestamp when the availabilityState changes to Available.
        • unavailabilitySummary string: Brief description of cause of the resource becoming unavailable.
        • unavailableOccurredTime string: Timestamp for when the availabilityState changed to Unavailable
      • recommendedActions array: Lists actions the user can take based on the current availabilityState of the resource.
      • reportedTime string: Timestamp for when the health was last checked.
      • resolutionETA string: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.
      • rootCauseAttributionTime string: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.
      • serviceImpactingEvents array: Lists the service impacting events that may be affecting the health of the resource.
      • summary string: Summary description of the availability status.
    • type string: Microsoft.ResourceHealth/AvailabilityStatuses.

availabilityStatusListResult

  • availabilityStatusListResult object: The List availabilityStatus operation response.
    • nextLink string: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses.
    • value required array: The list of availabilityStatuses.

emergingIssue

  • emergingIssue object: On-going emerging issue from azure status.
    • refreshTimestamp string: Timestamp for when last time refreshed for ongoing emerging issue.
    • statusActiveEvents array: The list of emerging issues of active event type.
    • statusBanners array: The list of emerging issues of banner type.

emergingIssueImpact

  • emergingIssueImpact object: Object of the emerging issue impact on services and regions.
    • id string: The impacted service id.
    • name string: The impacted service name.
    • regions array: The list of impacted regions for corresponding emerging issues.

emergingIssueListResult

  • emergingIssueListResult object: The list of emerging issues.
    • nextLink string: The link used to get the next page of emerging issues.
    • value array: The list of emerging issues.

emergingIssuesGetResult

  • emergingIssuesGetResult object: The Get EmergingIssues operation response.
    • properties emergingIssue
    • id string: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    • name string: The name of the resource
    • type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

event

  • event object: Service health event
    • properties object: Properties of event.
      • article object: Article of event.
        • articleContent string: Article content of event.
      • enableChatWithUs boolean: Tells if we want to enable or disable Microsoft Support for this event.
      • enableMicrosoftSupport boolean: Tells if we want to enable or disable Microsoft Support for this event.
      • eventLevel string (values: Critical, Warning, Informational): Level of event.
      • eventSource string (values: ResourceHealth, ServiceHealth): Source of event.
      • eventType string (values: ServiceIssue, PlannedMaintenance, HealthAdvisory, RCA): Type of event.
      • faqs array: Frequently asked questions for the service health event.
      • header string: Header text of event.
      • hirStage string: Stage for HIR Document
      • impact array: List services impacted by the service health event.
      • impactMitigationTime string: It provides the Timestamp for when the health impacting event resolved.
      • impactStartTime string: It provides the Timestamp for when the health impacting event started.
      • isHIR boolean: It provides information if the event is High incident rate event or not.
      • lastUpdateTime string: It provides the Timestamp for when the health impacting event was last updated.
      • level string (values: Critical, Warning): Level of insight.
      • links array: Useful links of event.
      • priority integer: Priority level of the event.
      • recommendedActions object: Recommended actions of event.
        • actions array: Recommended actions for the service health event.
          • items object: Recommended action for the service health event.
            • actionText string: Recommended action text
            • groupId integer: Recommended action group Id for the service health event.
        • localeCode string: Recommended action locale for the service health event.
        • message string: Recommended action title for the service health event.
      • status string (values: Active, Resolved): Current status of event.
      • summary string: Summary text of event.
      • title string: Title text of event.
    • id string: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    • name string: The name of the resource
    • type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

events

  • events object: The List events operation response.
    • nextLink string: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events.
    • value required array: The list of event.

faq

  • faq object: Frequently asked question for the service health event
    • answer string: FAQ answer for the service health event.
    • localeCode string: FAQ locale for the service health event.
    • question string: FAQ question for the service health event.

impact

  • impact object: Azure service impacted by the service health event.
    • impactedRegions array: List regions impacted by the service health event.
    • impactedService string: Impacted service name.

impactedRegion

  • impactedRegion object: Object of impacted region.
    • id string: The impacted region id.
    • name string: The impacted region name.

impactedResourceListResult

  • impactedResourceListResult object: The List impactedResourceStatus operation response.
    • nextLink string: The URI to fetch the next page of impactedResourceStatus.
    • value required array: The list of impactedResourceStatus.

impactedResourceStatus

  • impactedResourceStatus object: impactedResource with health status
    • properties object: Properties of impacted resource status.
      • availabilityState string (values: Available, Unavailable, Degraded, Unknown): Impacted resource status of the resource.
      • occuredTime string: Timestamp for when last change in health status occurred.
      • reasonType string (values: Unplanned, Planned, UserInitiated): When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated.
      • summary string: Summary description of the impacted resource status.
      • title string: Title description of the impacted resource status.
    • id string: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    • name string: The name of the resource
    • type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

impactedServiceRegion

  • impactedServiceRegion object: Azure region impacted by the service health event.
    • impactedRegion string: Impacted region name.
    • impactedSubscriptions array: List subscription impacted by the service health event.
      • items string: Subscription impacted by the service health event.
    • lastUpdateTime string: It provides the Timestamp for when the last update for the service health event.
    • status string (values: Active, Resolved): Current status of event in the region.
    • updates array: List of updates for given service health event.

link

  • link object: Useful links for service health event.
    • bladeName string: It provides the name of portal extension blade to produce link for given service health event.
    • displayText object: Display text of link.
      • localizedValue string: Localized display text of link.
      • value string: Display text of link.
    • extensionName string: It provides the name of portal extension to produce link for given service health event.
    • parameters object: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event.
    • type string (values: Button, Hyperlink): Type of link.

operation

  • operation object: Operation available in the resourcehealth resource provider.
    • display object: Properties of the operation.
      • description string: Description of the operation.
      • operation string: Operation name.
      • provider string: Provider name.
      • resource string: Resource name.
    • name string: Name of the operation.

operationListResult

  • operationListResult object: Lists the operations response.
    • value required array: List of operations available in the resourcehealth resource provider.

recommendedAction

  • recommendedAction object: Lists actions the user can take based on the current availabilityState of the resource.
    • action string: Recommended action.
    • actionUrl string: Link to the action
    • actionUrlText string: Substring of action, it describes which text should host the action url.

serviceImpactingEvent

  • serviceImpactingEvent object: Lists the service impacting events that may be affecting the health of the resource.
    • correlationId string: Correlation id for the event
    • eventStartTime string: Timestamp for when the event started.
    • eventStatusLastModifiedTime string: Timestamp for when event was submitted/detected.
    • incidentProperties object: Properties of the service impacting event.
      • incidentType string: Type of Event.
      • region string: Region impacted by the event.
      • service string: Service impacted by the event.
      • title string: Title of the incident.
    • status object: Status of the service impacting event.
      • value string: Current status of the event

statusActiveEvent

  • statusActiveEvent object: Active event type of emerging issue.
    • cloud string: The cloud type of this active event.
    • description string: The details of active event.
    • impacts array: The list of emerging issues impacts.
    • lastModifiedTime string: The last time modified on this banner.
    • published boolean: The boolean value of this active event if published or not.
    • severity string (values: Information, Warning, Error): The severity level of this active event.
    • stage string (values: Active, Resolve, Archived): The stage of this active event.
    • startTime string: The impact start time on this active event.
    • title string: The active event title.
    • trackingId string: The tracking id of this active event.

statusBanner

  • statusBanner object: Banner type of emerging issue.
    • cloud string: The cloud type of this banner.
    • lastModifiedTime string: The last time modified on this banner.
    • message string: The details of banner.
    • title string: The banner title.

update

  • update object: Update for service health event.
    • summary string: Summary text for the given update for the service health event.
    • updateDateTime string: It provides the Timestamp for the given update for the service health event.