本文為機器翻譯文章。如需檢視英文版,請選取 [原文] 核取方塊。您也可以將滑鼠指標移到文字上,即可在快顯視窗顯示英文原文。
譯文
原文

加入角色

 

Add Role 作業會將虛擬機器加入至虛擬機器的部署。 執行這項作業之前,您必須在 Microsoft Azure 中已有現存的雲端服務及部署。 若要建立雲端服務,您可以使用 建立雲端服務 若要建立部署,您可以使用 建立虛擬機器部署

Add Role 要求可能會以下面方式指定。 取代 <subscription-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

必要項。 指定用於這個要求的作業版本。 此標頭應該設定為 2012年-03-01 或更高版本。 如需有關版本設定標頭的詳細資訊,請參閱 服務管理版本控制

要求主體的格式如下:


<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> <NetworkSecurityGroup>network-security-group</NetworkSecurityGroup> <PublicIPs> <PublicIP> <Name>name-of-public-ip</Name> <IdleTimeoutInMinutes>timeout-for-tcp-idle-connection</IdleTimeoutInMinutes> <DomainNameLabel>domain-label</DomainNameLabel> <PublicIP> <PublicIPs> <NetworkInterfaces> <NetworkInterface> <Name>interface-name</Name> <MacAddress>mac-address</MacAddress> <IPConfigurations> <IPConfiguration> <SubnetName>subnet-name</SubnetName> <Address>ip-address</Address> </IPConfiguration> <IPConfigurations> </NetworkInterface> </NetworkInterfaces> </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> <ResizedSizeInGB>resized-size</ResizedSizeInGB> </OSVirtualHardDisk> <RoleSize>size-of-virtual-machine</RoleSize> <ProvisionGuestAgent>install-an-agent</ProvisionGuestAgent> <VMImageInput> <OSDiskConfiguration> <ResizedSizeInGB>resized-size</ResizedSizeInGB> </OSDiskConfiguration> <DataDiskConfigurations> <DataDiskConfiguration> <Name>data-disk-name</Name> <ResizedSizeInGB>resized-size</ResizedSizeInGB> </DataDiskConfiguration> </DataDiskConfigurations> </VMImageInput> </PersistentVMRole>

下表說明要求主體的元素。

元素名稱

說明

RoleName

必要項。 指定虛擬機器的名稱。

RoleType

必要項。 指定要使用的角色類型。 這必須是虛擬機器 PersistentVMRole

ConfigurationSets

選擇項。 包含定義系統及應用程式設定之組態集的集合。

ResourceExtensionReferences

選擇項。 包含要安裝於虛擬機器上的資源擴充功能集合。 如果 ProvisionGuestAgent 設定為使用此項目 true

ResourceExtensionReferences 項目只是使用 2013年-11-01 版或更高版本。

VMImageName

選擇項。 指定要用於建立虛擬機器之 VM 映像的名稱。 如果使用這個項目,則 ConfigurationSets 未使用項目。 如需詳細資訊,請參閱 擷取 VM 映像

VMImageName 項目只是使用 2014年-02-01 版或更高版本。

MediaLocation

如果是要透過發行的 VM 映像建立虛擬機器,則為必要項目。 指定當 VMImageName 指定發行的 VM 映像時,建立的 VHD 檔案所在位置。

MediaLocation 項目只是使用 2014年-05-01 版或更高版本。

AvailabilitySetName

選擇項。 指定虛擬機器集合的名稱。 指定於相同可用性設定組的虛擬機器會配置到不同的節點,以便盡可能提高可用性。

DataVirtualHardDisks

選擇項。 包含用以將資料磁碟加入至虛擬機器的參數。 如果使用 VM 映像來建立虛擬機器,則不會使用此元素。 如需有關資料磁碟的詳細資訊,請參閱 管理磁碟及映像

OSVirtualHardDisk

選擇項。 包含用以建立虛擬機器之作業系統磁碟的參數。 如果使用 VM 映像來建立虛擬機器,則不會使用此元素。

RoleSize

選擇項。 指定虛擬機器的大小。 預設的大小是 Small (小型)。 如需有關虛擬機器大小的詳細資訊,請參閱 虛擬機器和 Azure 的雲端服務大小

ProvisionGuestAgent

選擇項。 指出虛擬機器上是否已安裝 VM 代理程式。 若要在虛擬機器上執行資源擴充功能,必須安裝此服務。

可能的值為:

  • true

  • false

VMImageInput

選擇項。 指定 VM 映像中新的磁碟大小。

VMImageInput 項目只是使用 2014年-10-01 版或更高版本。

包含組態集的集合,其中指定系統和應用程式組態設定。

元素名稱

說明

ConfigurationSet

必要項。 指定虛擬機器的組態元素。 需要 type 屬性以避免將系統管理員密碼寫入作業記錄檔。

ConfigurationSetType

必要項。 若要建立虛擬機器,您必須指定下列其中一種組態集:

  • WindowsProvisioningConfiguration

  • LinuxProvisioningConfiguration

選擇項。 您可以選擇性地指定 NetworkConfiguration 包含建立虛擬機器的虛擬網路組態所需的中繼資料的集合。

ComputerName

在 WindowsProvisioningConfiguration 下為選擇性。 指定虛擬機器的電腦名稱。 如果未指定電腦名稱,將會指派由部署名稱、角色名稱和識別碼組合而成的電腦名稱。 電腦名稱的長度必須是 1 到 15 個字元。

AdminPassword

在 WindowsProvisioningConfiguration 下為選擇性。 指定使用於虛擬機器上正在建立之管理員帳戶的密碼。 如果您要建立虛擬機器使用的映像,您必須指定要建立在機器使用系統管理員帳戶名稱 AdminUsername 項目。 您必須使用 AdminPassword 項目來指定正在建立的系統管理員帳戶的密碼。 如果使用現有的專用磁碟來建立虛擬機器,則不會使用此元素,因為磁碟中已存在帳戶。

EnableAutomaticUpdates

在 WindowsProvisioningConfiguration 下為選擇性。 指定虛擬機器是否啟用自動更新。 更新發生在上午 3:00 到上午 5:00 之間的隨機時間。

可能的值為:

  • 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。

WinRM 項目才支援 2013年-03-01 版和更新版本。

AdminUsername

在 WindowsProvisioningConfiguration 下為選擇性。 指定用於存取虛擬機器所建立之管理員帳戶的名稱。 如果您正在使用映像建立虛擬機器,必須使用此元素來指定要建立的管理員帳戶的名稱。 您必須使用 AdminPassword 項目來指定正在建立的系統管理員帳戶的密碼。 如果使用現有的專用磁碟來建立虛擬機器,則不會使用此元素,因為磁碟中已存在帳戶。

CustomData

在 WindowsProvisioningConfiguration 下為選擇性。 指定自訂資料的 Base-64 編碼字串。 Base-64 編碼字串會解碼成二進位陣列而儲存為虛擬機器上的檔案。 二進位陣列的長度上限是 65535 個位元組。 檔案會儲存為 %SYSTEMDRIVE%\AzureData\CustomData.bin。 如果此檔案存在,就會遭到覆寫。 目錄的安全性將設定為 System:完全控制和 Administrators:完全控制。

CustomData 項目只是使用 2013年-10-01 版或更高版本。

AdditionalUnattendContent

選擇項。 指定可併入 Unattend.xml 檔案 (由 Windows 安裝程式使用) 的額外 Base-64 編碼 XML 格式資訊。 如需詳細資訊,請參閱 回應檔案概觀

AdditionalUnattendContent 項目只是使用 2014年-04-01 版或更高版本。

主機名稱

在 LinuxProvisioningConfiguration 下為必要項。 指定虛擬機器的主機名稱。 主機名稱的長度必須是 1 到 64 個字元。

使用者名稱

在 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 代理程式複製到 /var/lib/waagent/ovf-env.xml。 在佈建期間,代理程式也會將 Base-64 編碼格式資料存放於 /var/lib/waagent/CustomData。 二進位陣列的長度上限是 65535 個位元組。

CustomData 項目只是使用 2013年-10-01 版或更高版本。

InputEndpoints

在 NetworkConfiguration 下為選擇性。 包含虛擬機器之外部端點的集合。

SubnetNames

在 NetworkConfiguration 下為選擇性。 包含虛擬機器所屬子網路的清單。

StaticVirtualNetworkIPAddress

選擇項。 為虛擬網路中的虛擬機器指定內部 IP 位址。 如果您指定這個項目,您也必須指定 SubnetNames 只能有一個子網路定義的項目。 此項目中指定的 IP 位址必須屬於中定義的子網路 SubnetNames 且不得前四個 IP 位址或子網路中的最後一個 IP 位址。 不支援將 Web 角色或背景工作角色部署至具有已定義 StaticVirtualNetworkIPAddress 之虛擬機器的子網路。

StaticVirtualNetworkIPAddress 項目只是使用 2013年-11-01 版或更高版本。

NetworkSecurityGroup

選擇項。 代表與虛擬機器相關聯的網路安全性群組名稱。 網路安全性群組必須存在於訂用帳戶內容中,並在部署虛擬機器的相同區域中建立。

NetworkSecurityGroup 項目只是使用 2014年-10-01 版或更高版本。

PublicIPs

選擇項。 包含除了虛擬機器的預設虛擬 IP 位址以外可使用的公用 IP 位址。

PublicIPs 項目只是使用 2014年-05-01 版或更高版本。

64e8f7ec-9472-4725-9a59-35ed508ac3b0#bk_networkinterfaces

選擇性,一組次要網路介面。 允許次要網路介面數目取決於虛擬機器的大小。 NetworkInterfaces 項目只是使用 2014年-08-01 版或更高版本。

包含定義虛擬機器即將加入之網域的屬性。

元素名稱

說明

認證

選擇項。 指定將虛擬機器加入網域時所用的認證。

JoinDomain

選擇項。 指定要加入的網域。

MachineObjectOU

選擇項。 指定建立電腦帳戶所在之組織單位 (OU) 的輕量型目錄存取通訊協定 (LDAP) X 500 辨別名稱。 這個帳戶位於電腦所加入之網域的網域控制站 Active Directory 中。

範例:OU=MyOu,OU=MyParentOu,DC=example.com,DC=MyCompany,DC=com

指定將虛擬機器加入網域時所用的認證。

元素名稱

說明

Domain

選擇項。 指定用來驗證帳戶之網域的名稱。 此值是完整的 DNS 網域。 如果未指定網域名稱, Username 必須指定使用者主要名稱 (UPN) 格式 (user@fully-qualified-DNS-domain) 或完整的限定-DNS 的網域 \ 使用者名稱格式。

範例: example.com

使用者名稱

必要項。 指定網域中可用來加入網域的使用者名稱。

Password

必要項。 指定要用來加入網域的密碼。

包含要佈建到新虛擬機器的服務憑證的清單。 預存憑證設定會參考已經存在雲端服務中的憑證。 您設定虛擬機器的預存的憑證之前,必須先呼叫 加入服務憑證 作業或者使用管理入口網站加入憑證。

元素名稱

說明

CertificateSetting

必要項。 指定憑證的參數。

StoreLocation

必要項。 指定虛擬機器上的憑證存放區位置。

唯一支援的值是 LocalMachine

StoreName

必要項。 指定要從中擷取憑證的憑證存放區名稱。

範例:My

Thumbprint

必要項。 指定憑證的憑證指紋。 此憑證指紋必須指定現有的服務憑證。

包含虛擬機器上的 Windows 遠端管理服務的組態設定。

元素名稱

說明

Listeners

必要項。 包含用於啟用遠端 Windows PowerShell 的資訊集合。

接聽程式

必要項。 指定接聽程式的通訊協定和憑證資訊。

通訊協定

指定接聽程式的通訊協定。

可能的值為:

  • Http

  • Https

此值會區分大小寫。

CertificateThumbprint

選擇項。 指定安全連接的憑證指紋。 如果沒有指定此值,系統就會產生自我簽署憑證並且用於虛擬機器。

指定可併入 Unattend.xml 檔案 (由 Windows 安裝程式使用) 的額外 Base-64 編碼 XML 格式資訊。

元素名稱

說明

PassName

必要項。 指定套用內容的階段名稱。 唯一允許的值是 oobeSystem

ComponentName

必要項。 指定要設定所加入內容之元件的名稱。 唯一允許的值是 Microsoft-Windows-Shell-Setup

SettingName

必要項。 指定要套用內容之設定的名稱。

可能的值為:

  • FirstLogonCommands

  • AutoLogon

Content

必要項。 指定可加入指定路徑和元件之 unattend.xml 檔案的 Base-64 編碼 XML 格式內容。 XML 必須小於 4 KB,且必須併入要插入之設定或功能的根項目。

指定要搭配虛擬機器使用的 SSH 公開金鑰和金鑰組。

元素名稱

說明

PublicKeys

選擇項。 指定 SSH 公開金鑰的集合。

PublicKey

必要項。 指定公開金鑰。

FingerPrint

必要項。 指定與雲端服務相關聯且包含 SSH 公開金鑰之 X509 憑證的 SHA1 指紋。

路徑

必要項。 指定虛擬機器上儲存 SSH 公開金鑰之檔案的完整路徑。 如果檔案已經存在,指定的金鑰就會附加至該檔案。

範例: /home/user/.ssh/authorized_keys

KeyPairs

必要項。 指定 SSH 金鑰組的集合。

KeyPair

必要項。 指定要安裝於虛擬機器上的 SSH 金鑰組。

FingerPrint

必要項。 指定與雲端服務相關聯且包含 SSH 金鑰組之 X509 憑證的 SHA1 指紋。

路徑

必要項。 指定虛擬機器上儲存 SSH 私密金鑰之檔案的完整路徑。 當多個金鑰寫入檔案時,就會覆寫檔案。 SSH 公開金鑰會儲存在相同的目錄和具有與尾碼為.pub 的私密金鑰檔案相同的名稱。

範例: /home/user/.ssh/id_rsa

包含虛擬機器之外部端點的集合。

元素名稱

說明

InputEndpoint

必要項。 指定屬性以定義虛擬機器的外部端點。

LoadBalancedEndpointSetName

選擇項。 指定一組負載平衡端點的名稱。 針對端點指定這個元素,就會將該端點加入至集合。

如果您要加入端點以使用遠端桌面連接到虛擬機器,請勿設定此屬性。

System_CAPS_note注意事項

在虛擬機器的範圍內,端點名稱必須是唯一的。

LocalPort

必要項。 指定虛擬機器所接聽的內部連接埠。

名稱

必要項。 指定外部端點的名稱。

Port

必要項。 指定要用於端點的外部連接埠。

LoadBalancerProbe

選擇項。 包含定義端點設定的屬性,以供負載平衡器用於監視虛擬機器的可用性,然後再將流量轉送至端點。

通訊協定

必要項。 指定端點的傳輸通訊協定。

可能的值為:

  • TCP

  • UDP

預設值是 false

EnableDirectServerReturn

選擇項。 指定端點是否使用 Direct Server Return。 EnableDirectServerReturn RDP、 SSH 或 WinRM 端點不支援項目並不支援的公用連接埠和本機連接埠的端點時不同。 建議只在為 SQL Server 及 AlwaysOn 可用性群組設定虛擬機器時使用此元素。 如需詳細資訊,請參閱 高可用性和嚴重損壞修復 SQL server 在 Azure 虛擬機器

可能的值為:

  • true

  • false

預設值是 false

EndpointACL

選擇項。 包含用以控制將網路流量送至端點的規則集合。

EndpointACL 項目只是使用 2013年-06-01 版或更高版本。

LoadBalancerName

選擇項。 指定與此端點相關聯之內部負載平衡器的名稱。

LoadBalancerName 項目只是使用 2014年-05-01 版或更高版本。

IdleTimeoutInMinutes

選擇項。 指定 TCP 閒置連線的逾時。 此值可介於 4 與 30 分鐘之間。 預設值為 4 分鐘。 此元素只限於通訊協定設定為 TCP 時才會使用。

IdleTimeoutInMinutes 項目只是使用 2014年-06-01 版或更高版本。

包含定義端點設定的屬性,以供負載平衡器用於監視虛擬機器的可用性,然後再將流量轉送至端點。

元素名稱

說明

路徑

選擇項。 指定要檢查以判斷虛擬機器可用性狀態的相對路徑。 如果 Protocol 設定為 TCP, ,這個值必須是 NULL。

範例: 路徑

探查將會使用 https://example.com/path 來執行探查。

Port

選擇項。 指定要用來檢查虛擬機器可用性狀態的連接埠。

通訊協定

選擇項。 指定要用來檢查虛擬機器可用性狀態的通訊協定。

可能的值為:

  • HTTP

  • TCP

IntervalInSeconds

選擇項。 指定負載平衡器探查的間隔 (以秒為單位)。 最小值是 5 秒。 預設值是 15 秒。

TimeoutInSeconds

選擇項。 指定負載平衡器探查的逾時 (以秒為單位)。 最小值為 11 秒。 預設值為 31 秒。

包含用以控制將傳入網路流量送至端點的規則集合。

元素名稱

說明

規則

必要項。 指定存取控制規則的集合。 最多允許 50 項規則。

規則

必要項。 指定存取控制規則的定義。

訂單

必要項。 指定規則的優先順序。 此值可介於 0 到 65535 之間。 集合內每一項規則的順序編號都必須是唯一的。 順序編號愈低,規則的優先順序愈高。

動作

必要項。 指定應該允許或拒絕符合規則的流量。

可能的值為:

  • permit

  • deny

RemoteSubnet

必要項。 指定規則的子網路。 子網路必須採用 IPV4 無類別網域間路由選擇 (CIDR) 標記法,而且必須是有效的子網路。

說明

選擇項。 指定規則的描述。 描述的長度上限是 256 個字元。

包含除了虛擬機器的預設虛擬 IP 位址以外可使用的公用 IP 位址。

元素名稱

說明

PublicIP

必要項。 指定可用來與虛擬機器通訊的額外公用 IP 位址。

名稱

必要項。 指定公用 IP 位址的名稱。

IdleTimeoutInMinutes

選擇項。 指定 TCP 閒置連線的逾時。 此值可介於 4 與 30 分鐘之間。 預設值為 4 分鐘。 此元素只限於通訊協定設定為 TCP 時才會使用。

IdleTimeoutInMinutes 項目只是使用 2014年-06-01 版或更高版本。

DomainNameLabel

選擇項。 指定公用 IP 的網域名稱標籤。

DomainNameLabel 項目只是使用 2015年-03-01 版或更高版本。

包含一組次要網路介面。

元素名稱

說明

NetworkInterface

必要項。 指定次要網路介面。

名稱

必要項,會指定次要網路介面的名稱。

MacAddress

必要項。 指定次要網路介面的 MAC 位址。

64e8f7ec-9472-4725-9a59-35ed508ac3b0#bk_ipconfigurations

必要項。 指定次要網路介面的一組 IP 位址組態。

指定次要網路介面的一組 IP 位址組態。

元素名稱

說明

IPConfiguration

必要項。 指定次要網路介面的 IP 位址組態。

目前次要網路介面僅支援一個 IP 位址組態。

SubnetName

必要項。 指定此 IP 位址組態所屬之虛擬網路子網路的名稱。

位址

必要項,指定為次要網路介面設定的內部 IP 位址。

包含虛擬機器所屬子網路的清單。

元素名稱

說明

SubnetName

必要項。 指定虛擬機器所屬子網路的名稱。

包含用以將資料磁碟加入至虛擬機器的參數。

元素名稱

說明

DataVirtualHardDisk

必要項。 指定用來建立資料磁碟的屬性。

HostCaching

選擇項。 為了發揮讀取/寫入效率,指定資料磁碟的快取行為。 這個此屬性會影響磁碟的一致性。

可能的值為:

  • None

  • ReadOnly

  • ReadWrite

預設值是 None

DiskLabel

選擇項。 如果將要加入的磁碟已在訂閱中註冊,便會忽略這個元素。 若是建立新的磁碟,這個元素將用於提供磁碟的描述。 這個元素的值只能透過程式設計方式取得,而不會出現在管理入口網站中。

DiskName

選擇項。 如果將要加入的磁碟已在訂用帳戶中註冊,這個元素即用於識別所加入的磁碟。 若是由 Azure 建立新磁碟和相關聯的 VHD,則 Azure 將指派由部署名稱、角色名稱和識別碼組合而成的唯一名稱,不會使用這個元素。

磁碟的名稱只能包含英數字元、底線、句號或虛線。 名稱長度不得超過 256 個字元。 名稱不得以句號或虛線結尾。

Lun

選擇項。 指定資料磁碟的邏輯單元編號 (LUN)。 如果磁碟是第一個加入的磁碟,這個元素即為選擇性且將使用預設值 0。 如果加入的磁碟不止一個,這個元素則為必要項。 有效的 LUN 值是 0 到 31。 您可以使用 取得角色 來尋找已使用的 LUN 編號。

LogicalDiskSizeInGB

選擇項。 指定要連接至虛擬機器之空白磁碟的大小 (以 GB 為單位)。 如果將要加入的磁碟已在訂閱中註冊,便會忽略這個元素。 若加入的方式是由 Azure 建立磁碟和 VHD,這個元素將定義新磁碟的大小。

可加入至虛擬機器的磁碟數目受限於虛擬機器的大小。 如需詳細資訊,請參閱 虛擬機器和 Azure 的雲端服務大小

這個元素是與 MediaLink 元素搭配使用。

MediaLink

選擇項。 如果將要加入的磁碟已在訂閱中註冊,或該磁碟的 VHD 已存在於 Blob 儲存體,便會忽略這個元素。 若 Blob 儲存體中沒有此 VHD 檔案,這個元素將定義加入新磁碟時新建立的 VHD 所在位置。

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

SourceMediaLink

選擇項。 如果將要加入的磁碟已在訂閱中註冊,或該磁碟的 VHD 不存在於 Blob 儲存體,便會忽略這個元素。 若 Blob 儲存體中存在此 VHD 檔案,這個元素將定義 VHD 的路徑,以此做為來源註冊磁碟並將其連接至虛擬機器。

包含用以建立虛擬機器之作業系統磁碟的參數。

元素名稱

說明

HostCaching

選擇項。 指定作業系統磁碟的快取模式。 這項設定會影響磁碟的一致性和效能。

可能的值為:

  • ReadOnly

  • ReadWrite

預設值是 ReadWrite

System_CAPS_note注意事項

變更此值會導致虛擬機器重新啟動。

DiskLabel

選擇項。 指定磁碟的描述。

DiskName

如果正在使用現有的磁碟來建立虛擬機器,則為必要項目。 指定新磁碟或現有磁碟的名稱。 若為新磁碟,如果沒有指定這個元素,將會指派由部署名稱、角色名稱和識別碼組合而成的唯一名稱。

磁碟的名稱只能包含英數字元、底線、句號或虛線。 名稱長度不得超過 256 個字元。 名稱不得以句號或虛線結尾。

MediaLink

如果正在從平台映像建立虛擬機器,則為必要項目。 指定當 SourceImageName 指定平台映像時,建立的 VHD 檔案所在位置。 如果正在使用現有磁碟建立虛擬機器,則不使用此元素。

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

SourceImageName

選擇項。 指定要用來建立虛擬機器之映像的名稱。 您可以指定使用者映像或平台映像。 映像一定會與 VHD 相關聯,後者是以分頁 Blob 的形式儲存在 Azure 儲存體帳戶中的 .vhd 檔案。 如果指定平台映像,便會建立相關聯的 VHD,而必須使用 MediaLink 元素指定此 VHD 在儲存體中的位置。

OS

如果使用了 RemoteSourceImageLink,則為必要項目。 指定映像中安裝的作業系統類型。

可能的值為:

  • Windows

  • Linux

RemoteSourceImageLink

選擇項。 指定儲存用來建立虛擬機器之 OS 映像位置的 URI。 映像一定會與 VHD 相關聯,後者是以分頁 Blob 的形式儲存在 Windows Azure 儲存體帳戶中的 .vhd 檔案。 如果使用此元素指定映像的路徑,便會建立相關聯的 VHD,而必須使用 MediaLink 元素指定此 VHD 在儲存體中的位置。 如果使用此元素,則不會使用 SourceImageName 元素。

RemoteSourceImageLink 項目只是使用 2014年-05-01 版或更高版本。

ResizedSizeInGB

使用 OS 映像或 RemoteSourceImage 來建立 OSVirtualHardDisk 時,這個參數可用於將新 OSVirtualHardDisk 的大小調整成較大的大小。 ResizedSizeInGB 必須大於基礎 OS 映像的 LogicalSizeInGB。 ResizedSizeInGB 項目只是使用 2014年-10-01 版或更高版本。

指定 VM 映像中新的磁碟大小。

元素名稱

說明

OSDiskConfiguration

選擇項。 指定 VM 映像的作業系統磁碟組態。

OSDiskConfiguration 項目只是使用 2014年-10-01 版或更高版本。

ResizedSizeInGB

必要項。 指定 VM 映像中作業系統磁碟的新 (較大) 大小。

ResizedSizeInGB 項目只是使用 2014年-10-01 版或更高版本。

DataDiskConfigurations

選擇項。 指定 VM 映像的資料磁碟組態。

DataDiskConfigurations 項目只是使用 2014年-10-01 版或更高版本。

指定 VM 映像的資料磁碟組態。

元素名稱

說明

DataDiskConfiguration

必要項。 指定資料磁碟的組態。

DataDiskConfiguration 項目只是使用 2014年-10-01 版或更高版本。

名稱

必要項。 指定資料磁碟的名稱。

Name 項目只是使用 2014年-10-01 版或更高版本。

範例:MyVMImage1-datadisk-2-2014-02-21

ResizedSizeInGB

必要項。 指定資料磁碟的新 (較大) 大小。

ResizedSizeInGB 項目只是使用 2014年-10-01 版或更高版本。

包含要安裝於虛擬機器上的資源擴充功能集合。 資源擴充功能是在虛擬機器上安裝的軟體元件。 若要安裝資源延伸模組,必須在虛擬機器上安裝 VM 代理程式。 如需詳細資訊,請參閱 管理延伸模組

元素名稱

說明

ResourceExtensionReference

必要項。 指定應在虛擬機器上安裝之資源擴充功能的屬性。

ReferenceName

必要項。 指定資源擴充功能的參考名稱。

發行者

必要項。 指定建立資源擴充功能的發行者名稱。 您可以使用 列出資源擴充功能 來尋找資源擴充功能的發行者名稱。

名稱

必要項。 指定資源擴充功能的名稱。 您可以使用 列出資源擴充功能 來尋找可用的資源擴充功能的名稱。

版本

必要項。 指定資源擴充功能的版本。 您可以將此值設定為 * 使用延伸模組的最新版本。 如果已最近新增或更新延伸模組,您必須確定值 ReplicationCompleted 設為 true 才能使用延伸模組的版本。 您可以使用 列出資源擴充功能版本 來決定的複寫狀態和可用的延伸模組的版本。

ResourceExtensionParameterValues

選擇項。 包含在安裝時傳遞至資源擴充功能的參數集合。

狀態

選擇項。 指定資源擴充功能的狀態。 建立虛擬機器時,您可以指定唯一的狀態是 enable, ,這是預設值如果不使用這個元素。 如需有關停用或移除延伸模組的詳細資訊,請參閱 更新角色

憑證

選擇項。 包含安裝於虛擬機器上並由延伸模組使用的憑證集合。 憑證必須先新增到雲端服務,才能包含在此要求中。 如需詳細資訊,請參閱 加入服務憑證

Certificates 項目只是使用 2014年-06-01 版或更高版本。

包含安裝於虛擬機器上並由延伸模組使用的憑證集合。

元素名稱

說明

Thumbprint

必要項。 指定延伸模組所要使用之憑證的指紋。

ThumbprintAlgorithm

必要項。 指定指紋演算法。 這個值一律為 sha1

包含在安裝時傳遞至資源擴充功能的參數集合。

元素名稱

說明

ResourceExtensionParameterValue

必要項。 指定參數的金鑰、值和類型。

金鑰

必要項。 指定參數的金鑰。

必要項。 指定參數的 Base-64 編碼值。 如果延伸模組的組態是在 XML 中格式化,則會使用公用或私人結構描述來驗證此值。 使用結構描述而定的值 Type

如果延伸模組的組態是在 JSON 中格式化,則此值必須包含有效的 JSON 物件。 公用或私人結構描述無法用於驗證物件。 若要使用 JSON 物件,版本必須是 2014-04-01 或更新版本。

類型

必要項。 指定資源擴充功能的類型。

可能的值為:

  • Public

  • Private

如果此值設定為 Private, ,參數將不會傳回由 取得部署 您最多只能指定兩個參數,且只能有一個公用參數及一個私用參數。

包含要與虛擬機器建立關聯的 DNS 伺服器的清單。

元素名稱

說明

DnsServers

必要項。 包含各項參數以指定要用於虛擬機器的 DNS 伺服器。

DnsServer

必要項。 包含 NameAddress DNS 伺服器的項目。

名稱

必要項。 指定 DNS 伺服器的名稱。

位址

必要項。 指定 DNS 伺服器的 IP 位址。

回應包括 HTTP 狀態碼、一組回應標頭和回應主體。

成功的作業會傳回狀態碼「202 (已接受)」。 如需狀態碼的相關資訊,請參閱 服務管理狀態和錯誤碼

這項作業的回應包括下列標頭。 回應也可能包括其他標準 HTTP 標頭。 所有標準標頭符合 HTTP/1.1 通訊協定規格

回應標頭

說明

x-ms-request-id

唯一識別對管理服務發出之要求的值。

您也可以使用下列資源,將虛擬機器加入至部署:

佈建的磁碟只可以加入至佈建的 VM 大小。

顯示: