다음을 통해 공유


Virtual Machines - List

지정된 랩에서 가상 머신을 나열합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
labName
path True

string

랩의 이름입니다.

resourceGroupName
path True

string

리소스 그룹의 이름.

subscriptionId
path True

string

구독 ID입니다.

api-version
query True

string

클라이언트 API 버전입니다.

$expand
query

string

$expand 쿼리를 지정합니다. 예: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'

$filter
query

string

작업에 적용할 필터입니다. 예: '$filter=contains(name,'myName')

$orderby
query

string

OData 표기법을 사용하여 결과에 대한 순서 지정 식입니다. 예: '$orderby=name desc'

$top
query

integer

int32

작업에서 반환할 최대 리소스 수입니다. 예: '$top=10'

응답

Name 형식 Description
200 OK

LabVirtualMachineList

정상

Other Status Codes

CloudError

BadRequest

보안

azure_auth

OAuth2 암시적 허용

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation Microsoft Azure에 액세스

예제

VirtualMachines_List

샘플 요청

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines?api-version=2018-09-15

샘플 응답

{
  "value": [
    {
      "properties": {
        "ownerObjectId": "",
        "ownerUserPrincipalName": "",
        "createdByUserId": "",
        "createdByUser": "",
        "createdDate": "2018-10-01T16:53:02.4830866-07:00",
        "computeId": "/subscriptions/{subscriptionId}/resourceGroups/{labName}-{vmName}-{randomSuffix}/providers/Microsoft.Compute/virtualMachines/{vmName}",
        "osType": "Linux",
        "size": "Standard_A2_v2",
        "userName": "{userName}",
        "labSubnetName": "{virtualNetworkName}Subnet",
        "labVirtualNetworkId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
        "disallowPublicIpAddress": true,
        "artifactDeploymentStatus": {
          "artifactsApplied": 0,
          "totalArtifacts": 0
        },
        "galleryImageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "16.04-LTS",
          "osType": "Linux",
          "version": "Latest"
        },
        "networkInterface": {},
        "allowClaim": true,
        "storageType": "Standard",
        "virtualMachineCreationSource": "FromGalleryImage",
        "dataDiskParameters": [],
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualmachines/{vmName}",
      "name": "{vmName}",
      "type": "Microsoft.DevTestLab/labs/virtualMachines",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

정의

Name Description
ApplicableSchedule

가상 머신에 적용 가능한 일정입니다. 일정은 VM 또는 랩 수준에서 정의되었을 수 있습니다.

ArtifactDeploymentStatusProperties

아티팩트 배포의 속성입니다.

ArtifactInstallProperties

아티팩트 속성입니다.

ArtifactParameterProperties

아티팩트 매개 변수의 속성입니다.

AttachNewDataDiskOptions

Virtual Machine에 새 디스크를 연결하는 속성입니다.

CloudError

REST 요청의 오류입니다.

CloudErrorBody

REST 요청의 오류 본문입니다.

ComputeDataDisk

가상 머신에 연결된 데이터 디스크입니다.

ComputeVmInstanceViewStatus

가상 머신에 대한 상태 정보입니다.

ComputeVmProperties

Microsoft.Compute API에서 반환된 가상 머신의 속성입니다.

DataDiskProperties

가상 머신에 새 데이터 디스크 또는 기존 데이터 디스크를 추가하기 위한 요청 본문입니다.

DayDetails

일일 일정의 속성입니다.

EnableStatus

일정의 상태(예: 사용, 사용 안 함)

GalleryImageReference

Azure Marketplace 이미지에 대한 참조 정보입니다.

HostCachingOptions

데이터 디스크에 대한 캐싱 옵션(예: 없음, ReadOnly, ReadWrite).

HourDetails

시간별 일정의 속성입니다.

InboundNatRule

NAT에 대한 규칙 - 부하 분산 장치를 사용하여 공용 IP 주소에 VM의 포트(backendPort)를 노출합니다.

LabVirtualMachine

가상 머신 -

LabVirtualMachineList

목록 작업의 응답입니다.

NetworkInterfaceProperties

네트워크 인터페이스의 속성입니다.

NotificationSettings

일정에 대한 알림 설정입니다.

Schedule

일정입니다.

ScheduleCreationParameter

일정을 만들기 위한 속성입니다.

SharedPublicIpAddressConfiguration

부하 분산 장치에 연결되는 방법을 결정하는 가상 머신의 속성입니다.

StorageType

디스크의 스토리지 유형(예: 표준, 프리미엄)입니다.

TransportProtocol

엔드포인트의 전송 프로토콜입니다.

VirtualMachineCreationSource

랩 가상 머신 만들기의 원본을 알려줍니다. 출력 속성만 해당합니다.

WeekDetails

주별 일정의 속성입니다.

ApplicableSchedule

가상 머신에 적용 가능한 일정입니다. 일정은 VM 또는 랩 수준에서 정의되었을 수 있습니다.

Name 형식 Description
id

string

리소스의 식별자입니다.

location

string

리소스의 위치입니다.

name

string

리소스의 이름입니다.

properties.labVmsShutdown

Schedule

랩 또는 랩 리소스 수준에서 설정된 경우 자동 종료 일정입니다.

properties.labVmsStartup

Schedule

랩 또는 랩 리소스 수준에서 설정된 경우 자동 시작 일정입니다.

tags

object

리소스의 태그입니다.

type

string

리소스 형식입니다.

ArtifactDeploymentStatusProperties

아티팩트 배포의 속성입니다.

Name 형식 Description
artifactsApplied

integer

성공적으로 적용된 아티팩트 총 수입니다.

deploymentStatus

string

아티팩트 배포 상태.

totalArtifacts

integer

미정으로 적용된 아티팩트 총 수입니다.

ArtifactInstallProperties

아티팩트 속성입니다.

Name 형식 Description
artifactId

string

아티팩트의 식별자입니다.

artifactTitle

string

아티팩트의 제목입니다.

deploymentStatusMessage

string

배포의 상태 메시지입니다.

installTime

string

아티팩트가 가상 머신에 설치하기 시작하는 시간입니다.

parameters

ArtifactParameterProperties[]

아티팩트 매개 변수입니다.

status

string

아티팩트 상태.

vmExtensionStatusMessage

string

가상 머신 확장의 상태 메시지입니다.

ArtifactParameterProperties

아티팩트 매개 변수의 속성입니다.

Name 형식 Description
name

string

아티팩트 매개 변수의 이름입니다.

value

string

아티팩트 매개 변수의 값입니다.

AttachNewDataDiskOptions

Virtual Machine에 새 디스크를 연결하는 속성입니다.

Name 형식 Description
diskName

string

연결할 디스크의 이름입니다.

diskSizeGiB

integer

Gibibytes에 연결할 디스크의 크기입니다.

diskType

StorageType

디스크의 스토리지 유형(예: 표준, 프리미엄)입니다.

CloudError

REST 요청의 오류입니다.

Name 형식 Description
error

CloudErrorBody

발생한 클라우드 오류

CloudErrorBody

REST 요청의 오류 본문입니다.

Name 형식 Description
code

string

오류 코드입니다.

details

CloudErrorBody[]

내부 오류.

message

string

오류 메시지입니다.

target

string

오류 대상입니다.

ComputeDataDisk

가상 머신에 연결된 데이터 디스크입니다.

Name 형식 Description
diskSizeGiB

integer

GiB에서 데이터 디스크 크기를 가져옵니다.

diskUri

string

Blob에서 백업하는 경우 기본 Blob의 URI입니다.

managedDiskId

string

관리 디스크에서 지원되는 경우 컴퓨팅 디스크 리소스의 ID입니다.

name

string

데이터 디스크 이름을 가져옵니다.

ComputeVmInstanceViewStatus

가상 머신에 대한 상태 정보입니다.

Name 형식 Description
code

string

상태 코드를 가져옵니다.

displayStatus

string

상태 대한 짧은 지역화 가능 레이블을 가져옵니다.

message

string

상태 연결된 메시지를 가져옵니다.

ComputeVmProperties

Microsoft.Compute API에서 반환된 가상 머신의 속성입니다.

Name 형식 Description
dataDiskIds

string[]

가상 머신에 대한 데이터 디스크 Blob URI를 가져옵니다.

dataDisks

ComputeDataDisk[]

가상 머신에 연결된 모든 데이터 디스크를 가져옵니다.

networkInterfaceId

string

가상 머신의 네트워크 인터페이스 ID를 가져옵니다.

osDiskId

string

가상 머신에 대한 OS 디스크 Blob URI를 가져옵니다.

osType

string

가상 머신의 OS 유형을 가져옵니다.

statuses

ComputeVmInstanceViewStatus[]

가상 머신의 상태를 가져옵니다.

vmSize

string

가상 머신의 크기를 가져옵니다.

DataDiskProperties

가상 머신에 새 데이터 디스크 또는 기존 데이터 디스크를 추가하기 위한 요청 본문입니다.

Name 형식 Description
attachNewDataDiskOptions

AttachNewDataDiskOptions

가상 머신에 새 디스크를 연결하는 옵션을 지정합니다.

existingLabDiskId

string

가상 머신에 연결할 기존 랩 디스크 ID를 지정합니다.

hostCaching

HostCachingOptions

데이터 디스크에 대한 캐싱 옵션(예: 없음, ReadOnly, ReadWrite).

DayDetails

일일 일정의 속성입니다.

Name 형식 Description
time

string

일정이 발생하는 시간입니다.

EnableStatus

일정의 상태(예: 사용, 사용 안 함)

Name 형식 Description
Disabled

string

Enabled

string

GalleryImageReference

Azure Marketplace 이미지에 대한 참조 정보입니다.

Name 형식 Description
offer

string

갤러리 이미지의 제안입니다.

osType

string

갤러리 이미지의 OS 유형입니다.

publisher

string

갤러리 이미지의 게시자입니다.

sku

string

갤러리 이미지의 SKU입니다.

version

string

갤러리 이미지의 버전입니다.

HostCachingOptions

데이터 디스크에 대한 캐싱 옵션(예: 없음, ReadOnly, ReadWrite).

Name 형식 Description
None

string

ReadOnly

string

ReadWrite

string

HourDetails

시간별 일정의 속성입니다.

Name 형식 Description
minute

integer

일정이 실행되는 시간(분)입니다.

InboundNatRule

NAT에 대한 규칙 - 부하 분산 장치를 사용하여 공용 IP 주소에 VM의 포트(backendPort)를 노출합니다.

Name 형식 Description
backendPort

integer

외부 트래픽이 리디렉션될 포트입니다.

frontendPort

integer

인바운드 연결의 외부 엔드포인트 포트입니다. 가능한 값은 1에서 65535(포함) 사이입니다. 지정하지 않으면 값이 자동으로 할당됩니다.

transportProtocol

TransportProtocol

엔드포인트의 전송 프로토콜입니다.

LabVirtualMachine

가상 머신 -

Name 형식 Default value Description
id

string

리소스의 식별자입니다.

location

string

리소스의 위치입니다.

name

string

리소스의 이름입니다.

properties.allowClaim

boolean

False

다른 사용자가 가상 머신의 소유권을 가져올 수 있는지 여부를 나타냅니다.

properties.applicableSchedule

ApplicableSchedule

가상 머신에 적용 가능한 일정입니다.

properties.artifactDeploymentStatus

ArtifactDeploymentStatusProperties

가상 머신에 대한 아티팩트 배포 상태.

properties.artifacts

ArtifactInstallProperties[]

가상 머신에 설치할 아티팩트입니다.

properties.computeId

string

가상 머신의 리소스 식별자(Microsoft.Compute)입니다.

properties.computeVm

ComputeVmProperties

컴퓨팅 가상 머신 속성입니다.

properties.createdByUser

string

가상 머신 작성자의 이메일 주소입니다.

properties.createdByUserId

string

가상 머신 작성자의 개체 식별자입니다.

properties.createdDate

string

가상 머신의 생성 날짜입니다.

properties.customImageId

string

가상 머신의 사용자 지정 이미지 식별자입니다.

properties.dataDiskParameters

DataDiskProperties[]

만든 후 가상 머신에 연결할 새 데이터 디스크 또는 기존 데이터 디스크

properties.disallowPublicIpAddress

boolean

False

공용 IP 주소 없이 가상 머신을 만들 것인지 여부를 나타냅니다.

properties.environmentId

string

이 가상 머신이 포함된 환경의 리소스 ID(있는 경우)입니다.

properties.expirationDate

string

VM의 만료 날짜입니다.

properties.fqdn

string

가상 머신의 정규화된 도메인 이름입니다.

properties.galleryImageReference

GalleryImageReference

가상 머신의 Microsoft Azure Marketplace 이미지 참조입니다.

properties.isAuthenticationWithSshKey

boolean

이 가상 머신이 인증에 SSH 키를 사용하는지 여부를 나타냅니다.

properties.labSubnetName

string

가상 머신의 랩 서브넷 이름입니다.

properties.labVirtualNetworkId

string

가상 머신의 랩 가상 네트워크 식별자입니다.

properties.lastKnownPowerState

string

DTL에서 마지막으로 캡처된 마지막으로 알려진 컴퓨팅 전원 상태

properties.networkInterface

NetworkInterfaceProperties

네트워크 인터페이스 속성입니다.

properties.notes

string

가상 머신의 노트입니다.

properties.osType

string

가상 머신의 OS 유형입니다.

properties.ownerObjectId

string

dynamicValue

가상 머신 소유자의 개체 식별자입니다.

properties.ownerUserPrincipalName

string

가상 머신 소유자의 사용자 계정 이름입니다.

properties.password

string

가상 머신 관리자의 암호입니다.

properties.planId

string

가상 머신 이미지와 연결된 계획의 ID입니다.

properties.provisioningState

string

리소스의 프로비전 상태.

properties.scheduleParameters

ScheduleCreationParameter[]

만들 Virtual Machine 일정

properties.size

string

가상 컴퓨터의 크기.

properties.sshKey

string

가상 머신 관리자의 SSH 키입니다.

properties.storageType

string

labStorageType

가상 머신(예: 표준, 프리미엄)에 사용할 스토리지 유형입니다.

properties.uniqueIdentifier

string

리소스의 변경할 수 없는 고유 식별자(Guid)입니다.

properties.userName

string

가상 머신의 사용자 이름입니다.

properties.virtualMachineCreationSource

VirtualMachineCreationSource

랩 가상 머신 만들기의 원본을 알려줍니다. 출력 속성만 해당합니다.

tags

object

리소스의 태그입니다.

type

string

리소스 형식입니다.

LabVirtualMachineList

목록 작업의 응답입니다.

Name 형식 Description
nextLink

string

다음 결과 집합에 대한 링크입니다.

value

LabVirtualMachine[]

목록 작업의 결과입니다.

NetworkInterfaceProperties

네트워크 인터페이스의 속성입니다.

Name 형식 Description
dnsName

string

DNS 이름입니다.

privateIpAddress

string

개인 IP 주소입니다.

publicIpAddress

string

공용 IP 주소입니다.

publicIpAddressId

string

공용 IP 주소의 리소스 ID입니다.

rdpAuthority

string

RdpAuthority 속성은 서버 DNS 호스트 이름 또는 IP 주소 뒤에 RDP(원격 데스크톱 프로토콜)에 대한 서비스 포트 번호입니다.

sharedPublicIpAddressConfiguration

SharedPublicIpAddressConfiguration

여러 가상 머신에서 공용 IP 주소를 공유하기 위한 구성입니다.

sshAuthority

string

SshAuthority 속성은 서버 DNS 호스트 이름 또는 IP 주소 뒤에 SSH에 대한 서비스 포트 번호입니다.

subnetId

string

서브넷의 리소스 ID입니다.

virtualNetworkId

string

가상 네트워크의 리소스 ID입니다.

NotificationSettings

일정에 대한 알림 설정입니다.

Name 형식 Default value Description
emailRecipient

string

알림을 보낼 전자 메일 받는 사람(세미콜론으로 구분된 전자 메일 주소 목록일 수 있음).

notificationLocale

string

알림을 보낼 때 사용할 로캘입니다(지원되지 않는 언어에 대한 대체는 EN임).

status

EnableStatus

Disabled

이 일정에 대한 알림이 활성화된 경우(예: 사용, 사용 안 함)

timeInMinutes

integer

알림이 전송되는 이벤트 전 시간(분)입니다.

webhookUrl

string

알림을 보낼 웹후크 URL입니다.

Schedule

일정입니다.

Name 형식 Default value Description
id

string

리소스의 식별자입니다.

location

string

리소스의 위치입니다.

name

string

리소스의 이름입니다.

properties.createdDate

string

일정의 생성 날짜입니다.

properties.dailyRecurrence

DayDetails

일정이 요일마다 한 번씩 발생하는 경우 일별 되풀이를 지정합니다.

properties.hourlyRecurrence

HourDetails

일정이 하루에 여러 번 발생하는 경우 시간별 되풀이를 지정합니다.

properties.notificationSettings

NotificationSettings

알림 설정.

properties.provisioningState

string

리소스의 프로비전 상태.

properties.status

EnableStatus

Disabled

일정의 상태(예: 사용, 사용 안 함)

properties.targetResourceId

string

일정이 속한 리소스 ID

properties.taskType

string

일정의 작업 유형(예: LabVmsShutdownTask, LabVmAutoStart)입니다.

properties.timeZoneId

string

표준 시간대 ID(예: 중국 표준시, 그린란드 표준시, 태평양 표준시 등)입니다. 이 속성에 대한 가능한 값은 (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)에서 IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds 찾을 수 있습니다.

properties.uniqueIdentifier

string

리소스의 변경할 수 없는 고유 식별자(Guid)입니다.

properties.weeklyRecurrence

WeekDetails

일정이 요일 중 일부만 발생하는 경우 매주 되풀이를 지정합니다.

tags

object

리소스의 태그입니다.

type

string

리소스 형식입니다.

ScheduleCreationParameter

일정을 만들기 위한 속성입니다.

Name 형식 Default value Description
location

string

새 가상 머신 또는 환경의 위치

name

string

가상 머신 또는 환경의 이름

properties.dailyRecurrence

DayDetails

일정이 요일마다 한 번씩 발생하는 경우 일별 되풀이를 지정합니다.

properties.hourlyRecurrence

HourDetails

일정이 하루에 여러 번 발생하는 경우 시간별 되풀이를 지정합니다.

properties.notificationSettings

NotificationSettings

알림 설정.

properties.status

EnableStatus

Disabled

일정의 상태(예: 사용, 사용 안 함)

properties.targetResourceId

string

일정이 속한 리소스 ID

properties.taskType

string

일정의 작업 유형(예: LabVmsShutdownTask, LabVmAutoStart)입니다.

properties.timeZoneId

string

표준 시간대 ID(예: 중국 표준시, 그린란드 표준시, 태평양 표준시 등)입니다. 이 속성에 대한 가능한 값은 (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)에서 IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds 찾을 수 있습니다.

properties.weeklyRecurrence

WeekDetails

일정이 요일 중 일부만 발생하는 경우 매주 되풀이를 지정합니다.

tags

object

리소스의 태그입니다.

SharedPublicIpAddressConfiguration

부하 분산 장치에 연결되는 방법을 결정하는 가상 머신의 속성입니다.

Name 형식 Description
inboundNatRules

InboundNatRule[]

들어오는 NAT 규칙

StorageType

디스크의 스토리지 유형(예: 표준, 프리미엄)입니다.

Name 형식 Description
Premium

string

Standard

string

StandardSSD

string

TransportProtocol

엔드포인트의 전송 프로토콜입니다.

Name 형식 Description
Tcp

string

Udp

string

VirtualMachineCreationSource

랩 가상 머신 만들기의 원본을 알려줍니다. 출력 속성만 해당합니다.

Name 형식 Description
FromCustomImage

string

FromGalleryImage

string

FromSharedGalleryImage

string

WeekDetails

주별 일정의 속성입니다.

Name 형식 Description
time

string

일정이 발생하는 날짜 시간입니다.

weekdays

string[]

일정이 설정된 요일(예: 일요일, 월요일, 화요일 등)입니다.