Skip to content

Commit f03d8f6

Browse files
committed
ARM template parameters table
1 parent 1bbf092 commit f03d8f6

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

azure-local/deploy/deployment-azure-resource-manager-template.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Azure Resource Manager template deployment for Azure Local, version 23H2
33
description: Learn how to prepare and then deploy Azure Local instance, version 23H2 using the Azure Resource Manager template.
44
author: alkohli
55
ms.topic: how-to
6-
ms.date: 07/07/2025
6+
ms.date: 07/08/2025
77
ms.author: alkohli
88
ms.reviewer: alkohli
99
ms.service: azure-local
@@ -221,46 +221,46 @@ You can also check out this community sourced template to [Deploy an Azure Local
221221
222222
## ARM template parameters reference
223223
224-
The following table describes the parameters defined in the ARM template's parameters file:
224+
The following table describes the parameters that you define in the ARM template's parameters file:
225225
226226
| Parameter | Description |
227227
|--|--|
228-
| deploymentMode | Determines if the deployment process should only validate or proceed with full deployment:<br/>- Validate: Creates Azure resources for this system and validates your system's readiness to deploy.<br/>- Deploy: Performs the actual deployment after successful validation. |
229-
| keyVaultName | Name of the Azure Key Vault to be used for storing secrets.<br/><br/><br/>For naming conventions, see [Microsoft.KeyVault](/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault) in the Naming rules and restrictions for Azure resources article. |
230-
| softDeleteRetentionDays | Number of days that deleted items (such as secrets, keys, or certificates) are retained in an Azure Key Vault before they are permanently deleted. Specify a value between 7 and 90 days. You can’t change the retention period later. |
231-
| diagnosticStorageAccountName | Name of the Azure Storage Account used to store key vault audit logs. This account is a locally redundant storage (LRS) account with a lock. |
232-
| logsRetentionInDays | <br/><br/>Number of days that logs are retained. If you don't want to apply any retention policy and retain data forever, specify 0. <br/> |
228+
| deploymentMode | Determines if the deployment process should only validate or proceed with full deployment:<br/>- **Validate**: Creates Azure resources for this system and validates your system's readiness to deploy.<br/>- **Deploy**: Performs the actual deployment after successful validation. |
229+
| keyVaultName | Name of the Azure Key Vault to be used for storing secrets.<br/><br/>For naming conventions, see [Microsoft.KeyVault](/azure/azure-resource-manager/management/resource-name-rules#microsoftkeyvault) in the Naming rules and restrictions for Azure resources article. |
230+
| softDeleteRetentionDays | Number of days that deleted items (such as secrets, keys, or certificates) are retained in an Azure Key Vault before they are permanently deleted.<br/>Specify a value between 7 and 90 days. You can’t change the retention period later. |
231+
| diagnosticStorageAccountName | Name of the Azure Storage Account used to store key vault audit logs. This account is a locally redundant storage (LRS) account with a lock. <br/><br/>For more information, see [Azure Storage Account](/azure/storage/common/storage-account-create?tabs=azure-portal). For naming conventions, see [Azure Storage account names](/azure/storage/common/storage-account-overview#storage-account-name).|
232+
| logsRetentionInDays | <br/><br/>Number of days that logs are retained. <br/> If you don't want to apply any retention policy and retain data forever, specify 0. |
233233
| storageAccountType | Type of the Azure Storage Account to be used in the deployment. For example, Standard_LRS. |
234-
| clusterName | Name of Azure Local instance being deployed. This name must be different from any of the node names. |
234+
| clusterName | Name of the Azure Local instance being deployed. This name must be different from any of the node names. |
235235
| location | Deployment location, typically derived from the resource group. <br/><br/>For a list of supported Azure regions, see [Azure requirements](../concepts/system-requirements-23h2.md?tabs=azure-public#azure-requirements). |
236-
| tenantId | Azure subscription tenant ID. |
237-
| witnessType | Witness type for your Azure Local cluster. Witness type must be Cloud for a two-node cluster. It can be empty for other cluster sizes.<br/><br/>For more information on cloud witness, see [Deploy a quorum witness](/windows-server/failover-clustering/deploy-quorum-witness?tabs=domain-joined-witness%2Cfailovercluster%2Cfailovercluster1&pivots=cloud-witness).<br/> |
236+
| tenantId | Azure subscription tenant ID. <br/><br/>For more information, see [Find your Microsoft Entra tenant](/azure/azure-portal/get-subscription-tenant-id#find-your-microsoft-entra-tenant).|
237+
| witnessType | Witness type for your Azure Local cluster. </br>Witness type must be Cloud for a two-node cluster. It can be empty for other cluster sizes.<br/><br/>For more information on cloud witness, see [Deploy a quorum witness](/windows-server/failover-clustering/deploy-quorum-witness?tabs=domain-joined-witness%2Cfailovercluster%2Cfailovercluster1&pivots=cloud-witness). |
238238
| clusterWitnessStorageAccountName | Name of the storage account used for cluster witness.<br/><br/>For more information, see [Azure Storage Account](/azure/storage/common/storage-account-create?tabs=azure-portal). For naming conventions, see [Azure Storage account names](/azure/storage/common/storage-account-overview#storage-account-name). |
239-
| localAdminUserName | Username for the local administrator for all the machines in your system. The credentials are identical for all the machines in your system. |
240-
| localAdminPassword | Password for the local administrator for all the machines in your system. The credentials are identical for all the machines in your system.<br/> |
241-
| AzureStackLCMAdminUsername | Username for the LCM admin. |
242-
| AzureStackLCMAdminPasssword | Password for the LCM admin. |
243-
| hciResourceProviderObjectID | Object ID of the Azure Local Resource Provider. |
239+
| localAdminUserName | Username for the local administrator for all the machines in your system. The credentials are identical for all the machines in your system. <br/><br/> For more information, see [Review deployment prerequisites for Azure Local](../deploy/deployment-prerequisites.md).|
240+
| localAdminPassword | Password for the local administrator for all the machines in your system. The credentials are identical for all the machines in your system.<br/><br/> For more information, see [Review deployment prerequisites for Azure Local](../deploy/deployment-prerequisites.md). |
241+
| AzureStackLCMAdminUsername | Username for the LCM admin.<br/><br/> For more information, see [Review deployment prerequisites for Azure Local](../deploy/deployment-prerequisites.md).|
242+
| AzureStackLCMAdminPasssword | Password for the LCM admin. <br/><br/> For more information, see [Review deployment prerequisites for Azure Local](../deploy/deployment-prerequisites.md).|
243+
| hciResourceProviderObjectID | Object ID of the Azure Local Resource Provider. <br/><br/> For more information, see [Get the object ID for Azure Local Resource Provider](#get-the-object-id-for-azure-local-resource-provider).|
244244
| arcNodeResourceIds | Array of resource IDs of the Azure Arc-enabled servers that are part of the Azure Local cluster. |
245245
| domainFqdn | Fully-qualified domain name (FQDN) for the Active Directory Domain Services prepared for deployment. |
246246
| namingPrefix | Prefix used for all objects created for the Azure Local deployment. |
247-
| adouPath | Path of the Organizational Unit (OU) created for this deployment. The OU can't be at the top level of the domain. For example: OU=Local001,DC=contoso,DC=com |
248-
| securityLevel | Security configuration profile to be applied to the Azure Local cluster during deployment. The default is Recommended. |
247+
| adouPath | Path of the Organizational Unit (OU) created for this deployment. The OU can't be at the top level of the domain. For example: OU=Local001,DC=contoso,DC=com. |
248+
| securityLevel | Security configuration profile to be applied to the Azure Local cluster during deployment. The default is **Recommended**. |
249249
| driftControlEnforced | Drift control setting to reapply the security defaults regularly. <br/><br/>For more information, see [Security features for Azure Local](../concepts/security-features.md). |
250-
| credentialGuardEnforced | Credential Guard setting that uses virtualization-based security to isolate secrets from credential-theft attacks. |
250+
| credentialGuardEnforced | Credential Guard setting that uses virtualization-based security to isolate secrets from credential-theft attacks. <br/><br/> For more information, see [Manage security defaults for Azure Local](../manage/manage-secure-baseline.md).|
251251
| smbSigningEnforced | Setting for signing SMB traffic between this Azure Local cluster and others to help prevent relay attacks.<br/><br/>For more information, see [Overview of Server Message Block signing](/troubleshoot/windows-server/networking/overview-server-message-block-signing). |
252252
| smbClusterEncryption | SMB cluster traffic setting for encrypting traffic between servers in the cluster on your storage network.<br/><br/>For more information, see [SMB encryption](/windows-server/storage/file-server/smb-security#smb-encryption). |
253253
| bitlockerBootVolume | BitLocker encyrption setting for encrypting OS volume on each server.<br/><br/>For more information, see [Manage BitLocker encryption on Azure Local](../manage/manage-bitlocker.md). |
254254
| bitlockerDataVolumes | BitLocker encryption setting for encrypting cluster shared volumes (CSVs) created on this system during deployment.<br/> <br/>For more information, see [Manage BitLocker encryption on Azure Local](../manage/manage-bitlocker.md). |
255255
| wdacEnforced | Application Control setting to control which drivers and apps are allowed to run directly on each server.<br/><br/>For more information, see [Manage Application Control for Azure Local](../manage/manage-wdac.md). |
256-
| streamingDataClient | Specifies whether telemetry data streaming from the Azure Local cluster to Microsoft is enabled |
256+
| streamingDataClient | Specifies whether telemetry data streaming from the Azure Local cluster to Microsoft is enabled. |
257257
| euLocation | Specifies whether to send and store telemetry and diagnostic data within the European Union (EU). |
258258
| episodicDataUpload | Episodic diagnostic data setting to specify whether to collect log data and upload to Microsoft to assist with troubleshooting and support.<br/><br/>For more information, see [Crash dump collection](../concepts/observability.md#crash-dump-collection). |
259-
| configurationMode | Storage volume configuration mode.<br/> |
259+
| configurationMode | Storage volume configuration mode. For example, Express.<br/> |
260260
| subnetMask | The subnet mask for the management network used by the Azure Local deployment. |
261261
| defaultGateway | The default gateway for deploying an Azure Local cluster. |
262-
| startingIPAddress | The first IP address in a contiguous block of at least six static IP addresses on your management network's subnet, omitting addresses already used by the machines.<br/><br/>These IPs are used by Azure Local and internal infrastructure (Arc Resource Bridge) that's required for Arc VM management and AKS Hybrid. |
263-
| endingIPAddress | The last IP address in a contiguous block of at least six static IP addresses on your management network's subnet, omitting addresses already used by the machines.<br/><br/>These IPs are used by Azure Local and internal infrastructure (Arc Resource Bridge) that's required for Arc VM management and AKS Hybrid. |
262+
| startingIPAddress | The first IP address in a contiguous block of at least six static IP addresses on your management network's subnet, omitting addresses already used by the machines.<br/>These IPs are used by Azure Local and internal infrastructure (Arc Resource Bridge) that's required for Arc VM management and AKS Hybrid. |
263+
| endingIPAddress | The last IP address in a contiguous block of at least six static IP addresses on your management network's subnet, omitting addresses already used by the machines.<br/>These IPs are used by Azure Local and internal infrastructure (Arc Resource Bridge) that's required for Arc VM management and AKS Hybrid. |
264264
| dnsServers | List of DNS server IPs. |
265265
| useDhcp | Indicates whether to use Dynamic Host Configuration Protocol (DHCP) for hosts and cluster IPs. If not declared, the deployment will default to static IPs. If TRUE, gateway and DNS servers are not required. |
266266
| physicalNodesSettings | Array of physical nodes with their IP addresses. |
@@ -278,7 +278,7 @@ The following table describes the parameters defined in the ARM template's param
278278
| sbeManifestCreationDate | Creation date of the SBE manifest. |
279279
| partnerProperties | List of partner-specific properties. |
280280
| partnerCredentiallist | List of partner credentials. |
281-
| clusterPattern | Supported storage type for the Azure Local cluster: <br/>- Standard<br/>- RackAware |
281+
| clusterPattern | Supported storage type for the Azure Local cluster: <br/>- **Standard**<br/>- **RackAware** |
282282
| localAvailabilityZones | Local Availability Zone information for the Azure Local cluster. |
283283
284284
## Troubleshoot deployment issues

0 commit comments

Comments
 (0)