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 パラメーター

名前	/	必須	型	説明
cloudServiceName	path	True	string	クラウドサービスの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	CloudServiceInstanceView	[OK]
Other Status Codes	CloudError	エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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

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.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/Cloudservice/stable/2024-11-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."
    }
  ]
}

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピュート・サービスからのエラー・レスポンス。
CloudServiceInstanceView	CloudService全体のInstanceView
InnerError	内部エラーの詳細。
InstanceViewStatusesSummary	インスタンスビューのステータス。
ResourceInstanceViewStatus	インスタンスビューの状態。
StatusCodeCount	クラウドサービスインスタンスビューの状態の状態コードと数
StatusLevelTypes	レベルコード。

ApiError

Object

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api 内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

Object

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

CloudError

Object

コンピュート・サービスからのエラー・レスポンス。

名前	型	説明
error	ApiError	API エラー。

CloudServiceInstanceView

Object

CloudService全体のInstanceView

名前	型	説明
privateIds	string[]	クラウドサービス用に内部的に生成された一意の識別子のリストを指定します。注: Azure Diagnostics 拡張機能を使用している場合、このプロパティを詳細クエリの 'DeploymentId' として使用できます。
roleInstance	InstanceViewStatusesSummary	インスタンスビューのステータス。
sdkVersion	string	クラウドサービスのパッケージの生成に使用された SDK のバージョン。
statuses	ResourceInstanceViewStatus[]	インスタンスビューの状態。

InnerError

Object

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラー・メッセージまたは例外ダンプ。
exceptiontype	string	例外タイプ。

InstanceViewStatusesSummary

Object

インスタンスビューのステータス。

名前	型	説明
statusesSummary	StatusCodeCount[]	概要。

ResourceInstanceViewStatus

Object

インスタンスビューの状態。

名前	型	説明
code	string	状態コード。
displayStatus	string	状態の短いローカライズ可能なラベル。
level	StatusLevelTypes	レベルコード。
message	string	アラートやエラーメッセージを含む詳細なステータスメッセージ。
time	string (date-time)	状態の時刻。

StatusCodeCount

Object

クラウドサービスインスタンスビューの状態の状態コードと数

名前	型	説明
code	string	インスタンスビューステータスコード
count	integer (int32)	このステータスコードを持つインスタンスの数

StatusLevelTypes

列挙

レベルコード。

値	説明
Info
Warning
Error