Skip to content

readme.md

Latest commit

 

History

History
147 lines (127 loc) · 5.97 KB

readme.md

File metadata and controls

147 lines (127 loc) · 5.97 KB

PowerShell and Azure CLI deployments

AVD Accelerator Baseline

Full Parameter Details

A full list of parameter details can be found for the relevant deployment type here:

PowerShell

Connect-AzAccount
#
$SubID = "<subscription-ID>"
$avdVmLocalUserPassword = Read-Host -Prompt "Local user password" -AsSecureString
#
Select-AzSubscription -SubscriptionId $SubID
New-AzSubscriptionDeployment `
  -Name "AVDAcceleratorDeployment" `
  -Location "<deployment-location>" `
  -TemplateFile "./workload/bicep/deploy-baseline.bicep" `
  -avdWorkloadSubsId $SubID `
  -avdSessionHostLocation "<session-host-location>" `
  -avdManagementPlaneLocation "<management-plane-location>" `
  -avdVmLocalUserName "<local-username>" `
  -avdVmLocalUserPassword $avdVmLocalUserPassword `
  -avdIdentityServiceProvider "EntraIDKerberos" `
  -identityDomainName "<domain-name>" `
  -avdServicePrincipalObjectId "<object-id>" `
  -avdSecurityGroups @(@{objectId="00000000-0000-0000-0000-000000000000"; displayName="Example-Security-Group"}) `
  -avdVnetworkAddressPrefixes "10.10.0.0/16" `
  -vNetworkAvdSubnetAddressPrefix "10.10.1.0/24" `
  -vNetworkPrivateEndpointSubnetAddressPrefix "10.10.2.0/27"

Note: above PowerShell deployment sample, deploys AVD with most of the default options in the AVD LZA using Entra ID Kerberos as identity provider and deploying new virtual network.

Azure CLI

az login
#
$SubID = "<subscription-ID>"
$avdVmLocalUserPassword = Read-Host -Prompt "Local user password" -AsSecureString
#
az account set --subscription "$SubID"
az deployment sub create `
--name "AVDAcceleratorDeployment" `
--location "<deployment-location>" `
--template-file "./workload/bicep/deploy-baseline.bicep" `
--parameters `
  avdWorkloadSubsId "$SubID" `
  avdSessionHostLocation "<session-host-location>" `
  avdManagementPlaneLocation "<management-plane-location>" `
  avdVmLocalUserName "<local-username>" `
  avdVmLocalUserPassword "$avdVmLocalUserPassword" `
  avdIdentityServiceProvider "EntraIDKerberos" `
  identityDomainName "<domain-name>" `
  avdServicePrincipalObjectId "<object-id>" `
  avdSecurityGroups @(@{objectId="00000000-0000-0000-0000-000000000000"; displayName="Example-Security-Group"}) `
  avdVnetworkAddressPrefixes "10.10.0.0/16" `
  vNetworkAvdSubnetAddressPrefix "10.10.1.0/24" `
  vNetworkPrivateEndpointSubnetAddressPrefix "10.10.2.0/27"

Note: above AZ CLI deployment sample, deploys AVD with most of the default options in the AVD LZA using Entra ID Kerberos as identity provider and deploying new virtual network.

Optional: Custom Image Build deployment

PowerShell

Connect-AzAccount
#
$SubID = "<subscription-ID>"
#
Select-AzSubscription -SubscriptionId $SubID
New-AzDeployment `
  -Location "<deployment-location>" `
  -TemplateFile "./workload/bicep/deploy-custom-image.bicep" `
  -Name "CustomImageDeployment" `
  -SubscriptionId $SubID `
  -sharedServicesSubId "<shared-services-subscription-id>" `
  -deploymentLocation "<deployment-location>" `
  -imageVersionPrimaryLocation "<primary-location>" `
  -mpImagePublisher "<image-publisher>" `
  -mpImageOffer "<image-offer>" `
  -mpImageSku "<image-sku>" `
  -mpImageVersion "latest" `
  -userAssignedManagedIdentityCustomName "<managed-identity-name>" `
  -enableMonitoringAlerts $false `
  -enableResourceTags $false `
  -enableTelemetry $true

Azure CLI

az login
#
$SubID = "<subscription-ID>"
#
az account set --subscription "$SubID"
az deployment sub create `
  --name "CustomImageDeployment" `
  --location "<deployment-location>" `
  --template-file "./workload/bicep/deploy-custom-image.bicep" `
  --parameters `
    subscriptionId "$SubID" `
    sharedServicesSubId "<shared-services-subscription-id>" `
    deploymentLocation "<deployment-location>" `
    imageVersionPrimaryLocation "<primary-location>" `
    mpImagePublisher "<image-publisher>" `
    mpImageOffer "<image-offer>" `
    mpImageSku "<image-sku>" `
    mpImageVersion "latest" `
    userAssignedManagedIdentityCustomName "<managed-identity-name>" `
    enableMonitoringAlerts false `
    enableResourceTags false `
    enableTelemetry true

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Reporting issues

Microsoft Support is not yet handling issues for any published tools in this repository. However, we would like to welcome you to open issues using GitHub issues to collaborate and improve these tools.