[Cloud] az cloud register/update: Add upcoming breaking change announcement

src/azure-cli/azure/cli/command_modules/cloud/_breaking_change.py

@@ -0,0 +1,17 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# pylint: disable=line-too-long
+
+from azure.cli.core.breaking_change import AzCLIOtherChange, register_conditional_breaking_change
+
+register_conditional_breaking_change(tag='CloudRegisterOutputBreakingChange',
+                                     breaking_change=AzCLIOtherChange(cmd='cloud register',
+                                                                      message='Starting from 2.73.0, no gallery endpoint will be returned if use endpoint discovery with --endpoint-resource-manager, please manually set with --endpoint-gallery')
+                                     )
+
+register_conditional_breaking_change(tag='CloudUpdateOutputBreakingChange',
+                                     breaking_change=AzCLIOtherChange(cmd='cloud update',
+                                                                      message='Starting from 2.73.0, no gallery endpoint will be returned if use endpoint discovery with --endpoint-resource-manager, please manually set with --endpoint-gallery')
+                                     )

src/azure-cli/azure/cli/command_modules/cloud/custom.py

@@ -67,7 +67,7 @@ def _populate_from_metadata_endpoint(cloud, arm_endpoint, session=None):
         raise CLIError(error_msg_fmt.format(msg))
 
 
-def _build_cloud(cli_ctx, cloud_name, cloud_config=None, cloud_args=None):
+def _build_cloud(cli_ctx, cloud_name, cloud_config=None, is_update=False, cloud_args=None):
     from azure.cli.core.cloud import CloudEndpointNotSetException
     if cloud_config:
         # Using JSON format so convert the keys to snake case
@@ -98,6 +98,12 @@ def _build_cloud(cli_ctx, cloud_name, cloud_config=None, cloud_args=None):
     except CloudEndpointNotSetException:
         arm_endpoint = None
 
+    from azure.cli.core.breaking_change import print_conditional_breaking_change
+    if arm_endpoint and is_update:
+        print_conditional_breaking_change(cli_ctx, tag='CloudUpdateOutputBreakingChange')
+    elif arm_endpoint:
+        print_conditional_breaking_change(cli_ctx, tag='CloudRegisterOutputBreakingChange')
+
     _populate_from_metadata_endpoint(c, arm_endpoint)
     required_endpoints = {'resource_manager': '--endpoint-resource-manager',
                           'active_directory': '--endpoint-active-directory',
@@ -132,7 +138,7 @@ def register_cloud(cmd,
                    suffix_azure_datalake_store_file_system_endpoint=None,
                    suffix_azure_datalake_analytics_catalog_and_job_endpoint=None,
                    suffix_acr_login_server_endpoint=None):
-    c = _build_cloud(cmd.cli_ctx, cloud_name, cloud_config=cloud_config,
+    c = _build_cloud(cmd.cli_ctx, cloud_name, cloud_config=cloud_config, is_update=False,
                      cloud_args=locals())
     try:
         add_cloud(cmd.cli_ctx, c)
@@ -161,7 +167,7 @@ def modify_cloud(cmd,
                  suffix_acr_login_server_endpoint=None):
     if not cloud_name:
         cloud_name = cmd.cli_ctx.cloud.name
-    c = _build_cloud(cmd.cli_ctx, cloud_name, cloud_config=cloud_config,
+    c = _build_cloud(cmd.cli_ctx, cloud_name, cloud_config=cloud_config, is_update=True,
                      cloud_args=locals())
     try:
         update_cloud(cmd.cli_ctx, c)