共用方式為


Virtual Machine Run Commands - Get

取得位置中訂用帳戶的特定執行命令。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}?api-version=2024-07-01

URI 參數

名稱 位於 必要 類型 Description
commandId
path True

string

命令標識碼。

location
path True

string

查詢執行命令的位置。

Regex 模式: ^[-\w\._]+$

subscriptionId
path True

string

可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

回應

名稱 類型 Description
200 OK

RunCommandDocument

還行

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

VirtualMachineRunCommandGet

範例要求

GET https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/providers/Microsoft.Compute/locations/SoutheastAsia/runCommands/RunPowerShellScript?api-version=2024-07-01

範例回覆

{
  "script": [
    "param(",
    "    [string]$arg1,",
    "    [string]$arg2",
    ")",
    "Write-Host This is a sample script with parameters $arg1 $arg2"
  ],
  "parameters": [
    {
      "name": "arg1",
      "type": "string",
      "defaultValue": "value1"
    },
    {
      "name": "arg2",
      "type": "string",
      "defaultValue": "value2"
    }
  ],
  "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
  "id": "RunPowerShellScript",
  "osType": "Windows",
  "label": "Executes a PowerShell script",
  "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property."
}

定義

名稱 Description
OperatingSystemTypes

操作系統類型。

RunCommandDocument

描述執行命令的屬性。

RunCommandParameterDefinition

描述執行命令參數的屬性。

OperatingSystemTypes

操作系統類型。

名稱 類型 Description
Linux

string

Windows

string

RunCommandDocument

描述執行命令的屬性。

名稱 類型 Description
$schema

string

VM 執行命令架構。

description

string

VM 執行命令描述。

id

string

VM 執行命令標識碼。

label

string

VM 執行命令標籤。

osType

OperatingSystemTypes

操作系統類型。

parameters

RunCommandParameterDefinition[]

腳本所使用的參數。

script

string[]

要執行的腳本。

RunCommandParameterDefinition

描述執行命令參數的屬性。

名稱 類型 預設值 Description
defaultValue

string

run 命令參數預設值。

name

string

執行命令參數名稱。

required

boolean

False

需要執行命令參數。

type

string

執行命令參數類型。