Role Configuration

Get an overview of parameters of the role configuration when deploying on a Windows Server

You use the role configuration file (role.cscfg) when deploying on Windows Servers with the AzureBlobSync tool.

Example:

<ServiceConfiguration xmlns="http://schemas.microsoft.com/ServiceHosting/2008/10/ServiceConfiguration">
	<Role name="Composite.WindowsAzure.WebRole.SimpleBoot">
		<ConfigurationSettings>
			<Setting name="WebRole.DisplayName" value="Website in US" />
			<Setting name="WebRole.Blob.ContainerName" value="deployment-20160501" />
			<Setting name="WebRole.Blob.ConnectionString" value="DefaultEndpointsProtocol=https;AccountName=orckestracmssites;AccountKey=zPIELz1YoHySxoKju6ZUQhfc7UlRAACrs8K8QScpL9CvS8atWBBLeBd0DcExiB5xyz5l0SevisNVgjSN/iRKOw==" />
			<Setting name="WebRole.Iis.AppPoolIdleTimeoutMinutes" value="60" />
			<Setting name="WebRole.Blob.UpdateCheckSleepInMilliSeconds" value="5000" />
			<Setting name="WebRole.Manager.RollingUpdate" value="true" />
			<Setting name="WebRole.Manager.RollingUpdateIntervalInSeconds" value="30" />
		</ConfigurationSettings>
		<Certificates></Certificates>
	</Role>
</ServiceConfiguration>

The following is the overview of all the available parameters:

ServiceConfiguration

ParameterDescriptionValue
xmlnsXML namespacehttp://schemas.microsoft.com/ServiceHosting/2008/10/ServiceConfiguration


Example:

<ServiceConfiguration serviceName="Composite.WindowsAzure.Package" 
xmlns="http://schemas.microsoft.com/ServiceHosting/2008/10/ServiceConfiguration" osFamily="4" 
osVersion="*" schemaVersion="2014-01.2.3">
<!-- ... -->
</ServiceConfiguration>

Role

ParameterDescriptionValue
nameThe programmatic name of the role on a server.[filled in automatically]


Example:

<Role name="Composite.WindowsAzure.WebRole.SimpleBoot">
<!-- ... -->
</Role>


Configuration Settings (WebRole, WebRole.Blob)

ParameterDescriptionValue
DisplayNameThe name of the role on a specific server. Used in a scaled out website deployment to distinguish between the same role running on various servers.[e.g. 'Role - North Europe']
ContainerNameThe name of the role deployment. The name also used as the name for the deployment container in a blob storage.[e.g. 'deployment']
ConnectionStringThe string used to connect to a blob storage. Includes the blob storage account name {ACCOUNT_NAME} and access key {KEY}. Used to store deployment files (in a deployment container) and website files (in a data/website container).[e.g. 'DefaultEndpointsProtocol=https;AccountName=orckestracmssites;AccountKey={primary_access_key}']
UpdateCheckSleepInMilliSeconds [e.g. 5000]


Example:

<Setting name="WebRole.DisplayName" value="{DISPLAY_NAME}" />
<Setting name="WebRole.Blob.ContainerName" value="{DEPLOYMENT_NAME}" />
<Setting name="WebRole.Blob.ConnectionString" 
value="DefaultEndpointsProtocol=https;AccountName={ACCOUNT_NAME};AccountKey={KEY}" />
<Setting name="WebRole.Blob.UpdateCheckSleepInMilliSeconds" value="5000" />

Configuration Settings (WebRole.Iis, WebRole.Manager)

ParameterDescriptionValue
AppPoolIdleTimeoutMinutesThe application pool's idle timeout (in minutes). 60 by default.[e.g. 60]
RollingUpdateIndicates whether website instances on multiple-server deployments must be updated consecutively with a certain interval. 'true' by default.[e.g. 'true']
RollingUpdateIntervalInSecondsThe interval (in seconds) between website instance updates on multiple-server deployments provided that the rolling update is enabled.[e.g. 30]


Example:

<Setting name="WebRole.Iis.AppPoolIdleTimeoutMinutes" value="60" />
<Setting name="WebRole.Manager.RollingUpdate" value="true" />
<Setting name="WebRole.Manager.RollingUpdateIntervalInSeconds" value="30" />