Virtual Machine Scale Set VM Run Commands - Get

참조

Service:: Compute

API Version:: 2024-03-01

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

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

With optional parameters:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
instanceId	path	True	string	가상 머신의 instance 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	형식	Description
200 OK	VirtualMachineRunCommand	정상 Media Types: "application/json", "text/json"
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다. Media Types: "application/json", "text/json"

Name

형식

Description

200 OK

VirtualMachineRunCommand

정상

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

Other Status Codes

CloudError

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

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

보안

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	사용자 계정 가장

예제

Get VirtualMachineScaleSet VM run commands.

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "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": {
      "scriptUri": "https://gist.githubusercontent.com/myusername/75fd3634w7511116063c60bcc50bee0/raw/04a4c68ac9e1d36asfasdc64bd1d889b104c7abdb8/HelloWorld.ps1"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "asyncExecution": false,
    "treatFailureAsDeploymentFailure": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded",
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
CloudError	Compute 서비스의 오류 응답입니다.
ExecutionState	스크립트 실행 상태.
InnerError	내부 오류 세부 정보입니다.
InstanceViewStatus	인스턴스 보기 상태.
RunCommandInputParameter	실행 명령 매개 변수의 속성을 설명합니다.
RunCommandManagedIdentity	명령 실행에서 사용되는 스토리지 Blob에 대한 액세스 권한이 있는 사용자 할당 관리 ID의 clientId 또는 objectId(둘 다만 사용)를 포함합니다. 시스템 할당 ID의 경우 빈 RunCommandManagedIdentity 개체를 사용합니다. scriptUri의 경우 Azure Storage Blob이 존재하고 관리 ID가 append Blob(outputBlobUri, errorBlobUri)에 대해 scriptUri Blob 및 'Storage Blob 데이터 기여자'를 사용하여 'Storage Blob 데이터 판독기' 역할 할당을 사용하여 Blob의 컨테이너에 액세스할 수 있는지 확인합니다. 사용자 할당 ID의 경우 VM의 ID 아래에 추가해야 합니다. 관리 ID 및 실행 명령에 대한 자세한 내용은 및 https://aka.ms/RunCommandManaged를 참조하세요https://aka.ms/ManagedIdentity.
StatusLevelTypes	수준 코드입니다.
VirtualMachineRunCommand	Virtual Machine 실행 명령에 대해 설명합니다.
VirtualMachineRunCommandInstanceView	가상 머신 실행 명령의 instance 보기입니다.
VirtualMachineRunCommandScriptSource	실행 명령에 대한 스크립트 원본을 설명합니다. scriptUri, commandId 스크립트 중 하나만 사용합니다.

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

CloudError

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

Name	형식	Description
error	ApiError	API 오류입니다.

ExecutionState

스크립트 실행 상태.

Name	형식	Description
Canceled	string
Failed	string
Pending	string
Running	string
Succeeded	string
TimedOut	string
Unknown	string

InnerError

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

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

InstanceViewStatus

인스턴스 보기 상태.

Name	형식	Description
code	string	상태 코드입니다.
displayStatus	string	상태 대한 짧은 지역화 가능 레이블입니다.
level	StatusLevelTypes	수준 코드입니다.
message	string	경고 및 오류 메시지를 포함하여 자세한 상태 메시지입니다.
time	string	상태 시간입니다.

RunCommandInputParameter

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

Name	형식	Description
name	string	실행 명령 매개 변수 이름입니다.
value	string	실행 명령 매개 변수 값입니다.

RunCommandManagedIdentity

명령 실행에서 사용되는 스토리지 Blob에 대한 액세스 권한이 있는 사용자 할당 관리 ID의 clientId 또는 objectId(둘 다만 사용)를 포함합니다. 시스템 할당 ID의 경우 빈 RunCommandManagedIdentity 개체를 사용합니다. scriptUri의 경우 Azure Storage Blob이 존재하고 관리 ID가 append Blob(outputBlobUri, errorBlobUri)에 대해 scriptUri Blob 및 'Storage Blob 데이터 기여자'를 사용하여 'Storage Blob 데이터 판독기' 역할 할당을 사용하여 Blob의 컨테이너에 액세스할 수 있는지 확인합니다. 사용자 할당 ID의 경우 VM의 ID 아래에 추가해야 합니다. 관리 ID 및 실행 명령에 대한 자세한 내용은 및 https://aka.ms/RunCommandManaged를 참조하세요https://aka.ms/ManagedIdentity.

Name	형식	Description
clientId	string	사용자가 할당한 관리 ID의 클라이언트 ID(GUID 값)입니다. ObjectId는 제공된 경우 사용하면 안 됩니다.
objectId	string	사용자가 할당한 관리 ID의 개체 ID(GUID 값)입니다. 제공된 경우 ClientId를 사용하면 안 됩니다.

StatusLevelTypes

수준 코드입니다.

Name	형식	Description
Error	string
Info	string
Warning	string

VirtualMachineRunCommand

Virtual Machine 실행 명령에 대해 설명합니다.

Name	형식	기본값	Description
id	string		리소스 ID
location	string		리소스 위치
name	string		리소스 이름
properties.asyncExecution	boolean	False	선택 사항입니다. true로 설정하면 스크립트가 시작되는 즉시 프로비전이 완료되고 스크립트가 완료될 때까지 기다리지 않습니다.
properties.errorBlobManagedIdentity	RunCommandManagedIdentity		errorBlobUri Storage Blob에 대한 액세스 권한이 있는 사용자 할당 관리 ID입니다. 시스템 할당 ID의 경우 빈 개체를 사용합니다. 관리 ID에 'Storage Blob 데이터 기여자' 역할 할당을 사용하여 Blob의 컨테이너에 대한 액세스 권한이 부여되었는지 확인합니다. 사용자 할당 ID의 경우 VM의 ID 아래에 추가해야 합니다. 관리 ID 및 실행 명령에 대한 자세한 내용은 및 를 참조하세요 https://aka.ms/ManagedIdentity . https://aka.ms/RunCommandManaged
properties.errorBlobUri	string		스크립트 오류 스트림이 업로드될 Azure Storage Blob을 지정합니다. 읽기, 추가, 만들기, 쓰기 액세스 권한이 있는 SAS URI를 사용하거나 관리 ID를 사용하여 Blob에 대한 VM 액세스를 제공합니다. errorBlobManagedIdentity 매개 변수를 참조하세요.
properties.instanceView	VirtualMachineRunCommandInstanceView		가상 머신 실행 명령 instance 보기입니다.
properties.outputBlobManagedIdentity	RunCommandManagedIdentity		outputBlobUri 스토리지 Blob에 대한 액세스 권한이 있는 사용자 할당 관리 ID입니다. 시스템 할당 ID의 경우 빈 개체를 사용합니다. 관리 ID에 'Storage Blob 데이터 기여자' 역할 할당을 사용하여 Blob의 컨테이너에 대한 액세스 권한이 부여되었는지 확인합니다. 사용자 할당 ID의 경우 VM의 ID 아래에 추가해야 합니다. 관리 ID 및 실행 명령에 대한 자세한 내용은 및 를 참조하세요 https://aka.ms/ManagedIdentity . https://aka.ms/RunCommandManaged
properties.outputBlobUri	string		스크립트 출력 스트림이 업로드될 Azure Storage Blob을 지정합니다. 읽기, 추가, 만들기, 쓰기 액세스 권한이 있는 SAS URI를 사용하거나 관리 ID를 사용하여 Blob에 대한 VM 액세스를 제공합니다. outputBlobManagedIdentity 매개 변수를 참조하세요.
properties.parameters	RunCommandInputParameter[]		스크립트에서 사용하는 매개 변수입니다.
properties.protectedParameters	RunCommandInputParameter[]		스크립트에서 사용하는 매개 변수입니다.
properties.provisioningState	string		응답에만 표시되는 프로비전 상태입니다. treatFailureAsDeploymentFailure를 true로 설정하면 스크립트의 오류가 배포에 실패하고 ProvisioningState가 실패로 표시됩니다. treatFailureAsDeploymentFailure가 false로 설정된 경우 ProvisioningState는 실행 명령이 확장 플랫폼에서 실행되었는지 여부만 반영합니다. 스크립트 실패 시 스크립트가 실패했는지 여부는 나타내지 않습니다. 스크립트 실패 시 실행 명령의 instance 보기를 참조하여 executionMessage, output, error를 확인합니다.https://aka.ms/runcommandmanaged#get-execution-status-and-results
properties.runAsPassword	string		실행 명령을 실행할 때 VM의 사용자 계정 암호를 지정합니다.
properties.runAsUser	string		실행 명령을 실행할 때 VM의 사용자 계정을 지정합니다.
properties.source	VirtualMachineRunCommandScriptSource		실행 명령 스크립트의 원본입니다.
properties.timeoutInSeconds	integer		실행 명령을 실행할 시간 제한(초)입니다.
properties.treatFailureAsDeploymentFailure	boolean	False	선택 사항입니다. true로 설정하면 스크립트의 오류가 배포에 실패하고 ProvisioningState가 실패로 표시됩니다. false로 설정하면 ProvisioningState는 실행 명령이 확장 플랫폼에서 실행되었는지 여부만 반영하며 스크립트 실패 시 스크립트가 실패했는지 여부를 나타내지 않습니다. 스크립트 실패 시 실행 명령의 instance 보기를 참조하여 executionMessage, output, error를 확인합니다.https://aka.ms/runcommandmanaged#get-execution-status-and-results
tags	object		리소스 태그
type	string		리소스 유형

VirtualMachineRunCommandInstanceView

가상 머신 실행 명령의 instance 보기입니다.

Name	형식	Description
endTime	string	스크립트 종료 시간입니다.
error	string	스크립트 오류 스트림.
executionMessage	string	스크립트 구성 오류 또는 실행 메시지를 전달합니다.
executionState	ExecutionState	스크립트 실행 상태.
exitCode	integer	스크립트 실행에서 반환된 종료 코드입니다.
output	string	스크립트 출력 스트림.
startTime	string	스크립트 시작 시간입니다.
statuses	InstanceViewStatus[]	리소스 상태 정보입니다.

VirtualMachineRunCommandScriptSource

실행 명령에 대한 스크립트 원본을 설명합니다. scriptUri, commandId 스크립트 중 하나만 사용합니다.

Name	형식	Description
commandId	string	미리 정의된 기본 제공 스크립트의 commandId를 지정합니다.
script	string	VM에서 실행할 스크립트 콘텐츠를 지정합니다.
scriptUri	string	스크립트 다운로드 위치를 지정합니다. 읽기 액세스 권한이 있는 Azure Storage Blob의 SAS URI 또는 공용 URI일 수 있습니다.
scriptUriManagedIdentity	RunCommandManagedIdentity	Azure Storage Blob의 경우 scriptUri에 대한 액세스 권한이 있는 사용자 할당 관리 ID입니다. 시스템 할당 ID의 경우 빈 개체를 사용합니다. Azure Storage Blob이 있고 관리 ID에 'Storage Blob 데이터 판독기' 역할 할당을 사용하여 Blob의 컨테이너에 대한 액세스 권한이 부여되었는지 확인합니다. 사용자 할당 ID의 경우 VM의 ID 아래에 추가해야 합니다. 관리 ID 및 실행 명령에 대한 자세한 내용은 및 https://aka.ms/RunCommandManaged를 참조하세요https://aka.ms/ManagedIdentity.

Virtual Machine Scale Set VM Run Commands - Get

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

Get VirtualMachineScaleSet VM run commands.

Sample Request

Sample Response

정의

ApiError

ApiErrorBase

CloudError

ExecutionState

InnerError

InstanceViewStatus

RunCommandInputParameter

RunCommandManagedIdentity

StatusLevelTypes

VirtualMachineRunCommand

VirtualMachineRunCommandInstanceView

VirtualMachineRunCommandScriptSource

추가 리소스