az vmware private-cloud maintenance
Note
This reference is part of the vmware extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az vmware private-cloud maintenance command. Learn more about extensions.
Manage Maintenance.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az vmware private-cloud maintenance initiate-check |
Initiate maintenance readiness checks. |
Extension | GA |
| az vmware private-cloud maintenance list |
List Maintenance resources by subscription ID. |
Extension | GA |
| az vmware private-cloud maintenance reschedule |
Reschedule a maintenance. |
Extension | GA |
| az vmware private-cloud maintenance schedule |
Schedule a maintenance. |
Extension | GA |
| az vmware private-cloud maintenance show |
Get a Maintenance. |
Extension | GA |
az vmware private-cloud maintenance initiate-check
Initiate maintenance readiness checks.
az vmware private-cloud maintenance initiate-check [--ids]
[--maintenance-name]
[--private-cloud-name]
[--resource-group]
[--subscription]
Examples
Maintenances_InitiateChecks
az vmware private-cloud maintenance initiate-check --resource-group group1 --private-cloud-name cloud1 --maintenance-name maintenance1
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the maintenance.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the private cloud.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az vmware private-cloud maintenance list
List Maintenance resources by subscription ID.
az vmware private-cloud maintenance list --private-cloud-name
--resource-group
[--from-date]
[--max-items]
[--next-token]
[--state-name {Canceled, Failed, InProgress, NotScheduled, Scheduled, Success}]
[--status {Active, Inactive}]
[--to-date]
Required Parameters
Name of the private cloud.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Date from which result should be returned. ie. scheduledStartTime >= from.
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Filter maintenances based on state.
| Property | Value |
|---|---|
| Accepted values: | Canceled, Failed, InProgress, NotScheduled, Scheduled, Success |
Filter active or inactive maintenances.
| Property | Value |
|---|---|
| Accepted values: | Active, Inactive |
Date till which result should be returned. i.e. scheduledStartTime <= to-date.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az vmware private-cloud maintenance reschedule
Reschedule a maintenance.
az vmware private-cloud maintenance reschedule [--ids]
[--maintenance-name]
[--message]
[--private-cloud-name]
[--reschedule-time]
[--resource-group]
[--subscription]
Examples
Maintenances_Reschedule
az vmware private-cloud maintenance reschedule --resource-group group1 --private-cloud-name cloud1 --maintenance-name maintenance1 --reschedule-time 2023-01-12T16:17:55.237Z --message "Rescheduled due to xyz"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the maintenance.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Scheduling message.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Name of the private cloud.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Reschedule time for the maintenance.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az vmware private-cloud maintenance schedule
Schedule a maintenance.
az vmware private-cloud maintenance schedule [--ids]
[--maintenance-name]
[--message]
[--private-cloud-name]
[--resource-group]
[--schedule-time]
[--subscription]
Examples
Maintenances_Schedule
az vmware private-cloud maintenance schedule --resource-group group1 --private-cloud-name cloud1 --maintenance-name maintenance1 --schedule-time 2025-09-12T16:17:55.237Z --message "scheduled due to xyz"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the maintenance.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Scheduling message.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Name of the private cloud.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Schedule time for maintenance.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az vmware private-cloud maintenance show
Get a Maintenance.
az vmware private-cloud maintenance show [--ids]
[--maintenance-name]
[--private-cloud-name]
[--resource-group]
[--subscription]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the maintenance.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the private cloud.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |