Edit

Invoke-AzVMwareInitiateMaintenanceCheck

  • Preview
Module:
Az.VMware Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Initiate maintenance readiness checks

Syntax

Initiate (Default) 

Invoke-AzVMwareInitiateMaintenanceCheck
    -MaintenanceName <String>
    -PrivateCloudName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InitiateViaIdentityPrivateCloud 

Invoke-AzVMwareInitiateMaintenanceCheck
    -MaintenanceName <String>
    -PrivateCloudInputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InitiateViaIdentity 

Invoke-AzVMwareInitiateMaintenanceCheck
    -InputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Initiate maintenance readiness checks

Examples

Example 1: Initiate maintenance readiness checks for a specific maintenance

Invoke-AzVMwareInitiateMaintenanceCheck -MaintenanceName maintenance1 -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group

Name         DisplayName      ReadinessStatus StateName ReadinessLastUpdated
----         -----------      --------------- --------- --------------------
maintenance1 vcsa 7.0 upgrade NotReady        Scheduled 1/16/2025 6:21:31 AM

Initiates maintenance readiness checks for the specified maintenance within the private cloud and resource group.

Parameters

-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

-InputObject

Identity Parameter

Parameter properties

Type:IVMwareIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InitiateViaIdentity
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

Initiate
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
InitiateViaIdentityPrivateCloud
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivateCloudInputObject

Identity Parameter

Parameter properties

Type:IVMwareIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InitiateViaIdentityPrivateCloud
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

Initiate
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

Initiate
Position:Named
Mandatory:True
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

Initiate
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.

Inputs

IVMwareIdentity

Outputs

IMaintenance