@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Microsoft.ResourceHealth
@base https://management.azure.com
@version 2018-07-01-preview
@auth OAuth2
@common_fields {api-version: any # Client Api Version.}
@endpoints 12
@toc providers(5), subscriptions(4), {resourceUri}(3)

@group providers
@endpoint GET /providers/Microsoft.ResourceHealth/metadata/{name}
@desc Gets the metadata entity.
@required {name: any # Name of metadata entity.}
@returns(200) OK. Successfully retrieved metadata entities
@errors {404: Client sent unknown metadata name}

@endpoint GET /providers/Microsoft.ResourceHealth/metadata
@desc Gets the list of metadata entities.
@returns(200) OK. Successfully retrieved metadata entities

@endpoint GET /providers/Microsoft.ResourceHealth/emergingIssues/{issueName}
@desc Gets Azure services' emerging issues.
@required {issueName: any # The name of the emerging issue.}
@returns(200) The body contains properties of azure emerging issues, which includes a list of status banner and status active events.

@endpoint GET /providers/Microsoft.ResourceHealth/emergingIssues
@desc Lists Azure services' emerging issues.
@returns(200) The body contains a list of azure emerging issues.

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events
@desc Lists current service health events in the subscription.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}
@optional {$filter: any # The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN}
@returns(200) The list of current service health events in the subscription

@endgroup

@group {resourceUri}
@endpoint GET /{resourceUri}/providers/Microsoft.ResourceHealth/events
@desc Lists current service health events for given resource.
@required {resourceUri: any # 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}}
@optional {$filter: any # The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN}
@returns(200) The list of current service health events for given resource

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/impactedResources
@desc Lists the current availability status for impacted resources in the subscription.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}
@optional {$filter: any # The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN}
@returns(200) The list of current availability status for impacted resources in the subscription

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses
@desc Lists the current availability status for all the resources in the subscription.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}
@optional {$filter: any # 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: any # Setting $expand=recommendedactions in url query expands the recommendedactions in the response.}
@returns(200) The list of current availability status for all the resources in the subscription

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses
@desc Lists the current availability status for all the resources in the resource group.
@required {subscriptionId: any # Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group.}
@optional {$filter: any # 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: any # Setting $expand=recommendedactions in url query expands the recommendedactions in the response.}
@returns(200) The list of current availability status for all the resources in the resource group

@endgroup

@group {resourceUri}
@endpoint GET /{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current
@desc Gets current availability status for a single resource
@required {resourceUri: any # 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}}
@optional {$filter: any # 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: any # Setting $expand=recommendedactions in url query expands the recommendedactions in the response.}
@returns(200) The current availability status for a single resource

@endpoint GET /{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses
@desc Lists all historical availability transitions and impacting events for a single resource.
@required {resourceUri: any # 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}}
@optional {$filter: any # 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: any # Setting $expand=recommendedactions in url query expands the recommendedactions in the response.}
@returns(200) The list of historical availability statuses for a single resource

@endgroup

@group providers
@endpoint GET /providers/Microsoft.ResourceHealth/operations
@desc Lists available operations for the resourcehealth resource provider
@returns(200) The list of available operations for the resourcehealth resource provider

@endgroup

@end