Virtual Machine Scale Set VMs - Get Instance View

Başvuru

Service:: Compute

API Version:: 2024-03-01

Vm ölçek kümesinden bir sanal makinenin durumunu alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
instanceId	path	True	string	Sanal makinenin örnek kimliği.
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
vmScaleSetName	path	True	string	VM ölçek kümesinin adı.
api-version	query	True	string	İstemci Api Sürümü.

Yanıtlar

Name	Tür	Description
200 OK	VirtualMachineScaleSetVMInstanceView	Tamam
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.

Sample Request

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_scale_set_vm_get_instance_view_auto_placed_on_dedicated_host_group.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.virtual_machine_scale_set_vms.get_instance_view(
        resource_group_name="myResourceGroup",
        vm_scale_set_name="myVirtualMachineScaleSet",
        instance_id="0",
    )
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.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/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/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
func ExampleVirtualMachineScaleSetVMsClient_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.NewVirtualMachineScaleSetVMsClient().GetInstanceView(ctx, "myResourceGroup", "myVirtualMachineScaleSet", "0", 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.VirtualMachineScaleSetVMInstanceView = armcompute.VirtualMachineScaleSetVMInstanceView{
	// 	AssignedHost: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost"),
	// 	Disks: []*armcompute.DiskInstanceView{
	// 		{
	// 			Name: to.Ptr("myOSDisk"),
	// 			Statuses: []*armcompute.InstanceViewStatus{
	// 				{
	// 					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, "2024-03-01T04:58:58.088Z"); return t}()),
	// 			}},
	// 	}},
	// 	PlatformFaultDomain: to.Ptr[int32](0),
	// 	PlatformUpdateDomain: to.Ptr[int32](0),
	// 	Statuses: []*armcompute.InstanceViewStatus{
	// 		{
	// 			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, "2020-06-05T04:59:58.185Z"); return t}()),
	// 		},
	// 		{
	// 			Code: to.Ptr("PowerState/running"),
	// 			DisplayStatus: to.Ptr("VM running"),
	// 			Level: to.Ptr(armcompute.StatusLevelTypesInfo),
	// 	}},
	// 	VMAgent: &armcompute.VirtualMachineAgentInstanceView{
	// 		Statuses: []*armcompute.InstanceViewStatus{
	// 			{
	// 				Code: to.Ptr("ProvisioningState/Unavailable"),
	// 				DisplayStatus: to.Ptr("Not Ready"),
	// 				Level: to.Ptr(armcompute.StatusLevelTypesWarning),
	// 				Message: to.Ptr("VM status blob is found but not yet populated."),
	// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-03-01T05:00:32.000Z"); return t}()),
	// 		}},
	// 		VMAgentVersion: to.Ptr("Unknown"),
	// 	},
	// }
}

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 virtual machine from a VM scale set.
 *
 * @summary Gets the status of a virtual machine from a VM scale set.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
 */
async function getInstanceViewOfAVirtualMachineFromAVMScaleSetPlacedOnADedicatedHostGroupThroughAutomaticPlacement() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const vmScaleSetName = "myVirtualMachineScaleSet";
  const instanceId = "0";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachineScaleSetVMs.getInstanceView(
    resourceGroupName,
    vmScaleSetName,
    instanceId,
  );
  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

Sample Response

Status code:: 200

{
  "platformUpdateDomain": 0,
  "platformFaultDomain": 0,
  "rdpThumbPrint": null,
  "vmAgent": {
    "vmAgentVersion": "Unknown",
    "statuses": [
      {
        "code": "ProvisioningState/Unavailable",
        "level": "Warning",
        "displayStatus": "Not Ready",
        "message": "VM status blob is found but not yet populated.",
        "time": "2024-03-01T05:00:32+00:00"
      }
    ],
    "extensionHandlers": null
  },
  "disks": [
    {
      "name": "myOSDisk",
      "encryptionSettings": null,
      "statuses": [
        {
          "code": "ProvisioningState/succeeded",
          "level": "Info",
          "displayStatus": "Provisioning succeeded",
          "message": null,
          "time": "2024-03-01T04:58:58.0882815+00:00"
        }
      ]
    }
  ],
  "extensions": null,
  "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
  "bootDiagnostics": null,
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "message": null,
      "time": "2020-06-05T04:59:58.1852966+00:00"
    },
    {
      "code": "PowerState/running",
      "level": "Info",
      "displayStatus": "VM running",
      "message": null,
      "time": null
    }
  ]
}

Tanımlar

Name	Description
ApiError	Api hatası.
ApiErrorBase	Api hata tabanı.
BootDiagnosticsInstanceView	Önyükleme Tanılama, VM durumunu tanılamak için Konsol Çıkışını ve Ekran Görüntüsünü görüntülemenizi sağlayan bir hata ayıklama özelliğidir. Konsol günlüğünüzün çıkışını kolayca görüntüleyebilirsiniz. Azure ayrıca hiper yöneticiden vm'nin ekran görüntüsünü görmenizi sağlar.
CloudError	İşlem hizmetinden bir hata yanıtı.
DiskEncryptionSettings	İşletim Sistemi Diski için şifreleme ayarlarını belirtir. En düşük api sürümü: 2015-06-15
DiskInstanceView	Disk bilgileri.
HyperVGeneration	Sanal Makinenin hiper yönetici oluşturması [V1, V2]
InnerError	İç hata ayrıntıları.
InstanceViewStatus	Örnek görünümü durumu.
KeyVaultKeyReference	Key Vault anahtar şifreleme anahtarının konumunu belirtir.
KeyVaultSecretReference	Key Vault Gizli Anahtarı olan disk şifreleme anahtarının konumunu belirtir.
MaintenanceOperationResultCodeTypes	Son Bakım İşlemi Sonuç Kodu.
MaintenanceRedeployStatus	Sanal makinedeki Bakım İşlemi durumu.
StatusLevelTypes	Düzey kodu.
SubResource	Gizli diziyi içeren Key Vault göreli URL'si.
VirtualMachineAgentInstanceView	Sanal makinede çalışan VM Aracısı.
VirtualMachineExtensionHandlerInstanceView	Sanal makine uzantısı işleyici örneği görünümü.
VirtualMachineExtensionInstanceView	Uzantı bilgileri.
VirtualMachineHealthStatus	VM'nin sistem durumu.
VirtualMachineScaleSetVMInstanceView	Sanal makine ölçek kümesi VM'sinin örnek görünümü.

ApiError

Api hatası.

Name	Tür	Description
code	string	Hata kodu.
details	ApiErrorBase[]	Api hata ayrıntıları
innererror	InnerError	Api iç hatası
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

ApiErrorBase

Api hata tabanı.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

BootDiagnosticsInstanceView

Önyükleme Tanılama, VM durumunu tanılamak için Konsol Çıkışını ve Ekran Görüntüsünü görüntülemenizi sağlayan bir hata ayıklama özelliğidir. Konsol günlüğünüzün çıkışını kolayca görüntüleyebilirsiniz. Azure ayrıca hiper yöneticiden vm'nin ekran görüntüsünü görmenizi sağlar.

Name	Tür	Description
consoleScreenshotBlobUri	string	Konsol ekran görüntüsü blob URI'si. Not: Önyükleme tanılaması şu anda yönetilen depolama ile etkinleştirildiyse bu ayar yapılmaz .
serialConsoleLogBlobUri	string	Seri konsol günlük blobu Uri'si. Not: Önyükleme tanılaması şu anda yönetilen depolama ile etkinleştirildiyse bu ayar yapılmaz .
status	InstanceViewStatus	VM için önyükleme tanılama durumu bilgileri. Not: Yalnızca önyükleme tanılamasını etkinleştirmede karşılaşılan hatalar varsa ayarlanır.

CloudError

İşlem hizmetinden bir hata yanıtı.

Name	Tür	Description
error	ApiError	Api hatası.

DiskEncryptionSettings

İşletim Sistemi Diski için şifreleme ayarlarını belirtir.

En düşük api sürümü: 2015-06-15

Name	Tür	Description
diskEncryptionKey	KeyVaultSecretReference	Key Vault Gizli Anahtarı olan disk şifreleme anahtarının konumunu belirtir.
enabled	boolean	Sanal makinede disk şifrelemesinin etkinleştirilip etkinleştirilmeymeyeceğini belirtir.
keyEncryptionKey	KeyVaultKeyReference	Key Vault anahtar şifreleme anahtarının konumunu belirtir.

DiskInstanceView

Disk bilgileri.

Name	Tür	Description
encryptionSettings	DiskEncryptionSettings[]	İşletim Sistemi Diski için şifreleme ayarlarını belirtir. En düşük api sürümü: 2015-06-15
name	string	Disk adı.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.

HyperVGeneration

Sanal Makinenin hiper yönetici oluşturması [V1, V2]

Name	Tür	Description
V1	string
V2	string

InnerError

İç hata ayrıntıları.

Name	Tür	Description
errordetail	string	İç hata iletisi veya özel durum dökümü.
exceptiontype	string	Özel durum türü.

InstanceViewStatus

Örnek görünümü durumu.

Name	Tür	Description
code	string	Durum kodu.
displayStatus	string	Durum için kısa yerelleştirilebilir etiket.
level	StatusLevelTypes	Düzey kodu.
message	string	Uyarılar ve hata iletileri de dahil olmak üzere ayrıntılı durum iletisi.
time	string	Durum zamanı.

KeyVaultKeyReference

Key Vault anahtar şifreleme anahtarının konumunu belirtir.

Name	Tür	Description
keyUrl	string	Key Vault anahtar şifreleme anahtarına başvuran URL.
sourceVault	SubResource	Anahtarı içeren Key Vault göreli URL'si.

KeyVaultSecretReference

Key Vault Gizli Anahtarı olan disk şifreleme anahtarının konumunu belirtir.

Name	Tür	Description
secretUrl	string	Key Vault gizli diziye başvuran URL.
sourceVault	SubResource	Gizli diziyi içeren Key Vault göreli URL'si.

MaintenanceOperationResultCodeTypes

Son Bakım İşlemi Sonuç Kodu.

Name	Tür	Description
MaintenanceAborted	string
MaintenanceCompleted	string
None	string
RetryLater	string

MaintenanceRedeployStatus

Sanal makinedeki Bakım İşlemi durumu.

Name	Tür	Description
isCustomerInitiatedMaintenanceAllowed	boolean	Doğru, müşterinin Bakım gerçekleştirmesine izin veriliyorsa.
lastOperationMessage	string	Son Bakım İşlemi için döndürülen ileti.
lastOperationResultCode	MaintenanceOperationResultCodeTypes	Son Bakım İşlemi Sonuç Kodu.
maintenanceWindowEndTime	string	Bakım Penceresinin Bitiş Saati.
maintenanceWindowStartTime	string	Bakım Penceresi için Başlangıç Saati.
preMaintenanceWindowEndTime	string	Bakım Öncesi Penceresinin Bitiş Saati.
preMaintenanceWindowStartTime	string	Bakım Öncesi Penceresi için Başlangıç Saati.

StatusLevelTypes

Düzey kodu.

Name	Tür	Description
Error	string
Info	string
Warning	string

SubResource

Gizli diziyi içeren Key Vault göreli URL'si.

Name	Tür	Description
id	string	Kaynak Kimliği

VirtualMachineAgentInstanceView

Sanal makinede çalışan VM Aracısı.

Name	Tür	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	Sanal makine uzantısı işleyici örneği görünümü.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
vmAgentVersion	string	VM Aracısı tam sürümü.

VirtualMachineExtensionHandlerInstanceView

Sanal makine uzantısı işleyici örneği görünümü.

Name	Tür	Description
status	InstanceViewStatus	Uzantı işleyici durumu.
type	string	Uzantının türünü belirtir; "CustomScriptExtension" örnek olarak verilmiştir.
typeHandlerVersion	string	Betik işleyicisinin sürümünü belirtir.

VirtualMachineExtensionInstanceView

Uzantı bilgileri.

Name	Tür	Description
name	string	Sanal makine uzantısı adı.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
substatuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
type	string	Uzantının türünü belirtir; "CustomScriptExtension" örnek olarak verilmiştir.
typeHandlerVersion	string	Betik işleyicisinin sürümünü belirtir.

VirtualMachineHealthStatus

VM'nin sistem durumu.

Name	Tür	Description
status	InstanceViewStatus	VM'nin sistem durumu bilgileri.

VirtualMachineScaleSetVMInstanceView

Sanal makine ölçek kümesi VM'sinin örnek görünümü.

Name	Tür	Description
assignedHost	string	Sanal makine, otomatik yerleştirmenin etkinleştirildiği ayrılmış bir konak grubuyla ilişkilendirildiğinde, sanal makinenin otomatik yerleştirme yoluyla ayrıldığı ayrılmış konağın kaynak kimliği. En düşük api sürümü: 2020-06-01.
bootDiagnostics	BootDiagnosticsInstanceView	Önyükleme Tanılama, VM durumunu tanılamak için Konsol Çıkışını ve Ekran Görüntüsünü görüntülemenizi sağlayan bir hata ayıklama özelliğidir. Konsol günlüğünüzün çıkışını kolayca görüntüleyebilirsiniz. Azure ayrıca hiper yöneticiden vm'nin ekran görüntüsünü görmenizi sağlar.
computerName	string	Sanal makinenin konak işletim sistemi adını belirtir. Vm oluşturulduktan sonra bu ad güncelleştirilemez. Maksimum uzunluk (Windows): 15 karakter Maksimum uzunluk (Linux): 64 karakter. Adlandırma kuralları ve kısıtlamaları için bkz. Azure altyapı hizmetleri uygulama yönergeleri.
disks	DiskInstanceView[]	Disk bilgileri.
extensions	VirtualMachineExtensionInstanceView[]	Uzantı bilgileri.
hyperVGeneration	HyperVGeneration	Sanal Makinenin hiper yönetici oluşturması [V1, V2]
maintenanceRedeployStatus	MaintenanceRedeployStatus	Sanal makinedeki Bakım İşlemi durumu.
osName	string	Karma makinede çalışan İşletim Sistemi.
osVersion	string	Karma makinede çalışan İşletim Sistemi sürümü.
placementGroupId	string	VM'nin çalıştığı yerleştirme grubu. VM serbest bırakılırsa placementGroupId değeri olmaz.
platformFaultDomain	integer	Hata Etki Alanı sayısı.
platformUpdateDomain	integer	Etki Alanını Güncelleştir sayısı.
rdpThumbPrint	string	Uzak masaüstü sertifikası parmak izi.
statuses	InstanceViewStatus[]	Kaynak durumu bilgileri.
vmAgent	VirtualMachineAgentInstanceView	Sanal makinede çalışan VM Aracısı.
vmHealth	VirtualMachineHealthStatus	VM'nin sistem durumu.

Share via

Virtual Machine Scale Set VMs - Get Instance View

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.

Sample Request

Sample Response

Tanımlar

ApiError

ApiErrorBase

BootDiagnosticsInstanceView

CloudError

DiskEncryptionSettings

DiskInstanceView

HyperVGeneration

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

MaintenanceOperationResultCodeTypes

MaintenanceRedeployStatus

StatusLevelTypes

SubResource

VirtualMachineAgentInstanceView

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionInstanceView

VirtualMachineHealthStatus

VirtualMachineScaleSetVMInstanceView

Ek kaynaklar