Virtual Machine Scale Sets - Get Instance View

Service:

Compute

API Version:

2022-03-01

Mendapatkan status instans set skala VM.

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

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vmScaleSetName	path	True	string	Nama set skala VM.
api-version	query	True	string	Versi Api Klien.

Respons

Name	Type	Description
200 OK	VirtualMachineScaleSetInstanceView	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen

VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen

VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaa/instanceView?api-version=2022-03-01

Java

import com.azure.core.util.Context;

/** Samples for VirtualMachineScaleSets GetInstanceView. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineScaleSetsGetInstanceViewMaximumSetGen(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .virtualMachines()
            .manager()
            .serviceClient()
            .getVirtualMachineScaleSets()
            .getInstanceViewWithResponse("rgcompute", "aaaaaaaaaaaaaaa", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_GetInstanceView() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcompute.NewVirtualMachineScaleSetsClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetInstanceView(ctx,
		"rgcompute",
		"aaaaaaaaaaaaaaa",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Gets the status of a VM scale set instance.
 *
 * @summary Gets the status of a VM scale set instance.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.json
 */
async function virtualMachineScaleSetsGetInstanceViewMaximumSetGen() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.getInstanceView(
    resourceGroupName,
    vmScaleSetName
  );
  console.log(result);
}

virtualMachineScaleSetsGetInstanceViewMaximumSetGen().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "virtualMachine": {
    "statusesSummary": [
      {
        "code": "aa",
        "count": 21
      }
    ]
  },
  "extensions": [
    {
      "name": "aaaaaaaaaaa",
      "statusesSummary": [
        {
          "code": "aa",
          "count": 21
        }
      ]
    }
  ],
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": "aaaaaaaaaaaaaaaaaaaaaaa",
      "time": "2021-11-30T12:58:26.526Z"
    }
  ],
  "orchestrationServices": [
    {
      "serviceName": "AutomaticRepairs",
      "serviceState": "NotRunning"
    }
  ]
}

VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaa/instanceView?api-version=2022-03-01

Java

import com.azure.core.util.Context;

/** Samples for VirtualMachineScaleSets GetInstanceView. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen.json
     */
    /**
     * Sample code: VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void virtualMachineScaleSetsGetInstanceViewMinimumSetGen(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .virtualMachines()
            .manager()
            .serviceClient()
            .getVirtualMachineScaleSets()
            .getInstanceViewWithResponse("rgcompute", "aaaaaaaaaaaaaaa", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

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

/**
 * This sample demonstrates how to Gets the status of a VM scale set instance.
 *
 * @summary Gets the status of a VM scale set instance.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen.json
 */
async function virtualMachineScaleSetsGetInstanceViewMinimumSetGen() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "rgcompute";
  const vmScaleSetName = "aaaaaaaaaaaaaaa";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSets.getInstanceView(
    resourceGroupName,
    vmScaleSetName
  );
  console.log(result);
}

virtualMachineScaleSetsGetInstanceViewMinimumSetGen().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{}

Definisi

ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
CloudError	Respons kesalahan dari layanan Komputasi.
InnerError	Detail kesalahan dalam.
InstanceViewStatus	Status tampilan instans.
OrchestrationServiceNames	Nama layanan.
OrchestrationServiceState	Status layanan saat ini.
OrchestrationServiceSummary	Ringkasan untuk layanan orkestrasi set skala komputer virtual.
StatusLevelTypes	Kode tingkat.
VirtualMachineScaleSetInstanceView	Tampilan instans set skala komputer virtual.
VirtualMachineScaleSetInstanceViewStatusesSummary	Ringkasan status tampilan instans untuk komputer virtual dari set skala komputer virtual.
VirtualMachineScaleSetVMExtensionsSummary	Ringkasan ekstensi untuk komputer virtual dari set skala komputer virtual.
VirtualMachineStatusCodeCount	Kode status dan jumlah ringkasan status tampilan instans set skala komputer virtual.

ApiError

Kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Name	Type	Description
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

CloudError

Respons kesalahan dari layanan Komputasi.

Name	Type	Description
error	ApiError	Kesalahan api.

InnerError

Detail kesalahan dalam.

Name	Type	Description
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

InstanceViewStatus

Status tampilan instans.

Name	Type	Description
code	string	Kode status.
displayStatus	string	Label pendek yang dapat dilokalkan untuk status tersebut.
level	StatusLevelTypes	Kode tingkat.
message	string	Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan.
time	string	Waktu status.

OrchestrationServiceNames

Nama layanan.

Name	Type	Description
AutomaticRepairs	string

OrchestrationServiceState

Status layanan saat ini.

Name	Type	Description
NotRunning	string
Running	string
Suspended	string

OrchestrationServiceSummary

Ringkasan untuk layanan orkestrasi set skala komputer virtual.

Name	Type	Description
serviceName	OrchestrationServiceNames	Nama layanan.
serviceState	OrchestrationServiceState	Status layanan saat ini.

StatusLevelTypes

Kode tingkat.

Name	Type	Description
Error	string
Info	string
Warning	string

VirtualMachineScaleSetInstanceView

Tampilan instans set skala komputer virtual.

Name	Type	Description
extensions	VirtualMachineScaleSetVMExtensionsSummary[]	Informasi ekstensi.
orchestrationServices	OrchestrationServiceSummary[]	Informasi layanan orkestrasi.
statuses	InstanceViewStatus[]	Informasi status sumber daya.
virtualMachine	VirtualMachineScaleSetInstanceViewStatusesSummary	Ringkasan status tampilan instans untuk set skala komputer virtual.

VirtualMachineScaleSetInstanceViewStatusesSummary

Ringkasan status tampilan instans untuk komputer virtual dari set skala komputer virtual.

Name	Type	Description
statusesSummary	VirtualMachineStatusCodeCount[]	Informasi ekstensi.

VirtualMachineScaleSetVMExtensionsSummary

Ringkasan ekstensi untuk komputer virtual dari set skala komputer virtual.

Name	Type	Description
name	string	Nama ekstensi.
statusesSummary	VirtualMachineStatusCodeCount[]	Informasi ekstensi.

VirtualMachineStatusCodeCount

Kode status dan jumlah ringkasan status tampilan instans set skala komputer virtual.

Name	Type	Description
code	string	Kode status tampilan instans.
count	integer	Jumlah instans yang memiliki kode status tertentu.