Dela via


Virtual Machine Run Commands - Get

Hämtar ett specifikt körningskommando för en prenumeration på en plats.

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

URI-parametrar

Name I Obligatorisk Typ Description
commandId
path True

string

Kommando-ID:t.

location
path True

string

Platsen där körningskommandon efterfrågas.

Reguljärt uttrycksmönster: ^[-\w\._]+$

subscriptionId
path True

string

Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version
query True

string

Klient-API-version.

Svar

Name Typ Description
200 OK

RunCommandDocument

OKEJ

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

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

VirtualMachineRunCommandGet

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
OperatingSystemTypes

Typ av operativsystem.

RunCommandDocument

Beskriver egenskaperna för ett körningskommando.

RunCommandParameterDefinition

Beskriver egenskaperna för en körningskommandoparameter.

OperatingSystemTypes

Typ av operativsystem.

Name Typ Description
Linux

string

Windows

string

RunCommandDocument

Beskriver egenskaperna för ett körningskommando.

Name Typ Description
$schema

string

Kommandoschemat kör den virtuella datorn.

description

string

Kommandobeskrivningen kör den virtuella datorn.

id

string

Kommando-ID:t för den virtuella datorn körs.

label

string

Kommandoetiketten kör den virtuella datorn.

osType

OperatingSystemTypes

Typ av operativsystem.

parameters

RunCommandParameterDefinition[]

Parametrarna som används av skriptet.

script

string[]

Skriptet som ska köras.

RunCommandParameterDefinition

Beskriver egenskaperna för en körningskommandoparameter.

Name Typ Standardvärde Description
defaultValue

string

Standardvärdet för körningskommandoparametern.

name

string

Namnet på körningskommandoparametern.

required

boolean

False

Körningskommandoparametern krävs.

type

string

Parametertypen kör kommando.