{KeyVault} Track 2 mgmt-plane adoption (#14150)

scripts/sdk_process/patch_models.py

@@ -35,6 +35,11 @@
 from msrest.exceptions import HttpOperationError
 """
 
+track2_header = copyright_header + b"""import msrest.serialization
+from typing import Dict, List, Optional, Union
+from msrest.exceptions import HttpOperationError
+"""
+
 paging_header = copyright_header + b"""from msrest.paging import Paged
 """
 
@@ -59,26 +64,27 @@ def parse_input(input_parameter):
     return package_name, module_name
 
 
-def solve_mro(models):
+def solve_mro(models, track2=False):
     for models_module in models:
         models_path = models_module.__path__[0]
         _LOGGER.info("Working on %s", models_path)
-        if Path(models_path, "models_py3.py").exists():
+
+        if not track2 and Path(models_path, "models_py3.py").exists():
             _LOGGER.info("Skipping since already patched")
             return
 
         # Build the new files in a temp folder
         with tempfile.TemporaryDirectory() as temp_folder:
             final_models_path = Path(temp_folder, "models")
             final_models_path.mkdir()
-            solve_one_model(models_module, final_models_path)
+            solve_one_model(models_module, final_models_path, track2=track2)
 
             # Switch the files
             shutil.rmtree(models_path)
             shutil.move(final_models_path, models_path)
 
 
-def solve_one_model(models_module, output_folder):
+def solve_one_model(models_module, output_folder, track2=False):
     """Will build the compacted models in the output_folder"""
 
     models_classes = [
@@ -110,8 +116,8 @@ def solve_one_model(models_module, output_folder):
     else:
         enum_file_module_name = None
 
-    write_model_file(Path(output_folder, "models_py3.py"), models_classes)
-    write_model_file(Path(output_folder, "models.py"), py2_models_classes)
+    write_model_file(Path(output_folder, "models_py3.py"), models_classes, track2=track2)
+    write_model_file(Path(output_folder, "models.py"), py2_models_classes, track2=track2)
     write_paging_file(Path(output_folder, "paged_models.py"), paged_models_classes)
     write_init(
         Path(output_folder, "__init__.py"),
@@ -122,9 +128,12 @@ def solve_one_model(models_module, output_folder):
     )
 
 
-def write_model_file(output_file_path, classes_to_write):
+def write_model_file(output_file_path, classes_to_write, track2=False):
     with open(output_file_path, "bw") as write_fd:
-        write_fd.write(header)
+        if track2:
+            write_fd.write(track2_header)
+        else:
+            write_fd.write(header)
 
         for model in classes_to_write:
             _, model_file_path, _ = model
@@ -191,7 +200,7 @@ def find_models_to_change(module_name):
         return [
             importlib.import_module('.' + label + '.models', main_module.__name__)
             for (_, label, ispkg) in pkgutil.iter_modules(main_module.__path__)
-            if ispkg
+            if ispkg and label != 'aio'
         ]
 
 
@@ -220,7 +229,15 @@ def find_autorest_generated_folder(module_prefix="azure.mgmt"):
 if __name__ == "__main__":
     logging.basicConfig(level=logging.INFO)
 
+    track2_packages = [
+        'azure.mgmt.keyvault'
+    ]
     prefix = sys.argv[1] if len(sys.argv) >= 2 else "azure.mgmt"
     for autorest_package in find_autorest_generated_folder(prefix):
         models = find_models_to_change(autorest_package)
-        solve_mro(models)
+        track2 = False
+        for track2_pkg in track2_packages:
+            if autorest_package.startswith(track2_pkg):
+                track2 = True
+                break
+        solve_mro(models, track2=track2)

src/azure-cli-core/azure/cli/core/commands/arm.py

@@ -636,6 +636,10 @@ def get_provisioning_state(instance):
             properties = getattr(instance, 'properties', None)
             if properties:
                 provisioning_state = getattr(properties, 'provisioning_state', None)
+                # some SDK, like keyvault, has 'provisioningState' under 'properties.additional_properties'
+                if not provisioning_state:
+                    additional_properties = getattr(properties, 'additional_properties', {})
+                    provisioning_state = additional_properties.get('provisioningState')
         return provisioning_state
 
     def handler(args):

src/azure-cli-core/azure/cli/core/profiles/__init__.py

@@ -4,7 +4,8 @@
 # --------------------------------------------------------------------------------------------
 
 #  pylint: disable=unused-import
-from azure.cli.core.profiles._shared import AZURE_API_PROFILES, ResourceType, CustomResourceType, PROFILE_TYPE
+from azure.cli.core.profiles._shared import AZURE_API_PROFILES, ResourceType, CustomResourceType, PROFILE_TYPE,\
+    SDKProfile
 
 
 def get_api_version(cli_ctx, resource_type, as_sdk_profile=False):

src/azure-cli/azure/cli/command_modules/keyvault/_command_type.py

@@ -98,6 +98,7 @@ def keyvault_command_handler(command_args):
                 command_args[client_arg_name] = client
             if 'cmd' not in op_args:
                 command_args.pop('cmd')
+
             try:
                 result = op(**command_args)
                 # apply results transform if specified

src/azure-cli/azure/cli/command_modules/keyvault/_help.py

@@ -178,6 +178,15 @@
 short-summary: Manage vault network ACLs.
 """
 
+helps['keyvault network-rule wait'] = """
+type: command
+short-summary: Place the CLI in a waiting state until a condition of the vault is met.
+examples:
+  - name: Pause CLI until the network ACLs are updated.
+    text: |
+        az keyvault network-rule wait --name MyVault --updated
+"""
+
 helps['keyvault private-endpoint-connection'] = """
 type: group
 short-summary: Manage vault private endpoint connections.
@@ -388,3 +397,12 @@
         az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup
     crafted: true
 """
+
+helps['keyvault wait'] = """
+type: command
+short-summary: Place the CLI in a waiting state until a condition of the vault is met.
+examples:
+  - name: Pause CLI until the vault is created.
+    text: |
+        az keyvault wait --name MyVault --created
+"""

src/azure-cli/azure/cli/command_modules/keyvault/_validators.py

@@ -242,13 +242,14 @@ def validate_deleted_vault_name(cmd, ns):
     if not vault:
         raise CLIError('No deleted vault was found with name ' + ns.vault_name)
 
-    setattr(ns, 'resource_group_name', getattr(ns, 'resource_group_name', None) or id_comps['resource_group'])
-
-    # resource_group_name must match the resource group of the deleted vault
-    if id_comps['resource_group'] != ns.resource_group_name:
-        raise CLIError("The specified resource group does not match that of the deleted vault %s. The vault "
-                       "must be recovered to the original resource group %s."
-                       % (vault_name, id_comps['resource_group']))
+    if 'purge' not in cmd.name:
+        setattr(ns, 'resource_group_name', getattr(ns, 'resource_group_name', None) or id_comps['resource_group'])
+
+        # resource_group_name must match the resource group of the deleted vault
+        if id_comps['resource_group'] != ns.resource_group_name:
+            raise CLIError("The specified resource group does not match that of the deleted vault %s. The vault "
+                           "must be recovered to the original resource group %s."
+                           % (vault_name, id_comps['resource_group']))
 
 
 def validate_x509_certificate_chain(ns):

src/azure-cli/azure/cli/command_modules/keyvault/commands.py

@@ -24,6 +24,7 @@
 def load_command_table(self, _):
     mgmt_api_version = str(get_api_version(self.cli_ctx, ResourceType.MGMT_KEYVAULT))
     mgmt_api_version = mgmt_api_version.replace('-', '_')
+
     data_api_version = str(get_api_version(self.cli_ctx, ResourceType.DATA_KEYVAULT))
     data_api_version = data_api_version.replace('.', '_')
     data_api_version = data_api_version.replace('-', '_')
@@ -61,9 +62,9 @@ def load_command_table(self, _):
 
     # Management Plane Commands
     with self.command_group('keyvault', kv_vaults_sdk, client_factory=keyvault_client_vaults_factory) as g:
-        g.custom_command('create', 'create_keyvault',
+        g.custom_command('create', 'create_keyvault', supports_no_wait=True,
                          doc_string_source='azure.mgmt.keyvault.v' + mgmt_api_version + '.models#VaultProperties')
-        g.custom_command('recover', 'recover_keyvault')
+        g.custom_command('recover', 'recover_keyvault', supports_no_wait=True)
         g.custom_command('list', 'list_keyvault')
         g.show_command('show', 'get')
         g.command('delete', 'delete', deprecate_info=g.deprecate(
@@ -73,22 +74,25 @@ def load_command_table(self, _):
                                    'the soft deleted state. Please see the following documentation for additional '
                                    'guidance.\n'
                                    'https://docs.microsoft.com/en-us/azure/key-vault/general/soft-delete-overview'))
-        g.command('purge', 'purge_deleted')
-        g.custom_command('set-policy', 'set_policy')
-        g.custom_command('delete-policy', 'delete_policy')
+        g.command('purge', 'begin_purge_deleted', supports_no_wait=True)
+        g.custom_command('set-policy', 'set_policy', supports_no_wait=True)
+        g.custom_command('delete-policy', 'delete_policy', supports_no_wait=True)
         g.command('list-deleted', 'list_deleted')
         g.generic_update_command(
             'update', setter_name='update_keyvault_setter', setter_type=kv_vaults_custom,
             custom_func_name='update_keyvault',
-            doc_string_source='azure.mgmt.keyvault.v' + mgmt_api_version + '.models#VaultProperties')
+            doc_string_source='azure.mgmt.keyvault.v' + mgmt_api_version + '.models#VaultProperties',
+            supports_no_wait=True)
+        g.wait_command('wait')
 
     with self.command_group('keyvault network-rule',
                             kv_vaults_sdk,
                             min_api='2018-02-14',
                             client_factory=keyvault_client_vaults_factory) as g:
-        g.custom_command('add', 'add_network_rule')
-        g.custom_command('remove', 'remove_network_rule')
+        g.custom_command('add', 'add_network_rule', supports_no_wait=True)
+        g.custom_command('remove', 'remove_network_rule', supports_no_wait=True)
         g.custom_command('list', 'list_network_rules')
+        g.wait_command('wait')
 
     with self.command_group('keyvault private-endpoint-connection',
                             kv_private_endpoint_connections_sdk,
@@ -99,7 +103,7 @@ def load_command_table(self, _):
                          validator=validate_private_endpoint_connection_id)
         g.custom_command('reject', 'reject_private_endpoint_connection', supports_no_wait=True,
                          validator=validate_private_endpoint_connection_id)
-        g.command('delete', 'delete', validator=validate_private_endpoint_connection_id)
+        g.command('delete', 'begin_delete', validator=validate_private_endpoint_connection_id, supports_no_wait=True)
         g.show_command('show', 'get', validator=validate_private_endpoint_connection_id)
         g.wait_command('wait', validator=validate_private_endpoint_connection_id)