AvailabilityStatuses interface

Package:

@azure/arm-resourcehealth

Interface representing a AvailabilityStatuses.

Methods

getByResource(string, AvailabilityStatusesGetByResourceOptionalParams)	Gets current availability status for a single resource
list(string, AvailabilityStatusesListOptionalParams)	Lists all historical availability transitions and impacting events for a single resource.
listByResourceGroup(string, AvailabilityStatusesListByResourceGroupOptionalParams)	Lists the current availability status for all the resources in the resource group.
listBySubscriptionId(AvailabilityStatusesListBySubscriptionIdOptionalParams)	Lists the current availability status for all the resources in the subscription.

Method Details

getByResource(string, AvailabilityStatusesGetByResourceOptionalParams)

Gets current availability status for a single resource

function getByResource(resourceUri: string, options?: AvailabilityStatusesGetByResourceOptionalParams): Promise<AvailabilityStatus>

Parameters

resourceUri

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}

options

AvailabilityStatusesGetByResourceOptionalParams

The options parameters.

Returns

Promise<AvailabilityStatus>

list(string, AvailabilityStatusesListOptionalParams)

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

function list(resourceUri: string, options?: AvailabilityStatusesListOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus, AvailabilityStatus[], PageSettings>

Parameters

resourceUri

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}

options

AvailabilityStatusesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AvailabilityStatus, AvailabilityStatus[], PageSettings>

listByResourceGroup(string, AvailabilityStatusesListByResourceGroupOptionalParams)

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

function listByResourceGroup(resourceGroupName: string, options?: AvailabilityStatusesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus, AvailabilityStatus[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

AvailabilityStatusesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AvailabilityStatus, AvailabilityStatus[], PageSettings>

listBySubscriptionId(AvailabilityStatusesListBySubscriptionIdOptionalParams)

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

function listBySubscriptionId(options?: AvailabilityStatusesListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus, AvailabilityStatus[], PageSettings>

Parameters

options

AvailabilityStatusesListBySubscriptionIdOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AvailabilityStatus, AvailabilityStatus[], PageSettings>