{ "swagger": "2.0", "info": { "title": "RunCommandsClient", "description": "The Run Commands Client.", "version": "2021-11-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json", "text/json" ], "produces": [ "application/json", "text/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands": { "get": { "tags": [ "VirtualMachineRunCommands" ], "operationId": "VirtualMachineRunCommands_List", "x-ms-examples": { "VirtualMachineRunCommandList": { "$ref": "./examples/runCommands/VirtualMachineRunCommandList.json" } }, "description": "Lists all available run commands for a subscription in a location.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location upon which run commands is queried.", "pattern": "^[-\\w\\._]+$" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RunCommandListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": { "get": { "tags": [ "VirtualMachineRunCommands" ], "operationId": "VirtualMachineRunCommands_Get", "x-ms-examples": { "VirtualMachineRunCommandGet": { "$ref": "./examples/runCommands/VirtualMachineRunCommandGet.json" } }, "description": "Gets specific run command for a subscription in a location.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location upon which run commands is queried.", "pattern": "^[-\\w\\._]+$" }, { "name": "commandId", "in": "path", "required": true, "type": "string", "description": "The command id." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RunCommandDocument" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": { "post": { "tags": [ "VirtualMachines" ], "operationId": "VirtualMachines_RunCommand", "x-ms-examples": { "VirtualMachineRunCommand": { "$ref": "./examples/runCommands/VirtualMachineRunCommand.json" } }, "description": "Run command on the VM.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RunCommandInput" }, "description": "Parameters supplied to the Run command operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RunCommandResult" } }, "202": { "description": "Accepted" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_RunCommand", "x-ms-examples": { "VirtualMachineScaleSetVMs_RunCommand": { "$ref": "./examples/runCommands/VMScaleSetRunCommand.json" } }, "description": "Run command on a virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RunCommandInput" }, "description": "Parameters supplied to the Run command operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RunCommandResult" } }, "202": { "description": "Accepted" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}": { "put": { "tags": [ "VirtualMachineRunCommands" ], "operationId": "VirtualMachineRunCommands_CreateOrUpdate", "description": "The operation to create or update the run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine where the run command should be created or updated." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "name": "runCommand", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" }, "description": "Parameters supplied to the Create Virtual Machine RunCommand operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create or update a run command.": { "$ref": "./examples/runCommands/CreateOrUpdateRunCommand.json" } } }, "patch": { "tags": [ "VirtualMachineRunCommands" ], "operationId": "VirtualMachineRunCommands_Update", "description": "The operation to update the run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine where the run command should be updated." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "name": "runCommand", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineRunCommandUpdate" }, "description": "Parameters supplied to the Update Virtual Machine RunCommand operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Update a run command.": { "$ref": "./examples/runCommands/UpdateRunCommand.json" } } }, "delete": { "tags": [ "VirtualMachineRunCommands" ], "operationId": "VirtualMachineRunCommands_Delete", "description": "The operation to delete the run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine where the run command should be deleted." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete a run command.": { "$ref": "./examples/runCommands/DeleteRunCommand.json" } } }, "get": { "tags": [ "VirtualMachineRunCommands" ], "operationId": "VirtualMachineRunCommands_GetByVirtualMachine", "description": "The operation to get the run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine containing the run command." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Get a run command.": { "$ref": "./examples/runCommands/GetRunCommand.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands": { "get": { "tags": [ "VirtualMachineRunCommands" ], "operationId": "VirtualMachineRunCommands_ListByVirtualMachine", "description": "The operation to get all run commands of a Virtual Machine.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine containing the run command." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommandsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "List run commands in a Virtual Machine.": { "$ref": "./examples/runCommands/ListRunCommandsInVM.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}": { "put": { "tags": [ "VirtualMachineScaleSetVMRunCommands" ], "operationId": "VirtualMachineScaleSetVMRunCommands_CreateOrUpdate", "description": "The operation to create or update the VMSS VM run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "name": "runCommand", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" }, "description": "Parameters supplied to the Create Virtual Machine RunCommand operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create VirtualMachineScaleSet VM run command.": { "$ref": "./examples/runCommands/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.json" } } }, "patch": { "tags": [ "VirtualMachineScaleSetVMRunCommands" ], "operationId": "VirtualMachineScaleSetVMRunCommands_Update", "description": "The operation to update the VMSS VM run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "name": "runCommand", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineRunCommandUpdate" }, "description": "Parameters supplied to the Update Virtual Machine RunCommand operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Update VirtualMachineScaleSet VM run command.": { "$ref": "./examples/runCommands/UpdateVirtualMachineScaleSetVMRunCommands.json" } } }, "delete": { "tags": [ "VirtualMachineScaleSetVMRunCommands" ], "operationId": "VirtualMachineScaleSetVMRunCommands_Delete", "description": "The operation to delete the VMSS VM run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete VirtualMachineScaleSet VM run command.": { "$ref": "./examples/runCommands/DeleteVirtualMachineScaleSetVMRunCommands.json" } } }, "get": { "tags": [ "VirtualMachineScaleSetVMRunCommands" ], "operationId": "VirtualMachineScaleSetVMRunCommands_Get", "description": "The operation to get the VMSS VM run command.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "runCommandName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine run command." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommand" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Get VirtualMachineScaleSet VM run commands.": { "$ref": "./examples/runCommands/GetVirtualMachineScaleSetVMRunCommands.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands": { "get": { "tags": [ "VirtualMachineScaleSetVMRunCommands" ], "operationId": "VirtualMachineScaleSetVMRunCommands_List", "description": "The operation to get all run commands of an instance in Virtual Machine Scaleset.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineRunCommandsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List run commands in Vmss instance.": { "$ref": "./examples/runCommands/ListVirtualMachineScaleSetVMRunCommands.json" } } } } }, "definitions": { "RunCommandInputParameter": { "properties": { "name": { "type": "string", "description": "The run command parameter name." }, "value": { "type": "string", "description": "The run command parameter value." } }, "required": [ "name", "value" ], "description": "Describes the properties of a run command parameter." }, "RunCommandInput": { "properties": { "commandId": { "type": "string", "description": "The run command id." }, "script": { "type": "array", "items": { "type": "string" }, "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command." }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/RunCommandInputParameter" }, "x-ms-identifiers": [ "name" ], "description": "The run command parameters." } }, "required": [ "commandId" ], "description": "Capture Virtual Machine parameters." }, "RunCommandParameterDefinition": { "properties": { "name": { "type": "string", "description": "The run command parameter name." }, "type": { "type": "string", "description": "The run command parameter type." }, "defaultValue": { "type": "string", "description": "The run command parameter default value." }, "required": { "type": "boolean", "description": "The run command parameter required.", "default": false } }, "required": [ "name", "type" ], "description": "Describes the properties of a run command parameter." }, "RunCommandDocumentBase": { "properties": { "$schema": { "type": "string", "description": "The VM run command schema." }, "id": { "type": "string", "description": "The VM run command id." }, "osType": { "type": "string", "description": "The Operating System type.", "enum": [ "Windows", "Linux" ], "x-ms-enum": { "name": "OperatingSystemTypes", "modelAsString": false } }, "label": { "type": "string", "description": "The VM run command label." }, "description": { "type": "string", "description": "The VM run command description." } }, "required": [ "$schema", "id", "osType", "label", "description" ], "description": "Describes the properties of a Run Command metadata." }, "RunCommandDocument": { "allOf": [ { "$ref": "#/definitions/RunCommandDocumentBase" } ], "properties": { "script": { "type": "array", "items": { "type": "string" }, "description": "The script to be executed." }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/RunCommandParameterDefinition" }, "x-ms-identifiers": [ "name", "type" ], "description": "The parameters used by the script." } }, "required": [ "script" ], "description": "Describes the properties of a Run Command." }, "RunCommandListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RunCommandDocumentBase" }, "description": "The list of virtual machine run commands." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." } }, "required": [ "value" ], "description": "The List Virtual Machine operation response." }, "InstanceViewStatus": { "properties": { "code": { "type": "string", "description": "The status code." }, "level": { "type": "string", "description": "The level code.", "enum": [ "Info", "Warning", "Error" ], "x-ms-enum": { "name": "StatusLevelTypes", "modelAsString": false } }, "displayStatus": { "type": "string", "description": "The short localizable label for the status." }, "message": { "type": "string", "description": "The detailed status message, including for alerts and error messages." }, "time": { "type": "string", "format": "date-time", "description": "The time of the status." } }, "description": "Instance view status." }, "RunCommandResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/InstanceViewStatus" }, "x-ms-identifiers": [], "description": "Run command operation response." } } }, "VirtualMachineRunCommandInstanceView": { "properties": { "executionState": { "type": "string", "description": "Script execution status.", "enum": [ "Unknown", "Pending", "Running", "Failed", "Succeeded", "TimedOut", "Canceled" ], "x-ms-enum": { "name": "ExecutionState", "modelAsString": true } }, "executionMessage": { "type": "string", "description": "Communicate script configuration errors or execution messages." }, "exitCode": { "type": "integer", "format": "int32", "description": "Exit code returned from script execution." }, "output": { "type": "string", "description": "Script output stream." }, "error": { "type": "string", "description": "Script error stream." }, "startTime": { "type": "string", "format": "date-time", "description": "Script start time." }, "endTime": { "type": "string", "format": "date-time", "description": "Script end time." }, "statuses": { "type": "array", "items": { "$ref": "#/definitions/InstanceViewStatus" }, "x-ms-identifiers": [], "description": "The resource status information." } }, "description": "The instance view of a virtual machine run command." }, "VirtualMachineRunCommandScriptSource": { "properties": { "script": { "type": "string", "description": "Specifies the script content to be executed on the VM." }, "scriptUri": { "type": "string", "description": "Specifies the script download location." }, "commandId": { "type": "string", "description": "Specifies a commandId of predefined built-in script." } }, "description": "Describes the script sources for run command." }, "VirtualMachineRunCommandProperties": { "properties": { "source": { "$ref": "#/definitions/VirtualMachineRunCommandScriptSource", "description": "The source of the run command script." }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/RunCommandInputParameter" }, "x-ms-identifiers": [ "name" ], "description": "The parameters used by the script." }, "protectedParameters": { "type": "array", "items": { "$ref": "#/definitions/RunCommandInputParameter" }, "x-ms-identifiers": [ "name" ], "description": "The parameters used by the script." }, "asyncExecution": { "type": "boolean", "description": "Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.", "default": false }, "runAsUser": { "type": "string", "description": "Specifies the user account on the VM when executing the run command." }, "runAsPassword": { "type": "string", "description": "Specifies the user account password on the VM when executing the run command." }, "timeoutInSeconds": { "type": "integer", "format": "int32", "description": "The timeout in seconds to execute the run command." }, "outputBlobUri": { "type": "string", "description": "Specifies the Azure storage blob where script output stream will be uploaded." }, "errorBlobUri": { "type": "string", "description": "Specifies the Azure storage blob where script error stream will be uploaded." }, "provisioningState": { "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." }, "instanceView": { "readOnly": true, "$ref": "#/definitions/VirtualMachineRunCommandInstanceView", "description": "The virtual machine run command instance view." } }, "description": "Describes the properties of a Virtual Machine run command." }, "VirtualMachineRunCommand": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineRunCommandProperties" } }, "allOf": [ { "$ref": "#/definitions/Resource" } ], "description": "Describes a Virtual Machine run command." }, "VirtualMachineRunCommandUpdate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineRunCommandProperties" } }, "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], "description": "Describes a Virtual Machine run command." }, "VirtualMachineRunCommandsListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineRunCommand" }, "description": "The list of run commands" }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of run commands." } }, "required": [ "value" ], "description": "The List run command operation response" }, "ApiErrorBase": { "properties": { "code": { "type": "string", "description": "The error code." }, "target": { "type": "string", "description": "The target of the particular error." }, "message": { "type": "string", "description": "The error message." } }, "description": "Api error base." }, "InnerError": { "properties": { "exceptiontype": { "type": "string", "description": "The exception type." }, "errordetail": { "type": "string", "description": "The internal error message or exception dump." } }, "description": "Inner error details." }, "CloudError": { "x-ms-external": true, "properties": { "error": { "$ref": "#/definitions/ApiError" } }, "description": "An error response from the Compute service." }, "ApiError": { "properties": { "details": { "type": "array", "items": { "$ref": "#/definitions/ApiErrorBase" }, "x-ms-identifiers": [ "message", "target" ], "description": "The Api error details" }, "innererror": { "$ref": "#/definitions/InnerError", "description": "The Api inner error" }, "code": { "type": "string", "description": "The error code." }, "target": { "type": "string", "description": "The target of the particular error." }, "message": { "type": "string", "description": "The error message." } }, "description": "Api error." }, "Resource": { "description": "The Resource model definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id" }, "name": { "readOnly": true, "type": "string", "description": "Resource name" }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "location": { "type": "string", "description": "Resource location" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags" } }, "required": [ "location" ], "x-ms-azure-resource": true }, "UpdateResource": { "description": "The Update Resource model definition.", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags" } } } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client Api Version." } } }