From 8d00b8017590bbe18d1f15fb8ccdfb0a0c3f1192 Mon Sep 17 00:00:00 2001 From: hongma-ms <31637121+alexmahonic@users.noreply.github.com> Date: Thu, 17 Oct 2024 23:20:24 -0700 Subject: [PATCH] Update cli (#8154) Co-authored-by: Hong Ma --- .../azext_multicloud_connector/_utils.py | 1 + .../aaz/latest/arc_multicloud/__cmd_group.py | 4 +++- .../aaz/latest/arc_multicloud/_generate_aws_template.py | 2 ++ .../arc_multicloud/public_cloud_connector/__cmd_group.py | 4 +++- .../arc_multicloud/public_cloud_connector/_create.py | 7 ++++++- .../arc_multicloud/public_cloud_connector/_delete.py | 4 +++- .../latest/arc_multicloud/public_cloud_connector/_list.py | 4 +++- .../latest/arc_multicloud/public_cloud_connector/_show.py | 4 +++- .../public_cloud_connector/_test_permission.py | 4 +++- .../arc_multicloud/public_cloud_connector/_update.py | 4 +++- .../arc_multicloud/solution_configuration/__cmd_group.py | 4 +++- .../arc_multicloud/solution_configuration/_create.py | 2 ++ .../arc_multicloud/solution_configuration/_delete.py | 2 ++ .../latest/arc_multicloud/solution_configuration/_list.py | 2 ++ .../latest/arc_multicloud/solution_configuration/_show.py | 2 ++ .../arc_multicloud/solution_configuration/_sync_now.py | 2 ++ .../arc_multicloud/solution_configuration/_update.py | 2 ++ .../aaz/latest/arc_multicloud/solution_type/__cmd_group.py | 4 +++- .../aaz/latest/arc_multicloud/solution_type/_list.py | 4 +++- .../aaz/latest/arc_multicloud/solution_type/_show.py | 4 +++- .../azext_multicloud_connector/custom.py | 3 ++- 21 files changed, 56 insertions(+), 13 deletions(-) diff --git a/src/multicloud-connector/azext_multicloud_connector/_utils.py b/src/multicloud-connector/azext_multicloud_connector/_utils.py index f3a88277657..ff669fc695f 100644 --- a/src/multicloud-connector/azext_multicloud_connector/_utils.py +++ b/src/multicloud-connector/azext_multicloud_connector/_utils.py @@ -22,6 +22,7 @@ required_rps = [rp_name_hybrid_connectivity, rp_name_aws_connector, rp_name_hybrid_compute] +# We call this method before running each individual command. See usage in src/multicloud-connector/azext_multicloud_connector/custom.py def register_providers_if_needed(cmd): logger.debug("Start to check if required RPs are registered ...") for rp_name in required_rps: diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/__cmd_group.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/__cmd_group.py index 93ce3b76748..67c5f608b0f 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/__cmd_group.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/__cmd_group.py @@ -15,7 +15,9 @@ "arc-multicloud", ) class __CMDGroup(AAZCommandGroup): - """commands for arc-multicloud + """Commands for arc-multicloud + + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest """ pass diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/_generate_aws_template.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/_generate_aws_template.py index 4cd48562913..2fc84253ff5 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/_generate_aws_template.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/_generate_aws_template.py @@ -17,6 +17,8 @@ class GenerateAwsTemplate(AAZCommand): """Retrieve AWS Cloud Formation template + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: GenerateAwsTemplate_Post az arc-multicloud generate-aws-template --connector-id /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{} --output-directory example_folder/templates """ diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/__cmd_group.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/__cmd_group.py index 39fd7096b74..20190dee534 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/__cmd_group.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/__cmd_group.py @@ -15,7 +15,9 @@ "arc-multicloud public-cloud-connector", ) class __CMDGroup(AAZCommandGroup): - """commands for multicloudConnector + """Commands for multicloudConnector + + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest """ pass diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_create.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_create.py index 8863562626f..9943c0d9c96 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_create.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_create.py @@ -17,8 +17,13 @@ class Create(AAZCommand): """Create a PublicCloudConnector + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + + :example: PublicCloudConnectors_CreateOrUpdate + az arc-multicloud public-cloud-connector create --resource-group multiCloudRG --name awsConnector --aws-cloud-profile "{account-id:123456789123,excluded-accounts:[123456789124,123456789125],is-organizational-account:True}" --host-type AWS --tags "{a:b}" --location eastus + :example: PublicCloudConnectors_CreateOrUpdate - az arc-multicloud public-cloud-connector create --resource-group rgpublicCloud --name myConnector--aws-cloud-profile "{account-id:123456789123,excluded-accounts:[123456789124,123456789125],is-organizational-account:True}" --host-type AWS --tags "{a:b}" --location eastus + az arc-multicloud public-cloud-connector create --resource-group multiCloudRG --name awsConnector --aws-cloud-profile account-id=123456789123 is-organizational-account=false --host-type AWS --tags a=b --location eastus """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_delete.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_delete.py index cc1327cf616..0221289541a 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_delete.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_delete.py @@ -18,8 +18,10 @@ class Delete(AAZCommand): """Delete a PublicCloudConnector + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: PublicCloudConnectors_Delete - az arc-multicloud public-cloud-connector delete --resource-group rgpublicCloud --name myConnector + az arc-multicloud public-cloud-connector delete --resource-group multiCloudRG --name awsConnector """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_list.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_list.py index beeaf278364..ee99f8fb18e 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_list.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_list.py @@ -17,8 +17,10 @@ class List(AAZCommand): """List PublicCloudConnector resources within the current subscription, and limit to the specified resource group if one is provided. + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: PublicCloudConnectors_ListBySubscription - az arc-multicloud public-cloud-connector list --resource-group rgpublicCloud + az arc-multicloud public-cloud-connector list --resource-group multiCloudRG """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_show.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_show.py index ff51e89d4f5..ac7908fd599 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_show.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_show.py @@ -17,8 +17,10 @@ class Show(AAZCommand): """Get a PublicCloudConnector + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: publicCloudConnectors_Get - az arc-multicloud public-cloud-connector show --resource-group rgpublicCloud --name myConnector + az arc-multicloud public-cloud-connector show --resource-group multiCloudRG --name awsConnector """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_test_permission.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_test_permission.py index eb611b6076d..20202d6290b 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_test_permission.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_test_permission.py @@ -17,8 +17,10 @@ class TestPermission(AAZCommand): """A long-running resource action. + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: PublicCloudConnectors_TestPermissions - az arc-multicloud public-cloud-connector test-permission --resource-group rgpublicCloud --name myConnector + az arc-multicloud public-cloud-connector test-permission --resource-group multiCloudRG --name awsConnector """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_update.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_update.py index 474a80c53e8..35db7647f85 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_update.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/public_cloud_connector/_update.py @@ -17,8 +17,10 @@ class Update(AAZCommand): """Update a PublicCloudConnector + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: publicCloudConnectors_Update - az arc-multicloud public-cloud-connector update --resource-group rgpublicCloud --name myConnector --aws-cloud-profile "{excluded-accounts:[123456789123,123456789124]}" --tags "{}" + az arc-multicloud public-cloud-connector update --resource-group multiCloudRG --name awsConnector --aws-cloud-profile "{excluded-accounts:[123456789123,123456789124]}" --tags "{}" """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/__cmd_group.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/__cmd_group.py index 45b2824c54c..1a0971f5684 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/__cmd_group.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/__cmd_group.py @@ -15,7 +15,9 @@ "arc-multicloud solution-configuration", ) class __CMDGroup(AAZCommandGroup): - """commands for solution-configuration + """Commands for solution-configuration + + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest """ pass diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_create.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_create.py index 796adcb1806..81ac841fabb 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_create.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_create.py @@ -17,6 +17,8 @@ class Create(AAZCommand): """Create a SolutionConfiguration + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionConfigurations_CreateOrUpdate az arc-multicloud solution-configuration create --connector-id /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{} --name mySolutionConfig --solution-type "Microsoft.AssetManagement" --solution-settings periodicSync="true" cloudProviderServiceTypes="ec2,s3" awsGlobalReadOnly="true" cloudProviderRegions="us-east-1,us-east-2" periodicSyncTime="1" diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_delete.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_delete.py index 97a27f1c747..1aa41cb45dc 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_delete.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_delete.py @@ -18,6 +18,8 @@ class Delete(AAZCommand): """Delete a SolutionConfiguration + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionConfigurations_Delete az arc-multicloud solution-configuration delete --connector-id /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{} --name mySolutionConfig """ diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_list.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_list.py index 9c99ef1c260..22854e78463 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_list.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_list.py @@ -17,6 +17,8 @@ class List(AAZCommand): """List SolutionConfiguration resources by parent public cloud connector + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionConfigurations_List az arc-multicloud solution-configuration list --connector-id /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{} """ diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_show.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_show.py index e4981511420..796e26a7c7f 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_show.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_show.py @@ -17,6 +17,8 @@ class Show(AAZCommand): """Get a SolutionConfiguration + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionConfigurations_Get az arc-multicloud solution-configuration show --connector-id /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{} --name mySolutionConfig """ diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_sync_now.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_sync_now.py index d3d60b518d2..8eab5a59c55 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_sync_now.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_sync_now.py @@ -17,6 +17,8 @@ class SyncNow(AAZCommand): """Trigger immediate sync with source cloud + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionConfigurations_SyncNow az arc-multicloud solution-configuration sync-now --connector-id /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{} --name mySolutionConfig """ diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_update.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_update.py index 614b8c36e31..2237d9f1f31 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_update.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_configuration/_update.py @@ -17,6 +17,8 @@ class Update(AAZCommand): """Update a SolutionConfiguration + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionConfigurations_Update az arc-multicloud solution-configuration update --connector-id /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{} --name mySolutionConfig --solution-type "Microsoft.AssetManagement" --solution-settings periodicSync="true" cloudProviderServiceTypes="ec2,s3" awsGlobalReadOnly="true" cloudProviderRegions="us-east-1,us-east-2" periodicSyncTime="1" """ diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/__cmd_group.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/__cmd_group.py index e0d86a82dbb..1656c503ff8 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/__cmd_group.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/__cmd_group.py @@ -15,7 +15,9 @@ "arc-multicloud solution-type", ) class __CMDGroup(AAZCommandGroup): - """commands for solution-type + """Commands for solution-type + + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest """ pass diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_list.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_list.py index 23dd8cc5ea4..091d9cc8fff 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_list.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_list.py @@ -17,8 +17,10 @@ class List(AAZCommand): """List SolutionTypeResource within the current subscription, and limit to the specified resource group if one is provided. + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionTypes_ListBySubscription - az arc-multicloud solution-type list --resource-group rgpublicCloud --subscription 2c60e476-6048-5ff0-9635-373175a378d9 + az arc-multicloud solution-type list --resource-group multiCloudRG --subscription 2c60e476-6048-5ff0-9635-373175a378d9 """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_show.py b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_show.py index 5c606677498..321569cb931 100644 --- a/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_show.py +++ b/src/multicloud-connector/azext_multicloud_connector/aaz/latest/arc_multicloud/solution_type/_show.py @@ -17,8 +17,10 @@ class Show(AAZCommand): """Get a SolutionTypeResource + For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest + :example: SolutionTypes_Get - az arc-multicloud solution-type show --resource-group rgpublicCloud --name "Microsoft.AssetManagement" + az arc-multicloud solution-type show --resource-group multiCloudRG --name "Microsoft.AssetManagement" """ _aaz_info = { diff --git a/src/multicloud-connector/azext_multicloud_connector/custom.py b/src/multicloud-connector/azext_multicloud_connector/custom.py index 6dcdeb943e5..b06a8816e7b 100644 --- a/src/multicloud-connector/azext_multicloud_connector/custom.py +++ b/src/multicloud-connector/azext_multicloud_connector/custom.py @@ -41,6 +41,7 @@ logger = get_logger(__name__) +# Wrapper - Customization for GenerateAwsTemplate, add new argument and write the output to json file on disk def customized_generate_aws_template(cmd, connector_id, output_directory=None): class OutputAwsTemplateToFile(_GenAwsTemplate): @classmethod @@ -115,7 +116,7 @@ def _output(self, *args, **kwargs): }) -# Register required RPs before execute each command +# Inheritance - Register required RPs before execute each command class CustomizedPublicCloudConnectorCreate(_PublicCloudConnectorCreate): def pre_operations(self): register_providers_if_needed(cmd=self.ctx)