Get-AzVMwareMaintenance

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.

Get a Maintenance

Syntax

List (Default)

Get-AzVMwareMaintenance
    -PrivateCloudName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-From <DateTime>]
    [-StateName <String>]
    [-Status <String>]
    [-To <DateTime>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityPrivateCloud

Get-AzVMwareMaintenance
    -Name <String>
    -PrivateCloudInputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzVMwareMaintenance
    -Name <String>
    -PrivateCloudName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzVMwareMaintenance
    -InputObject <IVMwareIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a Maintenance

Examples

Example 1: List maintenance under resource group

Get-AzVMwareMaintenance -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group

Name         ResourceGroupName
----         -----------------
maintenance1 group1
maintenance2 group1

Lists all maintenance items within the specified private cloud and resource group

Example 2: Get a maintenace by name in a private cloud

Get-AzVMwareMaintenance -Name maintenance1 -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group

Name         DisplayName      Component StateName ReadinessStatus ScheduledStartTime    EstimatedDurationInMinute ClusterId
----         -----------      --------- --------- --------------- ------------------    ------------------------- ---------
maintenance1 vcsa 7.0 upgrade VCSA      Scheduled NotReady        1/12/2023 11:00:11 AM                       960         1

Gets detailed information about a specific maintenance item by name within the private cloud and resource group.

Parameters

-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

-From

date from which result should be returned. ie. scheduledStartTime >= from

Parameter properties

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

Parameter sets

List

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

GetViaIdentity

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

-Name

Name of the maintenance

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	MaintenanceName

Parameter sets

GetViaIdentityPrivateCloud

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

Get

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

GetViaIdentityPrivateCloud

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

List

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

Get

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

List

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

Get

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

-StateName

Filter maintenances based on state

Parameter properties

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

Parameter sets

List

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

-Status

Filter active or inactive maintenances

Parameter properties

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

Parameter sets

List

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

List

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

Get

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

-To

date till which result should be returned. i.e. scheduledStartTime <= to

Parameter properties

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

Parameter sets

List

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