AvailabilityStatuses | @azure/arm-resourcehealth

Class representing a AvailabilityStatuses.

Hierarchy

AvailabilityStatuses

Index

Constructors

constructor

Methods

Constructors

constructor

new AvailabilityStatuses(client: MicrosoftResourceHealthContext): AvailabilityStatuses

- Defined in operations/availabilityStatuses.ts:19
Create a AvailabilityStatuses.

Parameters
- client: MicrosoftResourceHealthContext
  
  Reference to the service client.
Returns AvailabilityStatuses

Methods

getByResource

getByResource(resourceUri: string, options?: Models.AvailabilityStatusesGetByResourceOptionalParams): Promise<Models.AvailabilityStatusesGetByResourceResponse>
getByResource(resourceUri: string, callback: msRest.ServiceCallback<AvailabilityStatus>): void
getByResource(resourceUri: string, options: AvailabilityStatusesGetByResourceOptionalParams, callback: msRest.ServiceCallback<AvailabilityStatus>): void

- Defined in operations/availabilityStatuses.ts:93
Gets current availability status for a single resource

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}
- Optional options: Models.AvailabilityStatusesGetByResourceOptionalParams
Returns Promise<Models.AvailabilityStatusesGetByResourceResponse>

Promise<Models.AvailabilityStatusesGetByResourceResponse>
- Defined in operations/availabilityStatuses.ts:102
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}
- callback: msRest.ServiceCallback<AvailabilityStatus>
  
  The callback
Returns void
- Defined in operations/availabilityStatuses.ts:112
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 optional parameters
- callback: msRest.ServiceCallback<AvailabilityStatus>
  
  The callback
Returns void

list

list(resourceUri: string, options?: Models.AvailabilityStatusesListOptionalParams): Promise<Models.AvailabilityStatusesListResponse>
list(resourceUri: string, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void
list(resourceUri: string, options: AvailabilityStatusesListOptionalParams, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void

- Defined in operations/availabilityStatuses.ts:134
Lists all historical availability transitions and impacting events for a single resource. Use the nextLink property in the response to get the next page of availability status

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}
- Optional options: Models.AvailabilityStatusesListOptionalParams
Returns Promise<Models.AvailabilityStatusesListResponse>

Promise<Models.AvailabilityStatusesListResponse>
- Defined in operations/availabilityStatuses.ts:143
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}
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void
- Defined in operations/availabilityStatuses.ts:153
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 optional parameters
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: Models.AvailabilityStatusesListByResourceGroupOptionalParams): Promise<Models.AvailabilityStatusesListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void
listByResourceGroup(resourceGroupName: string, options: AvailabilityStatusesListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void

- Defined in operations/availabilityStatuses.ts:61
Lists the current availability status for all the resources in the resource group. Use the nextLink property in the response to get the next page of availability statuses.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: Models.AvailabilityStatusesListByResourceGroupOptionalParams
Returns Promise<Models.AvailabilityStatusesListByResourceGroupResponse>

Promise<Models.AvailabilityStatusesListByResourceGroupResponse>
- Defined in operations/availabilityStatuses.ts:66
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void
- Defined in operations/availabilityStatuses.ts:72
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- options: AvailabilityStatusesListByResourceGroupOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void

listByResourceGroupNext

listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.AvailabilityStatusesListByResourceGroupNextResponse>
listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void
listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void

- Defined in operations/availabilityStatuses.ts:200
Lists the current availability status for all the resources in the resource group. Use the nextLink property in the response to get the next page of availability statuses.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.AvailabilityStatusesListByResourceGroupNextResponse>

Promise<Models.AvailabilityStatusesListByResourceGroupNextResponse>
- Defined in operations/availabilityStatuses.ts:205
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void
- Defined in operations/availabilityStatuses.ts:211
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void

listBySubscriptionId

listBySubscriptionId(options?: Models.AvailabilityStatusesListBySubscriptionIdOptionalParams): Promise<Models.AvailabilityStatusesListBySubscriptionIdResponse>
listBySubscriptionId(callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void
listBySubscriptionId(options: AvailabilityStatusesListBySubscriptionIdOptionalParams, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void

- Defined in operations/availabilityStatuses.ts:35
Lists the current availability status for all the resources in the subscription. Use the nextLink property in the response to get the next page of availability statuses.

Parameters
- Optional options: Models.AvailabilityStatusesListBySubscriptionIdOptionalParams
Returns Promise<Models.AvailabilityStatusesListBySubscriptionIdResponse>

Promise<Models.AvailabilityStatusesListBySubscriptionIdResponse>
- Defined in operations/availabilityStatuses.ts:39
Parameters
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void
- Defined in operations/availabilityStatuses.ts:44
Parameters
- options: AvailabilityStatusesListBySubscriptionIdOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void

listBySubscriptionIdNext

listBySubscriptionIdNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.AvailabilityStatusesListBySubscriptionIdNextResponse>
listBySubscriptionIdNext(nextPageLink: string, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void
listBySubscriptionIdNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void

- Defined in operations/availabilityStatuses.ts:171
Lists the current availability status for all the resources in the subscription. Use the nextLink property in the response to get the next page of availability statuses.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.AvailabilityStatusesListBySubscriptionIdNextResponse>

Promise<Models.AvailabilityStatusesListBySubscriptionIdNextResponse>
- Defined in operations/availabilityStatuses.ts:176
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void
- Defined in operations/availabilityStatuses.ts:182
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.AvailabilityStatusesListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AvailabilityStatusListResult>): void

- Defined in operations/availabilityStatuses.ts:229
Lists all historical availability transitions and impacting events for a single resource. Use the nextLink property in the response to get the next page of availability status

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.AvailabilityStatusesListNextResponse>

Promise<Models.AvailabilityStatusesListNextResponse>
- Defined in operations/availabilityStatuses.ts:234
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void
- Defined in operations/availabilityStatuses.ts:240
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<AvailabilityStatusListResult>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: MicrosoftResourceHealthContext

Returns AvailabilityStatuses

Methods

getByResource

Parameters

resourceUri: string

Optional options: Models.AvailabilityStatusesGetByResourceOptionalParams

Returns Promise<Models.AvailabilityStatusesGetByResourceResponse>

Parameters

resourceUri: string

callback: msRest.ServiceCallback<AvailabilityStatus>

Returns void

Parameters

resourceUri: string

options: AvailabilityStatusesGetByResourceOptionalParams

callback: msRest.ServiceCallback<AvailabilityStatus>

Returns void

list

Parameters

resourceUri: string

Optional options: Models.AvailabilityStatusesListOptionalParams

Returns Promise<Models.AvailabilityStatusesListResponse>

Parameters

resourceUri: string

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

Parameters

resourceUri: string

options: AvailabilityStatusesListOptionalParams

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: Models.AvailabilityStatusesListByResourceGroupOptionalParams

Returns Promise<Models.AvailabilityStatusesListByResourceGroupResponse>

Parameters

resourceGroupName: string

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

Parameters

resourceGroupName: string

options: AvailabilityStatusesListByResourceGroupOptionalParams

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

listByResourceGroupNext

Parameters

nextPageLink: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.AvailabilityStatusesListByResourceGroupNextResponse>

Parameters

nextPageLink: string

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

Parameters

nextPageLink: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

listBySubscriptionId

Parameters

Optional options: Models.AvailabilityStatusesListBySubscriptionIdOptionalParams

Returns Promise<Models.AvailabilityStatusesListBySubscriptionIdResponse>

Parameters

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

Parameters

options: AvailabilityStatusesListBySubscriptionIdOptionalParams

callback: msRest.ServiceCallback<AvailabilityStatusListResult>

Returns void

listBySubscriptionIdNext

Parameters

nextPageLink: string