您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Cloud Services - List

获取资源组下的所有云服务的列表。 在响应中使用 nextLink 属性可获取下一页面的云服务。 为此,请执行此操作,直到 nextLink 为 null 才能获取所有云服务。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices?api-version=2021-03-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

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

api-version
query True
  • string

客户端 Api 版本。

响应

Name Type Description
200 OK

确定

Other Status Codes

错误

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

List Cloud Services in a Resource Group

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices?api-version=2021-03-01

Sample Response

{
  "value": [
    {
      "name": "{cs-name}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
      "type": "Microsoft.Compute/cloudServices",
      "location": "eastus2euap",
      "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"
                      }
                    }
                  }
                ]
              }
            }
          ]
        },
        "extensionProfile": {
          "extensions": [
            {
              "name": "RDPExtension",
              "properties": {
                "autoUpgradeMinorVersion": false,
                "provisioningState": "Succeeded",
                "rolesAppliedTo": [
                  "*"
                ],
                "publisher": "Microsoft.Windows.Azure.Extensions",
                "type": "RDP",
                "typeHandlerVersion": "1.2.1",
                "settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
              }
            }
          ]
        },
        "provisioningState": "Succeeded",
        "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
      }
    }
  ]
}

定义

ApiError

Api 错误。

ApiErrorBase

Api 错误基础。

CloudError

计算服务出现错误响应。

CloudService

介绍云服务。

CloudServiceExtensionProfile

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

CloudServiceExtensionProperties

扩展属性。

CloudServiceListResult
CloudServiceNetworkProfile

云服务的网络配置文件。

CloudServiceOsProfile

描述云服务的操作系统配置文件。

CloudServiceProperties

云服务属性

CloudServiceRoleProfile

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

CloudServiceRoleProfileProperties

介绍角色属性。

CloudServiceRoleSku

介绍云服务角色 sku。

CloudServiceUpgradeMode

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

Auto

手动

同时

如果未指定,则默认值为 "自动"。如果设置为 "手动",则必须调用 PUT Roleenvironment.currentroleinstance.updatedomain 来应用更新。 如果设置为 "自动",则更新将按顺序自动应用于每个更新域。

CloudServiceVaultAndSecretReference
CloudServiceVaultCertificate

描述 Key Vault 中的单个证书引用以及证书应位于角色实例上的位置。

CloudServiceVaultSecretGroup

描述同一 Key Vault 中的一组证书。

Extension

描述云服务扩展。

InnerError

内部错误详细信息。

LoadBalancerConfiguration

说明负载均衡器配置。

LoadBalancerConfigurationProperties
LoadBalancerFrontendIPConfiguration
LoadBalancerFrontendIPConfigurationProperties

描述云服务 IP 配置

SubResource

ApiError

Api 错误。

Name Type Description
code
  • string

错误代码。

details

Api 错误详细信息

innererror

Api 内部错误

message
  • string

错误消息。

target
  • string

特定错误的目标。

ApiErrorBase

Api 错误基础。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息。

target
  • string

特定错误的目标。

CloudError

计算服务出现错误响应。

Name Type Description
error

Api 错误。

CloudService

介绍云服务。

Name Type Description
id
  • string

资源 Id。

location
  • string

资源位置。

name
  • string

资源名称。

properties

云服务属性

tags
  • object

资源标记。

type
  • string

资源类型。

CloudServiceExtensionProfile

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

Name Type Description
extensions

云服务的扩展列表。

CloudServiceExtensionProperties

扩展属性。

Name Type Description
autoUpgradeMinorVersion
  • boolean

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

forceUpdateTag
  • string

标记强制应用提供的公共和受保护的设置。 更改标记值可在不更改任何公共或受保护设置的情况下重新运行扩展。 如果 forceUpdateTag 未发生更改,则处理程序仍将应用对公共或受保护设置的更新。 如果 forceUpdateTag 或任何公共或受保护的设置都不会发生更改,则扩展会流向具有相同序列号的角色实例,并且无论是否重新运行,都将执行处理程序实现

protectedSettings
  • string

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

protectedSettingsFromKeyVault
provisioningState
  • string

预配状态,只出现在响应中。

publisher
  • string

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

rolesAppliedTo
  • string[]

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

settings
  • string

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

type
  • string

指定扩展的类型。

typeHandlerVersion
  • string

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

CloudServiceListResult

Name Type Description
nextLink
  • string
value

介绍云服务。

CloudServiceNetworkProfile

云服务的网络配置文件。

Name Type Description
loadBalancerConfigurations

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

swappableCloudService

云服务的 id 引用,其中包含主题云服务可用于执行交换的目标 IP。 设置此属性后,无法对其进行更新。 此 id 所引用的可交换云服务必须存在,否则将引发错误。

CloudServiceOsProfile

描述云服务的操作系统配置文件。

Name Type Description
secrets

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

CloudServiceProperties

云服务属性

Name Type Description
allowModelOverride
  • boolean

(可选) 指示在模型/模板中指定的角色 sku 属性) (是否应分别覆盖 .cscfg 和 roleProfile 中指定的角色实例计数和 vm 大小。 默认值为 false

configuration
  • string

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

configurationUrl
  • string

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

extensionProfile

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

networkProfile

云服务的网络配置文件。

osProfile

描述云服务的操作系统配置文件。

packageUrl
  • string

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

provisioningState
  • string

预配状态,只出现在响应中。

roleProfile

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

startCloudService
  • boolean

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

uniqueId
  • string

云服务的唯一标识符。

upgradeMode

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

Auto

手动

同时

如果未指定,则默认值为 "自动"。如果设置为 "手动",则必须调用 PUT Roleenvironment.currentroleinstance.updatedomain 来应用更新。 如果设置为 "自动",则更新将按顺序自动应用于每个更新域。

CloudServiceRoleProfile

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

Name Type Description
roles

云服务的角色列表。

CloudServiceRoleProfileProperties

介绍角色属性。

Name Type Description
name
  • string

资源名称。

sku

介绍云服务角色 sku。

CloudServiceRoleSku

介绍云服务角色 sku。

Name Type Description
capacity
  • integer

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

name
  • string

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

tier
  • string

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

标准

基本

CloudServiceUpgradeMode

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

Auto

手动

同时

如果未指定,则默认值为 "自动"。如果设置为 "手动",则必须调用 PUT Roleenvironment.currentroleinstance.updatedomain 来应用更新。 如果设置为 "自动",则更新将按顺序自动应用于每个更新域。

Name Type Description
Auto
  • string
Manual
  • string
Simultaneous
  • string

CloudServiceVaultAndSecretReference

Name Type Description
secretUrl
  • string
sourceVault

CloudServiceVaultCertificate

描述 Key Vault 中的单个证书引用以及证书应位于角色实例上的位置。

Name Type Description
certificateUrl
  • string

这是已上传到机密 Key Vault 证书的 URL。

CloudServiceVaultSecretGroup

描述同一 Key Vault 中的一组证书。

Name Type Description
sourceVault

Key Vault 的相对 URL,其中包含 VaultCertificates 中的所有证书。

vaultCertificates

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

Extension

描述云服务扩展。

Name Type Description
name
  • string

扩展插件的名称。

properties

扩展属性。

InnerError

内部错误详细信息。

Name Type Description
errordetail
  • string

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

exceptiontype
  • string

异常类型。

LoadBalancerConfiguration

说明负载均衡器配置。

Name Type Description
id
  • string

资源 Id

name
  • string

负载均衡器的名称

properties

负载均衡器配置的属性。

LoadBalancerConfigurationProperties

Name Type Description
frontendIPConfigurations

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

LoadBalancerFrontendIPConfiguration

Name Type Description
name
  • string

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

properties

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

LoadBalancerFrontendIPConfigurationProperties

描述云服务 IP 配置

Name Type Description
privateIPAddress
  • string

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

publicIPAddress

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

subnet

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

SubResource

Name Type Description
id
  • string

资源 Id