[ACR] az acr connected-registry create/update: Add new parameters for enabling and setting interval for garbage collection within a connected registry (#30956)

Author: trisavo-msft

src/azure-cli/azure/cli/command_modules/acr/_client_factory.py

@@ -82,4 +82,4 @@ def cf_acr_agentpool(cli_ctx, *_):
 
 
 def cf_acr_connected_registries(cli_ctx, *_):
-    return get_acr_service_client(cli_ctx, VERSION_2021_08_01_PREVIEW).connected_registries
+    return get_acr_service_client(cli_ctx, VERSION_2024_11_01_PREVIEW).connected_registries

src/azure-cli/azure/cli/command_modules/acr/_params.py

@@ -551,6 +551,10 @@ def load_arguments(self, _):  # pylint: disable=too-many-statements
         c.argument('sync_schedule', options_list=['--sync-schedule', '-s'], help='Optional parameter to define the sync schedule. Uses cron expression to determine the schedule. If not specified, the instance is considered always online and attempts to sync every minute.', required=False, default="* * * * *")
         c.argument('sync_message_ttl', help='Determine how long the sync messages will be kept in the cloud. Uses ISO 8601 duration format.', required=False, default="P2D")
         c.argument('notifications', options_list=['--notifications'], nargs='+', help='List of artifact pattern for which notifications need to be generated. Use the format "--notifications [PATTERN1 PATTERN2 ...]".')
+        c.argument('garbage_collection_enabled', options_list=['--gc-enabled'],
+                   help='Indicate whether garbage collection is enabled. It is enabled by default.', arg_type=get_three_state_flag(), required=False, default="true")
+        c.argument('garbage_collection_schedule', options_list=['--gc-schedule'],
+                   help='Used to determine garbage collection schedule. Uses cron expression to determine the schedule. If not specified, garbage collection is set to run once a day.', required=False, default="0 0 * * *")
 
     with self.argument_context('acr connected-registry update') as c:
         c.argument('log_level', help='Set the log level for logging on the instance. Accepted log levels are Debug, Information, Warning, Error, and None.')
@@ -565,7 +569,9 @@ def load_arguments(self, _):  # pylint: disable=too-many-statements
                    help='List of artifact pattern to be added to notifications list. Use the format "--add-notifications [PATTERN1 PATTERN2 ...]".')
         c.argument('remove_notifications', options_list=['--remove-notifications'], nargs='*',
                    help='List of artifact pattern to be removed from notifications list. Use the format "--remove-notifications [PATTERN1 PATTERN2 ...]".')
-
+        c.argument('garbage_collection_enabled', options_list=['--gc-enabled'],
+                   help='Indicate whether garbage collection is enabled. It is enabled by default.', arg_type=get_three_state_flag())
+        c.argument('garbage_collection_schedule', options_list=['--gc-schedule'], help='Used to determine garbage collection schedule. Uses cron expression to determine the schedule. If not specified, garbage collection is set to run once a day.')
     with self.argument_context('acr connected-registry permissions') as c:
         c.argument('add_repos', options_list=['--add'], nargs='*',
                    help='repository permissions to be added to the targeted connected registry and it\'s ancestors sync scope maps. Use the format "--add [REPO1 REPO2 ...]" per flag. ' + repo_valid_actions)

src/azure-cli/azure/cli/command_modules/acr/connected_registry.py

@@ -60,6 +60,8 @@ def acr_connected_registry_create(cmd,  # pylint: disable=too-many-locals, too-m
                                   log_level=None,
                                   sync_audit_logs_enabled=False,
                                   notifications=None,
+                                  garbage_collection_enabled=None,
+                                  garbage_collection_schedule=None,
                                   yes=False):
 
     if bool(sync_token_name) == bool(repositories):
@@ -71,7 +73,7 @@ def acr_connected_registry_create(cmd,  # pylint: disable=too-many-locals, too-m
     registry, resource_group_name = get_registry_by_name(cmd.cli_ctx, registry_name, resource_group_name)
 
     if not registry.data_endpoint_enabled:
-        user_confirmation("Dedicated data enpoints must be enabled to use connected-registry. Enabling might " +
+        user_confirmation("Dedicated data endpoints must be enabled to use connected-registry. Enabling might " +
                           "impact your firewall rules. Are you sure you want to enable it for '{}' registry?".format(
                               registry_name), yes)
         acr_update_custom(cmd, registry, resource_group_name, data_endpoint_enabled=True)
@@ -111,8 +113,10 @@ def acr_connected_registry_create(cmd,  # pylint: disable=too-many-locals, too-m
     notifications_set = set(notifications) \
         if notifications else set()
 
-    ConnectedRegistry, LoggingProperties, SyncProperties, ParentProperties = cmd.get_models(
-        'ConnectedRegistry', 'LoggingProperties', 'SyncProperties', 'ParentProperties')
+    ConnectedRegistry, LoggingProperties, SyncProperties, \
+        ParentProperties, GarbageCollectionProperties = cmd.get_models(
+            'ConnectedRegistry', 'LoggingProperties', 'SyncProperties',
+            'ParentProperties', 'GarbageCollectionProperties')
     connected_registry_create_parameters = ConnectedRegistry(
         provisioning_state=None,
         mode=mode,
@@ -130,6 +134,10 @@ def acr_connected_registry_create(cmd,  # pylint: disable=too-many-locals, too-m
             log_level=log_level,
             audit_log_status='Enabled' if sync_audit_logs_enabled else 'Disabled'
         ),
+        garbage_collection=GarbageCollectionProperties(
+            enabled=garbage_collection_enabled,
+            schedule=garbage_collection_schedule
+        ),
         notifications_list=list(notifications_set) if notifications_set else None
     )
 
@@ -155,7 +163,9 @@ def acr_connected_registry_update(cmd,  # pylint: disable=too-many-locals, too-m
                                   sync_message_ttl=None,
                                   sync_audit_logs_enabled=None,
                                   add_notifications=None,
-                                  remove_notifications=None):
+                                  remove_notifications=None,
+                                  garbage_collection_enabled=None,
+                                  garbage_collection_schedule=None):
     _, resource_group_name = validate_managed_registry(
         cmd, registry_name, resource_group_name)
     subscription_id = get_subscription_id(cmd.cli_ctx)
@@ -211,8 +221,10 @@ def acr_connected_registry_update(cmd,  # pylint: disable=too-many-locals, too-m
 
     notifications_list = list(notifications_set) if notifications_set != current_notifications_set else None
 
-    ConnectedRegistryUpdateParameters, SyncUpdateProperties, LoggingProperties = cmd.get_models(
-        'ConnectedRegistryUpdateParameters', 'SyncUpdateProperties', 'LoggingProperties')
+    ConnectedRegistryUpdateParameters, SyncUpdateProperties, \
+        LoggingProperties, GarbageCollectionProperties = cmd.get_models(
+            'ConnectedRegistryUpdateParameters', 'SyncUpdateProperties',
+            'LoggingProperties', 'GarbageCollectionProperties')
     connected_registry_update_parameters = ConnectedRegistryUpdateParameters(
         sync_properties=SyncUpdateProperties(
             schedule=sync_schedule,
@@ -223,6 +235,10 @@ def acr_connected_registry_update(cmd,  # pylint: disable=too-many-locals, too-m
             log_level=log_level,
             audit_log_status=sync_audit_logs_enabled
         ),
+        garbage_collection=GarbageCollectionProperties(
+            enabled=garbage_collection_enabled,
+            schedule=garbage_collection_schedule
+        ),
         client_token_ids=client_token_list,
         notifications_list=notifications_list
     )