你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Compute cloudServices 2022-04-04

Bicep 资源定义

cloudServices 资源类型可以通过针对以下操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Compute/cloudServices 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Compute/cloudServices@2022-04-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: {}
}

属性值

cloudServices

名称 说明
name 资源名称 字符串 (必需)

字符限制:1-15



有效字符:
不得使用空格、控制字符或以下字符:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

不能以下划线开头。 不能以句点或连字符结尾。
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 云服务属性 CloudServiceProperties
systemData 与此资源相关的系统元数据。 SystemData

CloudServiceProperties

名称 说明
allowModelOverride (可选) 指示在模型/模板中指定的 roleProfile.roles.sku (roleProfile.roles.sku) 应分别替代 .cscfg 和 .csdef 中指定的角色实例计数和 vm 大小。
默认值为 false
bool
配置 指定云服务的 XML 服务配置 (.cscfg) 。 字符串
configurationUrl 指定一个 URL,该 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,直到你调用“启动”,此时服务将启动。 即使已关闭,已部署的服务仍会产生费用。
bool
upgradeMode 云服务的更新模式。 在部署服务时将角色实例分配给更新域。 可在每个更新域中手动开始更新,也可以在所有更新域中自动开始更新。
可能的值为

Auto

手动

同时


如果未指定,则默认值为“自动”。如果设置为“手动”,则必须调用 PUT UpdateDomain 来应用更新。 如果设置为“自动”,则会按顺序自动将更新应用到每个更新域。
“自动”
“手动”
“同时”

CloudServiceExtensionProfile

名称 说明
扩展 云服务的扩展列表。 Extension[]

扩展名

“属性” 说明
name 扩展插件的名称。 string
properties 扩展属性。 CloudServiceExtensionProperties

CloudServiceExtensionProperties

名称 说明
autoUpgradeMinorVersion 显式指定平台是否可以在 typeHandlerVersion 可用时自动将 typeHandlerVersion 升级到更高次要版本。 bool
forceUpdateTag 强制应用提供的公共和受保护的设置的标记。
更改标记值允许重新运行扩展,而无需更改任何公共或受保护的设置。
如果未更改 forceUpdateTag,处理程序仍会应用对公共或受保护设置的更新。
如果 forceUpdateTag 或任何公共或受保护的设置均未更改,扩展将流向具有相同序列号的角色实例,并且
由处理程序实现决定是否重新运行它
字符串
protectedSettings 在发送到角色实例之前加密的扩展的受保护设置。 对于 Bicep,可以使用 any () 函数。
protectedSettingsFromKeyVault 扩展的受保护设置,使用 KeyVault 引用,这些设置在发送到角色实例之前已加密。 CloudServiceVaultAndSecretReference
publisher 扩展处理程序发布者的名称。 字符串
rolesAppliedTo 用于应用此扩展的角色的可选列表。 如果未指定属性或指定了“*”,则扩展将应用于云服务中的所有角色。 string[]
设置 扩展的公共设置。 对于 JSON 扩展,这是扩展的 JSON 设置。 对于 RDP) 等 XML 扩展 (,这是扩展的 XML 设置。 对于 Bicep,可以使用 any () 函数。
类型 指定扩展的类型。 字符串
typeHandlerVersion 指定扩展的版本。 指定扩展的版本。 如果未指定此元素或将星号 (*) 用作值,则使用最新版本的扩展。 如果使用主版本号和星号指定该值作为 X.) 的次要版本号 (,则选择指定主版本的最新次要版本。 如果 (X.Y) 指定了主版本号和次要版本号,则选择特定的扩展版本。 如果指定版本,将对角色实例执行自动升级。 字符串

CloudServiceVaultAndSecretReference

名称 说明
secretUrl 包含扩展的受保护设置的机密 URL 字符串
sourceVault 密钥保管库的 ARM 资源 ID SubResource

SubResource

名称 说明 Value
id 资源 ID 字符串

CloudServiceNetworkProfile

名称 说明
loadBalancerConfigurations 负载均衡器配置列表。 云服务最多可以有两个负载均衡器配置,对应于一个公共负载均衡器和一个内部负载均衡器。 LoadBalancerConfiguration[]
slotType 云服务的槽类型。
可能的值为

生产

过渡


如果未指定,则默认值为 Production。
“生产”
'Staging'
swappableCloudService 包含目标 IP 的云服务的 ID 引用,主题云服务可以与之执行交换。 此属性在设置后无法更新。 此 ID 引用的可交换云服务必须存在,否则将引发错误。 SubResource

LoadBalancerConfiguration

名称 说明 Value
id 资源 ID 字符串
name 负载均衡器的名称 字符串 (必需)
properties 负载均衡器配置的属性。 LoadBalancerConfigurationProperties (必需)

LoadBalancerConfigurationProperties

名称 说明
frontendIPConfigurations 指定要用于负载均衡器的前端 IP。 仅支持 IPv4 前端 IP 地址。 每个负载均衡器配置必须恰好具有一个前端 IP 配置。 LoadBalancerFrontendIPConfiguration[] (必需的)

LoadBalancerFrontendIPConfiguration

名称 说明
name 负载均衡器使用的前端 IP 配置集中唯一的资源的名称。 此名称可用于访问资源。 字符串 (必需)
properties 负载均衡器前端 IP 配置的属性。 LoadBalancerFrontendIPConfigurationProperties (必需)

LoadBalancerFrontendIPConfigurationProperties

名称 说明
privateIPAddress IP 配置的虚拟网络专用 IP 地址。 字符串
publicIPAddress 对公共 IP 地址资源的引用。 SubResource
子网 对虚拟网络子网资源的引用。 SubResource

CloudServiceOsProfile

名称 说明
机密 指定应安装在角色实例上的证书集。 CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

名称 说明
sourceVault 包含 VaultCertificates 中所有证书的密钥保管库的相对 URL。 SubResource
vaultCertificates SourceVault 中包含证书的密钥保管库引用列表。 CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

名称 说明
certificateUrl 这是已作为机密上传到密钥保管库的证书的 URL。 字符串

CloudServiceRoleProfile

名称 说明
角色 云服务的角色列表。 CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

名称 说明
name 资源名称。 字符串
sku 描述云服务角色 SKU。 CloudServiceRoleSku

CloudServiceRoleSku

名称 说明
容量 指定云服务中的角色实例数。 int
name SKU 名称。 注意:如果云服务当前使用的硬件不支持新 SKU,则需要删除并重新创建云服务或移回旧 SKU。 字符串
指定云服务的层。 可能的值为

标准

基本
字符串

SystemData

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

ARM 模板资源定义

cloudServices 资源类型可以通过针对以下操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Compute/cloudServices 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Compute/cloudServices",
  "apiVersion": "2022-04-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": {}
}

属性值

cloudServices

名称 说明 Value
type 资源类型 “Microsoft.Compute/cloudServices”
apiVersion 资源 API 版本 '2022-04-04'
name 资源名称 字符串 (必需)

字符限制:1-15



有效字符:
不得使用空格、控制字符或以下字符:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

不能以下划线开头。 不能以句点或连字符结尾。
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 云服务属性 CloudServiceProperties
systemData 与此资源相关的系统元数据。 SystemData

CloudServiceProperties

名称 说明
allowModelOverride (可选) 指示在模型/模板中指定的 roleProfile.roles.sku (roleProfile.roles.sku) 应分别替代 .cscfg 和 .csdef 中指定的角色实例计数和 vm 大小。
默认值为 false
bool
配置 指定云服务的 XML 服务配置 (.cscfg) 。 字符串
configurationUrl 指定一个 URL,该 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,直到你调用“启动”,此时服务将启动。 即使已关闭,已部署的服务仍会产生费用。
bool
upgradeMode 云服务的更新模式。 在部署服务时将角色实例分配给更新域。 可在每个更新域中手动开始更新,也可以在所有更新域中自动开始更新。
可能的值为

Auto

手动

同时


如果未指定,则默认值为“自动”。如果设置为“手动”,则必须调用 PUT UpdateDomain 来应用更新。 如果设置为“自动”,则会按顺序自动将更新应用到每个更新域。
“自动”
“手动”
“同时”

CloudServiceExtensionProfile

名称 说明
扩展 云服务的扩展列表。 Extension[]

扩展名

“属性” 说明
name 扩展插件的名称。 string
properties 扩展属性。 CloudServiceExtensionProperties

CloudServiceExtensionProperties

名称 说明
autoUpgradeMinorVersion 显式指定平台是否可以在 typeHandlerVersion 可用时自动将 typeHandlerVersion 升级到更高次要版本。 bool
forceUpdateTag 强制应用提供的公共和受保护的设置的标记。
更改标记值允许重新运行扩展,而无需更改任何公共或受保护的设置。
如果未更改 forceUpdateTag,处理程序仍会应用对公共或受保护设置的更新。
如果 forceUpdateTag 或任何公共或受保护的设置均未更改,扩展将流向具有相同序列号的角色实例,并且
由处理程序实现决定是否重新运行它
字符串
protectedSettings 在发送到角色实例之前加密的扩展的受保护设置。
protectedSettingsFromKeyVault 扩展的受保护设置,使用 KeyVault 引用,这些设置在发送到角色实例之前已加密。 CloudServiceVaultAndSecretReference
publisher 扩展处理程序发布者的名称。 字符串
rolesAppliedTo 用于应用此扩展的角色的可选列表。 如果未指定属性或指定了“*”,则扩展将应用于云服务中的所有角色。 string[]
设置 扩展的公共设置。 对于 JSON 扩展,这是扩展的 JSON 设置。 对于 RDP) 等 XML 扩展 (,这是扩展的 XML 设置。
类型 指定扩展的类型。 字符串
typeHandlerVersion 指定扩展的版本。 指定扩展的版本。 如果未指定此元素或将星号 (*) 用作值,则使用最新版本的扩展。 如果使用主版本号和星号指定该值作为 X.) 的次要版本号 (,则选择指定主版本的最新次要版本。 如果 (X.Y) 指定了主版本号和次要版本号,则选择特定的扩展版本。 如果指定版本,将对角色实例执行自动升级。 字符串

CloudServiceVaultAndSecretReference

名称 说明
secretUrl 包含扩展的受保护设置的机密 URL 字符串
sourceVault 密钥保管库的 ARM 资源 ID SubResource

SubResource

名称 说明 Value
id 资源 ID 字符串

CloudServiceNetworkProfile

名称 说明
loadBalancerConfigurations 负载均衡器配置列表。 云服务最多可以有两个负载均衡器配置,对应于一个公共负载均衡器和一个内部负载均衡器。 LoadBalancerConfiguration[]
slotType 云服务的槽类型。
可能的值为

生产

过渡


如果未指定,则默认值为 Production。
“生产”
'Staging'
swappableCloudService 包含目标 IP 的云服务的 ID 引用,主题云服务可以与之执行交换。 此属性在设置后无法更新。 此 ID 引用的可交换云服务必须存在,否则将引发错误。 SubResource

LoadBalancerConfiguration

名称 说明 Value
id 资源 ID 字符串
name 负载均衡器的名称 字符串 (必需)
properties 负载均衡器配置的属性。 LoadBalancerConfigurationProperties (必需)

LoadBalancerConfigurationProperties

名称 说明
frontendIPConfigurations 指定要用于负载均衡器的前端 IP。 仅支持 IPv4 前端 IP 地址。 每个负载均衡器配置必须恰好具有一个前端 IP 配置。 LoadBalancerFrontendIPConfiguration[] (必需的)

LoadBalancerFrontendIPConfiguration

名称 说明
name 负载均衡器使用的前端 IP 配置集中唯一的资源名称。 此名称可用于访问资源。 字符串 (必需)
properties 负载均衡器前端 IP 配置的属性。 LoadBalancerFrontendIPConfigurationProperties (必需)

LoadBalancerFrontendIPConfigurationProperties

名称 说明
privateIPAddress IP 配置的虚拟网络专用 IP 地址。 string
publicIPAddress 对公共 IP 地址资源的引用。 SubResource
子网 对虚拟网络子网资源的引用。 SubResource

CloudServiceOsProfile

名称 说明
机密 指定应安装到角色实例上的证书集。 CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

名称 说明
sourceVault 包含 VaultCertificates 中所有证书的密钥保管库的相对 URL。 SubResource
vaultCertificates SourceVault 中包含证书的密钥保管库引用列表。 CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

名称 说明
certificateUrl 这是已作为机密上传到密钥保管库的证书的 URL。 string

CloudServiceRoleProfile

名称 说明
角色 云服务的角色列表。 CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

名称 说明
name 资源名称。 string
sku 介绍云服务角色 SKU。 CloudServiceRoleSku

CloudServiceRoleSku

名称 说明
容量 指定云服务中的角色实例数。 int
name SKU 名称。 注意:如果云服务当前使用的硬件不支持新 SKU,则需要删除并重新创建云服务或移回旧 SKU。 string
指定云服务的层。 可能的值为

标准

基本
string

SystemData

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

Terraform (AzAPI 提供程序) 资源定义

cloudServices 资源类型可以使用面向以下对象的操作进行部署:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Compute/cloudServices 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/cloudServices@2022-04-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 = {}
  })
}

属性值

cloudServices

名称 说明 Value
type 资源类型 “Microsoft.Compute/cloudServices@2022-04-04”
name 资源名称 字符串 (必需)

字符限制:1-15



有效字符:
不得使用空格、控制字符或以下字符:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

不能以下划线开头。 不能以句点或连字符结尾。
location 资源位置。 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
properties 云服务属性 CloudServiceProperties
systemData 与此资源相关的系统元数据。 SystemData

CloudServiceProperties

名称 说明
allowModelOverride (可选) 指示在模型/模板中指定的 roleProfile.roles.sku (roleProfile.roles.sku) 应分别替代 .cscfg 和 .csdef 中指定的角色实例计数和 vm 大小。
默认值为 false
bool
配置 指定云服务的 XML 服务配置 (.cscfg) 。 字符串
configurationUrl 指定一个 URL,该 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,直到你调用“启动”,此时服务将启动。 即使已关闭,已部署的服务仍会产生费用。
bool
upgradeMode 云服务的更新模式。 在部署服务时将角色实例分配给更新域。 可在每个更新域中手动开始更新,也可以在所有更新域中自动开始更新。
可能的值为

Auto

手动

同时


如果未指定,则默认值为“自动”。如果设置为“手动”,则必须调用 PUT UpdateDomain 来应用更新。 如果设置为“自动”,则会按顺序自动将更新应用到每个更新域。
“Auto”
“手动”
“同时”

CloudServiceExtensionProfile

名称 说明
扩展 云服务的扩展列表。 Extension[]

扩展名

“属性” 说明
name 扩展插件的名称。 string
properties 扩展属性。 CloudServiceExtensionProperties

CloudServiceExtensionProperties

名称 说明
autoUpgradeMinorVersion 显式指定平台是否可以在 typeHandlerVersion 可用时自动将 typeHandlerVersion 升级到更高的次要版本。 bool
forceUpdateTag 强制应用提供的公共和受保护的设置的标记。
通过更改标记值,无需更改任何公共或受保护的设置即可重新运行扩展。
如果未更改 forceUpdateTag,处理程序仍会应用对公共或受保护设置的更新。
如果 forceUpdateTag 以及任何公共或受保护的设置都没有更改,扩展将流向具有相同序列号的角色实例,并且
由处理程序实现决定是否重新运行它
字符串
protectedSettings 在发送到角色实例之前加密的扩展的受保护设置。
protectedSettingsFromKeyVault 扩展的受保护设置,使用 KeyVault 引用,这些设置在发送到角色实例之前加密。 CloudServiceVaultAndSecretReference
publisher 扩展处理程序发布者的名称。 字符串
rolesAppliedTo 要应用此扩展的可选角色列表。 如果未指定属性或指定“*”,则扩展将应用于云服务中的所有角色。 string[]
设置 扩展的公共设置。 对于 JSON 扩展,这是扩展的 JSON 设置。 对于 RDP) 等 XML 扩展 (,这是扩展的 XML 设置。
类型 指定扩展的类型。 字符串
typeHandlerVersion 指定扩展的版本。 指定扩展的版本。 如果未指定此元素,或者将星号 (*) 用作值,则使用最新版本的扩展。 如果使用主版本号和星号指定值作为次要版本号 (X.) ,则选择指定主版本的最新次要版本。 如果 (X.Y) 指定主版本号和次要版本号,则选择特定的扩展版本。 如果指定版本,将对角色实例执行自动升级。 字符串

CloudServiceVaultAndSecretReference

名称 说明
secretUrl 包含扩展的受保护设置的机密 URL 字符串
sourceVault 密钥保管库的 ARM 资源 ID SubResource

SubResource

名称 说明 Value
id 资源 ID 字符串

CloudServiceNetworkProfile

名称 说明
loadBalancerConfigurations 负载均衡器配置列表。 云服务最多可以有两个负载均衡器配置,对应于公共负载均衡器和内部负载均衡器。 LoadBalancerConfiguration[]
slotType 云服务的槽类型。
可能的值为

生产

过渡


如果未指定,则默认值为“生产”。
“Production”
“暂存”
swappableCloudService 包含目标 IP 的云服务的 ID 引用,使用者云服务可以使用该 IP 执行交换。 此属性在设置后无法更新。 此 ID 引用的可交换云服务必须存在,否则将引发错误。 SubResource

LoadBalancerConfiguration

名称 说明 Value
id 资源 ID 字符串
name 负载均衡器的名称 字符串 (必需)
properties 负载均衡器配置的属性。 LoadBalancerConfigurationProperties (必需)

LoadBalancerConfigurationProperties

名称 说明
frontendIPConfigurations 指定要用于负载均衡器的前端 IP。 仅支持 IPv4 前端 IP 地址。 每个负载均衡器配置必须恰好具有一个前端 IP 配置。 LoadBalancerFrontendIPConfiguration[] (必需的)

LoadBalancerFrontendIPConfiguration

名称 说明
name 负载均衡器使用的前端 IP 配置集中唯一的资源的名称。 此名称可用于访问资源。 字符串 (必需)
properties 负载均衡器前端 IP 配置的属性。 LoadBalancerFrontendIPConfigurationProperties (必需)

LoadBalancerFrontendIPConfigurationProperties

名称 说明
privateIPAddress IP 配置的虚拟网络专用 IP 地址。 字符串
publicIPAddress 对公共 IP 地址资源的引用。 SubResource
子网 对虚拟网络子网资源的引用。 SubResource

CloudServiceOsProfile

名称 说明
机密 指定应安装在角色实例上的证书集。 CloudServiceVaultSecretGroup[]

CloudServiceVaultSecretGroup

名称 说明
sourceVault 包含 VaultCertificates 中所有证书的密钥保管库的相对 URL。 SubResource
vaultCertificates SourceVault 中包含证书的密钥保管库引用列表。 CloudServiceVaultCertificate[]

CloudServiceVaultCertificate

名称 说明
certificateUrl 这是已作为机密上传到密钥保管库的证书的 URL。 字符串

CloudServiceRoleProfile

名称 说明
角色 云服务的角色列表。 CloudServiceRoleProfileProperties[]

CloudServiceRoleProfileProperties

名称 说明
name 资源名称。 字符串
sku 描述云服务角色 SKU。 CloudServiceRoleSku

CloudServiceRoleSku

名称 说明
容量 指定云服务中的角色实例数。 int
name SKU 名称。 注意:如果云服务当前使用的硬件不支持新 SKU,则需要删除并重新创建云服务或移回旧 SKU。 字符串
指定云服务的层。 可能的值为

标准

基本
字符串

SystemData

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。