Lekéri a megadott futtatási parancsot egy adott helyen lévő előfizetéshez.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}?api-version=2024-03-01
URI-paraméterek
| Name |
In |
Kötelező |
Típus |
Description |
|
commandId
|
path |
True
|
string
|
A parancs azonosítója.
|
|
location
|
path |
True
|
string
|
A futtatási parancsok lekérdezett helye.
Regex pattern: ^[-\w\._]+$
|
|
subscriptionId
|
path |
True
|
string
|
Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
|
|
api-version
|
query |
True
|
string
|
Client API-verzió.
|
Válaszok
| Name |
Típus |
Description |
|
200 OK
|
RunCommandDocument
|
OK
Media Types: "application/json", "text/json"
|
Biztonság
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
|
felhasználói fiók megszemélyesítése
|
Példák
VirtualMachineRunCommandGet
Sample Request
GET https://management.azure.com/subscriptions/24fb23e3-6ba3-41f0-9b6e-e41131d5d61e/providers/Microsoft.Compute/locations/SoutheastAsia/runCommands/RunPowerShellScript?api-version=2024-03-01
/**
* Samples for VirtualMachineRunCommands Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/
* RunCommand_Get.json
*/
/**
* Sample code: VirtualMachineRunCommandGet.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void virtualMachineRunCommandGet(com.azure.resourcemanager.AzureResourceManager azure) {
azure.virtualMachines().manager().serviceClient().getVirtualMachineRunCommands()
.getWithResponse("SoutheastAsia", "RunPowerShellScript", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.compute import ComputeManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-compute
# USAGE
python run_command_get.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ComputeManagementClient(
credential=DefaultAzureCredential(),
subscription_id="24fb23e3-6ba3-41f0-9b6e-e41131d5d61e",
)
response = client.virtual_machine_run_commands.get(
location="SoutheastAsia",
command_id="RunPowerShellScript",
)
print(response)
# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/RunCommand_Get.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armcompute_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/RunCommand_Get.json
func ExampleVirtualMachineRunCommandsClient_Get() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewVirtualMachineRunCommandsClient().Get(ctx, "SoutheastAsia", "RunPowerShellScript", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.RunCommandDocument = armcompute.RunCommandDocument{
// Description: to.Ptr("Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property."),
// Schema: to.Ptr("http://schema.management.azure.com/schemas/2016-11-17/runcommands.json"),
// ID: to.Ptr("RunPowerShellScript"),
// Label: to.Ptr("Executes a PowerShell script"),
// OSType: to.Ptr(armcompute.OperatingSystemTypesWindows),
// Parameters: []*armcompute.RunCommandParameterDefinition{
// {
// Name: to.Ptr("arg1"),
// Type: to.Ptr("string"),
// DefaultValue: to.Ptr("value1"),
// },
// {
// Name: to.Ptr("arg2"),
// Type: to.Ptr("string"),
// DefaultValue: to.Ptr("value2"),
// }},
// Script: []*string{
// to.Ptr("param("),
// to.Ptr(" [string]$arg1,"),
// to.Ptr(" [string]$arg2"),
// to.Ptr(")"),
// to.Ptr("Write-Host This is a sample script with parameters $arg1 $arg2")},
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets specific run command for a subscription in a location.
*
* @summary Gets specific run command for a subscription in a location.
* x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/runCommandExamples/RunCommand_Get.json
*/
async function virtualMachineRunCommandGet() {
const subscriptionId =
process.env["COMPUTE_SUBSCRIPTION_ID"] || "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e";
const location = "SoutheastAsia";
const commandId = "RunPowerShellScript";
const credential = new DefaultAzureCredential();
const client = new ComputeManagementClient(credential, subscriptionId);
const result = await client.virtualMachineRunCommands.get(location, commandId);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"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."
}
Definíciók
OperatingSystemTypes
Az operációs rendszer típusa.
| Name |
Típus |
Description |
|
Linux
|
string
|
|
|
Windows
|
string
|
|
RunCommandDocument
A futtatási parancsok tulajdonságait ismerteti.
| Name |
Típus |
Description |
|
$schema
|
string
|
A virtuális gép futtatja a parancssémát.
|
|
description
|
string
|
A virtuális gép futtatja a parancs leírását.
|
|
id
|
string
|
A virtuális gép futtatási parancsazonosítója.
|
|
label
|
string
|
A virtuális gép futtatja a parancscímkét.
|
|
osType
|
OperatingSystemTypes
|
Az operációs rendszer típusa.
|
|
parameters
|
RunCommandParameterDefinition[]
|
A szkript által használt paraméterek.
|
|
script
|
string[]
|
A végrehajtandó szkript.
|
RunCommandParameterDefinition
Egy futtatási parancsparaméter tulajdonságait ismerteti.
| Name |
Típus |
Alapértelmezett érték |
Description |
|
defaultValue
|
string
|
|
A parancsfuttatási paraméter alapértelmezett értéke.
|
|
name
|
string
|
|
A parancsfuttatási paraméter neve.
|
|
required
|
boolean
|
False
|
A futtatás parancsparamétere szükséges.
|
|
type
|
string
|
|
A futtatási parancs paramétertípusa.
|