Invoke-AzVMwareScheduleMaintenance
Syntax
ScheduleExpanded (Default)
Invoke-AzVMwareScheduleMaintenance
-MaintenanceName <String>
-PrivateCloudName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Message <String>]
[-ScheduleTime <DateTime>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ScheduleViaIdentityPrivateCloudExpanded
Invoke-AzVMwareScheduleMaintenance
-MaintenanceName <String>
-PrivateCloudInputObject <IVMwareIdentity>
[-Message <String>]
[-ScheduleTime <DateTime>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ScheduleViaIdentityPrivateCloud
Invoke-AzVMwareScheduleMaintenance
-MaintenanceName <String>
-PrivateCloudInputObject <IVMwareIdentity>
-Body <IMaintenanceSchedule>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Schedule
Invoke-AzVMwareScheduleMaintenance
-MaintenanceName <String>
-PrivateCloudName <String>
-ResourceGroupName <String>
-Body <IMaintenanceSchedule>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ScheduleViaIdentityExpanded
Invoke-AzVMwareScheduleMaintenance
-InputObject <IVMwareIdentity>
[-Message <String>]
[-ScheduleTime <DateTime>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ScheduleViaIdentity
Invoke-AzVMwareScheduleMaintenance
-InputObject <IVMwareIdentity>
-Body <IMaintenanceSchedule>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
Example 1: Schedule a maintenance
Invoke-AzVMwareScheduleMaintenance -MaintenanceName maintenance1 -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group
Name DisplayName StateName ScheduledStartTime ReadinessStatus ProvisioningState
---- ----------- --------- ------------------ --------------- -----------------
maintenance1 vcsa 7.0 upgrade NotScheduled 1/12/2023 4:17:55 PM NotReady Succeeded
Schedules the specified maintenance item within the private cloud and resource group.
Parameters
-Body
schedule a maintenance
Parameter properties
Parameter sets
ScheduleViaIdentityPrivateCloud
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
Schedule
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
Type: IVMwareIdentity
Default value: None Supports wildcards: False DontShow: False
ScheduleViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-MaintenanceName
Name of the maintenance
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ScheduleExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentityPrivateCloudExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentityPrivateCloud
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Schedule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Message
scheduling message
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ScheduleExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentityPrivateCloudExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
Type: IVMwareIdentity
Default value: None Supports wildcards: False DontShow: False
ScheduleViaIdentityPrivateCloudExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentityPrivateCloud
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-PrivateCloudName
Name of the private cloud
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ScheduleExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Schedule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ScheduleExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Schedule
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ScheduleTime
schedule time
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ScheduleExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentityPrivateCloudExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ScheduleViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
ScheduleExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Schedule
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
