Merge pull request #590 from alexmahonic/feature-arc-1014

[arc-multicloud] Update help message
Azure · Oct 18, 2024 · 4be35c6 · 4be35c6
2 parents 64a022b + 01b7608
commit 4be35c6
Show file tree

Hide file tree

Showing 33 changed files with 148 additions and 42 deletions.
diff --git a/Commands/arc-multicloud/_generate-aws-template.md b/Commands/arc-multicloud/_generate-aws-template.md
@@ -2,6 +2,8 @@
 
 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
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvZ2VuZXJhdGVhd3N0ZW1wbGF0ZQ==/2024-12-01.xml) **Stable**

diff --git a/Commands/arc-multicloud/public-cloud-connector/_create.md b/Commands/arc-multicloud/public-cloud-connector/_create.md
@@ -2,6 +2,8 @@
 
 Create a PublicCloudConnector
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvcHVibGljY2xvdWRjb25uZWN0b3JzL3t9/2024-12-01.xml) **Stable**
@@ -12,5 +14,10 @@ Create a PublicCloudConnector
 
 - PublicCloudConnectors_CreateOrUpdate
     ```bash
-        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
+        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
+    ```
+
+- PublicCloudConnectors_CreateOrUpdate
+    ```bash
+        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
     ```
diff --git a/Commands/arc-multicloud/public-cloud-connector/_delete.md b/Commands/arc-multicloud/public-cloud-connector/_delete.md
@@ -2,6 +2,8 @@
 
 Delete a PublicCloudConnector
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvcHVibGljY2xvdWRjb25uZWN0b3JzL3t9/2024-12-01.xml) **Stable**
@@ -12,5 +14,5 @@ Delete a PublicCloudConnector
 
 - PublicCloudConnectors_Delete
     ```bash
-        arc-multicloud public-cloud-connector delete --resource-group rgpublicCloud --name myConnector
+        arc-multicloud public-cloud-connector delete --resource-group multiCloudRG --name awsConnector
     ```
diff --git a/Commands/arc-multicloud/public-cloud-connector/_list.md b/Commands/arc-multicloud/public-cloud-connector/_list.md
@@ -2,6 +2,8 @@
 
 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
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvcHVibGljY2xvdWRjb25uZWN0b3Jz/2024-12-01.xml) **Stable**
@@ -13,5 +15,5 @@ List PublicCloudConnector resources within the current subscription, and limit t
 
 - PublicCloudConnectors_ListBySubscription
     ```bash
-        arc-multicloud public-cloud-connector list --resource-group rgpublicCloud
+        arc-multicloud public-cloud-connector list --resource-group multiCloudRG
     ```
diff --git a/Commands/arc-multicloud/public-cloud-connector/_show.md b/Commands/arc-multicloud/public-cloud-connector/_show.md
@@ -2,6 +2,8 @@
 
 Get a PublicCloudConnector
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvcHVibGljY2xvdWRjb25uZWN0b3JzL3t9/2024-12-01.xml) **Stable**
@@ -12,5 +14,5 @@ Get a PublicCloudConnector
 
 - publicCloudConnectors_Get
     ```bash
-        arc-multicloud public-cloud-connector show --resource-group rgpublicCloud --name myConnector
+        arc-multicloud public-cloud-connector show --resource-group multiCloudRG --name awsConnector
     ```
diff --git a/Commands/arc-multicloud/public-cloud-connector/_test-permission.md b/Commands/arc-multicloud/public-cloud-connector/_test-permission.md
@@ -2,6 +2,8 @@
 
 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
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvcHVibGljY2xvdWRjb25uZWN0b3JzL3t9L3Rlc3RwZXJtaXNzaW9ucw==/2024-12-01.xml) **Stable**
@@ -12,5 +14,5 @@ A long-running resource action.
 
 - PublicCloudConnectors_TestPermissions
     ```bash
-        arc-multicloud public-cloud-connector test-permission --resource-group rgpublicCloud --name myConnector
+        arc-multicloud public-cloud-connector test-permission --resource-group multiCloudRG --name awsConnector
     ```
diff --git a/Commands/arc-multicloud/public-cloud-connector/_update.md b/Commands/arc-multicloud/public-cloud-connector/_update.md
@@ -2,6 +2,8 @@
 
 Update a PublicCloudConnector
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvcHVibGljY2xvdWRjb25uZWN0b3JzL3t9/2024-12-01.xml) **Stable**
@@ -12,5 +14,5 @@ Update a PublicCloudConnector
 
 - publicCloudConnectors_Update
     ```bash
-        arc-multicloud public-cloud-connector update --resource-group rgpublicCloud --name myConnector --aws-cloud-profile "{excluded-accounts:[123456789123,123456789124]}" --tags "{}"
+        arc-multicloud public-cloud-connector update --resource-group multiCloudRG --name awsConnector --aws-cloud-profile "{excluded-accounts:[123456789123,123456789124]}" --tags "{}"
     ```
diff --git a/Commands/arc-multicloud/public-cloud-connector/readme.md b/Commands/arc-multicloud/public-cloud-connector/readme.md
@@ -1,6 +1,8 @@
 # [Group] _arc-multicloud public-cloud-connector_
 
-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
 
 ## Commands
 

diff --git a/Commands/arc-multicloud/readme.md b/Commands/arc-multicloud/readme.md
@@ -1,17 +1,19 @@
 # [Group] _arc-multicloud_
 
-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
 
 ## Subgroups
 
 - [public-cloud-connector](/Commands/arc-multicloud/public-cloud-connector/readme.md)
-: commands for multicloudConnector
+: Commands for multicloudConnector
 
 - [solution-configuration](/Commands/arc-multicloud/solution-configuration/readme.md)
-: commands for solution-configuration
+: Commands for solution-configuration
 
 - [solution-type](/Commands/arc-multicloud/solution-type/readme.md)
-: commands for solution-type
+: Commands for solution-type
 
 ## Commands
 

diff --git a/Commands/arc-multicloud/solution-configuration/_create.md b/Commands/arc-multicloud/solution-configuration/_create.md
@@ -2,6 +2,8 @@
 
 Create a SolutionConfiguration
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb25jb25maWd1cmF0aW9ucy97fQ==/2024-12-01.xml) **Stable**

diff --git a/Commands/arc-multicloud/solution-configuration/_delete.md b/Commands/arc-multicloud/solution-configuration/_delete.md
@@ -2,6 +2,8 @@
 
 Delete a SolutionConfiguration
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb25jb25maWd1cmF0aW9ucy97fQ==/2024-12-01.xml) **Stable**

diff --git a/Commands/arc-multicloud/solution-configuration/_list.md b/Commands/arc-multicloud/solution-configuration/_list.md
@@ -2,6 +2,8 @@
 
 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
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb25jb25maWd1cmF0aW9ucw==/2024-12-01.xml) **Stable**

diff --git a/Commands/arc-multicloud/solution-configuration/_show.md b/Commands/arc-multicloud/solution-configuration/_show.md
@@ -2,6 +2,8 @@
 
 Get a SolutionConfiguration
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb25jb25maWd1cmF0aW9ucy97fQ==/2024-12-01.xml) **Stable**

diff --git a/Commands/arc-multicloud/solution-configuration/_sync-now.md b/Commands/arc-multicloud/solution-configuration/_sync-now.md
@@ -2,6 +2,8 @@
 
 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
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb25jb25maWd1cmF0aW9ucy97fS9zeW5jbm93/2024-12-01.xml) **Stable**

diff --git a/Commands/arc-multicloud/solution-configuration/_update.md b/Commands/arc-multicloud/solution-configuration/_update.md
@@ -2,6 +2,8 @@
 
 Update a SolutionConfiguration
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb25jb25maWd1cmF0aW9ucy97fQ==/2024-12-01.xml) **Stable**

diff --git a/Commands/arc-multicloud/solution-configuration/readme.md b/Commands/arc-multicloud/solution-configuration/readme.md
@@ -1,6 +1,8 @@
 # [Group] _arc-multicloud solution-configuration_
 
-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
 
 ## Commands
 

diff --git a/Commands/arc-multicloud/solution-type/_list.md b/Commands/arc-multicloud/solution-type/_list.md
@@ -2,6 +2,8 @@
 
 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
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb250eXBlcw==/2024-12-01.xml) **Stable**
@@ -13,5 +15,5 @@ List SolutionTypeResource within the current subscription, and limit to the spec
 
 - SolutionTypes_ListBySubscription
     ```bash
-        arc-multicloud solution-type list --resource-group rgpublicCloud --subscription 2c60e476-6048-5ff0-9635-373175a378d9
+        arc-multicloud solution-type list --resource-group multiCloudRG --subscription 2c60e476-6048-5ff0-9635-373175a378d9
     ```
diff --git a/Commands/arc-multicloud/solution-type/_show.md b/Commands/arc-multicloud/solution-type/_show.md
@@ -2,6 +2,8 @@
 
 Get a SolutionTypeResource
 
+For additional details, please visit the https://learn.microsoft.com/en-us/cli/azure/arc-multicloud?view=azure-cli-latest
+
 ## Versions
 
 ### [2024-12-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5oeWJyaWRjb25uZWN0aXZpdHkvc29sdXRpb250eXBlcy97fQ==/2024-12-01.xml) **Stable**
@@ -12,5 +14,5 @@ Get a SolutionTypeResource
 
 - SolutionTypes_Get
     ```bash
-        arc-multicloud solution-type show --resource-group rgpublicCloud --name "Microsoft.AssetManagement"
+        arc-multicloud solution-type show --resource-group multiCloudRG --name "Microsoft.AssetManagement"
     ```
diff --git a/Commands/arc-multicloud/solution-type/readme.md b/Commands/arc-multicloud/solution-type/readme.md
@@ -1,6 +1,8 @@
 # [Group] _arc-multicloud solution-type_
 
-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
 
 ## Commands
 

diff --git a/Commands/readme.md b/Commands/readme.md
@@ -27,7 +27,7 @@
 : Manage Azure Arc Machines.
 
 - [arc-multicloud](/Commands/arc-multicloud/readme.md)
-: commands for arc-multicloud
+: Commands for arc-multicloud
 
 - [astronomer](/Commands/astronomer/readme.md)
 : Manage Azure Astronomer resources.