changed param description for kb-numbers-to-include (Azure#8043)

OrosBogdanAndrei · Bogdan Oros · kairu-ms · web-flow · commit fcad2eb970f8 · 2024-10-09T15:55:03.000+08:00
* changed param description for kb-numbers-to-include

* updated version
cleaned up comments

* addressed github actions requirements

* Update HISTORY.rst

* Update setup.py

* Update src/maintenance/setup.py

Co-authored-by: kai ru &lt;69238381+kairu-ms@users.noreply.github.com&gt;

---------

Co-authored-by: Bogdan Oros &lt;boros@microsoft.com&gt;
Co-authored-by: kai ru &lt;69238381+kairu-ms@users.noreply.github.com&gt;
diff --git a/src/maintenance/HISTORY.rst b/src/maintenance/HISTORY.rst
@@ -2,6 +2,10 @@
 
 Release History
 ===============
+1.7.0b1
+++++++
+* Changed incorrect parameter name
+
 1.6.0
 ++++++
 * Added support for approving scheduled events
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/applyupdate/_create_or_update.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/applyupdate/_create_or_update.py
@@ -16,15 +16,12 @@
 )
 class CreateOrUpdate(AAZCommand):
     """Create maintenance updates to resource
-
-    :example: ApplyUpdates_CreateOrUpdate
-        az maintenance applyupdate create-or-update --apply-update-name "20230921151000" --provider-name "Microsoft.Maintenance" --resource-group "Maintenance-RG-1598" --resource-name "configuration1" --resource-type "maintenanceConfigurations" --status "Cancel"
     """
 
     _aaz_info = {
-        "version": "2023-09-01-preview",
+        "version": "2023-10-01-preview",
         "resources": [
-            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/{}/{}/{}/providers/microsoft.maintenance/applyupdates/{}", "2023-09-01-preview"],
+            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/{}/{}/{}/providers/microsoft.maintenance/applyupdates/{}", "2023-10-01-preview"],
         ]
     }
 
@@ -170,7 +167,7 @@ def url_parameters(self):
         def query_parameters(self):
             parameters = {
                 **self.serialize_query_param(
-                    "api-version", "2023-09-01-preview",
+                    "api-version", "2023-10-01-preview",
                     required=True,
                 ),
             }
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/applyupdate/_update.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/applyupdate/_update.py
@@ -16,15 +16,12 @@
 )
 class Update(AAZCommand):
     """Update maintenance updates to resource
-
-    :example: ApplyUpdates_Update
-        az maintenance applyupdate update --apply-update-name "20230921151000" --provider-name "Microsoft.Maintenance" --resource-group "Maintenance-RG-1598" --resource-name "configuration1" --resource-type "maintenanceConfigurations" --status "Cancel"
     """
 
     _aaz_info = {
-        "version": "2023-09-01-preview",
+        "version": "2023-10-01-preview",
         "resources": [
-            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/{}/{}/{}/providers/microsoft.maintenance/applyupdates/{}", "2023-09-01-preview"],
+            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/{}/{}/{}/providers/microsoft.maintenance/applyupdates/{}", "2023-10-01-preview"],
         ]
     }
 
@@ -188,7 +185,7 @@ def url_parameters(self):
         def query_parameters(self):
             parameters = {
                 **self.serialize_query_param(
-                    "api-version", "2023-09-01-preview",
+                    "api-version", "2023-10-01-preview",
                     required=True,
                 ),
             }
@@ -283,7 +280,7 @@ def url_parameters(self):
         def query_parameters(self):
             parameters = {
                 **self.serialize_query_param(
-                    "api-version", "2023-09-01-preview",
+                    "api-version", "2023-10-01-preview",
                     required=True,
                 ),
             }
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_create_or_update_resource_group.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_create_or_update_resource_group.py
@@ -19,7 +19,7 @@ class CreateOrUpdateResourceGroup(AAZCommand):
     """Create configuration for resource.
 
     :example: ConfigurationAssignments_CreateOrUpdateResourceGroup
-        az maintenance assignment create-or-update-resource-group  --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1"  --name assignmentname  --filter-locations eastus2euap centraluseuap  --filter-os-types windows linux  --filter-tags "{{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}}"  --filter-tags-operator All  --resource-group examplerg1
+        az maintenance assignment create-or-update-resource-group  --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1"  --name assignmentname  --filter-locations eastus2euap centraluseuap  --filter-os-types windows linux  --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}"  --filter-tags-operator All  --resource-group examplerg1
     """
 
     _aaz_info = {
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_create_or_update_subscription.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_create_or_update_subscription.py
@@ -19,7 +19,7 @@ class CreateOrUpdateSubscription(AAZCommand):
     """Create configuration for resource.
 
     :example: ConfigurationAssignments_CreateOrUpdateSubscription
-        az maintenance assignment create-or-update-subscription  --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1"  --name assignmentname  --filter-locations eastus2euap centraluseuap  --filter-os-types windows linux  --filter-tags "{{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}}"  --filter-tags-operator All
+        az maintenance assignment create-or-update-subscription  --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1"  --name assignmentname  --filter-locations eastus2euap centraluseuap  --filter-os-types windows linux  --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}"  --filter-tags-operator All
     """
 
     _aaz_info = {
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_update_resource_group.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_update_resource_group.py
@@ -19,7 +19,7 @@ class UpdateResourceGroup(AAZCommand):
     """Update configuration for resource.
 
     :example: ConfigurationAssignments_UpdateResourceGroup
-        az maintenance assignment create-or-update-resource-group --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1" --name assignmentname --filter-locations eastus2euap centraluseuap --filter-os-types windows linux --filter-tags "{{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}}" --filter-tags-operator All --resource-group examplerg1
+        az maintenance assignment create-or-update-resource-group --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1" --name assignmentname --filter-locations eastus2euap centraluseuap --filter-os-types windows linux --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}" --filter-tags-operator All --resource-group examplerg1
     """
 
     _aaz_info = {
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_update_subscription.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/assignment/_update_subscription.py
@@ -19,7 +19,7 @@ class UpdateSubscription(AAZCommand):
     """Update configuration for resource.
 
     :example: ConfigurationAssignments_UpdateSubscription
-        az maintenance assignment update-subscription  --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1"  --name assignmentname  --filter-locations eastus2euap centraluseuap  --filter-os-types windows linux  --filter-tags "{{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}}"  --filter-tags-operator All
+        az maintenance assignment update-subscription  --maintenance-configuration-id "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/exmaplerg2/providers/Microsoft. Maintenance/maintenanceConfigurations/config1"  --name assignmentname  --filter-locations eastus2euap centraluseuap  --filter-os-types windows linux  --filter-tags "{tagKey1:[tagKey1Val1,tagKey1Val2],tagKey2:[tagKey2Val1,tagKey2Val2]}"  --filter-tags-operator All
     """
 
     _aaz_info = {
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/configuration/_create.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/configuration/_create.py
@@ -135,7 +135,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
         )
         install_patches_windows_parameters.kb_numbers_to_include_list = AAZListArg(
             options=["kb-numbers-to-include-list"],
-            singular_options=["kb-numbers-to-include"],
+            singular_options=["kb-numbers-to-exclude"],
             help="Windows KBID to be included for patching.",
         )
 
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/scheduledevent/__cmd_group.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/scheduledevent/__cmd_group.py
@@ -16,7 +16,7 @@
     is_preview=True,
 )
 class __CMDGroup(AAZCommandGroup):
-    """Scheduled event actions
+    """ScheduledEvents action
     """
     pass
 
diff --git a/src/maintenance/azext_maintenance/aaz/latest/maintenance/scheduledevent/_acknowledge.py b/src/maintenance/azext_maintenance/aaz/latest/maintenance/scheduledevent/_acknowledge.py
@@ -16,16 +16,19 @@
     is_preview=True,
 )
 class Acknowledge(AAZCommand):
-    """Post Scheduled Event Acknowledgement
+    """Acknowledge Scheduled Event
 
-    :example: Acknowledge scheduled event of a VM
-        az --resource-group {resourceGroup} --resource-name {VMname} --scheduled-event-id {GuidEventId} --subscription {subscriptionId}
+    :example: Acknowledge scheduled event of a VirtualMachine
+        az maintenance scheduledevent acknowledge --resource-group {resourceGroupName} --resource-type "virtualMachines" --resource-name {VMname} --scheduled-event-id {scheduledEventId} --subscription {subscriptionId}
+        az maintenance scheduledevent acknowledge --ids /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.compute/virtualMachines/{resourceName}/providers/microsoft.maintenance/scheduledevents/{scheduledEventId}
 
-    :example: Acknowledge scheduled event of a VMSS
-        az --resource-group {resourceGroup} --resource-name {VMSSname} --scheduled-event-id {GuidEventId} --subscription {subscriptionId}
+    :example: Acknowledge scheduled event of a VirtualMachineScaleSets
+        az maintenance scheduledevent acknowledge --resource-group {resourceGroup} --resource-type "virtualMachineScaleSets" --resource-name {VMSSname} --scheduled-event-id {scheduledEventId} --subscription {subscriptionId}
+        az maintenance scheduledevent acknowledge --ids /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.compute/virtualMachineScaleSets/{resourceName}/providers/microsoft.maintenance/scheduledevents/{scheduledEventId}
 
     :example: Acknowledge scheduled event of a AvailabilitySet
-        az --resource-group {resourceGroup} --resource-name {AVSetname} --scheduled-event-id {GuidEventId} --subscription {subscriptionId}
+        az maintenance scheduledevent acknowledge--resource-group {resourceGroupName} --resource-type "availabilitySets"--resource-name {AVSetname} --scheduled-event-id {scheduledEventId} --subscription {subscriptionId}
+        az maintenance scheduledevent acknowledge --ids /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.compute/AvalabilitySets/{resourceName}/providers/microsoft.maintenance/scheduledevents/{scheduledEventId}
     """
 
     _aaz_info = {
diff --git a/src/maintenance/azext_maintenance/azext_metadata.json b/src/maintenance/azext_maintenance/azext_metadata.json
@@ -1,4 +1,4 @@
 {
-    "azext.isExperimental": true,
-    "azext.minCliCoreVersion": "2.56.0"
+    "azext.isPreview": true,
+    "azext.minCliCoreVersion": "2.61.0"
 }
diff --git a/src/maintenance/azext_maintenance/tests/latest/recordings/test_maintenance_Scenario.yaml b/src/maintenance/azext_maintenance/tests/latest/recordings/test_maintenance_Scenario.yaml
diff --git a/src/maintenance/azext_maintenance/tests/latest/test_maintenance_scenario.py b/src/maintenance/azext_maintenance/tests/latest/test_maintenance_scenario.py
diff --git a/src/maintenance/setup.py b/src/maintenance/setup.py

Original file line number	Diff line number	Diff line change
`@@ -16,15 +16,12 @@`
`16`	`16`	`)`
`17`	`17`	`class CreateOrUpdate(AAZCommand):`
`18`	`18`	`"""Create maintenance updates to resource`
`19`		`-`
`20`		`- :example: ApplyUpdates_CreateOrUpdate`
`21`		`- az maintenance applyupdate create-or-update --apply-update-name "20230921151000" --provider-name "Microsoft.Maintenance" --resource-group "Maintenance-RG-1598" --resource-name "configuration1" --resource-type "maintenanceConfigurations" --status "Cancel"`
`22`	`19`	`"""`
`23`	`20`
`24`	`21`	`_aaz_info = {`
`25`		`- "version": "2023-09-01-preview",`
	`22`	`+ "version": "2023-10-01-preview",`
`26`	`23`	`"resources": [`
`27`		`- ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/{}/{}/{}/providers/microsoft.maintenance/applyupdates/{}", "2023-09-01-preview"],`
	`24`	`+ ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/{}/{}/{}/providers/microsoft.maintenance/applyupdates/{}", "2023-10-01-preview"],`
`28`	`25`	`]`
`29`	`26`	`}`
`30`	`27`
`@@ -170,7 +167,7 @@ def url_parameters(self):`
`170`	`167`	`def query_parameters(self):`
`171`	`168`	`parameters = {`
`172`	`169`	`**self.serialize_query_param(`
`173`		`- "api-version", "2023-09-01-preview",`
	`170`	`+ "api-version", "2023-10-01-preview",`
`174`	`171`	`required=True,`
`175`	`172`	`),`
`176`	`173`	`}`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ def _build_arguments_schema(cls, args, *kwargs):`
`135`	`135`	`)`
`136`	`136`	`install_patches_windows_parameters.kb_numbers_to_include_list = AAZListArg(`
`137`	`137`	`options=["kb-numbers-to-include-list"],`
`138`		`- singular_options=["kb-numbers-to-include"],`
	`138`	`+ singular_options=["kb-numbers-to-exclude"],`
`139`	`139`	`help="Windows KBID to be included for patching.",`
`140`	`140`	`)`
`141`	`141`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`is_preview=True,`
`17`	`17`	`)`
`18`	`18`	`class __CMDGroup(AAZCommandGroup):`
`19`		`- """Scheduled event actions`
	`19`	`+ """ScheduledEvents action`
`20`	`20`	`"""`
`21`	`21`	`pass`
`22`	`22`