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

Cloud Services - Update

更新云服务。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}?api-version=2022-09-04

URI 参数

名称 必需 类型 说明
cloudServiceName
path True

string

云服务的名称。

resourceGroupName
path True

string

资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

请求正文

名称 类型 说明
tags

object

资源标记

响应

名称 类型 说明
200 OK

CloudService

确定

Other Status Codes

CloudError

错误

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Update existing Cloud Service to add tags

示例请求

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}?api-version=2022-09-04

{
  "tags": {
    "Documentation": "RestAPI"
  }
}

示例响应

{
  "name": "{cs-name}",
  "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
  "type": "Microsoft.Compute/cloudServices",
  "location": "eastus2euap",
  "tags": {
    "Documentation": "RestAPI"
  },
  "properties": {
    "configuration": "{ServiceConfiguration}",
    "upgradeMode": "Auto",
    "roleProfile": {
      "roles": [
        {
          "name": "ContosoFrontend",
          "sku": {
            "name": "Standard_D1_v2",
            "tier": "Standard",
            "capacity": 2
          }
        },
        {
          "name": "ContosoBackend",
          "sku": {
            "name": "Standard_D1_v2",
            "tier": "Standard",
            "capacity": 2
          }
        }
      ]
    },
    "osProfile": {
      "secrets": []
    },
    "networkProfile": {
      "loadBalancerConfigurations": [
        {
          "name": "contosolb",
          "properties": {
            "frontendIpConfigurations": [
              {
                "name": "contosofe",
                "properties": {
                  "publicIPAddress": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
                  }
                }
              }
            ]
          }
        }
      ]
    },
    "provisioningState": "Updating",
    "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
  }
}

定义

名称 说明
ApiError

Api 错误。

ApiErrorBase

Api 错误基。

CloudError

来自计算服务的错误响应。

CloudService

描述云服务。

CloudServiceExtensionProfile

描述云服务扩展配置文件。

CloudServiceExtensionProperties

扩展属性。

CloudServiceNetworkProfile

云服务的网络配置文件。

CloudServiceOsProfile

描述云服务的 OS 配置文件。

CloudServiceProperties

云服务属性

CloudServiceRoleProfile

描述云服务的角色配置文件。

CloudServiceRoleProfileProperties

描述角色属性。

CloudServiceRoleSku

描述云服务角色 SKU。

CloudServiceSlotType

云服务的槽类型。 可能的值为

生产

过渡

如果未指定,则默认值为“生产”。

CloudServiceUpdate
CloudServiceUpgradeMode

云服务的更新模式。 在部署服务时将角色实例分配给更新域。 可在每个更新域中手动开始更新,也可以在所有更新域中自动开始更新。 可能的值为

Auto

手动

同时

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

CloudServiceVaultAndSecretReference

扩展的受保护设置,使用 KeyVault 引用,这些设置在发送到角色实例之前加密。

CloudServiceVaultCertificate

描述密钥保管库中的单个证书引用,以及证书应驻留在角色实例上的位置。

CloudServiceVaultSecretGroup

描述一组证书,这些证书全部位于同一密钥保管库中。

Extension

描述云服务扩展。

InnerError

内部错误详细信息。

LoadBalancerConfiguration

描述负载均衡器配置。

LoadBalancerConfigurationProperties

描述负载均衡器配置的属性。

LoadBalancerFrontendIpConfiguration

指定要用于负载均衡器的前端 IP。 仅支持 IPv4 前端 IP 地址。 每个负载均衡器配置必须恰好具有一个前端 IP 配置。

LoadBalancerFrontendIpConfigurationProperties

描述云服务 IP 配置

SubResource
SystemData

与此资源相关的系统元数据。

ApiError

Api 错误。

名称 类型 说明
code

string

错误代码。

details

ApiErrorBase[]

Api 错误详细信息

innererror

InnerError

Api 内部错误

message

string

错误消息。

target

string

特定错误的目标。

ApiErrorBase

Api 错误基。

名称 类型 说明
code

string

错误代码。

message

string

错误消息。

target

string

特定错误的目标。

CloudError

来自计算服务的错误响应。

名称 类型 说明
error

ApiError

Api 错误。

CloudService

描述云服务。

名称 类型 说明
id

string

资源 ID。

location

string

资源位置。

name

string

资源名称。

properties

CloudServiceProperties

云服务属性

systemData

SystemData

与此资源相关的系统元数据。

tags

object

资源标记。

type

string

资源类型。

zones

string[]

资源的逻辑可用性区域列表。 列表应仅包含应预配云服务的 1 个区域。 此字段是可选的。

CloudServiceExtensionProfile

描述云服务扩展配置文件。

名称 类型 说明
extensions

Extension[]

云服务的扩展列表。

CloudServiceExtensionProperties

扩展属性。

名称 类型 说明
autoUpgradeMinorVersion

boolean

显式指定平台是否可以在 typeHandlerVersion 可用时自动将 typeHandlerVersion 升级到更高的次要版本。

forceUpdateTag

string

强制应用提供的公共和受保护的设置的标记。 通过更改标记值,无需更改任何公共或受保护的设置即可重新运行扩展。 如果未更改 forceUpdateTag,处理程序仍会应用对公共或受保护设置的更新。 如果 forceUpdateTag 以及任何公共或受保护的设置都没有更改,扩展将流向具有相同序列号的角色实例,并且由处理程序实现决定是否重新运行它

protectedSettings

object

在发送到角色实例之前加密的扩展的受保护设置。

protectedSettingsFromKeyVault

CloudServiceVaultAndSecretReference

扩展的受保护设置,使用 KeyVault 引用,这些设置在发送到角色实例之前加密。

provisioningState

string

预配状态,仅显示在响应中。

publisher

string

扩展处理程序发布者的名称。

rolesAppliedTo

string[]

要应用此扩展的可选角色列表。 如果未指定属性或指定“*”,则扩展将应用于云服务中的所有角色。

settings

object

扩展的公共设置。 对于 JSON 扩展,这是扩展的 JSON 设置。 对于 RDP) 等 XML 扩展 (,这是扩展的 XML 设置。

type

string

指定扩展的类型。

typeHandlerVersion

string

指定扩展的版本。 指定扩展的版本。 如果未指定此元素,或者将星号 (*) 用作值,则使用最新版本的扩展。 如果使用主版本号和星号指定值作为次要版本号 (X.) ,则选择指定主版本的最新次要版本。 如果 (X.Y) 指定主版本号和次要版本号,则选择特定的扩展版本。 如果指定版本,将对角色实例执行自动升级。

CloudServiceNetworkProfile

云服务的网络配置文件。

名称 类型 说明
loadBalancerConfigurations

LoadBalancerConfiguration[]

负载均衡器配置列表。 云服务最多可以有两个负载均衡器配置,对应于公共负载均衡器和内部负载均衡器。

slotType

CloudServiceSlotType

云服务的槽类型。 可能的值为

生产

过渡

如果未指定,则默认值为“生产”。

swappableCloudService

SubResource

包含目标 IP 的云服务的 ID 引用,使用者云服务可以使用该 IP 执行交换。 此属性在设置后无法更新。 此 ID 引用的可交换云服务必须存在,否则将引发错误。

CloudServiceOsProfile

描述云服务的 OS 配置文件。

名称 类型 说明
secrets

CloudServiceVaultSecretGroup[]

指定应安装在角色实例上的证书集。

CloudServiceProperties

云服务属性

名称 类型 说明
allowModelOverride

boolean

(可选) 指示在模型/模板中指定的 roleProfile.roles.sku (roleProfile.roles.sku) 应分别替代 .cscfg 和 .csdef 中指定的角色实例计数和 vm 大小。 默认值为 false

configuration

string

指定云服务的 XML 服务配置 (.cscfg) 。

configurationUrl

string

指定一个 URL,该 URL 引用 Blob 服务中服务配置的位置。 服务包 URL 可以是共享访问签名 (来自任何存储帐户的 SAS) URI。 这是一个只写属性,不会在 GET 调用中返回。

extensionProfile

CloudServiceExtensionProfile

描述云服务扩展配置文件。

networkProfile

CloudServiceNetworkProfile

云服务的网络配置文件。

osProfile

CloudServiceOsProfile

描述云服务的 OS 配置文件。

packageUrl

string

指定引用 BLOB 服务中的服务包的位置的 URL。 服务包 URL 可以是共享访问签名 (来自任何存储帐户的 SAS) URI。 这是一个只写属性,不会在 GET 调用中返回。

provisioningState

string

预配状态,仅显示在响应中。

roleProfile

CloudServiceRoleProfile

描述云服务的角色配置文件。

startCloudService

boolean

(可选) 指示是否在创建云服务后立即启动云服务。 默认值为 true。 如果为 false,则仍会部署服务模型,但不会立即运行代码。 相反,服务是 PoweredOff,直到你调用“启动”,此时服务将启动。 即使已关闭,已部署的服务仍会产生费用。

uniqueId

string

云服务的唯一标识符。

upgradeMode

CloudServiceUpgradeMode

云服务的更新模式。 在部署服务时将角色实例分配给更新域。 可在每个更新域中手动开始更新,也可以在所有更新域中自动开始更新。 可能的值为

Auto

手动

同时

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

CloudServiceRoleProfile

描述云服务的角色配置文件。

名称 类型 说明
roles

CloudServiceRoleProfileProperties[]

云服务的角色列表。

CloudServiceRoleProfileProperties

描述角色属性。

名称 类型 说明
name

string

资源名称。

sku

CloudServiceRoleSku

描述云服务角色 SKU。

CloudServiceRoleSku

描述云服务角色 SKU。

名称 类型 说明
capacity

integer

指定云服务中的角色实例数。

name

string

SKU 名称。 注意:如果云服务当前使用的硬件不支持新 SKU,则需要删除并重新创建云服务或移回旧 SKU。

tier

string

指定云服务的层。 可能的值为

标准

基本

CloudServiceSlotType

云服务的槽类型。 可能的值为

生产

过渡

如果未指定,则默认值为“生产”。

名称 类型 说明
Production

string

Staging

string

CloudServiceUpdate

名称 类型 说明
tags

object

资源标记

CloudServiceUpgradeMode

云服务的更新模式。 在部署服务时将角色实例分配给更新域。 可在每个更新域中手动开始更新,也可以在所有更新域中自动开始更新。 可能的值为

Auto

手动

同时

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

名称 类型 说明
Auto

string

Manual

string

Simultaneous

string

CloudServiceVaultAndSecretReference

扩展的受保护设置,使用 KeyVault 引用,这些设置在发送到角色实例之前加密。

名称 类型 说明
secretUrl

string

包含扩展的受保护设置的机密 URL

sourceVault

SubResource

密钥保管库的 ARM 资源 ID

CloudServiceVaultCertificate

描述密钥保管库中的单个证书引用,以及证书应驻留在角色实例上的位置。

名称 类型 说明
certificateUrl

string

这是已作为机密上传到密钥保管库的证书的 URL。

CloudServiceVaultSecretGroup

描述一组证书,这些证书全部位于同一密钥保管库中。

名称 类型 说明
sourceVault

SubResource

包含 VaultCertificates 中所有证书的密钥保管库的相对 URL。

vaultCertificates

CloudServiceVaultCertificate[]

SourceVault 中包含证书的密钥保管库引用列表。

Extension

描述云服务扩展。

名称 类型 说明
name

string

扩展插件的名称。

properties

CloudServiceExtensionProperties

扩展属性。

InnerError

内部错误详细信息。

名称 类型 说明
errordetail

string

内部错误消息或异常转储。

exceptiontype

string

异常类型。

LoadBalancerConfiguration

描述负载均衡器配置。

名称 类型 说明
id

string

资源 ID

name

string

负载均衡器的名称

properties

LoadBalancerConfigurationProperties

负载均衡器配置的属性。

LoadBalancerConfigurationProperties

描述负载均衡器配置的属性。

名称 类型 说明
frontendIpConfigurations

LoadBalancerFrontendIpConfiguration[]

指定要用于负载均衡器的前端 IP。 仅支持 IPv4 前端 IP 地址。 每个负载均衡器配置必须恰好具有一个前端 IP 配置。

LoadBalancerFrontendIpConfiguration

指定要用于负载均衡器的前端 IP。 仅支持 IPv4 前端 IP 地址。 每个负载均衡器配置必须恰好具有一个前端 IP 配置。

名称 类型 说明
name

string

负载均衡器使用的前端 IP 配置集中唯一的资源的名称。 此名称可用于访问资源。

properties

LoadBalancerFrontendIpConfigurationProperties

负载均衡器前端 IP 配置的属性。

LoadBalancerFrontendIpConfigurationProperties

描述云服务 IP 配置

名称 类型 说明
privateIPAddress

string

IP 配置的虚拟网络专用 IP 地址。

publicIPAddress

SubResource

对公共 IP 地址资源的引用。

subnet

SubResource

对虚拟网络子网资源的引用。

SubResource

名称 类型 说明
id

string

资源 ID

SystemData

与此资源相关的系统元数据。

名称 类型 说明
createdAt

string

指定创建云服务 (扩展支持) 资源的 UTC 时间。
最低 API 版本:2022-04-04。

lastModifiedAt

string

指定上次修改云服务 (扩展支持) 资源的 UTC 时间。
最低 API 版本:2022-04-04。