导出 (0) 打印
全部展开

添加角色

更新时间: 2014年8月

Add Role 操作将虚拟机添加到虚拟机的部署。运行此操作之前,你必须在 Microsoft Azure 中有现有的云服务和部署。若要创建云服务,你可以使用创建云服务。若要创建部署,你可以使用创建虚拟机部署

可以按以下方式指定 Add Role 请求。将 <subscription-id> 替换为订阅 ID,将 <cloudservice-name> 替换为云服务的名称,将 <deployment-name> 替换为部署的名称。

 

方法 请求 URI

POST

https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>/roles

你必须确保向管理服务发出的请求是安全的。有关其他详细信息,请参见对服务管理请求进行身份验证

无。

下表介绍请求标头。

 

请求标头 说明

Content-Type

必需。将此标头设置为 application/xml。

x-ms-version

必需。指定用于此请求的操作的版本。应将此标头设置为 01.03.12 或更高版本。有关版本控制标头的详细信息,请参阅服务管理版本控制

请求正文的格式如下所示:


<PersistentVMRole xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <RoleName>name-of-the-virtual-machine</RoleName>
  <RoleType>PersistentVMRole</RoleType>
  <ConfigurationSets>
    <ConfigurationSet i:type="WindowsProvisioningConfigurationSet">
      <ConfigurationSetType>WindowsProvisioningConfiguration</ConfigurationType> 
      <ComputerName>name-of-computer</ComputerName>
      <AdminPassword>administrator-password</AdminPassword> 
      <EnableAutomaticUpdates>enable-updates</EnableAutomaticUpdates>  
      <TimeZone>time-zone</TimeZone>
      <DomainJoin>
        <Credentials>
          <Domain>domain-to-join</Domain>
          <Username>user-name-in-the-domain</Username>
          <Password>password-for-the-user-name</Password>
        </Credentials>
        <JoinDomain>domain-to-join</JoinDomain>
        <MachineObjectOU>distinguished-name-of-the-ou</MachineObjectOU>
      </DomainJoin>
      <StoredCertificateSettings>
        <CertificateSetting>
          <StoreLocation>LocalMachine</StoreLocation>
          <StoreName>name-of-store-on-the-machine</StoreName>
          <Thumbprint>certificate-thumbprint</Thumbprint>
        </CertificateSetting>
      </StoredCertificateSettings>
      <WinRM>
        <Listeners>
          <Listener>
            <Protocol>listener-protocol</Protocol>
          </Listener>
          <Listener>
            <CertificateThumbprint>certificate-thumbprint</CertificateThumbprint>
            <Protocol>listener-protocol</Protocol>
          </Listener>
        </Listeners>
      </WinRM>
      <AdminUsername>name-of-administrator-account</AdminUsername>
      <CustomData>base-64-encoded-data</CustomData>
      <AdditionalUnattendContent>
        <Passes>
          <UnattendPass>
            <PassName>name-of-pass</PassName>
            <Components>
              <UnattendComponent>
                <ComponentName>name-of-component</ComponentName>
                <ComponentSettings>
                  <ComponentSetting>
                    <SettingName>name-of-setting</SettingName>
                    <Content>base-64-encoded-XML-content</Content>
                  </ComponentSetting>
                </ComponentSettings>
              </UnattendComponent>
            </Components>
          </UnattendPass>
        </Passes>
      </AdditionalUnattendedContent>
    </ConfigurationSet>
    <ConfigurationSet i:type="LinuxProvisioningConfigurationSet">
      <ConfigurationSetType>LinuxProvisioningConfiguration</ConfigurationType>
      <HostName>host-name-for-the-virtual-machine</HostName>
      <UserName>new-user-name</UserName> 
      <UserPassword>password-for-the-new-user</UserPassword> 
      <DisableSshPasswordAuthentication>password-authentication</DisableSshPasswordAuthentication>           
      <SSH>
        <PublicKeys>
          <PublicKey>
            <FingerPrint>certificate-fingerprint</FingerPrint>
            <Path>SSH-public-key-storage-location</Path>     
          </PublicKey>
        </PublicKeys>
        <KeyPairs>
          <KeyPair>
            <FingerPrint>certificate-fingerprint</FingerPrint>
            <Path>SSH-public-key-storage-location</Path>
          </KeyPair>
        </KeyPairs>
      </SSH>
      <CustomData>base-64-encoded-data</CustomData>
    </ConfigurationSet>
    <ConfigurationSet>
      <ConfigurationSetType>NetworkConfiguration</ConfigurationSetType>          
      <InputEndpoints>
        <InputEndpoint>
          <LoadBalancedEndpointSetName>name-of-load-balanced-set</LoadBalancedEndpointSetName>
          <LocalPort>local-port-number</LocalPort>
          <Name>name-of-endpoint</Name>
          <Port>external-port-number</Port>
          <LoadBalancerProbe>
            <Path>path-of-probe</Path>
            <Port>port-assigned-to-probe</Port>
            <Protocol>probe-protocol</Protocol>
            <IntervalInSeconds>interval-of-probe</IntervalInSeconds>
            <TimeoutInSeconds>timeout-for-probe</TimeoutInSeconds>
          </LoadBalancerProbe>
          <Protocol>endpoint-protocol</Protocol>
          <EnableDirectServerReturn>enable-direct-server-return</EnableDirectServerReturn>
          <EndpointACL>
            <Rules>
              <Rule>
                <Order>priority-of-the-rule</Order>
                <Action>permit-rule</Action>
                <RemoteSubnet>subnet-of-the-rule</RemoteSubnet>
                <Description>description-of-the-rule</Description>
              </Rule>
            </Rules>
          </EndpointACL>
          <LoadBalancerName>name-of-internal-loadbalancer</LoadBalancerName>
          <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>  
        </InputEndpoint>
      </InputEndpoints>
      <SubnetNames>
        <SubnetName>name-of-subnet</SubnetName>
      </SubnetNames>
      <StaticVirtualNetworkIPAddress>ip-address</StaticVirtualNetworkIPAddress>
      <PublicIPs>
        <PublicIP>
          <Name>name-of-public-ip</Name>
          <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes>
        <PublicIP>
      <PublicIPs>
    </ConfigurationSet>
  </ConfigurationSets>
  <ResourceExtensionReferences>
    <ResourceExtensionReference>
      <ReferenceName>name-of-reference</ReferenceName>
      <Publisher>name-of-publisher</Publisher>
      <Name>name-of-extension</Name>
      <Version>version-of-extension</Version>
      <ResourceExtensionParameterValues>
        <ResourceExtensionParameterValue>
          <Key>name-of-parameter-key</Key>
          <Value>parameter-value</Value>
          <Type>type-of-parameter</Type>
        </ResourceExtensionParameterValue>
      </ResourceExtensionParameterValues>
      <State>state-of-resource</State>
      <Certificates>
        <Certificate>
          <Thumbprint>certificate-thumbprint</Thumbprint>
          <ThumbprintAlgorithm>certificate-algorithm</ThumbprintAlgorithm>
        </Certificate>
      </Certificates>
    </ResourceExtensionReference>
  </ResourceExtensionReferences>
  <VMImageName>name-of-vm-image</VMImageName>
  <MediaLocation>path-to-vhd</MediaLocation>
  <AvailabilitySetName>name-of-availability-set</AvailabilitySetName>
  <DataVirtualHardDisks>
    <DataVirtualHardDisk>
      <HostCaching>caching-mode</HostCaching> 
      <DiskLabel>label-of-data-disk</DiskLabel>            
      <DiskName>name-of-disk</DiskName>
      <Lun>logical-unit-number</Lun>
      <LogicalDiskSizeInGB>size-in-gb-of-data-disk</LogicalDiskSizeInGB>            
      <MediaLink>path-to-vhd</MediaLink>
    </DataVirtualHardDisk>
  </DataVirtualHardDisks>
  <OSVirtualHardDisk>
    <HostCaching>caching-mode</HostCaching>    
    <DiskLabel>label-of-operating-system-disk</DiskLabel>
    <DiskName>name-of-disk</DiskName>                    
    <MediaLink>path-to-vhd</MediaLink>
    <SourceImageName>name-of-source-image</SourceImageName>
    <OS>operating-system-of-image</OS>
    <RemoteSourceImageLink>path-to-source-image</RemoteSourceImageLink>
  </OSVirtualHardDisk>      
  <RoleSize>size-of-virtual-machine</RoleSize>
  <ProvisionGuestAgent>install-an-agent</ProvisionGuestAgent>   
</PersistentVMRole>

下表说明了请求正文的元素。

 

元素名称 说明

RoleName

必需。指定虚拟机的名称。

RoleType

必需。指定要使用的角色的类型。对于虚拟机,此项必须为 PersistentVMRole

ConfigurationSets

可选。包含配置集的集合,这些配置集定义系统和应用程序设置。

ResourceExtensionReferences

可选。包含要在虚拟机上安装的资源扩展集合。如果 ProvisionGuestAgent 设置为 true,则使用此元素。

仅在 01.11.13 版或更高版本中才可以使用 ResourceExtensionReferences 元素。

VMImageName

可选。指定要用于创建虚拟机的 VM 映像的名称。使用此元素时,不使用 ConfigurationSets 元素。有关详细信息,请参阅捕获 VM 映像

仅在 01.02.14 版或更高版本中才可以使用 VMImageName 元素。

MediaLocation

如果从发布的 VM 映像创建虚拟机,则此项为必需。指定当 VMImageName 指定发布的 VM 映像时创建的 VHD 文件的位置。

仅在 01.05.14 版或更高版本中才可以使用 MediaLocation 元素。

AvailabilitySetName

可选。指定虚拟机的集合的名称。在同一可用性集中指定的虚拟机分配给不同节点,以便尽量提高可用性。有关可用性集的更多信息,请参阅管理虚拟机的可用性

DataVirtualHardDisks

可选。包含用于将数据磁盘添加到虚拟机的参数。如果要使用 VM 映像创建虚拟机,则不使用此元素。有关数据磁盘的详细信息,请参阅管理磁盘和映像

OSVirtualHardDisk

可选。包含用于为虚拟机创建操作系统磁盘的参数。如果要使用 VM 映像创建虚拟机,则不使用此元素。

RoleSize

可选。指定虚拟机的大小。默认大小为“小”。有关虚拟机大小的详细信息,请参阅 Azure 的虚拟机和云服务大小

ProvisionGuestAgent

可选。指示是否在虚拟机上安装 VM 代理。若要在虚拟机上运行资源扩展,必须安装此服务。

可能的值有:

  • true

  • false

包含配置集的集合,这些配置集指定系统和应用程序配置设置。

 

元素名称 说明

ConfigurationSet

必需。指定虚拟机的配置元素。需要使用 type 特性来防止将管理员密码写入到操作历史记录文件。

ConfigurationSetType

必需。若要创建虚拟机,必须指定下列配置集之一:

  • WindowsProvisioningConfiguration

  • LinuxProvisioningConfiguration

可选。你可以选择指定 NetworkConfiguration 集,其中包含为虚拟机创建虚拟网络配置所需的元数据。

ComputerName

在 WindowsProvisioningConfiguration 中可选。指定虚拟机的计算机名称。如果不指定计算机名称,则将分配一个由部署名称、角色名称和标识号组成的名称。计算机名称长度必须介于 1 到 15 个字符之间。

AdminPassword

在 WindowsProvisioningConfiguration 中可选。指定要对虚拟机上要创建的管理员帐户使用的密码。如果要使用映像创建虚拟机,则必须使用 AdminUsername 元素指定要在计算机上创建的管理员帐户的名称。必须使用 AdminPassword 元素指定要创建的管理员帐户的密码。如果要使用现有的专用磁盘创建虚拟机,则不使用此元素,因为帐户应已存在于磁盘上。

EnableAutomaticUpdates

在 WindowsProvisioningConfiguration 中可选。指定是否为虚拟机启用自动更新。在 3:00 AM 到 5:00 AM 之间的一个随机时间进行更新。

可能的值有:

  • true

  • false

默认值为 true

TimeZone

在 WindowsProvisioningConfiguration 中可选。指定虚拟机的时区。

有关支持的时区条目的完整列表,你可以:

  • 参考注册表项 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 中列出的值。

  • 你可以使用 tzutil 命令行工具列出有效时间。

DomainJoin

在 WindowsProvisioningConfiguration 中可选。包含定义虚拟机将加入的域的属性。

StoredCertificateSettings

在 WindowsProvisioningConfiguration 中可选。包含对新虚拟机进行设置所使用的服务证书的列表。

WinRM

在 WindowsProvisioningConfiguration 中可选。包含虚拟机上的 Windows 远程管理服务的配置设置。这将启用远程 Windows PowerShell。

仅 2013-03-01 版和更高版本中支持 WinRM 元素。

AdminUsername

在 WindowsProvisioningConfiguration 中可选。指定创建用于访问虚拟机的管理员帐户的名称。如果要使用映像创建虚拟机,则必须指定要使用此元素创建的管理员帐户的名称。必须使用 AdminPassword 元素指定要创建的管理员帐户的密码。如果要使用现有的专用磁盘创建虚拟机,则不使用此元素,因为帐户应已存在于磁盘上。

CustomData

在 WindowsProvisioningConfiguration 中可选。指定自定义数据的 Base-64 编码的字符串。Base-64 编码的字符串将解码为一个二进制数组并作为一个文件保存在虚拟机上。该二进制数组的最大长度为 65535 字节。该文件将保存到 %SYSTEMDRIVE%\AzureData\CustomData.bin。如果该文件已存在,则将被覆盖。目录的安全性将设置为 System:Full Control 和 Administrators:Full Control。

仅在 01.10.13 版或更高版本中才可以使用 CustomData 元素。

AdditionalUnattendContent

可选。指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 Base-64 编码 XML 格式信息。有关详细信息,请参阅应答文件概述

仅在 01.04.14 版或更高版本中才可以使用 AdditionalUnattendContent 元素。

HostName

在 LinuxProvisioningConfiguration 中必需。指定虚拟机的主机名称。主机名称长度必须介于 1 到 64 个字符之间。

UserName

在 LinuxProvisioningConfiguration 中必需。指定要在虚拟机的 sudoer 组中创建的用户帐户的名称。用户帐户名的长度必须为 1 到 32 个字符。

UserPassword

在 LinuxProvisioningConfiguration 中必需。指定用户帐户的密码。密码长度必须为 6 到 72 个字符。

DisableSshPasswordAuthentication

在 LinuxProvisioningConfiguration 中可选。指定是否禁用 SSH 密码身份验证。默认情况下,此值设置为 true。

可能的值有:

  • true

  • false

默认值为 true

SSH

在 LinuxProvisioningConfiguration 中可选。指定用于虚拟机的 SSH 公钥和密钥对。

CustomData

在 LinuxProvisioningConfiguration 中可选。指定自定义数据的 Base-64 编码的字符串。Base-64 编码的字符串位于虚拟机的 ISO 上的 ovf-env.xml 文件中。该文件将由 Azure Linux Agent 复制到 /var/lib/waagent/ovf-env.xml 中。在设置期间,代理还会将 base-64 编码的数据置于 /var/lib/waagent/CustomData 中。该二进制数组的最大长度为 65535 字节。

仅在 01.10.13 版或更高版本中才可以使用 CustomData 元素。

InputEndpoints

在 NetworkConfiguration 中可选。包含虚拟机的外部端点的集合。

SubnetNames

在 NetworkConfiguration 中可选。包含虚拟机将属于的子网的列表。

StaticVirtualNetworkIPAddress

可选。为虚拟网络中的虚拟机指定内部 IP 地址。如果指定此元素,还必须指定只定义了一个子网的 SubnetNames 元素。在此元素中指定的 IP 地址必须属于在 SubnetNames 中定义的子网,并且不应为此子网中前四个 IP 地址或最后一个 IP 地址。对于具有已定义了 StaticVirtualNetworkIPAddress 的虚拟机的子网,不支持将 Web 角色或辅助角色部署到其中。

仅在 01.11.13 版或更高版本中才可以使用 StaticVirtualNetworkIPAddress 元素。

PublicIPs

可选。包含除虚拟机的默认虚拟 IP 地址外可以使用的公共 IP 地址。

仅在 01.05.14 版或更高版本中才可以使用 PublicIPs 元素。

包含定义虚拟机将加入的域的属性。

 

元素名称 说明

Credentials

可选。指定用于将虚拟机加入到域的凭据。

JoinDomain

可选。指定要加入的域。

MachineObjectOU

可选。指定要在其中创建计算机帐户的部门 (OU) 的轻型目录访问协议 (LDAP) X 500 可分辨名称。该帐户处于计算机要加入的域中域控制器上的 Active Directory 中。

示例:

OU=MyOu,OU=MyParentOu,DC=example.com,DC=MyCompany,DC=com

指定用于将虚拟机加入到域的凭据。

 

元素名称 说明

可选。指定用来对帐户进行身份验证的域的名称。该值为完全限定 DNS 域。如果未指定域名,则 Username 必须指定用户主体名称 (UPN) 格式 (user@fully-qualified-DNS-domain) 或 fully-qualified-DNS-domain\username 格式。

示例:

example.com

Username

必需。指定域中可用于加入域的用户名。

密码

必需。指定要用于加入域的密码。

包含对新虚拟机进行设置所使用的服务证书的列表。存储的证书设置引用已在云服务中存在的证书。在为虚拟机配置存储的证书之前,你必须使用管理门户调用 添加服务证书 操作或添加证书。

 

元素名称 说明

CertificateSetting

必需。指定证书的参数。

StoreLocation

必需。指定虚拟机上证书存储区位置。

唯一支持的值为 LocalMachine

StoreName

必需。指定从其检索证书的证书存储区的名称。

例如“My”。

Thumbprint

必需。指定证书的指纹。该指纹必须指定现有服务证书。

包含虚拟机上的 Windows 远程管理服务的配置设置。

 

元素名称 说明

Listeners

必需。包含用于启用远程 Windows PowerShell 的信息的集合。

Listener

必需。指定侦听器的协议和证书信息。

协议

指定侦听器的协议。

可能的值有:

  • Http

  • Https

此值区分大小写。

CertificateThumbprint

可选。指定安全连接的证书指纹。如果未指定该值,将生成一个自签名的证书并且该证书用于虚拟机。

指定可包含在 Windows 安装程序使用的 Unattend.xml 文件中的其他 Base-64 编码 XML 格式信息。

 

元素名称 说明

PassName

必需。指定内容适用于的传递的名称。唯一允许的值为 oobeSystem

ComponentName

必需。指定要为其配置所添加内容的组件的名称。唯一允许的值为 Microsoft-Windows-Shell-Setup

SettingName

必需。指定内容适用于的设置的名称。

可能的值有:

  • FirstLogonCommands

  • AutoLogon

Content

必需。指定 Base-64 编码 XML 格式的内容,该内容将添加到针对指定路径和组件的 unattend.xml 文件中。XML 必须小于 4 KB,并且必须包括所插入的设置或功能的根元素。

指定用于虚拟机的 SSH 公钥和密钥对。

 

元素名称 说明

PublicKeys

可选。指定 SSH 公钥的集合。

PublicKey

必需。指定公钥。

FingerPrint

必需。指定与云服务相关联的 X509 证书的 SHA1 指纹,包括 SSH 公钥。

Path

必需。指定虚拟机上存储 SSH 公钥的文件的完整路径。如果该文件已存在,则指定的密钥将追加到该文件上。

示例:

/home/user/.ssh/authorized_keys

KeyPairs

必需。指定 SSH 密钥对的集合。

KeyPair

必需。指定要在虚拟机上安装的 SSH 密钥对。

FingerPrint

必需。指定与云服务相关联的 X509 证书的 SHA1 指纹,包括 SSH 密钥对。

Path

必需。指定虚拟机上用于存储 SSH 私钥的文件的完整路径。在将多个键写入该文件时,将覆盖该文件。SSH 公钥存储于相同目录中,并且与后缀为 .pub 的私钥文件具有相同名称。

示例:

/home/user/.ssh/id_rsa

包含虚拟机的外部端点的集合。

 

元素名称 说明

InputEndpoint

必需。指定定义虚拟机的外部端点的属性。

LoadBalancedEndpointSetName

可选。指定一组负载平衡终结点的名称。为某一端点指定此元素会将其添加到集合中。

如果要使用远程桌面添加端点以连接到虚拟机,请不要设置此属性。

note备注
该端点名称在虚拟机的作用域内必须唯一。

LocalPort

必需。指定虚拟机正在侦听的内部端口。

Name

必需。指定外部端点的名称。

Port

必需。指定用于终结点的外部端口。

LoadBalancerProbe

可选。所含的属性定义负载平衡器使用的端点设置,用于在向端点转发通信之前监视此虚拟机的可用性。

协议

必需。指定终结点的传输协议。

可能的值有:

  • TCP

  • UDP

默认值为 false

EnableDirectServerReturn

可选。指定端点是否使用直接服务器返回。RDP、SSH 或 WinRM 终结点不支持 EnableDirectServerReturn 元素,并且在终结点的公共端口和本地端口不相同时不支持此元素。建议仅在为 SQL Server 和 AlwaysOn 可用性组设置虚拟机时才使用该元素。有关详细信息,请参阅 Azure 虚拟机中的 SQL Server 高可用性和灾难恢复

可能的值有:

  • true

  • false

默认值为 false

EndpointACL

可选。包含控制指向端点的网络通信的规则集合。

EndpointACL 元素仅在使用版本 2013-06-01 或更高版本时可用。

LoadBalancerName

可选。指定与此终结点关联的内部负载平衡器的名称。

仅在 01.05.14 版或更高版本中才可以使用 LoadBalancerName 元素。

IdleTimeoutInMinutes

可选。指定 TCP 空闲连接的超时。该值可设置为介于 4 和 30 分钟之间。默认值为 4 分钟。仅在将协议设置为 TCP 后才使用此元素。

仅在 01.06.14 版或更高版本中才可以使用 IdleTimeoutInMinutes 元素。

所含的属性定义负载平衡器使用的端点设置,用于在向端点转发通信之前监视此虚拟机的可用性。

 

元素名称 说明

Path

可选。指定要检查的相对路径,用于确定虚拟机可用性状态。如果 Protocol 设置为 TCP,则此值必须为 NULL。

示例:

path

探测将使用 https://example.com/path 执行探测。

Port

可选。指定要用于检查虚拟机可用性状态的端口。

协议

可选。指定要用于检查虚拟机可用性状态的协议。

可能的值有:

  • HTTP

  • TCP

IntervalInSeconds

可选。以秒为单位指定负载平衡器探测的时间间隔。最小值为 5 秒。默认值为 15 秒。

TimeoutInSeconds

可选。以秒为单位指定负载平衡器探测的超时。最小值为 11 秒。默认值为 31 秒。

包含一组规则,这些规则控制通向终结点的入站网络流量。

 

元素名称 说明

规则

必需。指定访问控制规则的集合。最多允许 50 条规则。

Rule

必需。指定访问控制规则的定义。

订单

必需。指定规则的优先级。该值可介于 0 和 65535 之间。集合中每个规则的序号必须是唯一的。序号越低,规则优先级越高。

操作

必需。指定应允许还是拒绝与规则匹配的通信。

可能的值有:

  • permit

  • deny

RemoteSubnet

必需。指定规则的子网。子网必须为 IPV4 无类域间路由 (CIDR) 标记,并且必须为有效子集。

说明

可选。指定规则的说明。说明的最大长度为 256 个字符。

包含除虚拟机的默认虚拟 IP 地址外可以使用的公共 IP 地址。

 

元素名称 说明

PublicIP

必需。指定可用于与虚拟机通信的附加 IP 公共地址。

Name

必需。指定公共 IP 地址的名称。

IdleTimeoutInMinutes

可选。指定 TCP 空闲连接的超时。该值可设置为介于 4 和 30 分钟之间。默认值为 4 分钟。仅在将协议设置为 TCP 后才使用此元素。

仅在 01.06.14 版或更高版本中才可以使用 IdleTimeoutInMinutes 元素。

包含虚拟机将属于的子网的列表。

 

元素名称 说明

SubnetName

必需。指定虚拟机属于的子网的名称。

包含用于将数据磁盘添加到虚拟机的参数。

 

元素名称 说明

DataVirtualHardDisk

必需。指定用于创建数据磁盘的属性。

HostCaching

可选。指定针对读/写效率的数据磁盘的缓存行为。设置此属性将会影响磁盘的一致性。

可能的值有:

  • None

  • ReadOnly

  • ReadWrite

默认值为 None

DiskLabel

可选。如果要添加的磁盘已在订阅中注册,则忽略此元素。若要创建新磁盘,则此元素用于提供磁盘的说明。此元素的值仅通过编程方式获取,不显示在管理门户中。

DiskName

可选。如果要添加的磁盘已在订阅中注册,则此元素用于标识要添加的磁盘。如果新磁盘和关联的 VHD 将由 Azure 创建,则不使用此元素,并且 Azure 将分配一个由部署名称、角色名称和标识号组成的唯一名称。

磁盘的名称只能包含字母数字字符、下划线、句点或短划线。名称的长度不得超过 256 个字符。路径不能以句点或短划线结尾。

Lun

可选。指定数据磁盘的逻辑单元号 (LUN)。如果该磁盘是要添加的第一个磁盘,则此元素可选,并且使用默认值 0。如果要添加多个磁盘,则需要此元素。

可以使用获取角色来查找已经在使用的 LUN 编号。

有效的 LUN 值为 0 到 15。

LogicalDiskSizeInGB

可选。以 GB 为单位指定要附加到虚拟机的空磁盘的大小。如果要添加的磁盘已在订阅中注册,则忽略此元素。如果在添加时磁盘和 VHD 正由 Azure 创建,则此元素定义新磁盘的大小。

可以添加到虚拟机中的磁盘数量受虚拟机的大小限制。有关详细信息,请参阅 Azure 的虚拟机和云服务大小

此元素与 MediaLink 元素配合使用。

MediaLink

可选。如果要添加的磁盘已在订阅中注册,或者 Blob 存储中已存在磁盘的 VHD,则忽略此元素。如果 blob 存储中不存在 VHD 文件,则此元素定义在添加新磁盘时创建的新 VHD 的位置。

示例:

http://example.blob.core.windows.net/disks/mydatadisk.vhd

SourceMediaLink

可选。如果要添加的磁盘已在订阅中注册,或者 Blob 存储中不存在磁盘的 VHD,则忽略此元素。如果 Blob 存储中存在 VHD 文件,则此元素定义 VHD 的路径,从其中注册磁盘并附加到虚拟机。

包含用于为虚拟机创建操作系统磁盘的参数。

 

元素名称 说明

HostCaching

可选。指定操作系统磁盘的缓存模式。此设置将会影响磁盘的一致性和性能。

可能的值有:

  • ReadOnly

  • ReadWrite

默认值为 ReadWrite

note备注
更改此值将导致虚拟机重新启动。

DiskLabel

可选。指定磁盘的说明。

DiskName

如果要使用现有磁盘创建虚拟机,则此项为必需。指定新磁盘或现有磁盘的名称。对于新磁盘,如果未指定此元素,则将分配一个由部署名称、角色名称和标识号组成的唯一名称。

磁盘的名称只能包含字母数字字符、下划线、句点或短划线。名称的长度不得超过 256 个字符。路径不能以句点或短划线结尾。

MediaLink

如果从平台映像创建虚拟机,则此项为必需。指定当 SourceImageName 指定平台映像时创建的 VHD 文件的位置。如果要使用现有磁盘创建虚拟机,则不使用此元素。

示例:

http://contoso.blob.core.windows.net/disks/mydisk.vhd

SourceImageName

可选。指定要用于创建虚拟机的映像的名称。可以指定用户映像或平台映像。映像始终与 VHD 关联,这是一个 .vhd 文件,存储作为 Azure 中存储帐户的页 blob。如果指定了平台映像,则系统将创建关联的 VHD,并且你必须使用 MediaLink 元素来指定 VHD 位于存储中的位置。

操作系统

如果使用 RemoteSourceImageLink,则此项为必需。指定映像中安装的操作系统的类型。

可能的值有:

  • Windows

  • Linux

RemoteSourceImageLink

可选。指定用于创建虚拟机的 OS 映像的存储位置的 URI。映像始终与 VHD 关联,后者是一个 .vhd 文件,存储作为 Azure 的存储帐户中的页 Blob。如果使用此元素指定了映像的路径,系统将创建关联的 VHD,你必须使用 MediaLink 元素来指定 VHD 在存储中的位置。使用此元素时,不使用 SourceImageName。

仅在 01.05.14 版或更高版本中才可以使用 RemoteSourceImageLink 元素。

包含要在虚拟机上安装的资源扩展集合。资源扩展为虚拟机上安装的软件组件。若要安装资源扩展,必须在虚拟机上安装 VM 代理。有关详细信息,请参阅管理扩展

 

元素名称 说明

ResourceExtensionReference

必需。指定应安装在虚拟机上的资源扩展的属性。

ReferenceName

必需。指定资源扩展的引用名称。

发布服务器

必需。指定创建资源扩展的发布服务器的名称。可以使用列出资源扩展查找资源扩展的发布服务器名称。

Name

必需。指定资源扩展的名称。可以使用列出资源扩展查找可用资源扩展的名称。

Version

必需。指定资源扩展的版本。可以将此值设为 * 以使用最新版本的扩展。如果最近已添加或更新扩展,则必须确保在使用该版本的扩展前将 ReplicationCompleted 值设为 true。可以使用列出资源扩展版本来确定扩展的复制状态和可用版本。

ResourceExtensionParameterValues

可选。包含安装资源扩展时传递给它的参数的集合。

State

可选。指定资源扩展的状态。创建虚拟机时,可以指定的唯一状态是 enable,这是默认值(如果未使用此元素)。有关禁用或删除扩展的详细信息,请参阅更新角色

证书

可选。包含虚拟机上安装的由扩展使用的证书集合。必须先将证书添加到云服务,之后才能将其包括到该请求中。有关详细信息,请参阅添加服务证书

仅在 01.06.14 版或更高版本中才可以使用 Certificates 元素。

包含虚拟机上安装的由扩展使用的证书集合。

 

元素名称 说明

Thumbprint

必需。指定扩展将要使用的证书的指纹。

ThumbprintAlgorithm

必需。指定指纹算法。此值始终为 sha1

包含安装资源扩展时传递给它的参数的集合。

 

元素名称 说明

ResourceExtensionParameterValue

必需。指定参数的键、值和类型。

Key

必需。指定参数的键。

必需。指定以 Base-64 编码的参数值。如果以 XML 设置扩展配置的格式,则将使用公共或私有架构对此值进行验证。使用的架构取决于 Type 的值。

如果以 JSON 设置扩展配置的格式,则此值必须包含有效的 JSON 对象。公共或私有架构不能用于验证该对象。若要使用 JSON 对象,版本必须是 2014-04-01 或更高版本。

类型

必需。指定资源扩展的类型。

可能的值有:

  • Public

  • Private

如果此值设置为 Private,则获取部署将不会返回此参数。最多只能为两个参数指定一个公共参数和一个专用参数。

包含要与虚拟机关联的 DNS 服务器的列表。

 

元素名称 说明

DnsServers

必需。包含指定要用于虚拟机的 DNS 服务器的参数。

DnsServer

必需。包含 DNS 服务器的 NameAddress 元素。

Name

必需。指定 DNS 服务器的名称。

Address

必需。指定 DNS 服务器的 IP 地址。

响应包括 HTTP 状态代码、一组响应标头和响应正文。

成功的操作将返回状态代码 202(已接受)。有关状态代码的信息,请参阅服务管理状态和错误代码

此操作的响应包括以下标头。该响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范

 

响应标头 说明

x-ms-request-id

一个值,它唯一地标识对管理服务做出的请求。

无。

显示:
© 2014 Microsoft