@azure/arm-maintenance package

Classes

MaintenanceManagementClient

Interfaces

ApplyUpdate

Apply Update request

ApplyUpdateForResourceGroup

Interface representing a ApplyUpdateForResourceGroup.

ApplyUpdateForResourceGroupListOptionalParams

Optional parameters.

ApplyUpdates

Interface representing a ApplyUpdates.

ApplyUpdatesCreateOrUpdateOptionalParams

Optional parameters.

ApplyUpdatesCreateOrUpdateOrCancelOptionalParams

Optional parameters.

ApplyUpdatesCreateOrUpdateParentOptionalParams

Optional parameters.

ApplyUpdatesGetOptionalParams

Optional parameters.

ApplyUpdatesGetParentOptionalParams

Optional parameters.

ApplyUpdatesListOptionalParams

Optional parameters.

ConfigurationAssignment

Configuration Assignment

ConfigurationAssignmentFilterProperties

Azure query for the update configuration.

ConfigurationAssignments

Interface representing a ConfigurationAssignments.

ConfigurationAssignmentsCreateOrUpdateOptionalParams

Optional parameters.

ConfigurationAssignmentsCreateOrUpdateParentOptionalParams

Optional parameters.

ConfigurationAssignmentsDeleteOptionalParams

Optional parameters.

ConfigurationAssignmentsDeleteParentOptionalParams

Optional parameters.

ConfigurationAssignmentsForResourceGroup

Interface representing a ConfigurationAssignmentsForResourceGroup.

ConfigurationAssignmentsForResourceGroupCreateOrUpdateOptionalParams

Optional parameters.

ConfigurationAssignmentsForResourceGroupDeleteOptionalParams

Optional parameters.

ConfigurationAssignmentsForResourceGroupGetOptionalParams

Optional parameters.

ConfigurationAssignmentsForResourceGroupUpdateOptionalParams

Optional parameters.

ConfigurationAssignmentsForSubscriptions

Interface representing a ConfigurationAssignmentsForSubscriptions.

ConfigurationAssignmentsForSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

ConfigurationAssignmentsForSubscriptionsDeleteOptionalParams

Optional parameters.

ConfigurationAssignmentsForSubscriptionsGetOptionalParams

Optional parameters.

ConfigurationAssignmentsForSubscriptionsUpdateOptionalParams

Optional parameters.

ConfigurationAssignmentsGetOptionalParams

Optional parameters.

ConfigurationAssignmentsGetParentOptionalParams

Optional parameters.

ConfigurationAssignmentsListOptionalParams

Optional parameters.

ConfigurationAssignmentsListParentOptionalParams

Optional parameters.

ConfigurationAssignmentsWithinSubscription

Interface representing a ConfigurationAssignmentsWithinSubscription.

ConfigurationAssignmentsWithinSubscriptionListOptionalParams

Optional parameters.

ErrorDetails

An error response details received from the Azure Maintenance service.

InputLinuxParameters

Input properties for patching a Linux machine.

InputPatchConfiguration

Input configuration for a patch run

InputWindowsParameters

Input properties for patching a Windows machine.

ListApplyUpdate

Response for ApplyUpdate list

ListConfigurationAssignmentsResult

Response for ConfigurationAssignments list

ListMaintenanceConfigurationsResult

Response for MaintenanceConfigurations list

ListUpdatesResult

Response for Updates list

MaintenanceConfiguration

Maintenance configuration record type

MaintenanceConfigurations

Interface representing a MaintenanceConfigurations.

MaintenanceConfigurationsCreateOrUpdateOptionalParams

Optional parameters.

MaintenanceConfigurationsDeleteOptionalParams

Optional parameters.

MaintenanceConfigurationsForResourceGroup

Interface representing a MaintenanceConfigurationsForResourceGroup.

MaintenanceConfigurationsForResourceGroupListOptionalParams

Optional parameters.

MaintenanceConfigurationsGetOptionalParams

Optional parameters.

MaintenanceConfigurationsListOptionalParams

Optional parameters.

MaintenanceConfigurationsUpdateOptionalParams

Optional parameters.

MaintenanceError

An error response received from the Azure Maintenance service.

MaintenanceManagementClientOptionalParams

Optional parameters.

Operation

Represents an operation returned by the GetOperations request

OperationInfo

Information about an operation

Operations

Interface representing a Operations.

OperationsListOptionalParams

Optional parameters.

OperationsListResult

Result of the List Operations operation

PublicMaintenanceConfigurations

Interface representing a PublicMaintenanceConfigurations.

PublicMaintenanceConfigurationsGetOptionalParams

Optional parameters.

PublicMaintenanceConfigurationsListOptionalParams

Optional parameters.

Resource

Definition of a Resource

ScheduledEvent

Interface representing a ScheduledEvent.

ScheduledEventAcknowledgeOptionalParams

Optional parameters.

ScheduledEventApproveResponse

Response of scheduled event acknowledge

SystemData

Metadata pertaining to creation and last modification of the resource.

TagSettingsProperties

Tag filter information for the VM.

Update

Maintenance update on a resource

Updates

Interface representing a Updates.

UpdatesListOptionalParams

Optional parameters.

UpdatesListParentOptionalParams

Optional parameters.

Type Aliases

ApplyUpdateForResourceGroupListResponse

Contains response data for the list operation.

ApplyUpdatesCreateOrUpdateOrCancelResponse

Contains response data for the createOrUpdateOrCancel operation.

ApplyUpdatesCreateOrUpdateParentResponse

Contains response data for the createOrUpdateParent operation.

ApplyUpdatesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApplyUpdatesGetParentResponse

Contains response data for the getParent operation.

ApplyUpdatesGetResponse

Contains response data for the get operation.

ApplyUpdatesListResponse

Contains response data for the list operation.

ConfigurationAssignmentsCreateOrUpdateParentResponse

Contains response data for the createOrUpdateParent operation.

ConfigurationAssignmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConfigurationAssignmentsDeleteParentResponse

Contains response data for the deleteParent operation.

ConfigurationAssignmentsDeleteResponse

Contains response data for the delete operation.

ConfigurationAssignmentsForResourceGroupCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConfigurationAssignmentsForResourceGroupDeleteResponse

Contains response data for the delete operation.

ConfigurationAssignmentsForResourceGroupGetResponse

Contains response data for the get operation.

ConfigurationAssignmentsForResourceGroupUpdateResponse

Contains response data for the update operation.

ConfigurationAssignmentsForSubscriptionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ConfigurationAssignmentsForSubscriptionsDeleteResponse

Contains response data for the delete operation.

ConfigurationAssignmentsForSubscriptionsGetResponse

Contains response data for the get operation.

ConfigurationAssignmentsForSubscriptionsUpdateResponse

Contains response data for the update operation.

ConfigurationAssignmentsGetParentResponse

Contains response data for the getParent operation.

ConfigurationAssignmentsGetResponse

Contains response data for the get operation.

ConfigurationAssignmentsListParentResponse

Contains response data for the listParent operation.

ConfigurationAssignmentsListResponse

Contains response data for the list operation.

ConfigurationAssignmentsWithinSubscriptionListResponse

Contains response data for the list operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

ImpactType

Defines values for ImpactType.
KnownImpactType can be used interchangeably with ImpactType, this enum contains the known values that the service supports.

Known values supported by the service

None: Pending updates has no impact on resource.
Freeze: Pending updates can freeze network or disk io operation on resource.
Restart: Pending updates can cause resource to restart.
Redeploy: Pending updates can redeploy resource.

MaintenanceConfigurationsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

MaintenanceConfigurationsDeleteResponse

Contains response data for the delete operation.

MaintenanceConfigurationsForResourceGroupListResponse

Contains response data for the list operation.

MaintenanceConfigurationsGetResponse

Contains response data for the get operation.

MaintenanceConfigurationsListResponse

Contains response data for the list operation.

MaintenanceConfigurationsUpdateResponse

Contains response data for the update operation.

MaintenanceScope

Defines values for MaintenanceScope.
KnownMaintenanceScope can be used interchangeably with MaintenanceScope, this enum contains the known values that the service supports.

Known values supported by the service

Host: This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs.
Resource: This maintenance scope controls the default update maintenance of the Azure Resource
OSImage: This maintenance scope controls os image installation on VM/VMSS
Extension: This maintenance scope controls extension installation on VM/VMSS
InGuestPatch: This maintenance scope controls installation of windows and linux packages on VM/VMSS
SQLDB: This maintenance scope controls installation of SQL server platform updates.
SQLManagedInstance: This maintenance scope controls installation of SQL managed instance platform update.

OperationsListResponse

Contains response data for the list operation.

PublicMaintenanceConfigurationsGetResponse

Contains response data for the get operation.

PublicMaintenanceConfigurationsListResponse

Contains response data for the list operation.

RebootOptions

Defines values for RebootOptions.
KnownRebootOptions can be used interchangeably with RebootOptions, this enum contains the known values that the service supports.

Known values supported by the service

IfRequired
Never
Always

ScheduledEventAcknowledgeResponse

Contains response data for the acknowledge operation.

TagOperators

Defines values for TagOperators.

UpdateStatus

Defines values for UpdateStatus.
KnownUpdateStatus can be used interchangeably with UpdateStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: There are pending updates to be installed.
InProgress: Updates installation are in progress.
Completed: All updates are successfully applied.
RetryNow: Updates installation failed but are ready to retry again.
RetryLater: Updates installation failed and should be retried later.
NoUpdatesPending: No updates are pending.
Cancel: Cancel the schedule and stop creating PMR for resources part of it. Applicable to Maintenance Configuration resource type only.
Cancelled: Send the Cancelled response to the user if request came to cancel the schedule. Applicable to Maintenance Configuration resource type only.

UpdatesListParentResponse

Contains response data for the listParent operation.

UpdatesListResponse

Contains response data for the list operation.

Visibility

Defines values for Visibility.
KnownVisibility can be used interchangeably with Visibility, this enum contains the known values that the service supports.

Known values supported by the service

Custom: Only visible to users with permissions.
Public: Visible to all users.

Enums

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownImpactType

Known values of ImpactType that the service accepts.

KnownMaintenanceScope

Known values of MaintenanceScope that the service accepts.

KnownRebootOptions

Known values of RebootOptions that the service accepts.

KnownUpdateStatus

Known values of UpdateStatus that the service accepts.

KnownVisibility

Known values of Visibility that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.