VMRole Gallery Item – Lync Server 2013

This post is part of a series for the Building Clouds Blog Gallery Items for Collaboration Workloads.  For more information see the following Table of Contents post – https://aka.ms/bcbgicw.


The Lync Server 2013 gallery resource enables a service provider or enterprise administrator to publish a gallery item for tenants to deploy Lync Server 2013 on Windows Server 2012.


Download the Lync Server 2013 CU2 Windows Azure Pack Virtual Machine Role Gallery Item



This item does not include Active Directory which is required by Lync or an Enterprise Root Certificate Authority to provide certificates to the Lync server. You might consider the Domain Controller VMRole published to the Service Models WebPI Feed, to also publish in your environment.   For more information see the page below in reference to the Web Platform Installer.  You can manually add the Certificate Authority role to the VM after it provisions or add a post-install script to the VMRole if you are comfortable with that.

Downloading and Installing Windows Azure Pack Gallery Resource

This item has required post-installation tasks.  After the VMRole is online, the following tasks need to be completed.

  • Launch the topology builder and update the friendly URLs.  Republish the topology.

This VMRole Gallery Item is loosely based on work we completed regarding a Service Template for the same workload.  For more information see the following post.

Introducing Lync Service Templates


In order to publish the gallery resources as a gallery item, you must

  1. Add application payload content to the resource extension package.
  2. Import the resource extension package into System Center Virtual Machine Manager.
  3. Ensure the virtual hard disk for the operating system is properly prepared and has all the necessary properties set.
  4. Import the resource definition package as a gallery item.
  5. Make the gallery item public and add it to a plan.

Application Payload

Before importing the resource extension package, you must complete the modifications below.

File copy

Edit the resource extension file and copy the prerequisite installers in to the application payload folder.  If this is the first time you have imported content in to a resource extension and you would like additional information, a more detailed guide to this process is also linked below.

  1. Open the ResExtPkg file by renaming it and adding .zip.
  2. Open the folder src.
  3. Open the folder LyncInstallScript.
    1. Open the folder LyncServer2013.
      1. Copy the Lync Server 2013 installation files in to this folder.
    2. Open the folder prereqs.
      1. Copy the downloaded Silverlight install file in to this folder.
  4. When finished, remove the .zip file extension.

Detailed guidance.

Windows Azure Pack VMRole Gallery Items for Collaboration Workloads


The content required as application payload can be downloaded from the following sites.

Lync Server 2013
Download the ISO from the volume licensing website or from an MSDN subscription.

Microsoft Silverlight

System Center Virtual Machine Manager

In order to use a gallery resource, you must take the following actions in System Center Virtual Machine Manager.

Import Resource Extension Package

Using PowerShell, you must import the resource extension package into the virtual machine manager library.

Sample Windows PowerShell

$libsharepath = <you must set the library sharepath from your environment> 
$resextpkg = “<pathtofile>\LyncServer2013.resextpkg” 
Import-CloudResourceExtension –ResourceExtensionPath $resextpkg  –SharePath $libsharepath –Description “Lync Server 2013”

The import can only be done using PowerShell.

To verify the import, run the get-CloudResourceExtension PowerShell command and locate the newly imported extension.


Prepare the virtual hard disk – Operating System template

A virtual hard disk containing a sysprepped version of one of the available editions of Windows Server 2012 must be added to a SCVMM library share.

Note that one of the Features that needs to be enabled for this image is .NET 3.5  For more information on adding .NET 3.5 to an offline VHD using the Roles and Features wizard in Windows Server 2012 R2, see the following Technet article.

Install or Uninstall Roles, Role Services, or Features

Set Virtual Hard Disk Properties

You must provide a virtual hard disk from which the virtual machine role will be created. You may have a virtual hard disk used in other virtual machine creations that will work for this gallery resource.

Operating System

The virtual hard disk must be sysprepped and contain a valid Windows Server 2012 operating system.

Since this resource extension will only work with Windows Server 2012, use one of the following operating system values on your Windows Server 2012 virtual hard disks.

  • 64-bit edition of Windows Server 2012 Datacenter
  • 64-bit edition of Windows Server 2012 Standard

Sample PowerShell

$myVHD = <you must set to the virtual hard disk in your environment> 
$WS2012Datacenter = Get-SCOperatingSystem | where { $_.name –eq “64-bit edition of Windows Server 2012 Datacenter” } 
Set-scvirtualharddisk –virtualharddisk $myVHD –OperatingSystem $WS2012Datacenter

The Operating System value can be set using PowerShell or the Virtual Machine Manager Administrator Console.

FamilyName and Release

The FamilyName and Release properties of the virtual hard disk must be set in order for the Windows Azure Pack portal to display the virtual hard disk as an available disk for this gallery resource. The FamilyName and Release properties are shown in the portal drop-down list, so set them to values that will make sense to your user.


FamilyName property values should indicate the contents of the virtual hard disk, including the Windows Server release and edition. For this gallery resource, you should consider the following FamilyName values.

  • Windows Server 2012 Datacenter
  • Windows Server 2012 Standard

Release property values must conform to the Windows Azure versioning scheme of n.n.n.n

  • etc

Sample PowerShell

$myVHD = <you must get the virtual hard disk in your environment> 
Set-SCVirtualHardDisk –VirtualHardDisk $myVHD –FamilyName “Windows Server 2012 Standard” 
” –Release “”

FamilyName and Release values can be set using PowerShell or the Virtual Machine Manager Administrator Console.


This gallery resource depends on a virtual hard disk with the following tags.

  • WindowsServer2012
  • R1

Sample PowerShell

$myVHD = <you must set to the virtual hard disk in your environment> 
Set-SCVirtualHardDisk –virtualharddisk $myVHD –Tag “WindowsServer2012”,”R1”

The tag property can only be set using PowerShell.

Windows Azure Pack Service Administrator Portal

Once the resource extension and virtual hard disk are all correctly set in SCVMM, you can import the resource definition package using the Service Administrator Portal in the Windows Azure Pack.

Import Resource Definition Package

  1. Open the Service Admin Portal.
  2. Navigate to the VM Clouds workspace.
  3. Click the Gallery tab.
  4. Import.
  5. Select and import the LyncServer2013.resdefpkg file in the unzipped location.
  6. Note that the gallery item now is listed on the Gallery tab.

Now that the packages for the Virtual Machine Role have been installed, you can publish the gallery item to make it available to tenants.

Publish gallery item and add to a plan

To make the Virtual Machine Role available to the tenant, you need to add it to a plan. In this procedure, you publish the Virtual Machine Role that you installed.

To publish the gallery item

  1. On the Gallery tab, select the version of the gallery item that you just imported.
  2. Click the arrow next to the gallery item name.
  3. Explore the details of the gallery item.
  4. Navigate back and click Make Public.
  5. Select the Plans workspace in the Service Admin Portal.
  6. Select the plan to which you want to add this gallery item.
  7. Select the Virtual Machine Clouds service.
  8. Scroll to the Gallery section.
  9. Click Add Gallery Items.
  10. Select the gallery items that you imported, and then click Save.

The Virtual Machine Role is now available to the tenant as part of the selected plan.

Deployment settings

When deploying this virtual machine role, the user must provide values for the following settings

  • Name – Sets the name of the object that will appear in the WAP interface to represent the service.
  • Local Administrator Credential – Type the password for the Administrator account that will be used inside the virtual machine for the local operating system.
  • Domain Name – The FQDN of the existing Active Directory environment that the VM will join.
  • Run As Credentials – The domain\account and password that will be used to join the domain and install Lync. This also means the account will require permissions to extend the Active Directory schema.


When complete, log in as a test admin and construct the prerequisites in the environment including a network, domain controller including a DNS server, and add the DNS client settings to the network.  Then deploy the Lync gallery item.  Console connect to the resulting VM and perform post-installation tasks.image

This gallery item may be combined with the other Building Clouds Blog Gallery Items and the Sample VMRole Packages to construct a collaboration environment.

Stay tuned to the Building Clouds Blog!