Skip to content

deploy-custom-image.bicep.md

Latest commit

 

History

History
566 lines (380 loc) · 19.6 KB

deploy-custom-image.bicep.md

File metadata and controls

566 lines (380 loc) · 19.6 KB

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-23h2)
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-23h2)
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)
mpImageOffer No Market place AVD OS image offer. (Default: Office-365)
mpImageSku No Market place AVD OS image SKU. (Default: win11-24h2-avd-m365)
mpImagePublisher No Market place AVD OS image publisher.
mpImageVersion No Market place AVD OS image version.
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

Custom name for Action Group.

  • Default value: ag-aib

alertsDistributionGroup

Parameter Setting

Input the email distribution list for alert notifications when AIB builds succeed or fail.

applicationNameTag

Parameter Setting

Details about the application.

  • Default value: Contoso-App

automationAccountCustomName

Parameter Setting

Custom name for the Automation Account.

  • Default value: aa-avd

buildSchedule

Parameter Setting

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

Cost center of owner team. (Default: Contoso-CC)

  • Default value: Contoso-CC

criticalityCustomTag

Parameter Setting

Tag value for custom criticality value. (Default: Contoso-Critical)

  • Default value: Contoso-Critical

criticalityTag

Parameter Setting

criticality of each workload. (Default: Low)

  • Default value: Low

  • Allowed values: Low, Medium, High, Mission-critical, Custom

customNaming

Parameter Setting

Determine whether to enable custom naming for the Azure resources. (Default: false)

  • Default value: False

dataClassificationTag

Parameter Setting

Sensitivity of data hosted (Default: Non-business)

  • Default value: Non-business

  • Allowed values: Non-business, Public, General, Confidential, Highly Confidential

departmentTag

Parameter Setting

Department that owns the deployment, (Dafult: Contoso-AVD)

  • Default value: Contoso-AVD

deploymentLocation

Parameter Setting

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

Set to deploy monitoring and alerts for the build automation (Default: false).

  • Default value: False

enableResourceTags

Parameter Setting

Apply tags on resources and resource groups. (Default: false)

  • Default value: False

enableTelemetry

Parameter Setting

Enable usage and telemetry feedback to Microsoft.

  • Default value: True

environmentTag

Parameter Setting

Deployment environment of the application, workload. (Default: Dev)

  • Default value: Dev

  • Allowed values: Prod, Dev, Staging

existingLogAnalyticsWorkspaceResourceId

Parameter Setting

Existing Azure log analytics workspace resource ID to capture build logs. (Default: )

existingSubnetName

Parameter Setting

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

Input the resource ID for the existing virtual network that the network interfaces on the build virtual machines will join. (Default: "")

imageBuildNameTag

Parameter Setting

The name of workload for tagging purposes. (Default: AVD-Image)

  • Default value: AVD-Image

imageDefinitionCustomName

Parameter Setting

Custom name for Image Definition. (Default: avd-win11-23h2)

  • Default value: avd-win11-23h2

imageDefinitionAcceleratedNetworkSupported

Parameter Setting

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

imageDefinitionHibernateSupported

Parameter Setting

The image will support hibernation.

  • Default value: False

imageDefinitionSecurityType

Parameter Setting

Choose the Security Type of the Image Definition. (Default: Standard)

  • Default value: Standard

  • Allowed values: Standard, TrustedLaunch, ConfidentialVM, ConfidentialVMSupported

imageGalleryCustomName

Parameter Setting

Custom name for Image Gallery. (Default: gal_avd_use2_001)

  • Default value: gal_avd_use2_001

imageTemplateCustomName

Parameter Setting

Custom name for Image Template. (Default: it-avd-win11-23h2)

  • Default value: it-avd-win11-23h2

imageVersionDisasterRecoveryLocation

Parameter Setting

Disaster recovery replication location for Image Version. (Default:"")

imageVersionPrimaryLocation

Parameter Setting

Primary replication location for Image Version. (Default:)

imageVersionStorageAccountType

Parameter Setting

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

Custom name for the Log Analytics Workspace.

  • Default value: log-avd

logAnalyticsWorkspaceDataRetention

Parameter Setting

Set the data retention in the number of days for the Log Analytics Workspace. (Default: 30)

  • Default value: 30

mpImageOffer

Parameter Setting

Market place AVD OS image offer. (Default: Office-365)

  • Default value: Office-365

mpImageSku

Parameter Setting

Market place AVD OS image SKU. (Default: win11-24h2-avd-m365)

  • Default value: win11-24h2-avd-m365

mpImagePublisher

Parameter Setting

Market place AVD OS image publisher.

  • Default value: MicrosoftWindowsDesktop

mpImageVersion

Parameter Setting

Market place AVD OS image version.

  • Default value: latest

operationsTeamTag

Parameter Setting

Team accountable for day-to-day operations. (Contoso-Ops)

  • Default value: workload-admins@Contoso.com

ownerTag

Parameter Setting

Organizational owner of the AVD deployment. (Default: Contoso-Owner)

  • Default value: workload-owner@Contoso.com

rdpShortPathManagedNetworks

Parameter Setting

Determine whether to enable RDP Short Path for Managed Networks. (Default: false)

  • Default value: False

resourceGroupCustomName

Parameter Setting

Custom name for Resource Group. (Default: rg-avd-use2-shared-services)

  • Default value: rg-avd-use2-shared-services

screenCaptureProtection

Parameter Setting

Determine whether to enable Screen Capture Protection. (Default: false)

  • Default value: False

sharedServicesSubId

Parameter Setting

AVD shared services subscription ID, multiple subscriptions scenario.

time

Parameter Setting

Do not modify, used to set unique value for resource deployment.

  • Default value: [utcNow()]

useExistingVirtualNetwork

Parameter Setting

Set to deploy Azure Image Builder to existing virtual network. (Default: false)

  • Default value: False

userAssignedManagedIdentityCustomName

Parameter Setting

Custom name for User Assigned Identity. (Default: id-avd)

workloadNameTag

Parameter Setting

Reference to the size of the VM for your workloads (Default: Contoso-Workload)

  • Default value: Contoso-Workload

Snippets

Parameter file

{
    "$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-23h2"
        },
        "imageDefinitionAcceleratedNetworkSupported": {
            "value": true
        },
        "imageDefinitionHibernateSupported": {
            "value": false
        },
        "imageDefinitionSecurityType": {
            "value": "Standard"
        },
        "imageGalleryCustomName": {
            "value": "gal_avd_use2_001"
        },
        "imageTemplateCustomName": {
            "value": "it-avd-win11-23h2"
        },
        "imageVersionDisasterRecoveryLocation": {
            "value": ""
        },
        "imageVersionPrimaryLocation": {
            "value": ""
        },
        "imageVersionStorageAccountType": {
            "value": "Standard_LRS"
        },
        "logAnalyticsWorkspaceCustomName": {
            "value": "log-avd"
        },
        "logAnalyticsWorkspaceDataRetention": {
            "value": 30
        },
        "mpImageOffer": {
            "value": "Office-365"
        },
        "mpImageSku": {
            "value": "win11-24h2-avd-m365"
        },
        "mpImagePublisher": {
            "value": "MicrosoftWindowsDesktop"
        },
        "mpImageVersion": {
            "value": "latest"
        },
        "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"
        }
    }
}