Cloud Services - Get Instance View

참조

서비스:: Compute

API 버전:: 2024-11-04

클라우드 서비스의 상태를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
cloudServiceName	path	True	string	클라우드 서비스의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	CloudServiceInstanceView	그래
Other Status Codes	CloudError	오류

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get Cloud Service Instance View with Multiple Roles

샘플 요청

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


/**
 * Samples for CloudServices GetInstanceView.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2024-11-04/examples/
     * CloudService_Get_InstanceViewWithMultiRole.json
     */
    /**
     * Sample code: Get Cloud Service Instance View with Multiple Roles.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getCloudServiceInstanceViewWithMultipleRoles(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getCloudServices().getInstanceViewWithResponse("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

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_instance_view_with_multi_role.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_instance_view(
        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_InstanceViewWithMultiRole.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

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_InstanceViewWithMultiRole.json
func ExampleCloudServicesClient_GetInstanceView() {
	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().GetInstanceView(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.CloudServiceInstanceView = armcompute.CloudServiceInstanceView{
	// 	PrivateIDs: []*string{
	// 		to.Ptr("3491bc0c-1f6c-444f-b1d0-ec0751a74e3e")},
	// 		RoleInstance: &armcompute.InstanceViewStatusesSummary{
	// 			StatusesSummary: []*armcompute.StatusCodeCount{
	// 				{
	// 					Code: to.Ptr("ProvisioningState/succeeded"),
	// 					Count: to.Ptr[int32](4),
	// 				},
	// 				{
	// 					Code: to.Ptr("PowerState/started"),
	// 					Count: to.Ptr[int32](4),
	// 				},
	// 				{
	// 					Code: to.Ptr("RoleState/RoleStateStarted"),
	// 					Count: to.Ptr[int32](4),
	// 			}},
	// 		},
	// 		SdkVersion: to.Ptr("2.9.6496.3"),
	// 		Statuses: []*armcompute.ResourceInstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/succeeded"),
	// 				DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-12T11:20:07.095Z"); return t}()),
	// 			},
	// 			{
	// 				Code: to.Ptr("PowerState/started"),
	// 				DisplayStatus: to.Ptr("Started"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-12T11:20:07.095Z"); return t}()),
	// 			},
	// 			{
	// 				Code: to.Ptr("CurrentUpgradeDomain/-1"),
	// 				DisplayStatus: to.Ptr("Current Upgrade Domain of cloud service is -1."),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			},
	// 			{
	// 				Code: to.Ptr("MaxUpgradeDomain/1"),
	// 				DisplayStatus: to.Ptr("Max Upgrade Domain of cloud service is 1."),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 		}},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Gets the status of a cloud service.
 *
 * @summary Gets the status of a cloud service.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2024-11-04/examples/CloudService_Get_InstanceViewWithMultiRole.json
 */
async function getCloudServiceInstanceViewWithMultipleRoles() {
  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.getInstanceView(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

{
  "roleInstance": {
    "statusesSummary": [
      {
        "code": "ProvisioningState/succeeded",
        "count": 4
      },
      {
        "code": "PowerState/started",
        "count": 4
      },
      {
        "code": "RoleState/RoleStateStarted",
        "count": 4
      }
    ]
  },
  "sdkVersion": "2.9.6496.3",
  "privateIds": [
    "3491bc0c-1f6c-444f-b1d0-ec0751a74e3e"
  ],
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2021-01-12T16:50:07.0953535+05:30"
    },
    {
      "code": "PowerState/started",
      "level": "Info",
      "displayStatus": "Started",
      "time": "2021-01-12T16:50:07.0953535+05:30"
    },
    {
      "code": "CurrentUpgradeDomain/-1",
      "level": "Info",
      "displayStatus": "Current Upgrade Domain of cloud service is -1."
    },
    {
      "code": "MaxUpgradeDomain/1",
      "level": "Info",
      "displayStatus": "Max Upgrade Domain of cloud service is 1."
    }
  ]
}

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
CloudError	Compute 서비스의 오류 응답입니다.
CloudServiceInstanceView	CloudService의 InstanceView 전체
InnerError	내부 오류 세부 정보입니다.
InstanceViewStatusesSummary	인스턴스 보기 상태입니다.
ResourceInstanceViewStatus	인스턴스 보기 상태입니다.
StatusCodeCount	상태 코드 및 클라우드 서비스 인스턴스 보기 상태의 수
StatusLevelTypes	수준 코드입니다.

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

CloudError

Compute 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류입니다.

CloudServiceInstanceView

CloudService의 InstanceView 전체

Name	형식	Description
privateIds	string[]	클라우드 서비스에 대해 내부적으로 생성된 고유 식별자 목록을 지정합니다. 참고: Azure Diagnostics 확장을 사용하는 경우 이 속성을 'DeploymentId'로 사용하여 세부 정보를 쿼리할 수 있습니다.
roleInstance	InstanceViewStatusesSummary	인스턴스 보기 상태입니다.
sdkVersion	string	클라우드 서비스에 대한 패키지를 생성하는 데 사용된 SDK의 버전입니다.
statuses	ResourceInstanceViewStatus[]	인스턴스 보기 상태입니다.

InnerError

내부 오류 세부 정보입니다.

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

InstanceViewStatusesSummary

인스턴스 보기 상태입니다.

Name	형식	Description
statusesSummary	StatusCodeCount[]	요약입니다.

ResourceInstanceViewStatus

인스턴스 보기 상태입니다.

Name	형식	Description
code	string	상태 코드입니다.
displayStatus	string	상태에 대한 짧은 지역화 가능 레이블입니다.
level	StatusLevelTypes	수준 코드입니다.
message	string	경고 및 오류 메시지를 포함한 자세한 상태 메시지입니다.
time	string	상태의 시간입니다.

StatusCodeCount

상태 코드 및 클라우드 서비스 인스턴스 보기 상태의 수

Name	형식	Description
code	string	인스턴스 보기 상태 코드
count	integer	이 상태 코드가 있는 인스턴스 수

StatusLevelTypes

수준 코드입니다.

Name	형식	Description
Error	string
Info	string
Warning	string

다음을 통해 공유

Cloud Services - Get Instance View

URI 매개 변수

응답

보안

azure_auth

범위

예제

Get Cloud Service Instance View with Multiple Roles

샘플 요청

샘플 응답

정의

ApiError

ApiErrorBase

CloudError

CloudServiceInstanceView

InnerError

InstanceViewStatusesSummary

ResourceInstanceViewStatus

StatusCodeCount

StatusLevelTypes

추가 리소스