Virtual Machine Scale Sets - Get Instance View

Service:

Compute

API Version:

2024-03-01

Ruft die status einer VM-Skalierungsgruppe instance ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmScaleSetName	path	True	string	Der Name der VM-Skalierungsgruppe.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineScaleSetInstanceView	OK
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen

VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen

VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen

Sample Request

HTTP

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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_GetInstanceView_virtualMachineScaleSetGetInstanceViewMaximumSetGen() {
	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.NewVirtualMachineScaleSetsClient().GetInstanceView(ctx, "rgcompute", "aaaaaaaaaaaaaaa", 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.VirtualMachineScaleSetInstanceView = armcompute.VirtualMachineScaleSetInstanceView{
	// 	OrchestrationServices: []*armcompute.OrchestrationServiceSummary{
	// 		{
	// 			ServiceName: to.Ptr(armcompute.OrchestrationServiceNamesAutomaticRepairs),
	// 			ServiceState: to.Ptr(armcompute.OrchestrationServiceStateNotRunning),
	// 	}},
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			Code: to.Ptr("ProvisioningState/succeeded"),
	// 			DisplayStatus: to.Ptr("Provisioning succeeded"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 			Message: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaa"),
	// 			Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T12:58:26.526Z"); return t}()),
	// 	}},
	// 	VirtualMachine: &armcompute.VirtualMachineScaleSetInstanceViewStatusesSummary{
	// 		StatusesSummary: []*armcompute.VirtualMachineStatusCodeCount{
	// 			{
	// 				Code: to.Ptr("aa"),
	// 				Count: to.Ptr[int32](21),
	// 		}},
	// 	},
	// 	Extensions: []*armcompute.VirtualMachineScaleSetVMExtensionsSummary{
	// 		{
	// 			Name: to.Ptr("aaaaaaaaaaa"),
	// 			StatusesSummary: []*armcompute.VirtualMachineStatusCodeCount{
	// 				{
	// 					Code: to.Ptr("aa"),
	// 					Count: to.Ptr[int32](21),
	// 			}},
	// 	}},
	// }
}

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

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"
    }
  ]
}

VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen

Sample Request

HTTP

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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_GetInstanceView_virtualMachineScaleSetGetInstanceViewMinimumSetGen() {
	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.NewVirtualMachineScaleSetsClient().GetInstanceView(ctx, "rgcompute", "aaaaaaaaaaaaaaa", 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.VirtualMachineScaleSetInstanceView = armcompute.VirtualMachineScaleSetInstanceView{
	// }
}

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

Sample Response

Status code:

200

{}

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort des Computediensts.
InnerError	Innere Fehlerdetails.
InstanceViewStatus	Instanzansicht status.
OrchestrationServiceNames	Der Name des Diensts.
OrchestrationServiceState	Der aktuelle Status des Diensts.
OrchestrationServiceSummary	Zusammenfassung für einen Orchestrierungsdienst einer VM-Skalierungsgruppe.
StatusLevelTypes	Der Ebenencode.
VirtualMachineScaleSetInstanceView	Die instance Ansicht einer VM-Skalierungsgruppe.
VirtualMachineScaleSetInstanceViewStatusesSummary	Zusammenfassung des Status der Instanzansicht für virtuelle Computer einer VM-Skalierungsgruppe.
VirtualMachineScaleSetVMExtensionsSummary	Zusammenfassung der Erweiterungen für virtuelle Computer einer VM-Skalierungsgruppe.
VirtualMachineStatusCodeCount	Der status Code und die Anzahl der VM-Skalierungsgruppe instance Ansicht status Zusammenfassung.

ApiError

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Api-Fehlerdetails
innererror	InnerError	Der innere Api-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des jeweiligen Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des jeweiligen Fehlers.

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Das interne Fehlermeldungs- oder Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

InstanceViewStatus

Instanzansicht status.

Name	Typ	Beschreibung
code	string	Der Statuscode.
displayStatus	string	Die kurze lokalisierbare Bezeichnung für die status.
level	StatusLevelTypes	Der Ebenencode.
message	string	Die detaillierte status Meldung, einschließlich Warnungen und Fehlermeldungen.
time	string	Die Zeit des status.

OrchestrationServiceNames

Der Name des Diensts.

Name	Typ	Beschreibung
AutomaticRepairs	string

OrchestrationServiceState

Der aktuelle Status des Diensts.

Name	Typ	Beschreibung
NotRunning	string
Running	string
Suspended	string

OrchestrationServiceSummary

Zusammenfassung für einen Orchestrierungsdienst einer VM-Skalierungsgruppe.

Name	Typ	Beschreibung
serviceName	OrchestrationServiceNames	Der Name des Diensts.
serviceState	OrchestrationServiceState	Der aktuelle Status des Diensts.

StatusLevelTypes

Der Ebenencode.

Name	Typ	Beschreibung
Error	string
Info	string
Warning	string

VirtualMachineScaleSetInstanceView

Die instance Ansicht einer VM-Skalierungsgruppe.

Name	Typ	Beschreibung
extensions	VirtualMachineScaleSetVMExtensionsSummary[]	Die Erweiterungsinformationen.
orchestrationServices	OrchestrationServiceSummary[]	Die Orchestrierungsdiensteinformationen.
statuses	InstanceViewStatus[]	Die Ressource status Informationen.
virtualMachine	VirtualMachineScaleSetInstanceViewStatusesSummary	Die instance Ansicht status Zusammenfassung für die VM-Skalierungsgruppe.

VirtualMachineScaleSetInstanceViewStatusesSummary

Zusammenfassung des Status der Instanzansicht für virtuelle Computer einer VM-Skalierungsgruppe.

Name	Typ	Beschreibung
statusesSummary	VirtualMachineStatusCodeCount[]	Die Erweiterungsinformationen.

VirtualMachineScaleSetVMExtensionsSummary

Zusammenfassung der Erweiterungen für virtuelle Computer einer VM-Skalierungsgruppe.

Name	Typ	Beschreibung
name	string	Der Erweiterungsname.
statusesSummary	VirtualMachineStatusCodeCount[]	Die Erweiterungsinformationen.

VirtualMachineStatusCodeCount

Der status Code und die Anzahl der VM-Skalierungsgruppe instance Ansicht status Zusammenfassung.

Name	Typ	Beschreibung
code	string	Die instance Ansicht status Code.
count	integer	Die Anzahl der Instanzen mit einem bestimmten status Code.