Virtual Machine Scale Set VM Run Commands - Get

Operasi untuk mendapatkan perintah jalankan 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

Parameter URI

Name In Required Type Description
instanceId
path True
  • string

ID instans komputer virtual.

resourceGroupName
path True
  • string

Nama grup sumber daya.

runCommandName
path True
  • string

Nama perintah eksekusi komputer virtual.

subscriptionId
path True
  • string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

vmScaleSetName
path True
  • string

Nama set skala VM.

api-version
query True
  • string

Versi Api Klien.

$expand
query
  • string

Ekspresi perluas untuk diterapkan pada operasi.

Respons

Name Type Description
200 OK

OK

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

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

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

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

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"
  }
}

Definisi

ApiError

Kesalahan api.

ApiErrorBase

Basis kesalahan api.

CloudError

Respons kesalahan dari layanan Komputasi.

ExecutionState

Status eksekusi skrip.

InnerError

Detail kesalahan dalam.

InstanceViewStatus

Status tampilan instans.

RunCommandInputParameter

Menjelaskan properti parameter perintah eksekusi.

StatusLevelTypes

Kode tingkat.

VirtualMachineRunCommand

Menjelaskan perintah eksekusi Komputer Virtual.

VirtualMachineRunCommandInstanceView

Tampilan instans dari perintah eksekusi komputer virtual.

VirtualMachineRunCommandScriptSource

Menjelaskan sumber skrip untuk menjalankan perintah.

ApiError

Kesalahan api.

Name Type Description
code
  • string

Kode kesalahan.

details

Detail kesalahan Api

innererror

Kesalahan dalam Api

message
  • string

Pesan kesalahan.

target
  • string

Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Name Type Description
code
  • string

Kode kesalahan.

message
  • string

Pesan kesalahan.

target
  • string

Target kesalahan tertentu.

CloudError

Respons kesalahan dari layanan Komputasi.

Name Type Description
error

Kesalahan api.

ExecutionState

Status eksekusi skrip.

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

InnerError

Detail kesalahan dalam.

Name Type Description
errordetail
  • string

Pesan kesalahan internal atau cadangan pengecualian.

exceptiontype
  • string

Jenis pengecualian.

InstanceViewStatus

Status tampilan instans.

Name Type Description
code
  • string

Kode status.

displayStatus
  • string

Label pendek yang dapat dilokalkan untuk status tersebut.

level

Kode tingkat.

message
  • string

Pesan status terperinci, termasuk untuk pemberitahuan dan pesan kesalahan.

time
  • string

Waktu status.

RunCommandInputParameter

Menjelaskan properti parameter perintah eksekusi.

Name Type Description
name
  • string

Nama parameter perintah eksekusi.

value
  • string

Nilai parameter perintah eksekusi.

StatusLevelTypes

Kode tingkat.

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

VirtualMachineRunCommand

Menjelaskan perintah eksekusi Komputer Virtual.

Name Type Default Value Description
id
  • string

ID sumber daya

location
  • string

Lokasi sumber daya

name
  • string

Nama sumber daya

properties.asyncExecution
  • boolean
False

Opsional. Jika diatur ke true, provisi akan selesai segera setelah skrip dimulai dan tidak akan menunggu skrip selesai.

properties.errorBlobUri
  • string

Menentukan blob penyimpanan Azure tempat aliran kesalahan skrip akan diunggah.

properties.instanceView

Tampilan instans perintah eksekusi komputer virtual.

properties.outputBlobUri
  • string

Menentukan blob penyimpanan Azure tempat aliran output skrip akan diunggah.

properties.parameters

Parameter yang digunakan oleh skrip.

properties.protectedParameters

Parameter yang digunakan oleh skrip.

properties.provisioningState
  • string

Status penyediaan, yang hanya muncul dalam respons.

properties.runAsPassword
  • string

Menentukan kata sandi akun pengguna pada VM saat menjalankan perintah jalankan.

properties.runAsUser
  • string

Menentukan akun pengguna pada VM saat menjalankan perintah jalankan.

properties.source

Sumber skrip perintah eksekusi.

properties.timeoutInSeconds
  • integer

Batas waktu dalam detik untuk menjalankan perintah jalankan.

tags
  • object

Tag sumber daya

type
  • string

Jenis Sumber Daya

VirtualMachineRunCommandInstanceView

Tampilan instans dari perintah eksekusi komputer virtual.

Name Type Description
endTime
  • string

Waktu akhir skrip.

error
  • string

Aliran kesalahan skrip.

executionMessage
  • string

Mengkomunikasikan kesalahan konfigurasi skrip atau pesan eksekusi.

executionState

Status eksekusi skrip.

exitCode
  • integer

Kode keluar dikembalikan dari eksekusi skrip.

output
  • string

Aliran output skrip.

startTime
  • string

Waktu mulai skrip.

statuses

Informasi status sumber daya.

VirtualMachineRunCommandScriptSource

Menjelaskan sumber skrip untuk menjalankan perintah.

Name Type Description
commandId
  • string

Menentukan commandId dari skrip bawaan yang telah ditentukan sebelumnya.

script
  • string

Menentukan konten skrip yang akan dijalankan pada VM.

scriptUri
  • string

Menentukan lokasi pengunduhan skrip.