Cloud Services - Get Instance View

參考

服務:: Compute

API 版本:: 2022-09-04

取得雲端服務的狀態。

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

URI 參數

名稱	位於	必要	類型	Description
cloudServiceName	path	True	string	雲端服務的名稱。
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	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

範圍

名稱	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=2022-09-04

/** Samples for CloudServices GetInstanceView. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-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");

/**
 * 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/2022-09-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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Get_InstanceViewWithMultiRole.json
// this example is just showing the usage of "CloudServices_GetInstanceView" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CloudServiceResource created on azure
// for more information of creating CloudServiceResource, please refer to the document of CloudServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "ConstosoRG";
string cloudServiceName = "{cs-name}";
ResourceIdentifier cloudServiceResourceId = CloudServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, cloudServiceName);
CloudServiceResource cloudService = client.GetCloudServiceResource(cloudServiceResourceId);

// invoke the operation
CloudServiceInstanceView result = await cloudService.GetInstanceViewAsync();

Console.WriteLine($"Succeeded: {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."
    }
  ]
}

定義

名稱	Description
ApiError	Api 錯誤。
ApiErrorBase	API 錯誤基底。
CloudError	來自計算服務的錯誤回應。
CloudServiceInstanceView	整個 CloudService 的 InstanceView
InnerError	內部錯誤詳細數據。
InstanceViewStatusesSummary	實例檢視狀態。
ResourceInstanceViewStatus	實例檢視狀態。
StatusCodeCount	雲端服務實例檢視狀態的狀態代碼和計數
StatusLevelTypes	層級程序代碼。

ApiError

Api 錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	ApiErrorBase[]	Api 錯誤詳細數據
innererror	InnerError	Api 內部錯誤
message	string	錯誤訊息。
target	string	特定錯誤的目標。

ApiErrorBase

API 錯誤基底。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

CloudError

來自計算服務的錯誤回應。

名稱	類型	Description
error	ApiError	Api 錯誤。

CloudServiceInstanceView

整個 CloudService 的 InstanceView

名稱	類型	Description
privateIds	string[]	指定雲端服務內部產生的唯一標識符清單。注意：如果您使用 Azure 診斷擴充功能，則可以將此屬性當做 'DeploymentId' 來查詢詳細數據。
roleInstance	InstanceViewStatusesSummary	實例檢視狀態。
sdkVersion	string	用來產生雲端服務套件的 SDK 版本。
statuses	ResourceInstanceViewStatus[]	實例檢視狀態。

InnerError

內部錯誤詳細數據。

名稱	類型	Description
errordetail	string	內部錯誤訊息或例外狀況傾印。
exceptiontype	string	例外狀況類型。

InstanceViewStatusesSummary

實例檢視狀態。

名稱	類型	Description
statusesSummary	StatusCodeCount[]	摘要。

ResourceInstanceViewStatus

實例檢視狀態。

名稱	類型	Description
code	string	狀態代碼。
displayStatus	string	狀態的簡短可當地語系化標籤。
level	StatusLevelTypes	層級程序代碼。
message	string	詳細的狀態消息，包括警示和錯誤訊息。
time	string	狀態的時間。

StatusCodeCount

雲端服務實例檢視狀態的狀態代碼和計數

名稱	類型	Description
code	string	實例檢視狀態代碼
count	integer	具有此狀態代碼的實例數目

StatusLevelTypes

層級程序代碼。

名稱	類型	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

其他資源