Add Files to your Windows Azure Package using Role Content Folders

Windows Azure applications often need to package and deploy additional content.  This could be advanced configuration files such as the diagnostics.wadcfg for the Diagnostics plugin.  It could also be scripts and binaries that modify the virtual machine to which a role is deployed, such as installing additional runtime components.  In any case, prior to the June 2012 (1.7) release of the Windows Azure Tools for Visual Studio, there were few direct ways to get this content into a package and deployed to Windows Azure. 

One of the most common ways to package and deploy additional content to Windows Azure was to add the content to one of the role projects and set its Build Action to Content.  On build (e.g. when creating a package or publishing to Windows Azure), the content would be copied to the role project’s output directory and subsequently picked up during packaging.  There are some downsides to this approach, however.  First, depending on the type of role (i.e. web or worker), the content could end up deployed to different locations, either in the role’s APPROOT directory or a bin subdirectory.  Any component which uses this content on the virtual machine must account for that inconsistency.  Second, the approach tends to pollute role projects with Azure-specific files when they might otherwise be platform agnostic.  (For example, a web application that can function on-premise as well as a web role in Windows Azure.)  In other words, they simply do not belong in the role projects.

The June 2012 (1.7) release introduces a new feature of Windows Azure projects: Role Content Folders.  Role Content Folders are nodes within Solution Explorer to which you can add new or existing files and folders.  These files will then be automatically added to the package and deployed to a consistent location on the virtual machine.  The role node itself is a Role Content Folder; it represents the role’s root directory and files added to that node will be deployed to the APPROOT directory.  Files added to folders added to the role node will be packaged and deployed in the same relative hierarchy.

To add a file, simply select the role node, right-click, and choose on of the commands from the Add submenu.

 

 

Note that the only item templates we include are for basic text and XML files.

 

Once added to a Role Content Folder, files and folders operate like any other you might find in a standard Visual Studio project.  They can be added, removed, and renamed, and are also source code controlled.  In this example, I’ve added two files to the web role, one directly to the web role node (i.e. APPROOT) and another in a subfolder.

The following two screenshots are of the application folder for one of the web role instances.  In them you can see the two files deployed to the same relative hierarchy as in the Windows Azure project.  That’s all it takes to package arbitrary role content!

You might be wondering how this all works.  This new feature is actually based on an existing capability of the Windows Azure SDK.  Since version 1.5 the Windows Azure SDK has supported the Contents element in the service definition that indicates additional folders to include in the package and deploy to the virtual machine.  The Tools simply did not have any tooling around this capability…until now.  During packaging, the Tools will identify project content within Role Content Folders and inject the appropriate elements into the service definition so that CSPack will insert that content into the package.

Note: Be careful of how you name content in a Role Content Folder.  Because this content is deployed to the role’s APPROOT directory—the same directory in which the role is deployed—there is the possibility of file name collisions.  Be sure to use filenames in your Azure project that are unlikely to conflict with files belonging to the role project itself.

Comments

• Anonymous
  April 15, 2014
  This is a great write up and I managed to get the new files added into my deployment and they appear in my APPROOT directory but I am using a web role and would like them to appear in my sitesroot folder as well. All files seem to get copied to the sitesroot folder except the ones uploaded via this method. Do you know if there is something I am missing to get them to copy over to the sitesroot folder?