MaintenanceEventsOperations interface

Package:

@azure/arm-horizondb

Interface representing a MaintenanceEvents operations.

Properties

applyNow	Applies the maintenance event immediately.
beginApplyNow
beginApplyNowAndWait
beginReschedule
beginRescheduleAndWait
get	Gets information about a maintenance event for a HorizonDB pool.
list	Lists maintenance events for a HorizonDB pool. Use the OData $filter query parameter to filter by properties/status with the eq and or operators. For example, properties/status eq 'Planned' or properties/status eq 'InProgress' returns upcoming events.
reschedule	Reschedules a maintenance event to a new date and time.

Property Details

applyNow

Applies the maintenance event immediately.

applyNow: (resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsApplyNowOptionalParams) => PollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsApplyNowOptionalParams) => PollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>

beginApplyNow

Warning

This API is now deprecated.

use applyNow instead

beginApplyNow: (resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsApplyNowOptionalParams) => Promise<SimplePollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsApplyNowOptionalParams) => Promise<SimplePollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>>

beginApplyNowAndWait

Warning

This API is now deprecated.

use applyNow instead

beginApplyNowAndWait: (resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsApplyNowOptionalParams) => Promise<MaintenanceEventActionResponse>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsApplyNowOptionalParams) => Promise<MaintenanceEventActionResponse>

beginReschedule

Warning

This API is now deprecated.

use reschedule instead

beginReschedule: (resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, body: MaintenanceEventRescheduleRequest, options?: MaintenanceEventsRescheduleOptionalParams) => Promise<SimplePollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, body: MaintenanceEventRescheduleRequest, options?: MaintenanceEventsRescheduleOptionalParams) => Promise<SimplePollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>>

beginRescheduleAndWait

Warning

This API is now deprecated.

use reschedule instead

beginRescheduleAndWait: (resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, body: MaintenanceEventRescheduleRequest, options?: MaintenanceEventsRescheduleOptionalParams) => Promise<MaintenanceEventActionResponse>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, body: MaintenanceEventRescheduleRequest, options?: MaintenanceEventsRescheduleOptionalParams) => Promise<MaintenanceEventActionResponse>

get

Gets information about a maintenance event for a HorizonDB pool.

get: (resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsGetOptionalParams) => Promise<MaintenanceEvent>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, options?: MaintenanceEventsGetOptionalParams) => Promise<MaintenanceEvent>

list

Lists maintenance events for a HorizonDB pool. Use the OData $filter query parameter to filter by properties/status with the eq and or operators. For example, properties/status eq 'Planned' or properties/status eq 'InProgress' returns upcoming events.

list: (resourceGroupName: string, clusterName: string, poolName: string, options?: MaintenanceEventsListOptionalParams) => PagedAsyncIterableIterator<MaintenanceEvent, MaintenanceEvent[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, options?: MaintenanceEventsListOptionalParams) => PagedAsyncIterableIterator<MaintenanceEvent, MaintenanceEvent[], PageSettings>

reschedule

Reschedules a maintenance event to a new date and time.

reschedule: (resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, body: MaintenanceEventRescheduleRequest, options?: MaintenanceEventsRescheduleOptionalParams) => PollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>

Property Value

(resourceGroupName: string, clusterName: string, poolName: string, maintenanceEventId: string, body: MaintenanceEventRescheduleRequest, options?: MaintenanceEventsRescheduleOptionalParams) => PollerLike<OperationState<MaintenanceEventActionResponse>, MaintenanceEventActionResponse>