Azure 云服务（外延支持）定义 WorkerRole 架构

项目
08/09/2024

Azure 辅助角色对普通开发非常有用，可为 web 角色执行后台处理。

服务定义文件的默认扩展名为 csdef。

辅助角色的基本服务定义架构。

对于包含辅助角色的服务定义文件，其基本格式如下所示。

<ServiceDefinition …>
  <WorkerRole name="<worker-role-name>" vmsize="<worker-role-size>" enableNativeCodeExecution="[true|false]">
    <Certificates>
      <Certificate name="<certificate-name>" storeLocation="[CurrentUser|LocalMachine]" storeName="[My|Root|CA|Trust|Disallow|TrustedPeople|TrustedPublisher|AuthRoot|AddressBook|<custom-store>" />
    </Certificates>
    <ConfigurationSettings>
      <Setting name="<setting-name>" />
    </ConfigurationSettings>
    <Endpoints>
      <InputEndpoint name="<input-endpoint-name>" protocol="[http|https|tcp|udp]" localPort="<local-port-number>" port="<port-number>" certificate="<certificate-name>" loadBalancerProbe="<load-balancer-probe-name>" />
      <InternalEndpoint name="<internal-endpoint-name" protocol="[http|tcp|udp|any]" port="<port-number>">
         <FixedPort port="<port-number>"/>
         <FixedPortRange min="<minimum-port-number>" max="<maximum-port-number>"/>
      </InternalEndpoint>
     <InstanceInputEndpoint name="<instance-input-endpoint-name>" localPort="<port-number>" protocol="[udp|tcp]">
         <AllocatePublicPortFrom>
            <FixedPortRange min="<minimum-port-number>" max="<maximum-port-number>"/>
         </AllocatePublicPortFrom>
      </InstanceInputEndpoint>
    </Endpoints>
    <Imports>
      <Import moduleName="[RemoteAccess|RemoteForwarder|Diagnostics]"/>
    </Imports>
    <LocalResources>
      <LocalStorage name="<local-store-name>" cleanOnRoleRecycle="[true|false]" sizeInMB="<size-in-megabytes>" />
    </LocalResources>
    <LocalStorage name="<local-store-name>" cleanOnRoleRecycle="[true|false]" sizeInMB="<size-in-megabytes>" />
    <Runtime executionContext="[limited|elevated]">
      <Environment>
         <Variable name="<variable-name>" value="<variable-value>">
            <RoleInstanceValue xpath="<xpath-to-role-environment-settings>"/>
          </Variable>
      </Environment>
      <EntryPoint>
         <NetFxEntryPoint assemblyName="<name-of-assembly-containing-entrypoint>" targetFrameworkVersion="<.net-framework-version>"/>
         <ProgramEntryPoint commandLine="<application>" setReadyOnProcessStart="[true|false]"/>
      </EntryPoint>
    </Runtime>
    <Startup priority="<for-internal-use-only>">
      <Task commandLine="" executionContext="[limited|elevated]" taskType="[simple|foreground|background]">
        <Environment>
         <Variable name="<variable-name>" value="<variable-value>">
            <RoleInstanceValue xpath="<xpath-to-role-environment-settings>"/>
          </Variable>
        </Environment>
      </Task>
    </Startup>
    <Contents>
      <Content destination="<destination-folder-name>" >
        <SourceDirectory path="<local-source-directory>" />
      </Content>
    </Contents>
  </WorkerRole>
</ServiceDefinition>

架构元素

服务定义文件包括以下元素，本文中的后续部分将对其进行详细说明：

WorkerRole

ConfigurationSettings

InstanceInputEndpoint

AllocatePublicPortFrom

WorkerRole

WorkerRole 元素描述一个对普通开发非常有用并且可为 web 角色执行后台处理的角色。一个服务可能包含零个或多个辅助角色。

下表介绍了 WorkerRole 元素的属性。

Attribute	类型	说明
name	字符串	必需。辅助角色的名称。该角色的名称必须唯一。
enableNativeCodeExecution	布尔值	可选。默认值是 `true`默认启用本机代码执行和完全信任。将此属性设置为 `false`，可禁用辅助角色的本机代码执行，并改为使用 Azure 部分信任。
vmsize	字符串	可选。设置此值可更改分配给此角色的虚拟机的大小。默认值是 `Small`。有关可能的虚拟机大小及其属性的列表，请参阅云服务的虚拟机大小。

ConfigurationSettings

ConfigurationSettings 元素描述辅助角色的配置设置集。此元素是 Setting 元素的父级。

设置

Setting 元素描述用于为角色实例指定配置设置的名称和值对。

下表介绍了 Setting 元素的属性。

Attribute	类型	说明
name	字符串	必需。配置设置的唯一名称。

角色的配置设置是在服务定义文件中声明并在服务配置文件中设置的名称-值对。

LocalResources

LocalResources 元素描述辅助角色的本地存储资源集。此元素是 LocalStorage 元素的父级。

LocalStorage

LocalStorage 元素标识用于在运行时为服务提供文件系统空间的本地存储资源。一个角色可以定义零个或多个本地存储资源。

注意

LocalStorage 元素可显示为 WorkerRole 元素的子级，提供与早期版本的 Azure SDK 的兼容性。

下表介绍了 LocalStorage 元素的属性。

Attribute	类型	说明
name	字符串	必需。本地存储的唯一名称。
cleanOnRoleRecycle	布尔值	可选。指示重启角色时是否应清理本地存储。默认值为 `true`。
sizeInMb	int	可选。需要为本地存储分配的存储空间量，以 MB 为单位。如果未指定，则分配的默认存储空间为 100 MB。可分配的最小存储空间量为 1 MB。最大的本地资源大小取决于虚拟机大小。有关详细信息，请参阅云服务的虚拟机大小。

分配给本地存储资源的目录的名称对应于为名称属性提供的值。

终结点

Endpoints 元素描述角色的输入（外部）、内部和实例输入终结点的集合。此元素是 InputEndpoint、InternalEndpoint 和 InstanceInputEndpoint 元素的父级。

输入和内部终结点是单独分配的。一个服务总共可以有 25 个输入终结点、内部终结点和实例输入终结点，这些终结点可在一个服务中允许存在的 25 个角色间分配。例如，如果你有 5 个角色，则可以为每个角色分配 5 个输入终结点，或者可以将 25 个输入终结点分配给单个角色，或者可以为 25 个角色每个都分配 1 个输入终结点。

注意

部署的每个角色需要一个实例。订阅的默认预配限制为 20 个内核，因此最多可有 20 个角色实例。如果应用程序需要的实例数比默认预配提供的数目更多，请参阅计费、订阅管理和配额支持，了解有关提高配额的详细信息。

InputEndpoint

InputEndpoint 元素描述辅助角色的外部终结点。

可以定义由 HTTP、HTTPS、UDP 和 TCP 终结点组成的多个终结点。可以指定为输入终结点选择的任意端口号，但为服务中每个角色指定的端口号必须唯一。例如，如果指定一个角色将端口 80 用于 HTTP，将端口 443 用于 HTTPS，则之后可能会指定第二个角色将端口 8080 用于 HTTP，将端口 8043 用于 HTTPS。

下表介绍了 InputEndpoint 元素的属性。

Attribute	类型	说明
name	字符串	必需。外部终结点的唯一名称。
protocol	字符串	必需。外部终结点的传输协议。对于辅助角色，可能的值为 `HTTP`、`HTTPS`、`UDP` 或 `TCP`。
port	int	必需。外部终结点的端口。可以指定所选的任意端口号，但为服务中每个角色指定的端口号必须唯一。可能的值介于 1 和 65535（包含在内）之间（Azure SDK 1.7 或更高版本）。
证书 (certificate)	string	HTTPS 终结点需要。由 `Certificate` 元素定义的证书的名称。
localPort	int	可选。指定用于终结点上内部连接的端口。 `localPort` 属性将终结点上的外部端口映射到角色上的内部端口。该属性在以下情况下非常有用：角色必须与端口上的内部组件通信，该内部组件不同于外部公开的组件。如果未指定，则 `localPort` 的值与 `port` 属性相同。将 `localPort` 的值设置为“*”会自动分配可使用运行时 API 发现的未分配端口。可能的值介于 1 和 65535（包含在内）之间（Azure SDK 1.7 或更高版本）。仅当使用 Azure SDK 1.3 或更高版本时，才提供 `localPort` 属性。
ignoreRoleInstanceStatus	布尔值	可选。当此属性的值设置为 `true` 时，会忽略服务的状态，并且负载均衡器不会移除该终结点。此值设置为 `true` 对调试服务的繁忙实例非常有用。默认值为 `false`。注意：即使角色不处于“就绪”状态，终结点仍可接收流量。
loadBalancerProbe	字符串	可选。与输入终结点关联的负载均衡器探测的名称。有关详细信息，请参阅 LoadBalancerProbe 架构。

InternalEndpoint

InternalEndpoint 元素描述辅助角色的内部终结点。只向服务中运行的其他角色实例提供内部终结点，而不向服务外部的客户端提供。辅助角色最多具有五个 HTTP、UDP 或 TCP 内部终结点。

下表介绍了 InternalEndpoint 元素的属性。

Attribute	类型	说明
name	字符串	必需。内部终结点的唯一名称。
protocol	字符串	必需。内部终结点的传输协议。可能的值为 `HTTP`、`TCP`、`UDP` 或 `ANY`。 `ANY` 的值指定允许任何协议、任何端口。
port	int	可选。用于终结点上的内部负载均衡连接的端口。一个负载均衡的终结点使用两个端口。用于公共 IP 地址的端口，以及用于专用 IP 地址的端口。通常情况下，这些值设为相同，但你可以选择使用不同的端口。可能的值介于 1 和 65535（包含在内）之间（Azure SDK 1.7 或更高版本）。仅当使用 Azure SDK 1.3 或更高版本时，才提供 `Port` 属性。

InstanceInputEndpoint

InstanceInputEndpoint 元素描述辅助角色的实例输入终结点。实例输入终结点通过使用负载均衡器中的端口转接，关联到特定的角色实例。每个实例输入终结点映射到一系列可能端口中的特定端口。此元素是 AllocatePublicPortFrom 元素的父级。

仅当使用 Azure SDK 1.7 或更高版本时，才提供 InstanceInputEndpoint 元素。

下表介绍了 InstanceInputEndpoint 元素的属性。

Attribute	类型	说明
name	字符串	必需。终结点的唯一名称。
localPort	int	必需。指定所有角色实例都要侦听的内部端口，以便接收从负载均衡器转发的传入流量。可能的值介于 1 和 65535（含）之间。
protocol	字符串	必需。内部终结点的传输协议。可能的值为 `udp` 或 `tcp`。将 `tcp` 用于基于 http/https 的流量。

AllocatePublicPortFrom

AllocatePublicPortFrom 元素描述可供外部客户用来访问每个实例输入终结点的公共端口范围。公共 (VIP) 端口号在此范围中分配，并在租户部署和更新过程中分配给每个单独的角色实例终结点。此元素是 FixedPortRange 元素的父级。

仅当使用 Azure SDK 1.7 或更高版本时，才提供 AllocatePublicPortFrom 元素。

FixedPort

FixedPort 元素指定内部终结点的端口，用于在该终结点上实现负载均衡的连接。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 FixedPort 元素。

下表介绍了 FixedPort 元素的属性。

Attribute	类型	说明
port	int	必需。内部终结点的端口。此属性的效果与将 `FixedPortRange` 最小值和最大值设置为同一端口一样。可能的值介于 1 和 65535（包含在内）之间（Azure SDK 1.7 或更高版本）。

FixedPortRange

FixedPortRange 元素指定分配给内部终结点或实例输入终结点的端口的范围，并设置用于在终结点上建立负载均衡连接的端口。

注意

FixedPortRange 元素的工作方式取决于它所在的元素。当 FixedPortRange 元素位于 InternalEndpoint 元素中时，它会为运行角色的所有虚拟机打开负载均衡器上 min 和 max 属性范围内的所有端口。当 FixedPortRange 元素位于 InstanceInputEndpoint 元素中时，它会在运行角色的每个虚拟机上只打开 min 和 max 属性范围内的一个端口。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 FixedPortRange 元素。

下表介绍了 FixedPortRange 元素的属性。

Attribute	类型	说明
分钟	int	必需。范围内的最小端口。可能的值介于 1 和 65535（包含在内）之间（Azure SDK 1.7 或更高版本）。
max	字符串	必需。范围内的最大端口。可能的值介于 1 和 65535（包含在内）之间（Azure SDK 1.7 或更高版本）。

证书

Certificates 元素描述辅助角色的证书集。此元素是 Certificate 元素的父级。一个角色可以包含任意数目的关联证书。有关使用 certificates 元素的详细信息，请参阅使用证书修改服务定义文件。

证书

Certificate 元素描述与辅助角色关联的证书。

下表介绍了 Certificate 元素的属性。

Attribute	类型	说明
name	字符串	必需。此证书的名称，用于在此证书与 HTTPS `InputEndpoint` 元素关联时对此证书进行引用。
storeLocation	字符串	必需。本地计算机上的证书存储位置，可在其中找到此证书。可能值为 `CurrentUser` 和 `LocalMachine`。
storeName	字符串	必需。本地计算机上此证书所在的证书存储的名称。可能的值包括内置存储名称 `My`、`Root`、`CA`、`Trust`、`Disallowed`、`TrustedPeople`、`TrustedPublisher`、`AuthRoot`、`AddressBook`，或任何自定义存储名称。如果指定了自定义存储名称，则会自动创建存储。
permissionLevel	字符串	可选。指定授予角色进程的访问权限。如果只希望提升的进程访问私钥，则指定 `elevated` 权限。 `limitedOrElevated` 权限允许所有角色进程访问私钥。可能的值为 `limitedOrElevated` 或 `elevated`。默认值是 `limitedOrElevated`。

导入

Imports 元素描述辅助角色的导入模块集，它会向来宾操作系统添加组件。此元素是 Import 元素的父级。此元素是可选的，一个角色只能有一个运行时块。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Imports 元素。

导入

Import 元素指定要添加到来宾操作系统的模块。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Import 元素。

下表介绍了 Import 元素的属性。

Attribute	类型	说明
moduleName	string	必需。要导入的模块的名称。有效的导入模块为： - RemoteAccess - RemoteForwarder - Diagnostics 借助 RemoteAccess 和 RemoteForwarder 模块，可配置远程桌面连接的角色实例。有关详细信息，请参阅扩展。借助 Diagnostics 模块，可收集角色实例的诊断数据

运行时

Runtime 元素描述辅助角色的环境变量设置集，这些设置用于控制 Azure 主机进程的运行时环境。此元素是 Environment 元素的父级。此元素是可选的，一个角色只能有一个运行时块。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Runtime 元素。

下表描述 Runtime 元素的属性：

Attribute	类型	说明
executionContext	字符串	可选。指定在其中启动角色进程的上下文。默认上下文为 `limited`。 - `limited` - 不使用管理员特权启动进程。 - `elevated` - 使用管理员特权启动进程。

环境

Environment 元素描述辅助角色的环境变量设置集。此元素是 Variable 元素的父级。一个角色可以包含任意数目的环境变量集。

变量

Variable 元素指定要在来宾操作系统中设置的环境变量。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Variable 元素。

下表描述 Variable 元素的属性：

Attribute	类型	说明
name	字符串	必需。要设置的环境变量的名称。
value	字符串	可选。要为环境变量设置的值。必须包含 value 属性或 `RoleInstanceValue` 元素。

RoleInstanceValue

RoleInstanceValue 元素指定要从其中检索变量值的 xPath。

下表介绍了 RoleInstanceValue 元素的属性。

Attribute	类型	说明
xpath	字符串	可选。实例的部署设置的位置路径。有关详细信息，请参阅带有 XPath 的配置变量。必须包含 value 属性或 `RoleInstanceValue` 元素。

EntryPoint

EntryPoint 元素指定角色的入口点。此元素是 NetFxEntryPoint 元素的父级。借助这些元素，可以指定默认 WaWorkerHost.exe 以外的应用程序充当角色入口点。

仅当使用 Azure SDK 1.5 或更高版本时，才提供 EntryPoint 元素。

NetFxEntryPoint

NetFxEntryPoint 元素指定要为角色运行的程序。

注意

仅当使用 Azure SDK 1.5 或更高版本时，才提供 NetFxEntryPoint 元素。

下表介绍了 NetFxEntryPoint 元素的属性。

Attribute	类型	说明
assemblyName	字符串	必需。包含入口点的程序集的路径和文件名称。该路径相对于文件夹 %ROLEROOT%\Approot（请勿在命令行中指定 %ROLEROOT%\Approot，它是假定的）。 %ROLEROOT% 是由 Azure 维护的环境变量，表示角色的根文件夹位置。 \%ROLEROOT%\Approot 文件夹表示你的角色的应用程序文件夹。
targetFrameworkVersion	字符串	必需。在其上生成程序集的 .NET Framework 的版本。例如，`targetFrameworkVersion="v4.0"`。

ProgramEntryPoint

ProgramEntryPoint 元素指定要为角色运行的程序。 ProgramEntryPoint 元素用于指定不基于 .NET 程序集的程序入口点。

注意

仅当使用 Azure SDK 1.5 或更高版本时，才提供 ProgramEntryPoint 元素。

下表介绍了 ProgramEntryPoint 元素的属性。

Attribute	类型	说明
commandLine	字符串	必需。要执行的程序的路径、文件名和任何命令行参数。该路径相对于文件夹 %ROLEROOT%\Approot（请勿在命令行中指定 %ROLEROOT%\Approot，它是假定的）。 %ROLEROOT% 是由 Azure 维护的环境变量，表示角色的根文件夹位置。 %ROLEROOT%\Approot 文件夹表示角色的应用程序文件夹。程序结束后会回收该角色，所以通常会将程序设置为继续运行，而不是启动后运行有限的任务。
setReadyOnProcessStart	boolean	必需。指定角色实例是否等待命令行程序表明它已启动。此时，此值必须设置为 `true`。保留将该值设置为 `false` 这一操作，供将来使用。

启动

Startup 元素描述角色启动时运行的任务的集合。此元素可以是 Variable 元素的父级。有关使用角色启动任务的详细信息，请参阅如何配置启动任务。此元素是可选的，一个角色只能有一个启动块。

下表描述 Startup 元素的属性。

Attribute	类型	说明
priority	int	仅限内部使用。

任务

Task 元素指定在角色启动时发生的启动任务。启动任务可用于执行准备角色以运行的任务，如安装软件组件或运行其他应用程序。这些任务会按照它们在 Startup 元素块中出现的顺序执行。

仅当使用 Azure SDK 1.3 或更高版本时，才提供 Task 元素。

下表介绍了 Task 元素的属性。

Attribute	类型	说明
commandLine	字符串	必需。包含要运行的命令的脚本（如 CMD 文件）。启动命令和批处理文件必须以 ANSI 格式保存。在文件开头设置字节顺序标记的文件格式无法得到正确处理。
executionContext	string	指定在其中运行脚本的上下文。 - `limited` [默认] - 使用与托管进程的角色相同的特权运行。 - `elevated` - 使用管理员特权运行。
taskType	string	指定命令的执行行为。 - `simple` [默认] - 系统等待任务退出，然后再启动其他所有任务。 - `background` - 系统不会等待任务退出。 - `foreground` - 与后台相似，但在所有前台任务全部退出之前，不会重启角色。

内容

Content 元素定义要复制到 Azure 虚拟机的内容的源位置，以及要复制到的目标路径。

仅当使用 Azure SDK 1.5 或更高版本时，才提供 Content 元素。

下表介绍了 Content 元素的属性。

Attribute	类型	描述
destination	字符串	必需。内容放置在 Azure 虚拟机上的位置。此位置相对于文件夹 %ROLEROOT%\Approot。

此元素是 SourceDirectory 元素的父元素。

SourceDirectory

SourceDirectory 元素定义要从中复制内容的本地目录。使用此元素指定要复制到 Azure 虚拟机的本地内容。

仅当使用 Azure SDK 1.5 或更高版本时，才提供 SourceDirectory 元素。

下表介绍了 SourceDirectory 元素的属性。

Attribute	类型	描述
path	string	必需。其内容将复制到 Azure 虚拟机的本地目录的相对或绝对路径。支持扩展目录路径中的环境变量。

另请参阅

云服务（外延支持）定义架构。

通过

Azure 云服务（外延支持）定义 WorkerRole 架构

辅助角色的基本服务定义架构。

架构元素

WorkerRole

ConfigurationSettings

设置

LocalResources

LocalStorage

终结点

InputEndpoint

InternalEndpoint

InstanceInputEndpoint

AllocatePublicPortFrom

FixedPort

FixedPortRange

证书

证书

导入

导入

运行时

环境

变量

RoleInstanceValue

EntryPoint

NetFxEntryPoint

ProgramEntryPoint

启动

任务

目录

内容

SourceDirectory

另请参阅

其他资源