Virtual Machines - List By Lab

Başvuru

Service:: Lab Services

API Version:: 2023-06-07

Laboratuvar için tüm sanal makineleri alın.
Laboratuvar için tüm sanal makinelerin listesini döndürür.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07&$filter={$filter}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
labName	path	True	string	Laboratuvar planını içeren içinde onu benzersiz olarak tanımlayan laboratuvarın adı. Kaynak URI'lerinde kullanılır.
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
$filter	query		string	İşleme uygulanacak filtre.

Yanıtlar

Name	Tür	Description
200 OK	PagedVirtualMachines	İstek başarılı oldu; yanıt, verilen laboratuvar için tüm sanal makineleri içerir.
Other Status Codes	ErrorResponse	Varsayılan hata yanıtı.

Örnekler

listVirtualMachine

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines?api-version=2023-06-07

Sample Response

Status code:: 200

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines/template",
      "name": "default",
      "type": "Microsoft.LabServices/VirtualMachine",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Running",
        "connectionProfile": {
          "privateIpAddress": "192.168.2.1",
          "sshAuthority": "vm-42.contoso.com:22",
          "sshInBrowserUrl": "vm-42.contoso.com",
          "rdpAuthority": "vm-42.contoso.com:3389",
          "rdpInBrowserUrl": "vm-42.contoso.com",
          "adminUsername": "user123"
        },
        "claimedByUserId": "testuser567",
        "vmType": "Template"
      }
    }
  ]
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
PagedVirtualMachines	Laboratuvar hizmetleri sanal makinelerinin sayfalanmış listesi.
ProvisioningState	Sanal makinenin geçerli sağlama durumu.
ResourceOperationError	Bu kaynakta en son işlem hatasının hata ayrıntıları
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
VirtualMachine	Laboratuvar sanal makine kaynağı.
VirtualMachineConnectionProfile	Sanal makine için bağlantı bilgileri
VirtualMachineState	Sanal makinenin durumu.
VirtualMachineType	Laboratuvar sanal makinesinin türü.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

PagedVirtualMachines

Laboratuvar hizmetleri sanal makinelerinin sayfalanmış listesi.

Name	Tür	Description
nextLink	string	Sanal makine sonuçlarının sonraki sayfasını alma bağlantısı.
value	VirtualMachine[]	Sanal makine sonuçlarının dizi sayfası.

ProvisioningState

Sanal makinenin geçerli sağlama durumu.

Name	Tür	Description
Creating	string	Kaynak oluşturulma aşamasındadır.
Deleting	string	Kaynak silinme aşamasında.
Failed	string	Kaynaktaki önceki işlem, kaynağı iyi durumda bırakmada başarısız oldu.
Locked	string	Kaynak kilitli ve değişiklikler şu anda engelleniyor. Bunun nedeni bakım veya zamanlanmış bir işlem olabilir. Kilitleme işlemi tamamlandıktan sonra durum başarılı durumuna geri döner.
Succeeded	string	Kaynak oluşturma veya güncelleştirme işleminden sonra iyi durumda.
Updating	string	Kaynağa yeni özellik değerleri uygulanıyor.

ResourceOperationError

Bu kaynakta en son işlem hatasının hata ayrıntıları

Name	Tür	Description
action	string	Başarısız olan işlem eylemi
code	string	İşlem hatasının türüne karşılık gelen kod
message	string	İşlem hatası iletisi
timestamp	string	Hatanın oluştuğu tarih saat

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

VirtualMachine

Laboratuvar sanal makine kaynağı.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.claimedByUserId	string	Sanal makineyi talep edenin laboratuvar kullanıcı kimliği (PUID!) değil.
properties.connectionProfile	VirtualMachineConnectionProfile	Sanal makineye bağlanma hakkında bilgi için profil.
properties.provisioningState	ProvisioningState	Sanal makinenin geçerli sağlama durumu.
properties.resourceOperationError	ResourceOperationError	Laboratuvar planında yapılan son işlemin hata ayrıntıları.
properties.state	VirtualMachineState	Sanal makinenin geçerli durumu
properties.vmType	VirtualMachineType	Bu VM kaynağının türü
systemData	systemData	Laboratuvar sanal makinesinin sistem verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

VirtualMachineConnectionProfile

Sanal makine için bağlantı bilgileri

Name	Tür	Description
adminUsername	string	Sanal makinede yönetici olarak oturum açmak için kullanılan kullanıcı adı.
nonAdminUsername	string	Varsa, sanal makinede yönetici olmayan olarak oturum açmak için kullanılan kullanıcı adı.
privateIpAddress	string	Sanal makinenin özel IP adresi.
rdpAuthority	string	RDP protokolü aracılığıyla sanal makineye bağlanmak için noktalı virgülle ayrılmış bağlantı noktası ve ana bilgisayar adı.
rdpInBrowserUrl	string	RDP protokolü aracılığıyla tarayıcıdaki sanal makineye bağlanma URL'si.
sshAuthority	string	Sanal makineye SSH protokolü aracılığıyla bağlanmak için noktalı virgülle ayrılmış bağlantı noktası ve ana bilgisayar adı.
sshInBrowserUrl	string	SSH protokolü aracılığıyla tarayıcıdaki sanal makineye bağlanma URL'si.

VirtualMachineState

Sanal makinenin durumu.

Name	Tür	Description
Redeploying	string	VM yeniden dağıtılıyor.
Reimaging	string	VM yeniden oluşturuluyor.
ResettingPassword	string	VM parolası sıfırlanıyor.
Running	string	VM çalışıyor.
Starting	string	VM başlatılıyor.
Stopped	string	VM şu anda durduruldu.
Stopping	string	VM durduruluyor.

VirtualMachineType

Laboratuvar sanal makinesinin türü.

Name	Tür	Description
Template	string	Şablon VM'leri
User	string	Kullanıcı VM'si