From 6ffaed5bfe7a6e70d0777871386c29413ced05e2 Mon Sep 17 00:00:00 2001 From: Dany Contreras <78437433+danycontre@users.noreply.github.com> Date: Fri, 19 Jan 2024 10:56:52 -0600 Subject: [PATCH 1/2] updates --- .../autoGenerated/deploy-baseline.bicep.md | 1421 ----------------- .../deploy-baseline.bicep.md.old | 1421 ----------------- .../deploy-custom-image.bicep.md | 536 ------- 3 files changed, 3378 deletions(-) delete mode 100644 workload/docs/autoGenerated/deploy-baseline.bicep.md delete mode 100644 workload/docs/autoGenerated/deploy-baseline.bicep.md.old delete mode 100644 workload/docs/autoGenerated/deploy-custom-image.bicep.md diff --git a/workload/docs/autoGenerated/deploy-baseline.bicep.md b/workload/docs/autoGenerated/deploy-baseline.bicep.md deleted file mode 100644 index 2c71291c5..000000000 --- a/workload/docs/autoGenerated/deploy-baseline.bicep.md +++ /dev/null @@ -1,1421 +0,0 @@ -# AVD Accelerator - Baseline Deployment - -AVD Accelerator - Deployment Baseline - -## Parameters - -Parameter name | Required | Description --------------- | -------- | ----------- -deploymentPrefix | No | The name of the resource group to deploy. (Default: AVD1) -deploymentEnvironment | No | The name of the resource group to deploy. (Default: Dev) -diskEncryptionKeyExpirationInDays | No | This value is used to set the expiration date on the disk encryption key. (Default: 60) -avdSessionHostLocation | No | Location where to deploy compute services. (Default: eastus2) -avdManagementPlaneLocation | No | Location where to deploy AVD management plane. (Default: eastus2) -avdWorkloadSubsId | No | AVD workload subscription ID, multiple subscriptions scenario. (Default: "") -avdEnterpriseAppObjectId | No | Azure Virtual Desktop Enterprise Application object ID. (Default: "") -avdVmLocalUserName | Yes | AVD session host local username. -avdVmLocalUserPassword | Yes | AVD session host local password. -avdIdentityServiceProvider | No | Required, The service providing domain services for Azure Virtual Desktop. (Default: ADDS) -createIntuneEnrollment | No | Required, Eronll session hosts on Intune. (Default: false) -securityPrincipalId | No | Optional, Identity ID to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") -securityPrincipalName | No | Optional, Identity name to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") -identityDomainName | No | FQDN of on-premises AD domain, used for FSLogix storage configuration and NTFS setup. (Default: "") -identityDomainGuid | No | AD domain GUID. (Default: "") -avdDomainJoinUserName | No | AVD session host domain join user principal name. (Default: none) -avdDomainJoinUserPassword | No | AVD session host domain join password. (Default: none) -avdOuPath | No | OU path to join AVd VMs. (Default: "") -avdHostPoolType | No | AVD host pool type. (Default: Pooled) -hostPoolPreferredAppGroupType | No | Optional. The type of preferred application group type, default to Desktop Application Group. -avdPersonalAssignType | No | AVD host pool type. (Default: Automatic) -avdHostPoolLoadBalancerType | No | AVD host pool load balacing type. (Default: BreadthFirst) -hostPoolMaxSessions | No | AVD host pool maximum number of user sessions per session host. (Default: 8) -avdStartVmOnConnect | No | AVD host pool start VM on Connect. (Default: true) -avdHostPoolRdpProperties | No | AVD host pool Custom RDP properties. (Default: audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2) -avdDeployScalingPlan | No | AVD deploy scaling plan. (Default: true) -createAvdVnet | No | Create new virtual network. (Default: true) -existingVnetAvdSubnetResourceId | No | Existing virtual network subnet for AVD. (Default: "") -existingVnetPrivateEndpointSubnetResourceId | No | Existing virtual network subnet for private endpoints. (Default: "") -existingHubVnetResourceId | No | Existing hub virtual network for perring. (Default: "") -avdVnetworkAddressPrefixes | No | AVD virtual network address prefixes. (Default: 10.10.0.0/23) -vNetworkAvdSubnetAddressPrefix | No | AVD virtual network subnet address prefix. (Default: 10.10.0.0/23) -vNetworkPrivateEndpointSubnetAddressPrefix | No | private endpoints virtual network subnet address prefix. (Default: 10.10.1.0/27) -customDnsIps | No | custom DNS servers IPs. (Default: "") -deployPrivateEndpointKeyvaultStorage | No | Deploy private endpoints for key vault and storage. (Default: true) -createPrivateDnsZones | No | Create new Azure private DNS zones for private endpoints. (Default: true) -avdVnetPrivateDnsZoneFilesId | No | Use existing Azure private DNS zone for Azure files privatelink.file.core.windows.net or privatelink.file.core.usgovcloudapi.net. (Default: "") -avdVnetPrivateDnsZoneKeyvaultId | No | Use existing Azure private DNS zone for key vault privatelink.vaultcore.azure.net or privatelink.vaultcore.usgovcloudapi.net. (Default: "") -vNetworkGatewayOnHub | No | Does the hub contains a virtual network gateway. (Default: false) -createAvdFslogixDeployment | No | Deploy Fslogix setup. (Default: true) -createMsixDeployment | No | Deploy MSIX App Attach setup. (Default: false) -fslogixFileShareQuotaSize | No | Fslogix file share size. (Default: 1) -msixFileShareQuotaSize | No | MSIX file share size. (Default: 1) -avdDeploySessionHosts | No | Deploy new session hosts. (Default: true) -deployGpuPolicies | No | Deploy VM GPU extension policies. (Default: false) -avdDeployMonitoring | No | Deploy AVD monitoring resources and setings. (Default: false) -deployAlaWorkspace | No | Deploy AVD Azure log analytics workspace. (Default: true) -deployCustomPolicyMonitoring | No | Create and assign custom Azure Policy for diagnostic settings for the AVD Log Analytics workspace. (Default: false) -avdAlaWorkspaceDataRetention | No | AVD Azure log analytics workspace data retention. (Default: 90) -alaExistingWorkspaceResourceId | No | Existing Azure log analytics workspace resource ID to connect to. (Default: "") -avdDeploySessionHostsCount | No | Quantity of session hosts to deploy. (Default: 1) -avdSessionHostCountIndex | No | The session host number to begin with for the deployment. This is important when adding virtual machines to ensure the names do not conflict. (Default: 0) -availabilityZonesCompute | No | When true VMs are distributed across availability zones, when set to false, VMs will be members of a new availability set. (Default: true) -zoneRedundantStorage | No | When true, Zone Redundant Storage (ZRS) is used, when set to false, Locally Redundant Storage (LRS) is used. (Default: false) -avsetFaultDomainCount | No | Sets the number of fault domains for the availability set. (Default: 2) -avsetUpdateDomainCount | No | Sets the number of update domains for the availability set. (Default: 5) -fslogixStoragePerformance | No | Storage account SKU for FSLogix storage. Recommended tier is Premium (Default: Premium) -msixStoragePerformance | No | Storage account SKU for MSIX storage. Recommended tier is Premium. (Default: Premium) -diskZeroTrust | No | Enables a zero trust configuration on the session host disks. (Default: false) -avdSessionHostsSize | No | Session host VM size. (Default: Standard_D4ads_v5) -avdSessionHostDiskType | No | OS disk type for session host. (Default: Premium_LRS) -enableAcceleratedNetworking | No | Enables accelerated Networking on the session hosts. If using a Azure Compute Gallery Image, the Image Definition must have been configured with the \'isAcceleratedNetworkSupported\' property set to \'true\'. -securityType | No | Specifies the securityType of the virtual machine. "ConfidentialVM" and "TrustedLaunch" require a Gen2 Image. (Default: TrustedLaunch) -secureBootEnabled | No | Specifies whether secure boot should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) -vTpmEnabled | No | Specifies whether vTPM should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) -avdOsImage | No | AVD OS image SKU. (Default: win11-22h2) -managementVmOsImage | No | Management VM image SKU (Default: winServer_2022_Datacenter_smalldisk_g2) -useSharedImage | No | Set to deploy image from Azure Compute Gallery. (Default: false) -avdImageTemplateDefinitionId | No | Source custom image ID. (Default: "") -storageOuPath | No | OU name for Azure Storage Account. It is recommended to create a new AD Organizational Unit (OU) in AD and disable password expiration policy on computer accounts or service logon accounts accordingly. (Default: "") -avdUseCustomNaming | No | AVD resources custom naming. (Default: false) -avdServiceObjectsRgCustomName | No | AVD service resources resource group custom name. (Default: rg-avd-app1-dev-use2-service-objects) -avdNetworkObjectsRgCustomName | No | AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-network) -avdComputeObjectsRgCustomName | No | AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-pool-compute) -avdStorageObjectsRgCustomName | No | AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-storage) -avdMonitoringRgCustomName | No | AVD monitoring resource group custom name. (Default: rg-avd-dev-use2-monitoring) -avdVnetworkCustomName | No | AVD virtual network custom name. (Default: vnet-app1-dev-use2-001) -avdAlaWorkspaceCustomName | No | AVD Azure log analytics workspace custom name. (Default: log-avd-app1-dev-use2) -avdVnetworkSubnetCustomName | No | AVD virtual network subnet custom name. (Default: snet-avd-app1-dev-use2-001) -privateEndpointVnetworkSubnetCustomName | No | private endpoints virtual network subnet custom name. (Default: snet-pe-app1-dev-use2-001) -avdNetworksecurityGroupCustomName | No | AVD network security group custom name. (Default: nsg-avd-app1-dev-use2-001) -privateEndpointNetworksecurityGroupCustomName | No | Private endpoint network security group custom name. (Default: nsg-pe-app1-dev-use2-001) -avdRouteTableCustomName | No | AVD route table custom name. (Default: route-avd-app1-dev-use2-001) -privateEndpointRouteTableCustomName | No | Private endpoint route table custom name. (Default: route-avd-app1-dev-use2-001) -avdApplicationSecurityGroupCustomName | No | AVD application security custom name. (Default: asg-app1-dev-use2-001) -avdWorkSpaceCustomName | No | AVD workspace custom name. (Default: vdws-app1-dev-use2-001) -avdWorkSpaceCustomFriendlyName | No | AVD workspace custom friendly (Display) name. (Default: App1 - Dev - East US 2 - 001) -avdHostPoolCustomName | No | AVD host pool custom name. (Default: vdpool-app1-dev-use2-001) -avdHostPoolCustomFriendlyName | No | AVD host pool custom friendly (Display) name. (Default: App1 - East US - Dev - 001) -avdScalingPlanCustomName | No | AVD scaling plan custom name. (Default: vdscaling-app1-dev-use2-001) -avdApplicationGroupCustomName | No | AVD desktop application group custom name. (Default: vdag-desktop-app1-dev-use2-001) -avdApplicationGroupCustomFriendlyName | No | AVD desktop application group custom friendly (Display) name. (Default: Desktops - App1 - East US - Dev - 001) -avdSessionHostCustomNamePrefix | No | AVD session host prefix custom name. (Default: vmapp1duse2) -avsetCustomNamePrefix | No | AVD availability set custom name. (Default: avail) -storageAccountPrefixCustomName | No | AVD FSLogix and MSIX app attach storage account prefix custom name. (Default: st) -fslogixFileShareCustomName | No | FSLogix file share name. (Default: fslogix-pc-app1-dev-001) -msixFileShareCustomName | No | MSIX file share name. (Default: msix-app1-dev-001) -avdWrklKvPrefixCustomName | No | AVD keyvault prefix custom name (with Zero Trust to store credentials to domain join and local admin). (Default: kv-sec) -ztDiskEncryptionSetCustomNamePrefix | No | AVD disk encryption set custom name. (Default: des-zt) -ztManagedIdentityCustomName | No | AVD managed identity for zero trust to encrypt managed disks using a customer managed key. (Default: id-zt) -ztKvPrefixCustomName | No | AVD key vault custom name for zero trust and store store disk encryption key (Default: kv-key) -createResourceTags | No | Apply tags on resources and resource groups. (Default: false) -workloadNameTag | No | The name of workload for tagging purposes. (Default: Contoso-Workload) -workloadTypeTag | No | Reference to the size of the VM for your workloads (Default: Light) -dataClassificationTag | No | Sensitivity of data hosted (Default: Non-business) -departmentTag | No | Department that owns the deployment, (Dafult: Contoso-AVD) -workloadCriticalityTag | No | Criticality of the workload. (Default: Low) -workloadCriticalityCustomValueTag | No | Tag value for custom criticality value. (Default: Contoso-Critical) -applicationNameTag | No | Details about the application. -workloadSlaTag | No | Service level agreement level of the worload. (Contoso-SLA) -opsTeamTag | No | Team accountable for day-to-day operations. (workload-admins@Contoso.com) -ownerTag | No | Organizational owner of the AVD deployment. (Default: workload-owner@Contoso.com) -costCenterTag | No | Cost center of owner team. (Default: Contoso-CC) -time | No | Do not modify, used to set unique value for resource deployment. -enableTelemetry | No | Enable usage and telemetry feedback to Microsoft. -enableKvPurgeProtection | No | Enable purge protection for the keyvaults. (Default: true) - -### deploymentPrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The name of the resource group to deploy. (Default: AVD1) - -- Default value: `AVD1` - -### deploymentEnvironment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The name of the resource group to deploy. (Default: Dev) - -- Default value: `Dev` - -- Allowed values: `Dev`, `Test`, `Prod` - -### diskEncryptionKeyExpirationInDays - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -This value is used to set the expiration date on the disk encryption key. (Default: 60) - -- Default value: `60` - -### avdSessionHostLocation - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Location where to deploy compute services. (Default: eastus2) - -- Default value: `eastus2` - -### avdManagementPlaneLocation - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Location where to deploy AVD management plane. (Default: eastus2) - -- Default value: `eastus2` - -### avdWorkloadSubsId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD workload subscription ID, multiple subscriptions scenario. (Default: "") - -### avdEnterpriseAppObjectId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Azure Virtual Desktop Enterprise Application object ID. (Default: "") - -### avdVmLocalUserName - -![Parameter Setting](https://img.shields.io/badge/parameter-required-orange?style=flat-square) - -AVD session host local username. - -### avdVmLocalUserPassword - -![Parameter Setting](https://img.shields.io/badge/parameter-required-orange?style=flat-square) - -AVD session host local password. - -### avdIdentityServiceProvider - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Required, The service providing domain services for Azure Virtual Desktop. (Default: ADDS) - -- Default value: `ADDS` - -- Allowed values: `ADDS`, `EntraDS`, `EntraID` - -### createIntuneEnrollment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Required, Eronll session hosts on Intune. (Default: false) - -- Default value: `False` - -### securityPrincipalId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Optional, Identity ID to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") - -### securityPrincipalName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Optional, Identity name to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") - -### identityDomainName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -FQDN of on-premises AD domain, used for FSLogix storage configuration and NTFS setup. (Default: "") - -- Default value: `none` - -### identityDomainGuid - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AD domain GUID. (Default: "") - -### avdDomainJoinUserName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD session host domain join user principal name. (Default: none) - -- Default value: `none` - -### avdDomainJoinUserPassword - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD session host domain join password. (Default: none) - -- Default value: `none` - -### avdOuPath - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -OU path to join AVd VMs. (Default: "") - -### avdHostPoolType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool type. (Default: Pooled) - -- Default value: `Pooled` - -- Allowed values: `Personal`, `Pooled` - -### hostPoolPreferredAppGroupType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Optional. The type of preferred application group type, default to Desktop Application Group. - -- Default value: `Desktop` - -- Allowed values: `Desktop`, `RemoteApp` - -### avdPersonalAssignType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool type. (Default: Automatic) - -- Default value: `Automatic` - -- Allowed values: `Automatic`, `Direct` - -### avdHostPoolLoadBalancerType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool load balacing type. (Default: BreadthFirst) - -- Default value: `BreadthFirst` - -- Allowed values: `BreadthFirst`, `DepthFirst` - -### hostPoolMaxSessions - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool maximum number of user sessions per session host. (Default: 8) - -- Default value: `8` - -### avdStartVmOnConnect - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool start VM on Connect. (Default: true) - -- Default value: `True` - -### avdHostPoolRdpProperties - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool Custom RDP properties. (Default: audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2) - -- Default value: `audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2` - -### avdDeployScalingPlan - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD deploy scaling plan. (Default: true) - -- Default value: `True` - -### createAvdVnet - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Create new virtual network. (Default: true) - -- Default value: `True` - -### existingVnetAvdSubnetResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing virtual network subnet for AVD. (Default: "") - -### existingVnetPrivateEndpointSubnetResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing virtual network subnet for private endpoints. (Default: "") - -### existingHubVnetResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing hub virtual network for perring. (Default: "") - -### avdVnetworkAddressPrefixes - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network address prefixes. (Default: 10.10.0.0/23) - -- Default value: `10.10.0.0/23` - -### vNetworkAvdSubnetAddressPrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network subnet address prefix. (Default: 10.10.0.0/23) - -- Default value: `10.10.0.0/24` - -### vNetworkPrivateEndpointSubnetAddressPrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -private endpoints virtual network subnet address prefix. (Default: 10.10.1.0/27) - -- Default value: `10.10.1.0/27` - -### customDnsIps - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -custom DNS servers IPs. (Default: "") - -### deployPrivateEndpointKeyvaultStorage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy private endpoints for key vault and storage. (Default: true) - -- Default value: `True` - -### createPrivateDnsZones - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Create new Azure private DNS zones for private endpoints. (Default: true) - -- Default value: `True` - -### avdVnetPrivateDnsZoneFilesId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Use existing Azure private DNS zone for Azure files privatelink.file.core.windows.net or privatelink.file.core.usgovcloudapi.net. (Default: "") - -### avdVnetPrivateDnsZoneKeyvaultId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Use existing Azure private DNS zone for key vault privatelink.vaultcore.azure.net or privatelink.vaultcore.usgovcloudapi.net. (Default: "") - -### vNetworkGatewayOnHub - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Does the hub contains a virtual network gateway. (Default: false) - -- Default value: `False` - -### createAvdFslogixDeployment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy Fslogix setup. (Default: true) - -- Default value: `True` - -### createMsixDeployment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy MSIX App Attach setup. (Default: false) - -- Default value: `False` - -### fslogixFileShareQuotaSize - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Fslogix file share size. (Default: 1) - -- Default value: `1` - -### msixFileShareQuotaSize - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -MSIX file share size. (Default: 1) - -- Default value: `1` - -### avdDeploySessionHosts - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy new session hosts. (Default: true) - -- Default value: `True` - -### deployGpuPolicies - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy VM GPU extension policies. (Default: false) - -- Default value: `False` - -### avdDeployMonitoring - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy AVD monitoring resources and setings. (Default: false) - -- Default value: `False` - -### deployAlaWorkspace - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy AVD Azure log analytics workspace. (Default: true) - -- Default value: `True` - -### deployCustomPolicyMonitoring - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Create and assign custom Azure Policy for diagnostic settings for the AVD Log Analytics workspace. (Default: false) - -- Default value: `False` - -### avdAlaWorkspaceDataRetention - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD Azure log analytics workspace data retention. (Default: 90) - -- Default value: `90` - -### alaExistingWorkspaceResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing Azure log analytics workspace resource ID to connect to. (Default: "") - -### avdDeploySessionHostsCount - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Quantity of session hosts to deploy. (Default: 1) - -- Default value: `1` - -### avdSessionHostCountIndex - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The session host number to begin with for the deployment. This is important when adding virtual machines to ensure the names do not conflict. (Default: 0) - -- Default value: `0` - -### availabilityZonesCompute - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -When true VMs are distributed across availability zones, when set to false, VMs will be members of a new availability set. (Default: true) - -- Default value: `True` - -### zoneRedundantStorage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -When true, Zone Redundant Storage (ZRS) is used, when set to false, Locally Redundant Storage (LRS) is used. (Default: false) - -- Default value: `False` - -### avsetFaultDomainCount - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Sets the number of fault domains for the availability set. (Default: 2) - -- Default value: `2` - -### avsetUpdateDomainCount - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Sets the number of update domains for the availability set. (Default: 5) - -- Default value: `5` - -### fslogixStoragePerformance - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Storage account SKU for FSLogix storage. Recommended tier is Premium (Default: Premium) - -- Default value: `Premium` - -- Allowed values: `Standard`, `Premium` - -### msixStoragePerformance - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Storage account SKU for MSIX storage. Recommended tier is Premium. (Default: Premium) - -- Default value: `Premium` - -- Allowed values: `Standard`, `Premium` - -### diskZeroTrust - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enables a zero trust configuration on the session host disks. (Default: false) - -- Default value: `False` - -### avdSessionHostsSize - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Session host VM size. (Default: Standard_D4ads_v5) - -- Default value: `Standard_D4ads_v5` - -### avdSessionHostDiskType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -OS disk type for session host. (Default: Premium_LRS) - -- Default value: `Premium_LRS` - -### enableAcceleratedNetworking - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enables accelerated Networking on the session hosts. -If using a Azure Compute Gallery Image, the Image Definition must have been configured with -the \'isAcceleratedNetworkSupported\' property set to \'true\'. - - -- Default value: `True` - -### securityType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Specifies the securityType of the virtual machine. "ConfidentialVM" and "TrustedLaunch" require a Gen2 Image. (Default: TrustedLaunch) - -- Default value: `TrustedLaunch` - -- Allowed values: `Standard`, `TrustedLaunch`, `ConfidentialVM` - -### secureBootEnabled - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Specifies whether secure boot should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) - -- Default value: `True` - -### vTpmEnabled - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Specifies whether vTPM should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) - -- Default value: `True` - -### avdOsImage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD OS image SKU. (Default: win11-22h2) - -- Default value: `win11_22h2` - -- Allowed values: `win10_21h2`, `win10_21h2_office`, `win10_22h2_g2`, `win10_22h2_office_g2`, `win11_21h2`, `win11_21h2_office`, `win11_22h2`, `win11_22h2_office`, `win11_23h2`, `win11_23h2_office` - -### managementVmOsImage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Management VM image SKU (Default: winServer_2022_Datacenter_smalldisk_g2) - -- Default value: `winServer_2022_Datacenter_smalldisk_g2` - -### useSharedImage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Set to deploy image from Azure Compute Gallery. (Default: false) - -- Default value: `False` - -### avdImageTemplateDefinitionId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Source custom image ID. (Default: "") - -### storageOuPath - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -OU name for Azure Storage Account. It is recommended to create a new AD Organizational Unit (OU) in AD and disable password expiration policy on computer accounts or service logon accounts accordingly. (Default: "") - -### avdUseCustomNaming - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD resources custom naming. (Default: false) - -- Default value: `False` - -### avdServiceObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD service resources resource group custom name. (Default: rg-avd-app1-dev-use2-service-objects) - -- Default value: `rg-avd-app1-dev-use2-service-objects` - -### avdNetworkObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-network) - -- Default value: `rg-avd-app1-dev-use2-network` - -### avdComputeObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-pool-compute) - -- Default value: `rg-avd-app1-dev-use2-pool-compute` - -### avdStorageObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-storage) - -- Default value: `rg-avd-app1-dev-use2-storage` - -### avdMonitoringRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD monitoring resource group custom name. (Default: rg-avd-dev-use2-monitoring) - -- Default value: `rg-avd-dev-use2-monitoring` - -### avdVnetworkCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network custom name. (Default: vnet-app1-dev-use2-001) - -- Default value: `vnet-app1-dev-use2-001` - -### avdAlaWorkspaceCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD Azure log analytics workspace custom name. (Default: log-avd-app1-dev-use2) - -- Default value: `log-avd-app1-dev-use2` - -### avdVnetworkSubnetCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network subnet custom name. (Default: snet-avd-app1-dev-use2-001) - -- Default value: `snet-avd-app1-dev-use2-001` - -### privateEndpointVnetworkSubnetCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -private endpoints virtual network subnet custom name. (Default: snet-pe-app1-dev-use2-001) - -- Default value: `snet-pe-app1-dev-use2-001` - -### avdNetworksecurityGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network security group custom name. (Default: nsg-avd-app1-dev-use2-001) - -- Default value: `nsg-avd-app1-dev-use2-001` - -### privateEndpointNetworksecurityGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Private endpoint network security group custom name. (Default: nsg-pe-app1-dev-use2-001) - -- Default value: `nsg-pe-app1-dev-use2-001` - -### avdRouteTableCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD route table custom name. (Default: route-avd-app1-dev-use2-001) - -- Default value: `route-avd-app1-dev-use2-001` - -### privateEndpointRouteTableCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Private endpoint route table custom name. (Default: route-avd-app1-dev-use2-001) - -- Default value: `route-pe-app1-dev-use2-001` - -### avdApplicationSecurityGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD application security custom name. (Default: asg-app1-dev-use2-001) - -- Default value: `asg-app1-dev-use2-001` - -### avdWorkSpaceCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD workspace custom name. (Default: vdws-app1-dev-use2-001) - -- Default value: `vdws-app1-dev-use2-001` - -### avdWorkSpaceCustomFriendlyName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD workspace custom friendly (Display) name. (Default: App1 - Dev - East US 2 - 001) - -- Default value: `App1 - Dev - East US 2 - 001` - -### avdHostPoolCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool custom name. (Default: vdpool-app1-dev-use2-001) - -- Default value: `vdpool-app1-dev-use2-001` - -### avdHostPoolCustomFriendlyName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool custom friendly (Display) name. (Default: App1 - East US - Dev - 001) - -- Default value: `App1 - Dev - East US 2 - 001` - -### avdScalingPlanCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD scaling plan custom name. (Default: vdscaling-app1-dev-use2-001) - -- Default value: `vdscaling-app1-dev-use2-001` - -### avdApplicationGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD desktop application group custom name. (Default: vdag-desktop-app1-dev-use2-001) - -- Default value: `vdag-desktop-app1-dev-use2-001` - -### avdApplicationGroupCustomFriendlyName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD desktop application group custom friendly (Display) name. (Default: Desktops - App1 - East US - Dev - 001) - -- Default value: `Desktops - App1 - Dev - East US 2 - 001` - -### avdSessionHostCustomNamePrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD session host prefix custom name. (Default: vmapp1duse2) - -- Default value: `vmapp1duse2` - -### avsetCustomNamePrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD availability set custom name. (Default: avail) - -- Default value: `avail` - -### storageAccountPrefixCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD FSLogix and MSIX app attach storage account prefix custom name. (Default: st) - -- Default value: `st` - -### fslogixFileShareCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -FSLogix file share name. (Default: fslogix-pc-app1-dev-001) - -- Default value: `fslogix-pc-app1-dev-use2-001` - -### msixFileShareCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -MSIX file share name. (Default: msix-app1-dev-001) - -- Default value: `msix-app1-dev-use2-001` - -### avdWrklKvPrefixCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD keyvault prefix custom name (with Zero Trust to store credentials to domain join and local admin). (Default: kv-sec) - -- Default value: `kv-sec` - -### ztDiskEncryptionSetCustomNamePrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD disk encryption set custom name. (Default: des-zt) - -- Default value: `des-zt` - -### ztManagedIdentityCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD managed identity for zero trust to encrypt managed disks using a customer managed key. (Default: id-zt) - -- Default value: `id-zt` - -### ztKvPrefixCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD key vault custom name for zero trust and store store disk encryption key (Default: kv-key) - -- Default value: `kv-key` - -### createResourceTags - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Apply tags on resources and resource groups. (Default: false) - -- Default value: `False` - -### workloadNameTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The name of workload for tagging purposes. (Default: Contoso-Workload) - -- Default value: `Contoso-Workload` - -### workloadTypeTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Reference to the size of the VM for your workloads (Default: Light) - -- Default value: `Light` - -- Allowed values: `Light`, `Medium`, `High`, `Power` - -### dataClassificationTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Sensitivity of data hosted (Default: Non-business) - -- Default value: `Non-business` - -- Allowed values: `Non-business`, `Public`, `General`, `Confidential`, `Highly-confidential` - -### departmentTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Department that owns the deployment, (Dafult: Contoso-AVD) - -- Default value: `Contoso-AVD` - -### workloadCriticalityTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Criticality of the workload. (Default: Low) - -- Default value: `Low` - -- Allowed values: `Low`, `Medium`, `High`, `Mission-critical`, `Custom` - -### workloadCriticalityCustomValueTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Tag value for custom criticality value. (Default: Contoso-Critical) - -- Default value: `Contoso-Critical` - -### applicationNameTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Details about the application. - -- Default value: `Contoso-App` - -### workloadSlaTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Service level agreement level of the worload. (Contoso-SLA) - -- Default value: `Contoso-SLA` - -### opsTeamTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Team accountable for day-to-day operations. (workload-admins@Contoso.com) - -- Default value: `workload-admins@Contoso.com` - -### ownerTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Organizational owner of the AVD deployment. (Default: workload-owner@Contoso.com) - -- Default value: `workload-owner@Contoso.com` - -### costCenterTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Cost center of owner team. (Default: Contoso-CC) - -- Default value: `Contoso-CC` - -### time - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Do not modify, used to set unique value for resource deployment. - -- Default value: `[utcNow()]` - -### enableTelemetry - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enable usage and telemetry feedback to Microsoft. - -- Default value: `True` - -### enableKvPurgeProtection - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enable purge protection for the keyvaults. (Default: true) - -- Default value: `True` - -## Snippets - -### Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "metadata": { - "template": "workload/bicep/deploy-baseline.json" - }, - "parameters": { - "deploymentPrefix": { - "value": "AVD1" - }, - "deploymentEnvironment": { - "value": "Dev" - }, - "diskEncryptionKeyExpirationInDays": { - "value": 60 - }, - "avdSessionHostLocation": { - "value": "eastus2" - }, - "avdManagementPlaneLocation": { - "value": "eastus2" - }, - "avdWorkloadSubsId": { - "value": "" - }, - "avdEnterpriseAppObjectId": { - "value": "" - }, - "avdVmLocalUserName": { - "value": "" - }, - "avdVmLocalUserPassword": { - "reference": { - "keyVault": { - "id": "" - }, - "secretName": "" - } - }, - "avdIdentityServiceProvider": { - "value": "ADDS" - }, - "createIntuneEnrollment": { - "value": false - }, - "securityPrincipalId": { - "value": "" - }, - "securityPrincipalName": { - "value": "" - }, - "identityDomainName": { - "value": "none" - }, - "identityDomainGuid": { - "value": "" - }, - "avdDomainJoinUserName": { - "value": "none" - }, - "avdDomainJoinUserPassword": { - "reference": { - "keyVault": { - "id": "" - }, - "secretName": "" - } - }, - "avdOuPath": { - "value": "" - }, - "avdHostPoolType": { - "value": "Pooled" - }, - "hostPoolPreferredAppGroupType": { - "value": "Desktop" - }, - "avdPersonalAssignType": { - "value": "Automatic" - }, - "avdHostPoolLoadBalancerType": { - "value": "BreadthFirst" - }, - "hostPoolMaxSessions": { - "value": 8 - }, - "avdStartVmOnConnect": { - "value": true - }, - "avdHostPoolRdpProperties": { - "value": "audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2" - }, - "avdDeployScalingPlan": { - "value": true - }, - "createAvdVnet": { - "value": true - }, - "existingVnetAvdSubnetResourceId": { - "value": "" - }, - "existingVnetPrivateEndpointSubnetResourceId": { - "value": "" - }, - "existingHubVnetResourceId": { - "value": "" - }, - "avdVnetworkAddressPrefixes": { - "value": "10.10.0.0/23" - }, - "vNetworkAvdSubnetAddressPrefix": { - "value": "10.10.0.0/24" - }, - "vNetworkPrivateEndpointSubnetAddressPrefix": { - "value": "10.10.1.0/27" - }, - "customDnsIps": { - "value": "" - }, - "deployPrivateEndpointKeyvaultStorage": { - "value": true - }, - "createPrivateDnsZones": { - "value": true - }, - "avdVnetPrivateDnsZoneFilesId": { - "value": "" - }, - "avdVnetPrivateDnsZoneKeyvaultId": { - "value": "" - }, - "vNetworkGatewayOnHub": { - "value": false - }, - "createAvdFslogixDeployment": { - "value": true - }, - "createMsixDeployment": { - "value": false - }, - "fslogixFileShareQuotaSize": { - "value": 1 - }, - "msixFileShareQuotaSize": { - "value": 1 - }, - "avdDeploySessionHosts": { - "value": true - }, - "deployGpuPolicies": { - "value": false - }, - "avdDeployMonitoring": { - "value": false - }, - "deployAlaWorkspace": { - "value": true - }, - "deployCustomPolicyMonitoring": { - "value": false - }, - "avdAlaWorkspaceDataRetention": { - "value": 90 - }, - "alaExistingWorkspaceResourceId": { - "value": "" - }, - "avdDeploySessionHostsCount": { - "value": 1 - }, - "avdSessionHostCountIndex": { - "value": 0 - }, - "availabilityZonesCompute": { - "value": true - }, - "zoneRedundantStorage": { - "value": false - }, - "avsetFaultDomainCount": { - "value": 2 - }, - "avsetUpdateDomainCount": { - "value": 5 - }, - "fslogixStoragePerformance": { - "value": "Premium" - }, - "msixStoragePerformance": { - "value": "Premium" - }, - "diskZeroTrust": { - "value": false - }, - "avdSessionHostsSize": { - "value": "Standard_D4ads_v5" - }, - "avdSessionHostDiskType": { - "value": "Premium_LRS" - }, - "enableAcceleratedNetworking": { - "value": true - }, - "securityType": { - "value": "TrustedLaunch" - }, - "secureBootEnabled": { - "value": true - }, - "vTpmEnabled": { - "value": true - }, - "avdOsImage": { - "value": "win11_22h2" - }, - "managementVmOsImage": { - "value": "winServer_2022_Datacenter_smalldisk_g2" - }, - "useSharedImage": { - "value": false - }, - "avdImageTemplateDefinitionId": { - "value": "" - }, - "storageOuPath": { - "value": "" - }, - "avdUseCustomNaming": { - "value": false - }, - "avdServiceObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-service-objects" - }, - "avdNetworkObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-network" - }, - "avdComputeObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-pool-compute" - }, - "avdStorageObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-storage" - }, - "avdMonitoringRgCustomName": { - "value": "rg-avd-dev-use2-monitoring" - }, - "avdVnetworkCustomName": { - "value": "vnet-app1-dev-use2-001" - }, - "avdAlaWorkspaceCustomName": { - "value": "log-avd-app1-dev-use2" - }, - "avdVnetworkSubnetCustomName": { - "value": "snet-avd-app1-dev-use2-001" - }, - "privateEndpointVnetworkSubnetCustomName": { - "value": "snet-pe-app1-dev-use2-001" - }, - "avdNetworksecurityGroupCustomName": { - "value": "nsg-avd-app1-dev-use2-001" - }, - "privateEndpointNetworksecurityGroupCustomName": { - "value": "nsg-pe-app1-dev-use2-001" - }, - "avdRouteTableCustomName": { - "value": "route-avd-app1-dev-use2-001" - }, - "privateEndpointRouteTableCustomName": { - "value": "route-pe-app1-dev-use2-001" - }, - "avdApplicationSecurityGroupCustomName": { - "value": "asg-app1-dev-use2-001" - }, - "avdWorkSpaceCustomName": { - "value": "vdws-app1-dev-use2-001" - }, - "avdWorkSpaceCustomFriendlyName": { - "value": "App1 - Dev - East US 2 - 001" - }, - "avdHostPoolCustomName": { - "value": "vdpool-app1-dev-use2-001" - }, - "avdHostPoolCustomFriendlyName": { - "value": "App1 - Dev - East US 2 - 001" - }, - "avdScalingPlanCustomName": { - "value": "vdscaling-app1-dev-use2-001" - }, - "avdApplicationGroupCustomName": { - "value": "vdag-desktop-app1-dev-use2-001" - }, - "avdApplicationGroupCustomFriendlyName": { - "value": "Desktops - App1 - Dev - East US 2 - 001" - }, - "avdSessionHostCustomNamePrefix": { - "value": "vmapp1duse2" - }, - "avsetCustomNamePrefix": { - "value": "avail" - }, - "storageAccountPrefixCustomName": { - "value": "st" - }, - "fslogixFileShareCustomName": { - "value": "fslogix-pc-app1-dev-use2-001" - }, - "msixFileShareCustomName": { - "value": "msix-app1-dev-use2-001" - }, - "avdWrklKvPrefixCustomName": { - "value": "kv-sec" - }, - "ztDiskEncryptionSetCustomNamePrefix": { - "value": "des-zt" - }, - "ztManagedIdentityCustomName": { - "value": "id-zt" - }, - "ztKvPrefixCustomName": { - "value": "kv-key" - }, - "createResourceTags": { - "value": false - }, - "workloadNameTag": { - "value": "Contoso-Workload" - }, - "workloadTypeTag": { - "value": "Light" - }, - "dataClassificationTag": { - "value": "Non-business" - }, - "departmentTag": { - "value": "Contoso-AVD" - }, - "workloadCriticalityTag": { - "value": "Low" - }, - "workloadCriticalityCustomValueTag": { - "value": "Contoso-Critical" - }, - "applicationNameTag": { - "value": "Contoso-App" - }, - "workloadSlaTag": { - "value": "Contoso-SLA" - }, - "opsTeamTag": { - "value": "workload-admins@Contoso.com" - }, - "ownerTag": { - "value": "workload-owner@Contoso.com" - }, - "costCenterTag": { - "value": "Contoso-CC" - }, - "time": { - "value": "[utcNow()]" - }, - "enableTelemetry": { - "value": true - }, - "enableKvPurgeProtection": { - "value": true - } - } -} -``` diff --git a/workload/docs/autoGenerated/deploy-baseline.bicep.md.old b/workload/docs/autoGenerated/deploy-baseline.bicep.md.old deleted file mode 100644 index 2c6870dc7..000000000 --- a/workload/docs/autoGenerated/deploy-baseline.bicep.md.old +++ /dev/null @@ -1,1421 +0,0 @@ -# AVD Accelerator - Baseline Deployment - -AVD Accelerator - Deployment Baseline - -## Parameters - -Parameter name | Required | Description --------------- | -------- | ----------- -deploymentPrefix | No | The name of the resource group to deploy. (Default: AVD1) -deploymentEnvironment | No | The name of the resource group to deploy. (Default: Dev) -diskEncryptionKeyExpirationInDays | No | This value is used to set the expiration date on the disk encryption key. (Default: 60) -avdSessionHostLocation | No | Location where to deploy compute services. (Default: eastus2) -avdManagementPlaneLocation | No | Location where to deploy AVD management plane. (Default: eastus2) -avdWorkloadSubsId | No | AVD workload subscription ID, multiple subscriptions scenario. (Default: "") -avdEnterpriseAppObjectId | No | Azure Virtual Desktop Enterprise Application object ID. (Default: "") -avdVmLocalUserName | Yes | AVD session host local username. -avdVmLocalUserPassword | Yes | AVD session host local password. -avdIdentityServiceProvider | No | Required, The service providing domain services for Azure Virtual Desktop. (Default: ADDS) -createIntuneEnrollment | No | Required, Eronll session hosts on Intune. (Default: false) -securityPrincipalId | No | Optional, Identity ID to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") -securityPrincipalName | No | Optional, Identity name to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") -identityDomainName | No | FQDN of on-premises AD domain, used for FSLogix storage configuration and NTFS setup. (Default: "") -identityDomainGuid | No | AD domain GUID. (Default: "") -avdDomainJoinUserName | No | AVD session host domain join user principal name. (Default: none) -avdDomainJoinUserPassword | No | AVD session host domain join password. (Default: none) -avdOuPath | No | OU path to join AVd VMs. (Default: "") -avdHostPoolType | No | AVD host pool type. (Default: Pooled) -hostPoolPreferredAppGroupType | No | Optional. The type of preferred application group type, default to Desktop Application Group. -avdPersonalAssignType | No | AVD host pool type. (Default: Automatic) -avdHostPoolLoadBalancerType | No | AVD host pool load balacing type. (Default: BreadthFirst) -hostPoolMaxSessions | No | AVD host pool maximum number of user sessions per session host. (Default: 8) -avdStartVmOnConnect | No | AVD host pool start VM on Connect. (Default: true) -avdHostPoolRdpProperties | No | AVD host pool Custom RDP properties. (Default: audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2) -avdDeployScalingPlan | No | AVD deploy scaling plan. (Default: true) -createAvdVnet | No | Create new virtual network. (Default: true) -existingVnetAvdSubnetResourceId | No | Existing virtual network subnet for AVD. (Default: "") -existingVnetPrivateEndpointSubnetResourceId | No | Existing virtual network subnet for private endpoints. (Default: "") -existingHubVnetResourceId | No | Existing hub virtual network for perring. (Default: "") -avdVnetworkAddressPrefixes | No | AVD virtual network address prefixes. (Default: 10.10.0.0/23) -vNetworkAvdSubnetAddressPrefix | No | AVD virtual network subnet address prefix. (Default: 10.10.0.0/23) -vNetworkPrivateEndpointSubnetAddressPrefix | No | private endpoints virtual network subnet address prefix. (Default: 10.10.1.0/27) -customDnsIps | No | custom DNS servers IPs. (Default: "") -deployPrivateEndpointKeyvaultStorage | No | Deploy private endpoints for key vault and storage. (Default: true) -createPrivateDnsZones | No | Create new Azure private DNS zones for private endpoints. (Default: true) -avdVnetPrivateDnsZoneFilesId | No | Use existing Azure private DNS zone for Azure files privatelink.file.core.windows.net or privatelink.file.core.usgovcloudapi.net. (Default: "") -avdVnetPrivateDnsZoneKeyvaultId | No | Use existing Azure private DNS zone for key vault privatelink.vaultcore.azure.net or privatelink.vaultcore.usgovcloudapi.net. (Default: "") -vNetworkGatewayOnHub | No | Does the hub contains a virtual network gateway. (Default: false) -createAvdFslogixDeployment | No | Deploy Fslogix setup. (Default: true) -createMsixDeployment | No | Deploy MSIX App Attach setup. (Default: false) -fslogixFileShareQuotaSize | No | Fslogix file share size. (Default: 1) -msixFileShareQuotaSize | No | MSIX file share size. (Default: 1) -avdDeploySessionHosts | No | Deploy new session hosts. (Default: true) -deployGpuPolicies | No | Deploy VM GPU extension policies. (Default: false) -avdDeployMonitoring | No | Deploy AVD monitoring resources and setings. (Default: false) -deployAlaWorkspace | No | Deploy AVD Azure log analytics workspace. (Default: true) -deployCustomPolicyMonitoring | No | Create and assign custom Azure Policy for diagnostic settings for the AVD Log Analytics workspace. (Default: false) -avdAlaWorkspaceDataRetention | No | AVD Azure log analytics workspace data retention. (Default: 90) -alaExistingWorkspaceResourceId | No | Existing Azure log analytics workspace resource ID to connect to. (Default: "") -avdDeploySessionHostsCount | No | Quantity of session hosts to deploy. (Default: 1) -avdSessionHostCountIndex | No | The session host number to begin with for the deployment. This is important when adding virtual machines to ensure the names do not conflict. (Default: 0) -availabilityZonesCompute | No | When true VMs are distributed across availability zones, when set to false, VMs will be members of a new availability set. (Default: true) -zoneRedundantStorage | No | When true, Zone Redundant Storage (ZRS) is used, when set to false, Locally Redundant Storage (LRS) is used. (Default: false) -avsetFaultDomainCount | No | Sets the number of fault domains for the availability set. (Default: 2) -avsetUpdateDomainCount | No | Sets the number of update domains for the availability set. (Default: 5) -fslogixStoragePerformance | No | Storage account SKU for FSLogix storage. Recommended tier is Premium (Default: Premium) -msixStoragePerformance | No | Storage account SKU for MSIX storage. Recommended tier is Premium. (Default: Premium) -diskZeroTrust | No | Enables a zero trust configuration on the session host disks. (Default: false) -avdSessionHostsSize | No | Session host VM size. (Default: Standard_D4ads_v5) -avdSessionHostDiskType | No | OS disk type for session host. (Default: Premium_LRS) -enableAcceleratedNetworking | No | Enables accelerated Networking on the session hosts. If using a Azure Compute Gallery Image, the Image Definition must have been configured with the \'isAcceleratedNetworkSupported\' property set to \'true\'. -securityType | No | Specifies the securityType of the virtual machine. "ConfidentialVM" and "TrustedLaunch" require a Gen2 Image. (Default: TrustedLaunch) -secureBootEnabled | No | Specifies whether secure boot should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) -vTpmEnabled | No | Specifies whether vTPM should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) -avdOsImage | No | AVD OS image SKU. (Default: win11-22h2) -managementVmOsImage | No | Management VM image SKU (Default: winServer_2022_Datacenter_smalldisk_g2) -useSharedImage | No | Set to deploy image from Azure Compute Gallery. (Default: false) -avdImageTemplateDefinitionId | No | Source custom image ID. (Default: "") -storageOuPath | No | OU name for Azure Storage Account. It is recommended to create a new AD Organizational Unit (OU) in AD and disable password expiration policy on computer accounts or service logon accounts accordingly. (Default: "") -avdUseCustomNaming | No | AVD resources custom naming. (Default: false) -avdServiceObjectsRgCustomName | No | AVD service resources resource group custom name. (Default: rg-avd-app1-dev-use2-service-objects) -avdNetworkObjectsRgCustomName | No | AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-network) -avdComputeObjectsRgCustomName | No | AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-pool-compute) -avdStorageObjectsRgCustomName | No | AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-storage) -avdMonitoringRgCustomName | No | AVD monitoring resource group custom name. (Default: rg-avd-dev-use2-monitoring) -avdVnetworkCustomName | No | AVD virtual network custom name. (Default: vnet-app1-dev-use2-001) -avdAlaWorkspaceCustomName | No | AVD Azure log analytics workspace custom name. (Default: log-avd-app1-dev-use2) -avdVnetworkSubnetCustomName | No | AVD virtual network subnet custom name. (Default: snet-avd-app1-dev-use2-001) -privateEndpointVnetworkSubnetCustomName | No | private endpoints virtual network subnet custom name. (Default: snet-pe-app1-dev-use2-001) -avdNetworksecurityGroupCustomName | No | AVD network security group custom name. (Default: nsg-avd-app1-dev-use2-001) -privateEndpointNetworksecurityGroupCustomName | No | Private endpoint network security group custom name. (Default: nsg-pe-app1-dev-use2-001) -avdRouteTableCustomName | No | AVD route table custom name. (Default: route-avd-app1-dev-use2-001) -privateEndpointRouteTableCustomName | No | Private endpoint route table custom name. (Default: route-avd-app1-dev-use2-001) -avdApplicationSecurityGroupCustomName | No | AVD application security custom name. (Default: asg-app1-dev-use2-001) -avdWorkSpaceCustomName | No | AVD workspace custom name. (Default: vdws-app1-dev-use2-001) -avdWorkSpaceCustomFriendlyName | No | AVD workspace custom friendly (Display) name. (Default: App1 - Dev - East US 2 - 001) -avdHostPoolCustomName | No | AVD host pool custom name. (Default: vdpool-app1-dev-use2-001) -avdHostPoolCustomFriendlyName | No | AVD host pool custom friendly (Display) name. (Default: App1 - East US - Dev - 001) -avdScalingPlanCustomName | No | AVD scaling plan custom name. (Default: vdscaling-app1-dev-use2-001) -avdApplicationGroupCustomName | No | AVD desktop application group custom name. (Default: vdag-desktop-app1-dev-use2-001) -avdApplicationGroupCustomFriendlyName | No | AVD desktop application group custom friendly (Display) name. (Default: Desktops - App1 - East US - Dev - 001) -avdSessionHostCustomNamePrefix | No | AVD session host prefix custom name. (Default: vmapp1duse2) -avsetCustomNamePrefix | No | AVD availability set custom name. (Default: avail) -storageAccountPrefixCustomName | No | AVD FSLogix and MSIX app attach storage account prefix custom name. (Default: st) -fslogixFileShareCustomName | No | FSLogix file share name. (Default: fslogix-pc-app1-dev-001) -msixFileShareCustomName | No | MSIX file share name. (Default: msix-app1-dev-001) -avdWrklKvPrefixCustomName | No | AVD keyvault prefix custom name (with Zero Trust to store credentials to domain join and local admin). (Default: kv-sec) -ztDiskEncryptionSetCustomNamePrefix | No | AVD disk encryption set custom name. (Default: des-zt) -ztManagedIdentityCustomName | No | AVD managed identity for zero trust to encrypt managed disks using a customer managed key. (Default: id-zt) -ztKvPrefixCustomName | No | AVD key vault custom name for zero trust and store store disk encryption key (Default: kv-key) -createResourceTags | No | Apply tags on resources and resource groups. (Default: false) -workloadNameTag | No | The name of workload for tagging purposes. (Default: Contoso-Workload) -workloadTypeTag | No | Reference to the size of the VM for your workloads (Default: Light) -dataClassificationTag | No | Sensitivity of data hosted (Default: Non-business) -departmentTag | No | Department that owns the deployment, (Dafult: Contoso-AVD) -workloadCriticalityTag | No | Criticality of the workload. (Default: Low) -workloadCriticalityCustomValueTag | No | Tag value for custom criticality value. (Default: Contoso-Critical) -applicationNameTag | No | Details about the application. -workloadSlaTag | No | Service level agreement level of the worload. (Contoso-SLA) -opsTeamTag | No | Team accountable for day-to-day operations. (workload-admins@Contoso.com) -ownerTag | No | Organizational owner of the AVD deployment. (Default: workload-owner@Contoso.com) -costCenterTag | No | Cost center of owner team. (Default: Contoso-CC) -time | No | Do not modify, used to set unique value for resource deployment. -enableTelemetry | No | Enable usage and telemetry feedback to Microsoft. -enableKvPurgeProtection | No | Enable purge protection for the keyvaults. (Default: true) - -### deploymentPrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The name of the resource group to deploy. (Default: AVD1) - -- Default value: `AVD1` - -### deploymentEnvironment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The name of the resource group to deploy. (Default: Dev) - -- Default value: `Dev` - -- Allowed values: `Dev`, `Test`, `Prod` - -### diskEncryptionKeyExpirationInDays - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -This value is used to set the expiration date on the disk encryption key. (Default: 60) - -- Default value: `60` - -### avdSessionHostLocation - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Location where to deploy compute services. (Default: eastus2) - -- Default value: `eastus2` - -### avdManagementPlaneLocation - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Location where to deploy AVD management plane. (Default: eastus2) - -- Default value: `eastus2` - -### avdWorkloadSubsId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD workload subscription ID, multiple subscriptions scenario. (Default: "") - -### avdEnterpriseAppObjectId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Azure Virtual Desktop Enterprise Application object ID. (Default: "") - -### avdVmLocalUserName - -![Parameter Setting](https://img.shields.io/badge/parameter-required-orange?style=flat-square) - -AVD session host local username. - -### avdVmLocalUserPassword - -![Parameter Setting](https://img.shields.io/badge/parameter-required-orange?style=flat-square) - -AVD session host local password. - -### avdIdentityServiceProvider - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Required, The service providing domain services for Azure Virtual Desktop. (Default: ADDS) - -- Default value: `ADDS` - -- Allowed values: `ADDS`, `AADDS`, `AAD` - -### createIntuneEnrollment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Required, Eronll session hosts on Intune. (Default: false) - -- Default value: `False` - -### securityPrincipalId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Optional, Identity ID to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") - -### securityPrincipalName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Optional, Identity name to grant RBAC role to access AVD application group and NTFS permissions. (Default: "") - -### identityDomainName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -FQDN of on-premises AD domain, used for FSLogix storage configuration and NTFS setup. (Default: "") - -- Default value: `none` - -### identityDomainGuid - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AD domain GUID. (Default: "") - -### avdDomainJoinUserName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD session host domain join user principal name. (Default: none) - -- Default value: `none` - -### avdDomainJoinUserPassword - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD session host domain join password. (Default: none) - -- Default value: `none` - -### avdOuPath - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -OU path to join AVd VMs. (Default: "") - -### avdHostPoolType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool type. (Default: Pooled) - -- Default value: `Pooled` - -- Allowed values: `Personal`, `Pooled` - -### hostPoolPreferredAppGroupType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Optional. The type of preferred application group type, default to Desktop Application Group. - -- Default value: `Desktop` - -- Allowed values: `Desktop`, `RemoteApp` - -### avdPersonalAssignType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool type. (Default: Automatic) - -- Default value: `Automatic` - -- Allowed values: `Automatic`, `Direct` - -### avdHostPoolLoadBalancerType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool load balacing type. (Default: BreadthFirst) - -- Default value: `BreadthFirst` - -- Allowed values: `BreadthFirst`, `DepthFirst` - -### hostPoolMaxSessions - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool maximum number of user sessions per session host. (Default: 8) - -- Default value: `8` - -### avdStartVmOnConnect - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool start VM on Connect. (Default: true) - -- Default value: `True` - -### avdHostPoolRdpProperties - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool Custom RDP properties. (Default: audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2) - -- Default value: `audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2` - -### avdDeployScalingPlan - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD deploy scaling plan. (Default: true) - -- Default value: `True` - -### createAvdVnet - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Create new virtual network. (Default: true) - -- Default value: `True` - -### existingVnetAvdSubnetResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing virtual network subnet for AVD. (Default: "") - -### existingVnetPrivateEndpointSubnetResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing virtual network subnet for private endpoints. (Default: "") - -### existingHubVnetResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing hub virtual network for perring. (Default: "") - -### avdVnetworkAddressPrefixes - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network address prefixes. (Default: 10.10.0.0/23) - -- Default value: `10.10.0.0/23` - -### vNetworkAvdSubnetAddressPrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network subnet address prefix. (Default: 10.10.0.0/23) - -- Default value: `10.10.0.0/24` - -### vNetworkPrivateEndpointSubnetAddressPrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -private endpoints virtual network subnet address prefix. (Default: 10.10.1.0/27) - -- Default value: `10.10.1.0/27` - -### customDnsIps - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -custom DNS servers IPs. (Default: "") - -### deployPrivateEndpointKeyvaultStorage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy private endpoints for key vault and storage. (Default: true) - -- Default value: `True` - -### createPrivateDnsZones - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Create new Azure private DNS zones for private endpoints. (Default: true) - -- Default value: `True` - -### avdVnetPrivateDnsZoneFilesId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Use existing Azure private DNS zone for Azure files privatelink.file.core.windows.net or privatelink.file.core.usgovcloudapi.net. (Default: "") - -### avdVnetPrivateDnsZoneKeyvaultId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Use existing Azure private DNS zone for key vault privatelink.vaultcore.azure.net or privatelink.vaultcore.usgovcloudapi.net. (Default: "") - -### vNetworkGatewayOnHub - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Does the hub contains a virtual network gateway. (Default: false) - -- Default value: `False` - -### createAvdFslogixDeployment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy Fslogix setup. (Default: true) - -- Default value: `True` - -### createMsixDeployment - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy MSIX App Attach setup. (Default: false) - -- Default value: `False` - -### fslogixFileShareQuotaSize - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Fslogix file share size. (Default: 1) - -- Default value: `1` - -### msixFileShareQuotaSize - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -MSIX file share size. (Default: 1) - -- Default value: `1` - -### avdDeploySessionHosts - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy new session hosts. (Default: true) - -- Default value: `True` - -### deployGpuPolicies - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy VM GPU extension policies. (Default: false) - -- Default value: `False` - -### avdDeployMonitoring - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy AVD monitoring resources and setings. (Default: false) - -- Default value: `False` - -### deployAlaWorkspace - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deploy AVD Azure log analytics workspace. (Default: true) - -- Default value: `True` - -### deployCustomPolicyMonitoring - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Create and assign custom Azure Policy for diagnostic settings for the AVD Log Analytics workspace. (Default: false) - -- Default value: `False` - -### avdAlaWorkspaceDataRetention - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD Azure log analytics workspace data retention. (Default: 90) - -- Default value: `90` - -### alaExistingWorkspaceResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing Azure log analytics workspace resource ID to connect to. (Default: "") - -### avdDeploySessionHostsCount - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Quantity of session hosts to deploy. (Default: 1) - -- Default value: `1` - -### avdSessionHostCountIndex - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The session host number to begin with for the deployment. This is important when adding virtual machines to ensure the names do not conflict. (Default: 0) - -- Default value: `0` - -### availabilityZonesCompute - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -When true VMs are distributed across availability zones, when set to false, VMs will be members of a new availability set. (Default: true) - -- Default value: `True` - -### zoneRedundantStorage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -When true, Zone Redundant Storage (ZRS) is used, when set to false, Locally Redundant Storage (LRS) is used. (Default: false) - -- Default value: `False` - -### avsetFaultDomainCount - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Sets the number of fault domains for the availability set. (Default: 2) - -- Default value: `2` - -### avsetUpdateDomainCount - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Sets the number of update domains for the availability set. (Default: 5) - -- Default value: `5` - -### fslogixStoragePerformance - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Storage account SKU for FSLogix storage. Recommended tier is Premium (Default: Premium) - -- Default value: `Premium` - -- Allowed values: `Standard`, `Premium` - -### msixStoragePerformance - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Storage account SKU for MSIX storage. Recommended tier is Premium. (Default: Premium) - -- Default value: `Premium` - -- Allowed values: `Standard`, `Premium` - -### diskZeroTrust - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enables a zero trust configuration on the session host disks. (Default: false) - -- Default value: `False` - -### avdSessionHostsSize - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Session host VM size. (Default: Standard_D4ads_v5) - -- Default value: `Standard_D4ads_v5` - -### avdSessionHostDiskType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -OS disk type for session host. (Default: Premium_LRS) - -- Default value: `Premium_LRS` - -### enableAcceleratedNetworking - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enables accelerated Networking on the session hosts. -If using a Azure Compute Gallery Image, the Image Definition must have been configured with -the \'isAcceleratedNetworkSupported\' property set to \'true\'. - - -- Default value: `True` - -### securityType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Specifies the securityType of the virtual machine. "ConfidentialVM" and "TrustedLaunch" require a Gen2 Image. (Default: TrustedLaunch) - -- Default value: `TrustedLaunch` - -- Allowed values: `Standard`, `TrustedLaunch`, `ConfidentialVM` - -### secureBootEnabled - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Specifies whether secure boot should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) - -- Default value: `True` - -### vTpmEnabled - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Specifies whether vTPM should be enabled on the virtual machine. This parameter is part of the UefiSettings. securityType should be set to TrustedLaunch or ConfidentialVM to enable UefiSettings. (Default: true) - -- Default value: `True` - -### avdOsImage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD OS image SKU. (Default: win11-22h2) - -- Default value: `win11_22h2` - -- Allowed values: `win10_21h2`, `win10_21h2_office`, `win10_22h2_g2`, `win10_22h2_office_g2`, `win11_21h2`, `win11_21h2_office`, `win11_22h2`, `win11_22h2_office`, `win11_23h2`, `win11_23h2_office` - -### managementVmOsImage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Management VM image SKU (Default: winServer_2022_Datacenter_smalldisk_g2) - -- Default value: `winServer_2022_Datacenter_smalldisk_g2` - -### useSharedImage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Set to deploy image from Azure Compute Gallery. (Default: false) - -- Default value: `False` - -### avdImageTemplateDefinitionId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Source custom image ID. (Default: "") - -### storageOuPath - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -OU name for Azure Storage Account. It is recommended to create a new AD Organizational Unit (OU) in AD and disable password expiration policy on computer accounts or service logon accounts accordingly. (Default: "") - -### avdUseCustomNaming - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD resources custom naming. (Default: false) - -- Default value: `False` - -### avdServiceObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD service resources resource group custom name. (Default: rg-avd-app1-dev-use2-service-objects) - -- Default value: `rg-avd-app1-dev-use2-service-objects` - -### avdNetworkObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-network) - -- Default value: `rg-avd-app1-dev-use2-network` - -### avdComputeObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-pool-compute) - -- Default value: `rg-avd-app1-dev-use2-pool-compute` - -### avdStorageObjectsRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network resources resource group custom name. (Default: rg-avd-app1-dev-use2-storage) - -- Default value: `rg-avd-app1-dev-use2-storage` - -### avdMonitoringRgCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD monitoring resource group custom name. (Default: rg-avd-dev-use2-monitoring) - -- Default value: `rg-avd-dev-use2-monitoring` - -### avdVnetworkCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network custom name. (Default: vnet-app1-dev-use2-001) - -- Default value: `vnet-app1-dev-use2-001` - -### avdAlaWorkspaceCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD Azure log analytics workspace custom name. (Default: log-avd-app1-dev-use2) - -- Default value: `log-avd-app1-dev-use2` - -### avdVnetworkSubnetCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD virtual network subnet custom name. (Default: snet-avd-app1-dev-use2-001) - -- Default value: `snet-avd-app1-dev-use2-001` - -### privateEndpointVnetworkSubnetCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -private endpoints virtual network subnet custom name. (Default: snet-pe-app1-dev-use2-001) - -- Default value: `snet-pe-app1-dev-use2-001` - -### avdNetworksecurityGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD network security group custom name. (Default: nsg-avd-app1-dev-use2-001) - -- Default value: `nsg-avd-app1-dev-use2-001` - -### privateEndpointNetworksecurityGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Private endpoint network security group custom name. (Default: nsg-pe-app1-dev-use2-001) - -- Default value: `nsg-pe-app1-dev-use2-001` - -### avdRouteTableCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD route table custom name. (Default: route-avd-app1-dev-use2-001) - -- Default value: `route-avd-app1-dev-use2-001` - -### privateEndpointRouteTableCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Private endpoint route table custom name. (Default: route-avd-app1-dev-use2-001) - -- Default value: `route-pe-app1-dev-use2-001` - -### avdApplicationSecurityGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD application security custom name. (Default: asg-app1-dev-use2-001) - -- Default value: `asg-app1-dev-use2-001` - -### avdWorkSpaceCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD workspace custom name. (Default: vdws-app1-dev-use2-001) - -- Default value: `vdws-app1-dev-use2-001` - -### avdWorkSpaceCustomFriendlyName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD workspace custom friendly (Display) name. (Default: App1 - Dev - East US 2 - 001) - -- Default value: `App1 - Dev - East US 2 - 001` - -### avdHostPoolCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool custom name. (Default: vdpool-app1-dev-use2-001) - -- Default value: `vdpool-app1-dev-use2-001` - -### avdHostPoolCustomFriendlyName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD host pool custom friendly (Display) name. (Default: App1 - East US - Dev - 001) - -- Default value: `App1 - Dev - East US 2 - 001` - -### avdScalingPlanCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD scaling plan custom name. (Default: vdscaling-app1-dev-use2-001) - -- Default value: `vdscaling-app1-dev-use2-001` - -### avdApplicationGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD desktop application group custom name. (Default: vdag-desktop-app1-dev-use2-001) - -- Default value: `vdag-desktop-app1-dev-use2-001` - -### avdApplicationGroupCustomFriendlyName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD desktop application group custom friendly (Display) name. (Default: Desktops - App1 - East US - Dev - 001) - -- Default value: `Desktops - App1 - Dev - East US 2 - 001` - -### avdSessionHostCustomNamePrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD session host prefix custom name. (Default: vmapp1duse2) - -- Default value: `vmapp1duse2` - -### avsetCustomNamePrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD availability set custom name. (Default: avail) - -- Default value: `avail` - -### storageAccountPrefixCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD FSLogix and MSIX app attach storage account prefix custom name. (Default: st) - -- Default value: `st` - -### fslogixFileShareCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -FSLogix file share name. (Default: fslogix-pc-app1-dev-001) - -- Default value: `fslogix-pc-app1-dev-use2-001` - -### msixFileShareCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -MSIX file share name. (Default: msix-app1-dev-001) - -- Default value: `msix-app1-dev-use2-001` - -### avdWrklKvPrefixCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD keyvault prefix custom name (with Zero Trust to store credentials to domain join and local admin). (Default: kv-sec) - -- Default value: `kv-sec` - -### ztDiskEncryptionSetCustomNamePrefix - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD disk encryption set custom name. (Default: des-zt) - -- Default value: `des-zt` - -### ztManagedIdentityCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD managed identity for zero trust to encrypt managed disks using a customer managed key. (Default: id-zt) - -- Default value: `id-zt` - -### ztKvPrefixCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD key vault custom name for zero trust and store store disk encryption key (Default: kv-key) - -- Default value: `kv-key` - -### createResourceTags - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Apply tags on resources and resource groups. (Default: false) - -- Default value: `False` - -### workloadNameTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The name of workload for tagging purposes. (Default: Contoso-Workload) - -- Default value: `Contoso-Workload` - -### workloadTypeTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Reference to the size of the VM for your workloads (Default: Light) - -- Default value: `Light` - -- Allowed values: `Light`, `Medium`, `High`, `Power` - -### dataClassificationTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Sensitivity of data hosted (Default: Non-business) - -- Default value: `Non-business` - -- Allowed values: `Non-business`, `Public`, `General`, `Confidential`, `Highly-confidential` - -### departmentTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Department that owns the deployment, (Dafult: Contoso-AVD) - -- Default value: `Contoso-AVD` - -### workloadCriticalityTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Criticality of the workload. (Default: Low) - -- Default value: `Low` - -- Allowed values: `Low`, `Medium`, `High`, `Mission-critical`, `Custom` - -### workloadCriticalityCustomValueTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Tag value for custom criticality value. (Default: Contoso-Critical) - -- Default value: `Contoso-Critical` - -### applicationNameTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Details about the application. - -- Default value: `Contoso-App` - -### workloadSlaTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Service level agreement level of the worload. (Contoso-SLA) - -- Default value: `Contoso-SLA` - -### opsTeamTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Team accountable for day-to-day operations. (workload-admins@Contoso.com) - -- Default value: `workload-admins@Contoso.com` - -### ownerTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Organizational owner of the AVD deployment. (Default: workload-owner@Contoso.com) - -- Default value: `workload-owner@Contoso.com` - -### costCenterTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Cost center of owner team. (Default: Contoso-CC) - -- Default value: `Contoso-CC` - -### time - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Do not modify, used to set unique value for resource deployment. - -- Default value: `[utcNow()]` - -### enableTelemetry - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enable usage and telemetry feedback to Microsoft. - -- Default value: `True` - -### enableKvPurgeProtection - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enable purge protection for the keyvaults. (Default: true) - -- Default value: `True` - -## Snippets - -### Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "metadata": { - "template": "workload/bicep/deploy-baseline.json" - }, - "parameters": { - "deploymentPrefix": { - "value": "AVD1" - }, - "deploymentEnvironment": { - "value": "Dev" - }, - "diskEncryptionKeyExpirationInDays": { - "value": 60 - }, - "avdSessionHostLocation": { - "value": "eastus2" - }, - "avdManagementPlaneLocation": { - "value": "eastus2" - }, - "avdWorkloadSubsId": { - "value": "" - }, - "avdEnterpriseAppObjectId": { - "value": "" - }, - "avdVmLocalUserName": { - "value": "" - }, - "avdVmLocalUserPassword": { - "reference": { - "keyVault": { - "id": "" - }, - "secretName": "" - } - }, - "avdIdentityServiceProvider": { - "value": "ADDS" - }, - "createIntuneEnrollment": { - "value": false - }, - "securityPrincipalId": { - "value": "" - }, - "securityPrincipalName": { - "value": "" - }, - "identityDomainName": { - "value": "none" - }, - "identityDomainGuid": { - "value": "" - }, - "avdDomainJoinUserName": { - "value": "none" - }, - "avdDomainJoinUserPassword": { - "reference": { - "keyVault": { - "id": "" - }, - "secretName": "" - } - }, - "avdOuPath": { - "value": "" - }, - "avdHostPoolType": { - "value": "Pooled" - }, - "hostPoolPreferredAppGroupType": { - "value": "Desktop" - }, - "avdPersonalAssignType": { - "value": "Automatic" - }, - "avdHostPoolLoadBalancerType": { - "value": "BreadthFirst" - }, - "hostPoolMaxSessions": { - "value": 8 - }, - "avdStartVmOnConnect": { - "value": true - }, - "avdHostPoolRdpProperties": { - "value": "audiocapturemode:i:1;audiomode:i:0;drivestoredirect:s:;redirectclipboard:i:1;redirectcomports:i:1;redirectprinters:i:1;redirectsmartcards:i:1;screen mode id:i:2" - }, - "avdDeployScalingPlan": { - "value": true - }, - "createAvdVnet": { - "value": true - }, - "existingVnetAvdSubnetResourceId": { - "value": "" - }, - "existingVnetPrivateEndpointSubnetResourceId": { - "value": "" - }, - "existingHubVnetResourceId": { - "value": "" - }, - "avdVnetworkAddressPrefixes": { - "value": "10.10.0.0/23" - }, - "vNetworkAvdSubnetAddressPrefix": { - "value": "10.10.0.0/24" - }, - "vNetworkPrivateEndpointSubnetAddressPrefix": { - "value": "10.10.1.0/27" - }, - "customDnsIps": { - "value": "" - }, - "deployPrivateEndpointKeyvaultStorage": { - "value": true - }, - "createPrivateDnsZones": { - "value": true - }, - "avdVnetPrivateDnsZoneFilesId": { - "value": "" - }, - "avdVnetPrivateDnsZoneKeyvaultId": { - "value": "" - }, - "vNetworkGatewayOnHub": { - "value": false - }, - "createAvdFslogixDeployment": { - "value": true - }, - "createMsixDeployment": { - "value": false - }, - "fslogixFileShareQuotaSize": { - "value": 1 - }, - "msixFileShareQuotaSize": { - "value": 1 - }, - "avdDeploySessionHosts": { - "value": true - }, - "deployGpuPolicies": { - "value": false - }, - "avdDeployMonitoring": { - "value": false - }, - "deployAlaWorkspace": { - "value": true - }, - "deployCustomPolicyMonitoring": { - "value": false - }, - "avdAlaWorkspaceDataRetention": { - "value": 90 - }, - "alaExistingWorkspaceResourceId": { - "value": "" - }, - "avdDeploySessionHostsCount": { - "value": 1 - }, - "avdSessionHostCountIndex": { - "value": 0 - }, - "availabilityZonesCompute": { - "value": true - }, - "zoneRedundantStorage": { - "value": false - }, - "avsetFaultDomainCount": { - "value": 2 - }, - "avsetUpdateDomainCount": { - "value": 5 - }, - "fslogixStoragePerformance": { - "value": "Premium" - }, - "msixStoragePerformance": { - "value": "Premium" - }, - "diskZeroTrust": { - "value": false - }, - "avdSessionHostsSize": { - "value": "Standard_D4ads_v5" - }, - "avdSessionHostDiskType": { - "value": "Premium_LRS" - }, - "enableAcceleratedNetworking": { - "value": true - }, - "securityType": { - "value": "TrustedLaunch" - }, - "secureBootEnabled": { - "value": true - }, - "vTpmEnabled": { - "value": true - }, - "avdOsImage": { - "value": "win11_22h2" - }, - "managementVmOsImage": { - "value": "winServer_2022_Datacenter_smalldisk_g2" - }, - "useSharedImage": { - "value": false - }, - "avdImageTemplateDefinitionId": { - "value": "" - }, - "storageOuPath": { - "value": "" - }, - "avdUseCustomNaming": { - "value": false - }, - "avdServiceObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-service-objects" - }, - "avdNetworkObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-network" - }, - "avdComputeObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-pool-compute" - }, - "avdStorageObjectsRgCustomName": { - "value": "rg-avd-app1-dev-use2-storage" - }, - "avdMonitoringRgCustomName": { - "value": "rg-avd-dev-use2-monitoring" - }, - "avdVnetworkCustomName": { - "value": "vnet-app1-dev-use2-001" - }, - "avdAlaWorkspaceCustomName": { - "value": "log-avd-app1-dev-use2" - }, - "avdVnetworkSubnetCustomName": { - "value": "snet-avd-app1-dev-use2-001" - }, - "privateEndpointVnetworkSubnetCustomName": { - "value": "snet-pe-app1-dev-use2-001" - }, - "avdNetworksecurityGroupCustomName": { - "value": "nsg-avd-app1-dev-use2-001" - }, - "privateEndpointNetworksecurityGroupCustomName": { - "value": "nsg-pe-app1-dev-use2-001" - }, - "avdRouteTableCustomName": { - "value": "route-avd-app1-dev-use2-001" - }, - "privateEndpointRouteTableCustomName": { - "value": "route-pe-app1-dev-use2-001" - }, - "avdApplicationSecurityGroupCustomName": { - "value": "asg-app1-dev-use2-001" - }, - "avdWorkSpaceCustomName": { - "value": "vdws-app1-dev-use2-001" - }, - "avdWorkSpaceCustomFriendlyName": { - "value": "App1 - Dev - East US 2 - 001" - }, - "avdHostPoolCustomName": { - "value": "vdpool-app1-dev-use2-001" - }, - "avdHostPoolCustomFriendlyName": { - "value": "App1 - Dev - East US 2 - 001" - }, - "avdScalingPlanCustomName": { - "value": "vdscaling-app1-dev-use2-001" - }, - "avdApplicationGroupCustomName": { - "value": "vdag-desktop-app1-dev-use2-001" - }, - "avdApplicationGroupCustomFriendlyName": { - "value": "Desktops - App1 - Dev - East US 2 - 001" - }, - "avdSessionHostCustomNamePrefix": { - "value": "vmapp1duse2" - }, - "avsetCustomNamePrefix": { - "value": "avail" - }, - "storageAccountPrefixCustomName": { - "value": "st" - }, - "fslogixFileShareCustomName": { - "value": "fslogix-pc-app1-dev-use2-001" - }, - "msixFileShareCustomName": { - "value": "msix-app1-dev-use2-001" - }, - "avdWrklKvPrefixCustomName": { - "value": "kv-sec" - }, - "ztDiskEncryptionSetCustomNamePrefix": { - "value": "des-zt" - }, - "ztManagedIdentityCustomName": { - "value": "id-zt" - }, - "ztKvPrefixCustomName": { - "value": "kv-key" - }, - "createResourceTags": { - "value": false - }, - "workloadNameTag": { - "value": "Contoso-Workload" - }, - "workloadTypeTag": { - "value": "Light" - }, - "dataClassificationTag": { - "value": "Non-business" - }, - "departmentTag": { - "value": "Contoso-AVD" - }, - "workloadCriticalityTag": { - "value": "Low" - }, - "workloadCriticalityCustomValueTag": { - "value": "Contoso-Critical" - }, - "applicationNameTag": { - "value": "Contoso-App" - }, - "workloadSlaTag": { - "value": "Contoso-SLA" - }, - "opsTeamTag": { - "value": "workload-admins@Contoso.com" - }, - "ownerTag": { - "value": "workload-owner@Contoso.com" - }, - "costCenterTag": { - "value": "Contoso-CC" - }, - "time": { - "value": "[utcNow()]" - }, - "enableTelemetry": { - "value": true - }, - "enableKvPurgeProtection": { - "value": true - } - } -} -``` \ No newline at end of file diff --git a/workload/docs/autoGenerated/deploy-custom-image.bicep.md b/workload/docs/autoGenerated/deploy-custom-image.bicep.md deleted file mode 100644 index 845806cac..000000000 --- a/workload/docs/autoGenerated/deploy-custom-image.bicep.md +++ /dev/null @@ -1,536 +0,0 @@ -# AVD Accelerator - Baseline Custom Image Deployment - -AVD Accelerator - Custom Image Baseline - -## Parameters - -Parameter name | Required | Description --------------- | -------- | ----------- -alertsActionGroupCustomName | No | Custom name for Action Group. -alertsDistributionGroup | No | Input the email distribution list for alert notifications when AIB builds succeed or fail. -applicationNameTag | No | Details about the application. -automationAccountCustomName | No | Custom name for the Automation Account. -buildSchedule | No | Determine whether to build the image template one time or check daily for a new marketplace image and auto build when found. (Default: Recurring) -costCenterTag | No | Cost center of owner team. (Default: Contoso-CC) -criticalityCustomTag | No | Tag value for custom criticality value. (Default: Contoso-Critical) -criticalityTag | No | criticality of each workload. (Default: Low) -customNaming | No | Determine whether to enable custom naming for the Azure resources. (Default: false) -dataClassificationTag | No | Sensitivity of data hosted (Default: Non-business) -departmentTag | No | Department that owns the deployment, (Dafult: Contoso-AVD) -deploymentLocation | No | Location to deploy the resources in this solution, except the image template. (Default: eastus) -enableMonitoringAlerts | No | Set to deploy monitoring and alerts for the build automation (Default: false). -enableResourceTags | No | Apply tags on resources and resource groups. (Default: false) -enableTelemetry | No | Enable usage and telemetry feedback to Microsoft. -environmentTag | No | Deployment environment of the application, workload. (Default: Dev) -existingLogAnalyticsWorkspaceResourceId | No | Existing Azure log analytics workspace resource ID to capture build logs. (Default: ) -existingSubnetName | No | Input the name of the subnet for the existing virtual network that the network interfaces on the build virtual machines will join. (Default: "") -existingVirtualNetworkResourceId | No | Input the resource ID for the existing virtual network that the network interfaces on the build virtual machines will join. (Default: "") -imageBuildNameTag | No | The name of workload for tagging purposes. (Default: AVD-Image) -imageDefinitionCustomName | No | Custom name for Image Definition. (Default: avd-win11-21h2) -imageDefinitionAcceleratedNetworkSupported | No | The image supports accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, greatly improving its networking performance. This high-performance path bypasses the host from the data path, which reduces latency, jitter, and CPU utilization for the most demanding network workloads on supported VM types. -imageDefinitionHibernateSupported | No | The image will support hibernation. -imageDefinitionSecurityType | No | Choose the Security Type of the Image Definition. (Default: Standard) -imageGalleryCustomName | No | Custom name for Image Gallery. (Default: gal_avd_use2_001) -imageTemplateCustomName | No | Custom name for Image Template. (Default: it-avd-win11-21h2) -imageVersionDisasterRecoveryLocation | No | Disaster recovery replication location for Image Version. (Default:"") -imageVersionPrimaryLocation | Yes | Primary replication location for Image Version. (Default:) -imageVersionStorageAccountType | No | Determine the Storage Account Type for the Image Version distributed by the Image Template. (Default: Standard_LRS) -logAnalyticsWorkspaceCustomName | No | Custom name for the Log Analytics Workspace. -logAnalyticsWorkspaceDataRetention | No | Set the data retention in the number of days for the Log Analytics Workspace. (Default: 30) -operatingSystemImage | No | AVD OS image source. (Default: win11-22h2) -operationsTeamTag | No | Team accountable for day-to-day operations. (Contoso-Ops) -ownerTag | No | Organizational owner of the AVD deployment. (Default: Contoso-Owner) -rdpShortPathManagedNetworks | No | Determine whether to enable RDP Short Path for Managed Networks. (Default: false) -resourceGroupCustomName | No | Custom name for Resource Group. (Default: rg-avd-use2-shared-services) -screenCaptureProtection | No | Determine whether to enable Screen Capture Protection. (Default: false) -sharedServicesSubId | Yes | AVD shared services subscription ID, multiple subscriptions scenario. -time | No | Do not modify, used to set unique value for resource deployment. -useExistingVirtualNetwork | No | Set to deploy Azure Image Builder to existing virtual network. (Default: false) -userAssignedManagedIdentityCustomName | No | Custom name for User Assigned Identity. (Default: id-avd) -workloadNameTag | No | Reference to the size of the VM for your workloads (Default: Contoso-Workload) - -### alertsActionGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for Action Group. - -- Default value: `ag-aib` - -### alertsDistributionGroup - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Input the email distribution list for alert notifications when AIB builds succeed or fail. - -### applicationNameTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Details about the application. - -- Default value: `Contoso-App` - -### automationAccountCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for the Automation Account. - -- Default value: `aa-avd` - -### buildSchedule - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Determine whether to build the image template one time or check daily for a new marketplace image and auto build when found. (Default: Recurring) - -- Default value: `Recurring` - -- Allowed values: `OneTime`, `Recurring` - -### costCenterTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Cost center of owner team. (Default: Contoso-CC) - -- Default value: `Contoso-CC` - -### criticalityCustomTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Tag value for custom criticality value. (Default: Contoso-Critical) - -- Default value: `Contoso-Critical` - -### criticalityTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -criticality of each workload. (Default: Low) - -- Default value: `Low` - -- Allowed values: `Low`, `Medium`, `High`, `Mission-critical`, `Custom` - -### customNaming - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Determine whether to enable custom naming for the Azure resources. (Default: false) - -- Default value: `False` - -### dataClassificationTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Sensitivity of data hosted (Default: Non-business) - -- Default value: `Non-business` - -- Allowed values: `Non-business`, `Public`, `General`, `Confidential`, `Highly Confidential` - -### departmentTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Department that owns the deployment, (Dafult: Contoso-AVD) - -- Default value: `Contoso-AVD` - -### deploymentLocation - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Location to deploy the resources in this solution, except the image template. (Default: eastus) - -- Default value: `eastus` - -- Allowed values: `australiaeast`, `australiasoutheast`, `brazilsouth`, `canadacentral`, `centralindia`, `centralus`, `eastasia`, `eastus`, `eastus2`, `francecentral`, `germanywestcentral`, `japaneast`, `jioindiawest`, `koreacentral`, `northcentralus`, `northeurope`, `norwayeast`, `qatarcentral`, `southafricanorth`, `southcentralus`, `southeastasia`, `switzerlandnorth`, `uaenorth`, `uksouth`, `ukwest`, `usgovarizona`, `usgoviowa`, `usgovtexas`, `usgovvirginia`, `westcentralus`, `westeurope`, `westus`, `westus2`, `westus3` - -### enableMonitoringAlerts - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Set to deploy monitoring and alerts for the build automation (Default: false). - -- Default value: `False` - -### enableResourceTags - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Apply tags on resources and resource groups. (Default: false) - -- Default value: `False` - -### enableTelemetry - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Enable usage and telemetry feedback to Microsoft. - -- Default value: `True` - -### environmentTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Deployment environment of the application, workload. (Default: Dev) - -- Default value: `Dev` - -- Allowed values: `Prod`, `Dev`, `Staging` - -### existingLogAnalyticsWorkspaceResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Existing Azure log analytics workspace resource ID to capture build logs. (Default: ) - -### existingSubnetName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Input the name of the subnet for the existing virtual network that the network interfaces on the build virtual machines will join. (Default: "") - -### existingVirtualNetworkResourceId - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Input the resource ID for the existing virtual network that the network interfaces on the build virtual machines will join. (Default: "") - -### imageBuildNameTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The name of workload for tagging purposes. (Default: AVD-Image) - -- Default value: `AVD-Image` - -### imageDefinitionCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for Image Definition. (Default: avd-win11-21h2) - -- Default value: `avd-win11-21h2` - -### imageDefinitionAcceleratedNetworkSupported - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The image supports accelerated networking. -Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, greatly improving its networking performance. -This high-performance path bypasses the host from the data path, which reduces latency, jitter, and CPU utilization for the -most demanding network workloads on supported VM types. - - -- Default value: `true` - -- Allowed values: `true`, `false` - -### imageDefinitionHibernateSupported - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -The image will support hibernation. - -- Default value: `false` - -- Allowed values: `true`, `false` - -### imageDefinitionSecurityType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Choose the Security Type of the Image Definition. (Default: Standard) - -- Default value: `Standard` - -- Allowed values: `Standard`, `TrustedLaunch`, `ConfidentialVM`, `ConfidentialVMSupported` - -### imageGalleryCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for Image Gallery. (Default: gal_avd_use2_001) - -- Default value: `gal_avd_use2_001` - -### imageTemplateCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for Image Template. (Default: it-avd-win11-21h2) - -- Default value: `it-avd-win11-22h2` - -### imageVersionDisasterRecoveryLocation - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Disaster recovery replication location for Image Version. (Default:"") - -### imageVersionPrimaryLocation - -![Parameter Setting](https://img.shields.io/badge/parameter-required-orange?style=flat-square) - -Primary replication location for Image Version. (Default:) - -### imageVersionStorageAccountType - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Determine the Storage Account Type for the Image Version distributed by the Image Template. (Default: Standard_LRS) - -- Default value: `Standard_LRS` - -- Allowed values: `Standard_LRS`, `Standard_ZRS` - -### logAnalyticsWorkspaceCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for the Log Analytics Workspace. - -- Default value: `log-avd` - -### logAnalyticsWorkspaceDataRetention - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Set the data retention in the number of days for the Log Analytics Workspace. (Default: 30) - -- Default value: `30` - -### operatingSystemImage - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -AVD OS image source. (Default: win11-22h2) - -- Default value: `win11_22h2` - -- Allowed values: `win10_21h2`, `win10_21h2_office`, `win10_22h2_g2`, `win10_22h2_office_g2`, `win11_21h2`, `win11_21h2_office`, `win11_22h2`, `win11_22h2_office`, `win11_23h2`, `win11_23h2_office` - -### operationsTeamTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Team accountable for day-to-day operations. (Contoso-Ops) - -- Default value: `workload-admins@Contoso.com` - -### ownerTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Organizational owner of the AVD deployment. (Default: Contoso-Owner) - -- Default value: `workload-owner@Contoso.com` - -### rdpShortPathManagedNetworks - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Determine whether to enable RDP Short Path for Managed Networks. (Default: false) - -- Default value: `False` - -### resourceGroupCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for Resource Group. (Default: rg-avd-use2-shared-services) - -- Default value: `rg-avd-use2-shared-services` - -### screenCaptureProtection - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Determine whether to enable Screen Capture Protection. (Default: false) - -- Default value: `False` - -### sharedServicesSubId - -![Parameter Setting](https://img.shields.io/badge/parameter-required-orange?style=flat-square) - -AVD shared services subscription ID, multiple subscriptions scenario. - -### time - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Do not modify, used to set unique value for resource deployment. - -- Default value: `[utcNow()]` - -### useExistingVirtualNetwork - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Set to deploy Azure Image Builder to existing virtual network. (Default: false) - -- Default value: `False` - -### userAssignedManagedIdentityCustomName - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Custom name for User Assigned Identity. (Default: id-avd) - -### workloadNameTag - -![Parameter Setting](https://img.shields.io/badge/parameter-optional-green?style=flat-square) - -Reference to the size of the VM for your workloads (Default: Contoso-Workload) - -- Default value: `Contoso-Workload` - -## Snippets - -### Parameter file - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "metadata": { - "template": "workload/bicep/deploy-custom-image.json" - }, - "parameters": { - "alertsActionGroupCustomName": { - "value": "ag-aib" - }, - "alertsDistributionGroup": { - "value": "" - }, - "applicationNameTag": { - "value": "Contoso-App" - }, - "automationAccountCustomName": { - "value": "aa-avd" - }, - "buildSchedule": { - "value": "Recurring" - }, - "costCenterTag": { - "value": "Contoso-CC" - }, - "criticalityCustomTag": { - "value": "Contoso-Critical" - }, - "criticalityTag": { - "value": "Low" - }, - "customNaming": { - "value": false - }, - "dataClassificationTag": { - "value": "Non-business" - }, - "departmentTag": { - "value": "Contoso-AVD" - }, - "deploymentLocation": { - "value": "eastus" - }, - "enableMonitoringAlerts": { - "value": false - }, - "enableResourceTags": { - "value": false - }, - "enableTelemetry": { - "value": true - }, - "environmentTag": { - "value": "Dev" - }, - "existingLogAnalyticsWorkspaceResourceId": { - "value": "" - }, - "existingSubnetName": { - "value": "" - }, - "existingVirtualNetworkResourceId": { - "value": "" - }, - "imageBuildNameTag": { - "value": "AVD-Image" - }, - "imageDefinitionCustomName": { - "value": "avd-win11-21h2" - }, - "imageDefinitionAcceleratedNetworkSupported": { - "value": "true" - }, - "imageDefinitionHibernateSupported": { - "value": "false" - }, - "imageDefinitionSecurityType": { - "value": "Standard" - }, - "imageGalleryCustomName": { - "value": "gal_avd_use2_001" - }, - "imageTemplateCustomName": { - "value": "it-avd-win11-22h2" - }, - "imageVersionDisasterRecoveryLocation": { - "value": "" - }, - "imageVersionPrimaryLocation": { - "value": "" - }, - "imageVersionStorageAccountType": { - "value": "Standard_LRS" - }, - "logAnalyticsWorkspaceCustomName": { - "value": "log-avd" - }, - "logAnalyticsWorkspaceDataRetention": { - "value": 30 - }, - "operatingSystemImage": { - "value": "win11_22h2" - }, - "operationsTeamTag": { - "value": "workload-admins@Contoso.com" - }, - "ownerTag": { - "value": "workload-owner@Contoso.com" - }, - "rdpShortPathManagedNetworks": { - "value": false - }, - "resourceGroupCustomName": { - "value": "rg-avd-use2-shared-services" - }, - "screenCaptureProtection": { - "value": false - }, - "sharedServicesSubId": { - "value": "" - }, - "time": { - "value": "[utcNow()]" - }, - "useExistingVirtualNetwork": { - "value": false - }, - "userAssignedManagedIdentityCustomName": { - "value": "" - }, - "workloadNameTag": { - "value": "Contoso-Workload" - } - } -} -``` From fcf8f803725ada40ec2c1dd29e85feedbb9c6aa8 Mon Sep 17 00:00:00 2001 From: Dany Contreras <78437433+danycontre@users.noreply.github.com> Date: Fri, 19 Jan 2024 11:01:46 -0600 Subject: [PATCH 2/2] updates --- workload/docs/autoGenerated/deploy-baseline.bicep.md | 0 workload/docs/autoGenerated/deploy-custom-image.bicep.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 workload/docs/autoGenerated/deploy-baseline.bicep.md create mode 100644 workload/docs/autoGenerated/deploy-custom-image.bicep.md diff --git a/workload/docs/autoGenerated/deploy-baseline.bicep.md b/workload/docs/autoGenerated/deploy-baseline.bicep.md new file mode 100644 index 000000000..e69de29bb diff --git a/workload/docs/autoGenerated/deploy-custom-image.bicep.md b/workload/docs/autoGenerated/deploy-custom-image.bicep.md new file mode 100644 index 000000000..e69de29bb