共用方式為


Microsoft.Compute cloudServices 2022-09-04

Bicep 資源定義

cloudServices 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.Compute/cloudServices 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Compute/cloudServices@2022-09-04' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    allowModelOverride: bool
    configuration: 'string'
    configurationUrl: 'string'
    extensionProfile: {
      extensions: [
        {
          name: 'string'
          properties: {
            autoUpgradeMinorVersion: bool
            forceUpdateTag: 'string'
            protectedSettings: any()
            protectedSettingsFromKeyVault: {
              secretUrl: 'string'
              sourceVault: {
                id: 'string'
              }
            }
            publisher: 'string'
            rolesAppliedTo: [
              'string'
            ]
            settings: any()
            type: 'string'
            typeHandlerVersion: 'string'
          }
        }
      ]
    }
    networkProfile: {
      loadBalancerConfigurations: [
        {
          id: 'string'
          name: 'string'
          properties: {
            frontendIpConfigurations: [
              {
                name: 'string'
                properties: {
                  privateIPAddress: 'string'
                  publicIPAddress: {
                    id: 'string'
                  }
                  subnet: {
                    id: 'string'
                  }
                }
              }
            ]
          }
        }
      ]
      slotType: 'string'
      swappableCloudService: {
        id: 'string'
      }
    }
    osProfile: {
      secrets: [
        {
          sourceVault: {
            id: 'string'
          }
          vaultCertificates: [
            {
              certificateUrl: 'string'
            }
          ]
        }
      ]
    }
    packageUrl: 'string'
    roleProfile: {
      roles: [
        {
          name: 'string'
          sku: {
            capacity: int
            name: 'string'
            tier: 'string'
          }
        }
      ]
    }
    startCloudService: bool
    upgradeMode: 'string'
  }
  systemData: {}
  zones: [
    'string' or int
  ]
}

屬性值

cloudServices

名字 描述 價值
名字 資源名稱 字串 (必要)

字元限制:1-15



合法字元:
無法使用空白、控制字元或下列字元:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

無法以底線開頭。 不能以句號或連字元結尾。
位置 資源位置。 字串 (必要)
標籤 資源標籤。 標記名稱和值的字典。 請參閱範本中的 標籤
性能 雲端服務屬性 CloudServiceProperties
systemData 與此資源相關的系統元數據。 SystemData
資源的邏輯可用性區域清單。 清單應該只包含應布建雲端服務的1個區域。 此欄位為選擇性欄位。 可用性區域陣列做為字串或int。

CloudServiceProperties

名字 描述 價值
allowModelOverride (選擇性)指出模型/範本中指定的角色 SKU 屬性 (roleProfile.roles.sku) 是否應該分別覆寫 .cscfg 和 .csdef 中指定的角色實例計數和 vm 大小。
預設值為 false
bool
配置 指定雲端服務的 XML 服務組態 (.cscfg)。 字串
configurationUrl 指定 URL,參考 Blob 服務中服務組態的位置。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。
這是唯寫屬性,而且不會在 GET 呼叫中傳回。
字串
extensionProfile 描述雲端服務擴充功能配置檔。 CloudServiceExtensionProfile
networkProfile 雲端服務的網路配置檔。 CloudServiceNetworkProfile
osProfile 描述雲端服務的 OS 配置檔。 CloudServiceOsProfile
packageUrl 指定參考 Blob 服務中服務套件位置的 URL。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。
這是唯寫屬性,而且不會在 GET 呼叫中傳回。
字串
roleProfile 描述雲端服務的角色配置檔。 CloudServiceRoleProfile
startCloudService (選擇性)指出是否要在建立雲端服務之後立即啟動。 預設值為 true
如果為 false,服務模型仍會部署,但程式代碼不會立即執行。 相反地,服務會是PoweredOff,直到您呼叫 Start 為止,此時服務將會啟動。 即使已部署的服務已關閉,仍會產生費用。
bool
upgradeMode 雲端服務的更新模式。 角色實例會配置在部署服務時更新網域。 更新可以在每個更新網域中手動起始,或在所有更新網域中自動起始。
可能的值為

自動

手動

同時


如果未指定,預設值為 Auto。如果設定為 Manual,則必須呼叫 PUT UpdateDomain 以套用更新。 如果設定為 [自動],則會自動將更新套用至每個循序更新網域。
'Auto'
'Manual'
'Simultaneous'

CloudServiceExtensionProfile

名字 描述 價值
擴展 雲端服務的擴充功能清單。 擴充功能[]

外延

名字 描述 價值
名字 延伸模組的名稱。 字串
性能 延伸模組屬性。 CloudServiceExtensionProperties

CloudServiceExtensionProperties

名字 描述 價值
autoUpgradeMinorVersion 明確指定平臺是否可以在提供時自動將 typeHandlerVersion 升級至較高的次要版本。 bool
forceUpdateTag 要強制套用提供的公用和受保護設定的標籤。
變更標籤值可讓您重新執行延伸模組,而不需要變更任何公用或受保護的設定。
如果未變更 forceUpdateTag,處理程式仍會套用對公用或受保護設定的更新。
如果 forceUpdateTag 和任何公用或受保護的設定都未變更,擴充功能就會流向具有相同序號的角色實例,
它由處理程序實作決定是否要重新執行
字串
protectedSettings 在傳送至角色實例之前加密之延伸模組的受保護設定。 針對 Bicep,您可以使用 any() 函式。
protectedSettingsFromKeyVault 延伸模組的受保護設定,使用 KeyVault 參考,這些金鑰會先加密再傳送至角色實例。 CloudServiceVaultAndSecretReference
發行人 擴充處理程序發行者的名稱。 字串
rolesAppliedTo 要套用此擴充功能的選擇性角色清單。 如果未指定 屬性或指定 『*』,擴充功能會套用至雲端服務中的所有角色。 string[]
設置 延伸模組的公用設定。 針對 JSON 擴充功能,這是擴充功能的 JSON 設定。 對於 XML 延伸模組 (例如 RDP),這是延伸模組的 XML 設定。 針對 Bicep,您可以使用 any() 函式。
類型 指定延伸模組的類型。 字串
typeHandlerVersion 指定延伸模組的版本。 指定延伸模組的版本。 如果未指定這個專案,或使用星號 \ 作為值,則會使用最新版本的延伸模組。 如果值是以主要版本號碼和星號指定為次要版本號碼 (X.),則會選取指定主要版本的最新次要版本。 如果指定了主要版本號碼和次要版本號碼(X.Y),則會選取特定的擴充功能版本。 如果指定版本,就會在角色實例上執行自動升級。 字串

CloudServiceVaultAndSecretReference

名字 描述 價值
secretUrl 包含延伸模組受保護設定的秘密 URL 字串
sourceVault Key Vault 的 ARM 資源識別碼 SubResource

SubResource

名字 描述 價值
id 資源標識碼 字串

CloudServiceNetworkProfile

名字 描述 價值
loadBalancerConfigurations 負載平衡器組態的清單。 雲端服務最多可以有兩個負載平衡器組態,對應至公用Load Balancer和內部負載平衡器。 LoadBalancerConfiguration[]
slotType 雲端服務的插槽類型。
可能的值為

生產

預備


如果未指定,預設值為 Production。
'Production'
'Staging'
swappableCloudService 雲端服務的標識碼參考,其中包含主體雲端服務可執行交換的目標IP。 一旦設定此屬性,就無法更新此屬性。 此標識碼所參考的可交換雲端服務必須存在,否則將會擲回錯誤。 SubResource

LoadBalancerConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 負載平衡器的名稱 字串 (必要)
性能 負載平衡器組態的屬性。 LoadBalancerConfigurationProperties (必要)

LoadBalancerConfigurationProperties

名字 描述 價值
frontendIpConfigurations 指定要用於負載平衡器的前端IP。 僅支援 IPv4 前端 IP 位址。 每個負載平衡器組態都必須只有一個前端IP組態。 LoadBalancerFrontendIpConfiguration[] (必要)

LoadBalancerFrontendIpConfiguration

名字 描述 價值
名字 負載平衡器所使用前端IP組態集合內唯一的資源名稱。 此名稱可用來存取資源。 字串 (必要)
性能 負載平衡器前端IP組態的屬性。 LoadBalancerFrontendIpConfigurationProperties (必要)

LoadBalancerFrontendIpConfigurationProperties

名字 描述 價值
privateIPAddress IP 組態的虛擬網路私人IP位址。 字串
publicIPAddress 公用IP位址資源的參考。 SubResource
虛擬網路子網資源的參考。 SubResource

CloudServiceOsProfile

名字 描述 價值
秘密 指定應該安裝在角色實例上的憑證集。 CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

名字 描述 價值
sourceVault Key Vault 的相對 URL,其中包含 VaultCertificates 中的所有憑證。 SubResource
vaultCertificates SourceVault 中包含憑證的金鑰保存庫參考清單。 CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

名字 描述 價值
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 字串

CloudServiceRoleProfile

名字 描述 價值
角色 雲端服務的角色清單。 CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

名字 描述 價值
名字 資源名稱。 字串
sku 描述雲端服務角色 SKU。 CloudServiceRoleSku

CloudServiceRoleSku

名字 描述 價值
能力 指定雲端服務中的角色實例數目。 int
名字 SKU 名稱。 注意:如果雲端服務目前所在的硬體不支援新的 SKU,您需要刪除並重新建立雲端服務,或移回舊的 SKU。 字串
指定雲端服務的層級。 可能的值為

Standard

基本
字串

SystemData

此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。

ARM 樣本資源定義

cloudServices 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.Compute/cloudServices 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Compute/cloudServices",
  "apiVersion": "2022-09-04",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "allowModelOverride": "bool",
    "configuration": "string",
    "configurationUrl": "string",
    "extensionProfile": {
      "extensions": [
        {
          "name": "string",
          "properties": {
            "autoUpgradeMinorVersion": "bool",
            "forceUpdateTag": "string",
            "protectedSettings": {},
            "protectedSettingsFromKeyVault": {
              "secretUrl": "string",
              "sourceVault": {
                "id": "string"
              }
            },
            "publisher": "string",
            "rolesAppliedTo": [ "string" ],
            "settings": {},
            "type": "string",
            "typeHandlerVersion": "string"
          }
        }
      ]
    },
    "networkProfile": {
      "loadBalancerConfigurations": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "frontendIpConfigurations": [
              {
                "name": "string",
                "properties": {
                  "privateIPAddress": "string",
                  "publicIPAddress": {
                    "id": "string"
                  },
                  "subnet": {
                    "id": "string"
                  }
                }
              }
            ]
          }
        }
      ],
      "slotType": "string",
      "swappableCloudService": {
        "id": "string"
      }
    },
    "osProfile": {
      "secrets": [
        {
          "sourceVault": {
            "id": "string"
          },
          "vaultCertificates": [
            {
              "certificateUrl": "string"
            }
          ]
        }
      ]
    },
    "packageUrl": "string",
    "roleProfile": {
      "roles": [
        {
          "name": "string",
          "sku": {
            "capacity": "int",
            "name": "string",
            "tier": "string"
          }
        }
      ]
    },
    "startCloudService": "bool",
    "upgradeMode": "string"
  },
  "systemData": {},
  "zones": [ "string" or int ]
}

屬性值

cloudServices

名字 描述 價值
類型 資源類型 'Microsoft.Compute/cloudServices'
apiVersion 資源 API 版本 '2022-09-04'
名字 資源名稱 字串 (必要)

字元限制:1-15



合法字元:
無法使用空白、控制字元或下列字元:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

無法以底線開頭。 不能以句號或連字元結尾。
位置 資源位置。 字串 (必要)
標籤 資源標籤。 標記名稱和值的字典。 請參閱範本中的 標籤
性能 雲端服務屬性 CloudServiceProperties
systemData 與此資源相關的系統元數據。 SystemData
資源的邏輯可用性區域清單。 清單應該只包含應布建雲端服務的1個區域。 此欄位為選擇性欄位。 可用性區域陣列做為字串或int。

CloudServiceProperties

名字 描述 價值
allowModelOverride (選擇性)指出模型/範本中指定的角色 SKU 屬性 (roleProfile.roles.sku) 是否應該分別覆寫 .cscfg 和 .csdef 中指定的角色實例計數和 vm 大小。
預設值為 false
bool
配置 指定雲端服務的 XML 服務組態 (.cscfg)。 字串
configurationUrl 指定 URL,參考 Blob 服務中服務組態的位置。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。
這是唯寫屬性,而且不會在 GET 呼叫中傳回。
字串
extensionProfile 描述雲端服務擴充功能配置檔。 CloudServiceExtensionProfile
networkProfile 雲端服務的網路配置檔。 CloudServiceNetworkProfile
osProfile 描述雲端服務的 OS 配置檔。 CloudServiceOsProfile
packageUrl 指定參考 Blob 服務中服務套件位置的 URL。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。
這是唯寫屬性,而且不會在 GET 呼叫中傳回。
字串
roleProfile 描述雲端服務的角色配置檔。 CloudServiceRoleProfile
startCloudService (選擇性)指出是否要在建立雲端服務之後立即啟動。 預設值為 true
如果為 false,服務模型仍會部署,但程式代碼不會立即執行。 相反地,服務會是PoweredOff,直到您呼叫 Start 為止,此時服務將會啟動。 即使已部署的服務已關閉,仍會產生費用。
bool
upgradeMode 雲端服務的更新模式。 角色實例會配置在部署服務時更新網域。 更新可以在每個更新網域中手動起始,或在所有更新網域中自動起始。
可能的值為

自動

手動

同時


如果未指定,預設值為 Auto。如果設定為 Manual,則必須呼叫 PUT UpdateDomain 以套用更新。 如果設定為 [自動],則會自動將更新套用至每個循序更新網域。
'Auto'
'Manual'
'Simultaneous'

CloudServiceExtensionProfile

名字 描述 價值
擴展 雲端服務的擴充功能清單。 擴充功能[]

外延

名字 描述 價值
名字 延伸模組的名稱。 字串
性能 延伸模組屬性。 CloudServiceExtensionProperties

CloudServiceExtensionProperties

名字 描述 價值
autoUpgradeMinorVersion 明確指定平臺是否可以在提供時自動將 typeHandlerVersion 升級至較高的次要版本。 bool
forceUpdateTag 要強制套用提供的公用和受保護設定的標籤。
變更標籤值可讓您重新執行延伸模組,而不需要變更任何公用或受保護的設定。
如果未變更 forceUpdateTag,處理程式仍會套用對公用或受保護設定的更新。
如果 forceUpdateTag 和任何公用或受保護的設定都未變更,擴充功能就會流向具有相同序號的角色實例,
它由處理程序實作決定是否要重新執行
字串
protectedSettings 在傳送至角色實例之前加密之延伸模組的受保護設定。
protectedSettingsFromKeyVault 延伸模組的受保護設定,使用 KeyVault 參考,這些金鑰會先加密再傳送至角色實例。 CloudServiceVaultAndSecretReference
發行人 擴充處理程序發行者的名稱。 字串
rolesAppliedTo 要套用此擴充功能的選擇性角色清單。 如果未指定 屬性或指定 『*』,擴充功能會套用至雲端服務中的所有角色。 string[]
設置 延伸模組的公用設定。 針對 JSON 擴充功能,這是擴充功能的 JSON 設定。 對於 XML 延伸模組 (例如 RDP),這是延伸模組的 XML 設定。
類型 指定延伸模組的類型。 字串
typeHandlerVersion 指定延伸模組的版本。 指定延伸模組的版本。 如果未指定這個專案,或使用星號 \ 作為值,則會使用最新版本的延伸模組。 如果值是以主要版本號碼和星號指定為次要版本號碼 (X.),則會選取指定主要版本的最新次要版本。 如果指定了主要版本號碼和次要版本號碼(X.Y),則會選取特定的擴充功能版本。 如果指定版本,就會在角色實例上執行自動升級。 字串

CloudServiceVaultAndSecretReference

名字 描述 價值
secretUrl 包含延伸模組受保護設定的秘密 URL 字串
sourceVault Key Vault 的 ARM 資源識別碼 SubResource

SubResource

名字 描述 價值
id 資源標識碼 字串

CloudServiceNetworkProfile

名字 描述 價值
loadBalancerConfigurations 負載平衡器組態的清單。 雲端服務最多可以有兩個負載平衡器組態,對應至公用Load Balancer和內部負載平衡器。 LoadBalancerConfiguration[]
slotType 雲端服務的插槽類型。
可能的值為

生產

預備


如果未指定,預設值為 Production。
'Production'
'Staging'
swappableCloudService 雲端服務的標識碼參考,其中包含主體雲端服務可執行交換的目標IP。 一旦設定此屬性,就無法更新此屬性。 此標識碼所參考的可交換雲端服務必須存在,否則將會擲回錯誤。 SubResource

LoadBalancerConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 負載平衡器的名稱 字串 (必要)
性能 負載平衡器組態的屬性。 LoadBalancerConfigurationProperties (必要)

LoadBalancerConfigurationProperties

名字 描述 價值
frontendIpConfigurations 指定要用於負載平衡器的前端IP。 僅支援 IPv4 前端 IP 位址。 每個負載平衡器組態都必須只有一個前端IP組態。 LoadBalancerFrontendIpConfiguration[] (必要)

LoadBalancerFrontendIpConfiguration

名字 描述 價值
名字 負載平衡器所使用前端IP組態集合內唯一的資源名稱。 此名稱可用來存取資源。 字串 (必要)
性能 負載平衡器前端IP組態的屬性。 LoadBalancerFrontendIpConfigurationProperties (必要)

LoadBalancerFrontendIpConfigurationProperties

名字 描述 價值
privateIPAddress IP 組態的虛擬網路私人IP位址。 字串
publicIPAddress 公用IP位址資源的參考。 SubResource
虛擬網路子網資源的參考。 SubResource

CloudServiceOsProfile

名字 描述 價值
秘密 指定應該安裝在角色實例上的憑證集。 CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

名字 描述 價值
sourceVault Key Vault 的相對 URL,其中包含 VaultCertificates 中的所有憑證。 SubResource
vaultCertificates SourceVault 中包含憑證的金鑰保存庫參考清單。 CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

名字 描述 價值
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 字串

CloudServiceRoleProfile

名字 描述 價值
角色 雲端服務的角色清單。 CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

名字 描述 價值
名字 資源名稱。 字串
sku 描述雲端服務角色 SKU。 CloudServiceRoleSku

CloudServiceRoleSku

名字 描述 價值
能力 指定雲端服務中的角色實例數目。 int
名字 SKU 名稱。 注意:如果雲端服務目前所在的硬體不支援新的 SKU,您需要刪除並重新建立雲端服務,或移回舊的 SKU。 字串
指定雲端服務的層級。 可能的值為

Standard

基本
字串

SystemData

此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。

Terraform (AzAPI 提供者) 資源定義

cloudServices 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.Compute/cloudServices 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/cloudServices@2022-09-04"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allowModelOverride = bool
      configuration = "string"
      configurationUrl = "string"
      extensionProfile = {
        extensions = [
          {
            name = "string"
            properties = {
              autoUpgradeMinorVersion = bool
              forceUpdateTag = "string"
              protectedSettingsFromKeyVault = {
                secretUrl = "string"
                sourceVault = {
                  id = "string"
                }
              }
              publisher = "string"
              rolesAppliedTo = [
                "string"
              ]
              type = "string"
              typeHandlerVersion = "string"
            }
          }
        ]
      }
      networkProfile = {
        loadBalancerConfigurations = [
          {
            id = "string"
            name = "string"
            properties = {
              frontendIpConfigurations = [
                {
                  name = "string"
                  properties = {
                    privateIPAddress = "string"
                    publicIPAddress = {
                      id = "string"
                    }
                    subnet = {
                      id = "string"
                    }
                  }
                }
              ]
            }
          }
        ]
        slotType = "string"
        swappableCloudService = {
          id = "string"
        }
      }
      osProfile = {
        secrets = [
          {
            sourceVault = {
              id = "string"
            }
            vaultCertificates = [
              {
                certificateUrl = "string"
              }
            ]
          }
        ]
      }
      packageUrl = "string"
      roleProfile = {
        roles = [
          {
            name = "string"
            sku = {
              capacity = int
              name = "string"
              tier = "string"
            }
          }
        ]
      }
      startCloudService = bool
      upgradeMode = "string"
    }
    systemData = {}
    zones = [
      "string" or int
    ]
  })
}

屬性值

cloudServices

名字 描述 價值
類型 資源類型 “Microsoft.Compute/cloudServices@2022-09-04”
名字 資源名稱 字串 (必要)

字元限制:1-15



合法字元:
無法使用空白、控制字元或下列字元:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

無法以底線開頭。 不能以句號或連字元結尾。
位置 資源位置。 字串 (必要)
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 字串 (必要)
標籤 資源標籤。 標記名稱和值的字典。
性能 雲端服務屬性 CloudServiceProperties
systemData 與此資源相關的系統元數據。 SystemData
資源的邏輯可用性區域清單。 清單應該只包含應布建雲端服務的1個區域。 此欄位為選擇性欄位。 可用性區域陣列做為字串或int。

CloudServiceProperties

名字 描述 價值
allowModelOverride (選擇性)指出模型/範本中指定的角色 SKU 屬性 (roleProfile.roles.sku) 是否應該分別覆寫 .cscfg 和 .csdef 中指定的角色實例計數和 vm 大小。
預設值為 false
bool
配置 指定雲端服務的 XML 服務組態 (.cscfg)。 字串
configurationUrl 指定 URL,參考 Blob 服務中服務組態的位置。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。
這是唯寫屬性,而且不會在 GET 呼叫中傳回。
字串
extensionProfile 描述雲端服務擴充功能配置檔。 CloudServiceExtensionProfile
networkProfile 雲端服務的網路配置檔。 CloudServiceNetworkProfile
osProfile 描述雲端服務的 OS 配置檔。 CloudServiceOsProfile
packageUrl 指定參考 Blob 服務中服務套件位置的 URL。 服務套件 URL 可以是來自任何記憶體帳戶的共用存取簽章 (SAS) URI。
這是唯寫屬性,而且不會在 GET 呼叫中傳回。
字串
roleProfile 描述雲端服務的角色配置檔。 CloudServiceRoleProfile
startCloudService (選擇性)指出是否要在建立雲端服務之後立即啟動。 預設值為 true
如果為 false,服務模型仍會部署,但程式代碼不會立即執行。 相反地,服務會是PoweredOff,直到您呼叫 Start 為止,此時服務將會啟動。 即使已部署的服務已關閉,仍會產生費用。
bool
upgradeMode 雲端服務的更新模式。 角色實例會配置在部署服務時更新網域。 更新可以在每個更新網域中手動起始,或在所有更新網域中自動起始。
可能的值為

自動

手動

同時


如果未指定,預設值為 Auto。如果設定為 Manual,則必須呼叫 PUT UpdateDomain 以套用更新。 如果設定為 [自動],則會自動將更新套用至每個循序更新網域。
“Auto”
“Manual”
“同時”

CloudServiceExtensionProfile

名字 描述 價值
擴展 雲端服務的擴充功能清單。 擴充功能[]

外延

名字 描述 價值
名字 延伸模組的名稱。 字串
性能 延伸模組屬性。 CloudServiceExtensionProperties

CloudServiceExtensionProperties

名字 描述 價值
autoUpgradeMinorVersion 明確指定平臺是否可以在提供時自動將 typeHandlerVersion 升級至較高的次要版本。 bool
forceUpdateTag 要強制套用提供的公用和受保護設定的標籤。
變更標籤值可讓您重新執行延伸模組,而不需要變更任何公用或受保護的設定。
如果未變更 forceUpdateTag,處理程式仍會套用對公用或受保護設定的更新。
如果 forceUpdateTag 和任何公用或受保護的設定都未變更,擴充功能就會流向具有相同序號的角色實例,
它由處理程序實作決定是否要重新執行
字串
protectedSettings 在傳送至角色實例之前加密之延伸模組的受保護設定。
protectedSettingsFromKeyVault 延伸模組的受保護設定,使用 KeyVault 參考,這些金鑰會先加密再傳送至角色實例。 CloudServiceVaultAndSecretReference
發行人 擴充處理程序發行者的名稱。 字串
rolesAppliedTo 要套用此擴充功能的選擇性角色清單。 如果未指定 屬性或指定 『*』,擴充功能會套用至雲端服務中的所有角色。 string[]
設置 延伸模組的公用設定。 針對 JSON 擴充功能,這是擴充功能的 JSON 設定。 對於 XML 延伸模組 (例如 RDP),這是延伸模組的 XML 設定。
類型 指定延伸模組的類型。 字串
typeHandlerVersion 指定延伸模組的版本。 指定延伸模組的版本。 如果未指定這個專案,或使用星號 \ 作為值,則會使用最新版本的延伸模組。 如果值是以主要版本號碼和星號指定為次要版本號碼 (X.),則會選取指定主要版本的最新次要版本。 如果指定了主要版本號碼和次要版本號碼(X.Y),則會選取特定的擴充功能版本。 如果指定版本,就會在角色實例上執行自動升級。 字串

CloudServiceVaultAndSecretReference

名字 描述 價值
secretUrl 包含延伸模組受保護設定的秘密 URL 字串
sourceVault Key Vault 的 ARM 資源識別碼 SubResource

SubResource

名字 描述 價值
id 資源標識碼 字串

CloudServiceNetworkProfile

名字 描述 價值
loadBalancerConfigurations 負載平衡器組態的清單。 雲端服務最多可以有兩個負載平衡器組態,對應至公用Load Balancer和內部負載平衡器。 LoadBalancerConfiguration[]
slotType 雲端服務的插槽類型。
可能的值為

生產

預備


如果未指定,預設值為 Production。
“Production”
“預備”
swappableCloudService 雲端服務的標識碼參考,其中包含主體雲端服務可執行交換的目標IP。 一旦設定此屬性,就無法更新此屬性。 此標識碼所參考的可交換雲端服務必須存在,否則將會擲回錯誤。 SubResource

LoadBalancerConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 負載平衡器的名稱 字串 (必要)
性能 負載平衡器組態的屬性。 LoadBalancerConfigurationProperties (必要)

LoadBalancerConfigurationProperties

名字 描述 價值
frontendIpConfigurations 指定要用於負載平衡器的前端IP。 僅支援 IPv4 前端 IP 位址。 每個負載平衡器組態都必須只有一個前端IP組態。 LoadBalancerFrontendIpConfiguration[] (必要)

LoadBalancerFrontendIpConfiguration

名字 描述 價值
名字 負載平衡器所使用前端IP組態集合內唯一的資源名稱。 此名稱可用來存取資源。 字串 (必要)
性能 負載平衡器前端IP組態的屬性。 LoadBalancerFrontendIpConfigurationProperties (必要)

LoadBalancerFrontendIpConfigurationProperties

名字 描述 價值
privateIPAddress IP 組態的虛擬網路私人IP位址。 字串
publicIPAddress 公用IP位址資源的參考。 SubResource
虛擬網路子網資源的參考。 SubResource

CloudServiceOsProfile

名字 描述 價值
秘密 指定應該安裝在角色實例上的憑證集。 CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

名字 描述 價值
sourceVault Key Vault 的相對 URL,其中包含 VaultCertificates 中的所有憑證。 SubResource
vaultCertificates SourceVault 中包含憑證的金鑰保存庫參考清單。 CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

名字 描述 價值
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 字串

CloudServiceRoleProfile

名字 描述 價值
角色 雲端服務的角色清單。 CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

名字 描述 價值
名字 資源名稱。 字串
sku 描述雲端服務角色 SKU。 CloudServiceRoleSku

CloudServiceRoleSku

名字 描述 價值
能力 指定雲端服務中的角色實例數目。 int
名字 SKU 名稱。 注意:如果雲端服務目前所在的硬體不支援新的 SKU,您需要刪除並重新建立雲端服務,或移回舊的 SKU。 字串
指定雲端服務的層級。 可能的值為

Standard

基本
字串

SystemData

此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。