Merge pull request Azure#588 from Azure/canary

likamrat · web-flow · commit a8595413cc72 · 2025-03-06T05:47:53.000-08:00
Canary
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
diff --git a/docs/azure_jumpstart_hcibox/cloud_deployment/_index.md b/docs/azure_jumpstart_hcibox/cloud_deployment/_index.md
@@ -32,8 +32,6 @@ Various options are available to connect to _HCIBox-Client_ VM, depending on the
 
 By design, HCIBox does not open port 3389 on the network security group. Therefore, you must create an NSG rule to allow inbound 3389.
 
-  > **Note:** If you deployed with Azure Developer CLI then this step is automatically done for you as part of the automation.
-
 - Open the _HCIBox-NSG_ resource in Azure portal and click "Add" to add a new rule.
 
   ![Screenshot showing HCIBox-Client NSG with blocked RDP](./rdp_nsg_blocked.png)
diff --git a/docs/azure_jumpstart_hcibox/deployment_az/_index.md b/docs/azure_jumpstart_hcibox/deployment_az/_index.md
@@ -113,7 +113,7 @@ Azure Bicep is used to deploy HCIBox into your Azure subscription. To deploy, yo
 
 > **Note:** Please avoid using the $ symbol in the `windowsAdminPassword`. Using this symbol can cause the LogonScript to fail.
 
-- Edit the [main.parameters.json](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_hcibox/bicep/main.bicepparam) template parameters file and supply values for your environment.
+- Edit the [main.bicepparam](https://github.com/microsoft/azure_arc/blob/main/azure_jumpstart_hcibox/bicep/main.bicepparam) template parameters file and supply values for your environment.
 
 | Name | Type | Description | Default |
 | --- | --- | --- | --- |
@@ -136,14 +136,7 @@ Azure Bicep is used to deploy HCIBox into your Azure subscription. To deploy, yo
 | `windowsAdminPassword` | securestring | Password for Windows account. Password must have 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character. The value must be between 12 and 123 characters long |  |
 | `windowsAdminUsername` | string | Username for Windows account |  |
 
-      > **Disclaimer:** The `governResourceTags` parameter is optional and set to true by default. If not specified, the following tag values will be added:
-
-  ```
-  CostControl: 'Ignore'
-  SecurityControl: 'Ignore'
-  ```
-
-     > Both the `CostControl` and `SecurityControl` tags are applicable to **ONLY Microsoft-internal Azure lab tenants** and designed for managing automated governance processes related to cost optimization and security controls. As mentioned, it will get added to the deployment **only** if the `governResourceTags` parameter was set to true. If you are deploying HCIBox from a Microsoft-internal tenant and Azure subscription, this parameter is required to be set to 'true'. Failure to do so will cause your deployment to have issues and most likely to fail.
+  > **Disclaimer:** The *governResourceTags* parameter is optional and set to true by default. If not specified, both *CostControl: 'Ignore'* and *SecurityControl: 'Ignore'* tag values will be added. These tags are applicable to **ONLY Microsoft-internal Azure lab tenants** and designed for managing automated governance processes related to cost optimization and security controls. As mentioned, it will get added to the deployment **only** if the *governResourceTags* parameter was set to true. If you are deploying HCIBox from a Microsoft-internal tenant and Azure subscription, this parameter is required to be set to 'true'. Failure to do so will cause your deployment to have issues and most likely to fail.
 
 Example parameter-file:
 
@@ -153,7 +146,7 @@ Example parameter-file:
 
   ```shell
   az group create --name "<resource-group-name>"  --location "<location>"
-  az deployment group create -g "<resource-group-name>" -f "main.bicep" -p "main.parameters.json"
+  az deployment group create -g "<resource-group-name>" -f "main.bicep" -p "main.bicepparam"
   ```
 
   ![Screenshot showing bicep deploying](./bicep_deploying.png)
diff --git a/docs/azure_jumpstart_hcibox/faq/_index.md b/docs/azure_jumpstart_hcibox/faq/_index.md
@@ -14,7 +14,7 @@ Jumpstart HCIBox is a turnkey solution that provides a complete sandbox for expl
 
 ## What is required to deploy HCIBox?
 
-HCIBox deployment requires an Azure service principal with Owner role-based access control (RBAC) on an Azure subscription and resource group. You can deploy HCIBox using Azure Bicep or the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview). A service principal is required to run the automation scripts that deploy and configure HCIBox features. You can view how the service principal is used by exploring the HCIBox code on our [public GitHub repository](https://github.com/microsoft/azure_arc).
+HCIBox deployment requires an Azure service principal with Owner role-based access control (RBAC) on an Azure subscription and resource group and can be deployed using Azure Bicep. A service principal is required to run the automation scripts that deploy and configure HCIBox features. You can view how the service principal is used by exploring the HCIBox code on our [public GitHub repository](https://github.com/microsoft/azure_arc).
 
 ## What Azure regions can HCIBox be deployed to?
 
diff --git a/docs/azure_jumpstart_hcibox/getting_started/_index.md b/docs/azure_jumpstart_hcibox/getting_started/_index.md
@@ -5,6 +5,7 @@ isGettingStarted: false
 weight: 2
 ---
 # Evaluating Azure Local with HCIBox
+
 ## Getting started
 
 HCIBox is a turnkey solution that provides a complete sandbox for exploring [Azure Local](https://learn.microsoft.com/azure-stack/hci/whats-new) capabilities and hybrid cloud integration in a virtualized environment. HCIBox is designed to be completely self-contained within a single Azure subscription and resource group, which will make it easy for a user to get hands-on with Azure Local and [Azure Arc](https://learn.microsoft.com/azure/azure-arc/overview) technology without the need for physical hardware.
diff --git a/docs/azure_jumpstart_hcibox/troubleshooting/_index.md b/docs/azure_jumpstart_hcibox/troubleshooting/_index.md
@@ -9,7 +9,7 @@ weight: 9
 
 Occasionally deployments of HCIBox may fail at various stages. Common reasons for failed deployments include:
 
-- Invalid service principal id, service principal secret, or service principal Azure tenant ID provided in _main.parameters.json_ file. This can cause failures when running automation that requires logging into Azure, such as the scripts that register the Azure Local instance, deploy AKS Hybrid, or configure Arc Resource Bridge.
+- Invalid service principal id, service principal secret, or service principal Azure tenant ID provided in the _main.bicepparam_ Bicep template file. This can cause failures when running automation that requires logging into Azure, such as the scripts that register the Azure Local instance, deploy AKS Hybrid, or configure Arc Resource Bridge.
 - Not enough vCPU quota available in your target Azure region - check vCPU quota and ensure you have at least 32 available. See the [prerequisites](../getting_started/#prerequisites) section for more details.
 - Corruption when downloading HCIBox VHD files can interrupt deployments. HCIBox should automatically halt if this occurs. Re-running the PowerShell script at _C:\HCIBox\HCIBoxLogonScript.ps1_ can often repair this issue.
 
