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

Cloud Services - Get

服务:

Compute

API 版本:

2024-11-04

显示有关云服务的信息。

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

URI 参数

名称	在	必需	类型	说明
cloudServiceName	path	True	string	云服务的名称。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	CloudService	还行
Other Status Codes	CloudError	错误

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get Cloud Service with Multiple Roles and RDP Extension

示例请求

HTTP

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

Java

/**
 * Samples for CloudServices GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2024-11-04/examples/
     * CloudService_Get_WithMultiRoleAndRDP.json
     */
    /**
     * Sample code: Get Cloud Service with Multiple Roles and RDP Extension.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getCloudServiceWithMultipleRolesAndRDPExtension(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getCloudServices()
            .getByResourceGroupWithResponse("ConstosoRG", "{cs-name}", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python cloud_service_get_with_multi_role_and_rdp.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.cloud_services.get(
        resource_group_name="ConstosoRG",
        cloud_service_name="{cs-name}",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2024-11-04/examples/CloudService_Get_WithMultiRoleAndRDP.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2024-11-04/examples/CloudService_Get_WithMultiRoleAndRDP.json
func ExampleCloudServicesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCloudServicesClient().Get(ctx, "ConstosoRG", "{cs-name}", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CloudService = armcompute.CloudService{
	// 	Name: to.Ptr("{cs-name}"),
	// 	Type: to.Ptr("Microsoft.Compute/cloudServices"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}"),
	// 	Location: to.Ptr("eastus2euap"),
	// 	Properties: &armcompute.CloudServiceProperties{
	// 		Configuration: to.Ptr("{ServiceConfiguration}"),
	// 		ExtensionProfile: &armcompute.CloudServiceExtensionProfile{
	// 			Extensions: []*armcompute.Extension{
	// 				{
	// 					Name: to.Ptr("RDPExtension"),
	// 					Properties: &armcompute.CloudServiceExtensionProperties{
	// 						Type: to.Ptr("RDP"),
	// 						AutoUpgradeMinorVersion: to.Ptr(false),
	// 						ProvisioningState: to.Ptr("Succeeded"),
	// 						Publisher: to.Ptr("Microsoft.Windows.Azure.Extensions"),
	// 						RolesAppliedTo: []*string{
	// 							to.Ptr("*")},
	// 							Settings: "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>",
	// 							TypeHandlerVersion: to.Ptr("1.2"),
	// 						},
	// 				}},
	// 			},
	// 			NetworkProfile: &armcompute.CloudServiceNetworkProfile{
	// 				LoadBalancerConfigurations: []*armcompute.LoadBalancerConfiguration{
	// 					{
	// 						Name: to.Ptr("contosolb"),
	// 						Properties: &armcompute.LoadBalancerConfigurationProperties{
	// 							FrontendIPConfigurations: []*armcompute.LoadBalancerFrontendIPConfiguration{
	// 								{
	// 									Name: to.Ptr("contosofe"),
	// 									Properties: &armcompute.LoadBalancerFrontendIPConfigurationProperties{
	// 										PublicIPAddress: &armcompute.SubResource{
	// 											ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"),
	// 										},
	// 									},
	// 							}},
	// 						},
	// 				}},
	// 			},
	// 			OSProfile: &armcompute.CloudServiceOsProfile{
	// 				Secrets: []*armcompute.CloudServiceVaultSecretGroup{
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			RoleProfile: &armcompute.CloudServiceRoleProfile{
	// 				Roles: []*armcompute.CloudServiceRoleProfileProperties{
	// 					{
	// 						Name: to.Ptr("ContosoFrontend"),
	// 						SKU: &armcompute.CloudServiceRoleSKU{
	// 							Name: to.Ptr("Standard_D1_v2"),
	// 							Capacity: to.Ptr[int64](2),
	// 							Tier: to.Ptr("Standard"),
	// 						},
	// 					},
	// 					{
	// 						Name: to.Ptr("ContosoBackend"),
	// 						SKU: &armcompute.CloudServiceRoleSKU{
	// 							Name: to.Ptr("Standard_D1_v2"),
	// 							Capacity: to.Ptr[int64](2),
	// 							Tier: to.Ptr("Standard"),
	// 						},
	// 				}},
	// 			},
	// 			UniqueID: to.Ptr("4ccb4323-4740-4545-bb81-780b27375947"),
	// 			UpgradeMode: to.Ptr(armcompute.CloudServiceUpgradeModeAuto),
	// 		},
	// 		SystemData: &armcompute.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Display information about a cloud service.
 *
 * @summary Display information about a cloud service.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2024-11-04/examples/CloudService_Get_WithMultiRoleAndRDP.json
 */
async function getCloudServiceWithMultipleRolesAndRdpExtension() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "ConstosoRG";
  const cloudServiceName = "{cs-name}";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.cloudServices.get(resourceGroupName, cloudServiceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "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",
            "settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
          }
        }
      ]
    },
    "provisioningState": "Succeeded",
    "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
  },
  "systemData": {
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
  }
}

定义

名称	说明
ApiError	Api 错误。
ApiErrorBase	Api 错误基数。
CloudError	来自计算服务的错误响应。
CloudService	描述云服务。
CloudServiceExtensionProfile	描述云服务扩展配置文件。
CloudServiceExtensionProperties	扩展属性。
CloudServiceNetworkProfile	云服务的网络配置文件。
CloudServiceOsProfile	描述云服务的 OS 配置文件。
CloudServiceProperties	云服务属性
CloudServiceRoleProfile	描述云服务的角色配置文件。
CloudServiceRoleProfileProperties	描述角色属性。
CloudServiceRoleSku	描述云服务角色 SKU。
CloudServiceSlotType	云服务的槽类型。 可能的值为 生产 暂存 如果未指定，则默认值为“生产”。
CloudServiceUpgradeMode	云服务的更新模式。 部署服务时，角色实例将分配给更新域。 可以在每个更新域中手动启动更新，也可以在所有更新域中自动启动更新。 可能的值为 自动 手动 同时 如果未指定，则默认值为“自动”。如果设置为“手动”，则必须调用 PUT UpdateDomain 才能应用更新。 如果设置为“自动”，则按顺序自动将更新应用到每个更新域。
CloudServiceVaultAndSecretReference	使用 KeyVault 引用的扩展的受保护设置，这些密钥在发送到角色实例之前进行了加密。
CloudServiceVaultCertificate	介绍 Key Vault 中的单个证书引用，以及证书应驻留在角色实例上的位置。
CloudServiceVaultSecretGroup	描述一组证书，这些证书都位于同一 Key Vault 中。
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 设置。 对于 XML 扩展（如 RDP），这是扩展的 XML 设置。
type	string	指定扩展的类型。
typeHandlerVersion	string	指定扩展的版本。 指定扩展的版本。 如果未指定此元素或星号 = 用作值，则使用最新版本的扩展。 如果使用主版本号和星号指定值作为次要版本号 （X.），则选择指定主版本的最新次要版本。 如果指定了主版本号和次要版本号（X.Y），则选择特定的扩展版本。 如果指定了版本，则对角色实例执行自动升级。

CloudServiceNetworkProfile

云服务的网络配置文件。

名称	类型	说明
loadBalancerConfigurations	LoadBalancerConfiguration[]	负载均衡器配置列表。 云服务最多可以有两个负载均衡器配置，对应于公共负载均衡器和内部负载均衡器。
slotType	CloudServiceSlotType	云服务的槽类型。 可能的值为 生产 暂存 如果未指定，则默认值为“生产”。
swappableCloudService	SubResource	云服务的 ID 引用，其中包含使用者云服务可以执行交换的目标 IP。 设置此属性后，无法更新此属性。 此 ID 引用的可交换云服务必须存在，否则将引发错误。

CloudServiceOsProfile

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

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

CloudServiceProperties

云服务属性

名称	类型	说明
allowModelOverride	boolean	（可选）指示模型/模板中指定的角色 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	指定一个 URL，该 URL 引用 Blob 服务中的服务包的位置。 服务包 URL 可以是任何存储帐户中的共享访问签名 （SAS） URI。 这是一个仅写属性，不会在 GET 调用中返回。
provisioningState	string	预配状态，仅出现在响应中。
roleProfile	CloudServiceRoleProfile	描述云服务的角色配置文件。
startCloudService	boolean	（可选）指示是否在创建云服务后立即启动云服务。 默认值为 true。 如果为 false，则仍部署服务模型，但代码不会立即运行。 相反，服务是 PoweredOff，直到调用“开始”，此时服务将启动。 即使已部署的服务已关闭，也仍会产生费用。
uniqueId	string	云服务的唯一标识符。
upgradeMode	CloudServiceUpgradeMode	云服务的更新模式。 部署服务时，角色实例将分配给更新域。 可以在每个更新域中手动启动更新，也可以在所有更新域中自动启动更新。 可能的值为 自动 手动 同时 如果未指定，则默认值为“自动”。如果设置为“手动”，则必须调用 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

CloudServiceUpgradeMode

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

自动

手动

同时

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

名称	类型	说明
Auto	string
Manual	string
Simultaneous	string

CloudServiceVaultAndSecretReference

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

名称	类型	说明
secretUrl	string	包含扩展的受保护设置的机密 URL
sourceVault	SubResource	Key Vault 的 ARM 资源 ID

CloudServiceVaultCertificate

介绍 Key Vault 中的单个证书引用，以及证书应驻留在角色实例上的位置。

名称	类型	说明
certificateUrl	string	这是已作为机密上传到 Key Vault 的证书的 URL。
isBootstrapCertificate	boolean	指示提供的证书是否为 Key Vault 扩展用于提取剩余证书的引导证书的标志。

CloudServiceVaultSecretGroup

描述一组证书，这些证书都位于同一 Key Vault 中。

名称	类型	说明
sourceVault	SubResource	Key Vault 的相对 URL，其中包含 VaultCertificates 中的所有证书。
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。