Virtual Machine Scale Set VM Run Commands - Get

VMSS VM 실행 명령을 가져오는 작업입니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}?$expand={$expand}&api-version=2022-08-01

URI 매개 변수

Name In Required Type Description
instanceId
path True
  • string

가상 머신의 인스턴스 ID입니다.

resourceGroupName
path True
  • string

리소스 그룹의 이름.

runCommandName
path True
  • string

가상 머신 실행 명령의 이름입니다.

subscriptionId
path True
  • string

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.

vmScaleSetName
path True
  • string

VM 확장 집합의 이름입니다.

api-version
query True
  • string

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

$expand
query
  • string

작업에 적용할 확장 식입니다.

응답

Name Type Description
200 OK

확인

Media Types: "application/json", "text/json"

Other Status Codes

작업이 실패한 이유를 설명하는 오류 응답입니다.

Media Types: "application/json", "text/json"

보안

azure_auth

OAuth2 Flow Azure Active Directory

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

Get VirtualMachineScaleSet VM run commands.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand?api-version=2022-08-01

Sample Response

{
  "name": "myRunCommand",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded"
  }
}

정의

ApiError

API 오류입니다.

ApiErrorBase

API 오류 기준입니다.

CloudError

Compute 서비스의 오류 응답입니다.

ExecutionState

스크립트 실행 상태입니다.

InnerError

내부 오류 세부 정보입니다.

InstanceViewStatus

인스턴스 보기 상태입니다.

RunCommandInputParameter

실행 명령 매개 변수의 속성을 설명합니다.

StatusLevelTypes

수준 코드입니다.

VirtualMachineRunCommand

Virtual Machine 실행 명령을 설명합니다.

VirtualMachineRunCommandInstanceView

가상 머신 실행 명령의 인스턴스 뷰입니다.

VirtualMachineRunCommandScriptSource

실행 명령에 대한 스크립트 원본에 대해 설명합니다.

ApiError

API 오류입니다.

Name Type Description
code
  • string

오류 코드입니다.

details

API 오류 세부 정보

innererror

API 내부 오류

message
  • string

오류 메시지입니다.

target
  • string

특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name Type Description
code
  • string

오류 코드입니다.

message
  • string

오류 메시지입니다.

target
  • string

특정 오류의 대상입니다.

CloudError

Compute 서비스의 오류 응답입니다.

Name Type Description
error

API 오류입니다.

ExecutionState

스크립트 실행 상태입니다.

Name Type Description
Canceled
  • string
Failed
  • string
Pending
  • string
Running
  • string
Succeeded
  • string
TimedOut
  • string
Unknown
  • string

InnerError

내부 오류 세부 정보입니다.

Name Type Description
errordetail
  • string

내부 오류 메시지 또는 예외 덤프입니다.

exceptiontype
  • string

예외 형식입니다.

InstanceViewStatus

인스턴스 보기 상태입니다.

Name Type Description
code
  • string

상태 코드입니다.

displayStatus
  • string

상태에 대한 짧은 지역화 가능한 레이블입니다.

level

수준 코드입니다.

message
  • string

경고 및 오류 메시지를 포함한 자세한 상태 메시지입니다.

time
  • string

상태의 시간입니다.

RunCommandInputParameter

실행 명령 매개 변수의 속성을 설명합니다.

Name Type Description
name
  • string

실행 명령 매개 변수 이름입니다.

value
  • string

실행 명령 매개 변수 값입니다.

StatusLevelTypes

수준 코드입니다.

Name Type Description
Error
  • string
Info
  • string
Warning
  • string

VirtualMachineRunCommand

Virtual Machine 실행 명령을 설명합니다.

Name Type Default Value Description
id
  • string

리소스 ID

location
  • string

리소스 위치

name
  • string

리소스 이름

properties.asyncExecution
  • boolean
False

선택 사항입니다. true로 설정하면 스크립트가 시작되는 즉시 프로비전이 완료되고 스크립트가 완료될 때까지 기다리지 않습니다.

properties.errorBlobUri
  • string

스크립트 오류 스트림이 업로드될 Azure Storage Blob을 지정합니다.

properties.instanceView

가상 머신이 명령 인스턴스 보기를 실행합니다.

properties.outputBlobUri
  • string

스크립트 출력 스트림이 업로드될 Azure Storage Blob을 지정합니다.

properties.parameters

스크립트에서 사용하는 매개 변수입니다.

properties.protectedParameters

스크립트에서 사용하는 매개 변수입니다.

properties.provisioningState
  • string

응답에만 나타나는 프로비전 상태입니다.

properties.runAsPassword
  • string

실행 명령을 실행할 때 VM의 사용자 계정 암호를 지정합니다.

properties.runAsUser
  • string

실행 명령을 실행할 때 VM의 사용자 계정을 지정합니다.

properties.source

실행 명령 스크립트의 원본입니다.

properties.timeoutInSeconds
  • integer

실행 명령을 실행할 시간 제한(초)입니다.

tags
  • object

리소스 태그

type
  • string

리소스 유형

VirtualMachineRunCommandInstanceView

가상 머신 실행 명령의 인스턴스 뷰입니다.

Name Type Description
endTime
  • string

스크립트 종료 시간입니다.

error
  • string

스크립트 오류 스트림입니다.

executionMessage
  • string

스크립트 구성 오류 또는 실행 메시지를 전달합니다.

executionState

스크립트 실행 상태입니다.

exitCode
  • integer

스크립트 실행에서 반환된 종료 코드입니다.

output
  • string

출력 스트림을 스크립터합니다.

startTime
  • string

스크립트 시작 시간입니다.

statuses

리소스 상태 정보입니다.

VirtualMachineRunCommandScriptSource

실행 명령에 대한 스크립트 원본에 대해 설명합니다.

Name Type Description
commandId
  • string

미리 정의된 기본 제공 스크립트의 commandId를 지정합니다.

script
  • string

VM에서 실행할 스크립트 콘텐츠를 지정합니다.

scriptUri
  • string

스크립트 다운로드 위치를 지정합니다.