@azure/arm-maintenance package

Classes

Interfaces

ApplyUpdate	Apply Update request
ApplyUpdateForResourceGroupListOptionalParams	Optional parameters.
ApplyUpdateForResourceGroupOperations	Interface representing a ApplyUpdateForResourceGroup operations.
ApplyUpdateProperties	Properties for apply update
ApplyUpdatesCreateOrUpdateOptionalParams	Optional parameters.
ApplyUpdatesCreateOrUpdateOrCancelOptionalParams	Optional parameters.
ApplyUpdatesCreateOrUpdateParentOptionalParams	Optional parameters.
ApplyUpdatesGetOptionalParams	Optional parameters.
ApplyUpdatesGetParentOptionalParams	Optional parameters.
ApplyUpdatesListOptionalParams	Optional parameters.
ApplyUpdatesOperations	Interface representing a ApplyUpdates operations.
ConfigurationAssignment	Configuration Assignment
ConfigurationAssignmentFilterProperties	Azure query for the update configuration.
ConfigurationAssignmentProperties	Properties for configuration assignment
ConfigurationAssignmentsCreateOrUpdateOptionalParams	Optional parameters.
ConfigurationAssignmentsCreateOrUpdateParentOptionalParams	Optional parameters.
ConfigurationAssignmentsDeleteOptionalParams	Optional parameters.
ConfigurationAssignmentsDeleteParentOptionalParams	Optional parameters.
ConfigurationAssignmentsForResourceGroupCreateOrUpdateOptionalParams	Optional parameters.
ConfigurationAssignmentsForResourceGroupDeleteOptionalParams	Optional parameters.
ConfigurationAssignmentsForResourceGroupGetOptionalParams	Optional parameters.
ConfigurationAssignmentsForResourceGroupOperations	Interface representing a ConfigurationAssignmentsForResourceGroup operations.
ConfigurationAssignmentsForResourceGroupUpdateOptionalParams	Optional parameters.
ConfigurationAssignmentsForSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
ConfigurationAssignmentsForSubscriptionsDeleteOptionalParams	Optional parameters.
ConfigurationAssignmentsForSubscriptionsGetOptionalParams	Optional parameters.
ConfigurationAssignmentsForSubscriptionsOperations	Interface representing a ConfigurationAssignmentsForSubscriptions operations.
ConfigurationAssignmentsForSubscriptionsUpdateOptionalParams	Optional parameters.
ConfigurationAssignmentsGetOptionalParams	Optional parameters.
ConfigurationAssignmentsGetParentOptionalParams	Optional parameters.
ConfigurationAssignmentsListOptionalParams	Optional parameters.
ConfigurationAssignmentsListParentOptionalParams	Optional parameters.
ConfigurationAssignmentsOperations	Interface representing a ConfigurationAssignments operations.
ConfigurationAssignmentsWithinSubscriptionListOptionalParams	Optional parameters.
ConfigurationAssignmentsWithinSubscriptionOperations	Interface representing a ConfigurationAssignmentsWithinSubscription operations.
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.
MaintenanceConfiguration	Maintenance configuration record type
MaintenanceConfigurationProperties	Properties for maintenance configuration
MaintenanceConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
MaintenanceConfigurationsDeleteOptionalParams	Optional parameters.
MaintenanceConfigurationsForResourceGroupListOptionalParams	Optional parameters.
MaintenanceConfigurationsForResourceGroupOperations	Interface representing a MaintenanceConfigurationsForResourceGroup operations.
MaintenanceConfigurationsGetOptionalParams	Optional parameters.
MaintenanceConfigurationsListOptionalParams	Optional parameters.
MaintenanceConfigurationsOperations	Interface representing a MaintenanceConfigurations operations.
MaintenanceConfigurationsUpdateOptionalParams	Optional parameters.
MaintenanceError	An error response received from the Azure Maintenance service.
MaintenanceManagementClientOptionalParams	Optional parameters for the client.
MaintenanceWindow	Definition of a MaintenanceWindow
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PublicMaintenanceConfigurationsGetOptionalParams	Optional parameters.
PublicMaintenanceConfigurationsListOptionalParams	Optional parameters.
PublicMaintenanceConfigurationsOperations	Interface representing a PublicMaintenanceConfigurations operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ScheduledEventAcknowledgeOptionalParams	Optional parameters.
ScheduledEventApproveResponse	Response of scheduled event acknowledge
ScheduledEventOperations	Interface representing a ScheduledEvent operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
TagSettingsProperties	Tag filter information for the VM.
Update	Maintenance update on a resource
UpdateProperties	Properties for update
UpdatesListOptionalParams	Optional parameters.
UpdatesListParentOptionalParams	Optional parameters.
UpdatesOperations	Interface representing a Updates operations.

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
ImpactType	The impact type 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.
MaintenanceScope	Gets or sets maintenanceScope of the configuration 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.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
RebootOptions	Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. 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
TagOperators	Filter VMs by Any or All specified tags.
UpdateStatus	The status 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.
Visibility	Gets or sets the visibility of the configuration. The default value is 'Custom' 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

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownImpactType	The impact type
KnownMaintenanceScope	Gets or sets maintenanceScope of the configuration
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownRebootOptions	Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed.
KnownUpdateStatus	The status
KnownVersions	The available API versions.
KnownVisibility	Gets or sets the visibility of the configuration. The default value is 'Custom'

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-maintenance package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

Variable Details

RestError

Type

Feedback