5.0.0 • Published 5 years ago
@datafire/azure_compute_runcommands v5.0.0
@datafire/azure_compute_runcommands
Client library for RunCommandsClient
Installation and Usage
npm install --save @datafire/azure_compute_runcommands
let azure_compute_runcommands = require('@datafire/azure_compute_runcommands').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
The Run Commands Client.
Actions
VirtualMachineRunCommands_List
Lists all available run commands for a subscription in a location.
azure_compute_runcommands.VirtualMachineRunCommands_List({
"location": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- location required
string
: The location upon which run commands is queried. - api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- location required
Output
- output RunCommandListResult
VirtualMachineRunCommands_Get
Gets specific run command for a subscription in a location.
azure_compute_runcommands.VirtualMachineRunCommands_Get({
"location": "",
"commandId": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- location required
string
: The location upon which run commands is queried. - commandId required
string
: The command id. - api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- location required
Output
- output RunCommandDocument
VirtualMachineScaleSetVMs_RunCommand
Run command on a virtual machine in a VM scale set.
azure_compute_runcommands.VirtualMachineScaleSetVMs_RunCommand({
"resourceGroupName": "",
"vmScaleSetName": "",
"instanceId": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - vmScaleSetName required
string
: The name of the VM scale set. - instanceId required
string
: The instance ID of the virtual machine. - parameters required RunCommandInput
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RunCommandResult
VirtualMachines_RunCommand
Run command on the VM.
azure_compute_runcommands.VirtualMachines_RunCommand({
"resourceGroupName": "",
"vmName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - vmName required
string
: The name of the virtual machine. - parameters required RunCommandInput
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output RunCommandResult
Definitions
InstanceViewStatus
- InstanceViewStatus
object
: Instance view status.- code
string
: The status code. - displayStatus
string
: The short localizable label for the status. - level
string
(values: Info, Warning, Error): The level code. - message
string
: The detailed status message, including for alerts and error messages. - time
string
: The time of the status.
- code
RunCommandDocument
- RunCommandDocument
object
: Describes the properties of a Run Command.- parameters
array
: The parameters used by the script. - script required
array
: The script to be executed.- items
string
- items
- $schema required
string
: The VM run command schema. - description required
string
: The VM run command description. - id required
string
: The VM run command id. - label required
string
: The VM run command label. - osType required
string
(values: Windows, Linux): The Operating System type.
- parameters
RunCommandDocumentBase
- RunCommandDocumentBase
object
: Describes the properties of a Run Command metadata.- $schema required
string
: The VM run command schema. - description required
string
: The VM run command description. - id required
string
: The VM run command id. - label required
string
: The VM run command label. - osType required
string
(values: Windows, Linux): The Operating System type.
- $schema required
RunCommandInput
- RunCommandInput
object
: Capture Virtual Machine parameters.- commandId required
string
: The run command id. - parameters
array
: The run command parameters.- items RunCommandInputParameter
- script
array
: Optional. The script to be executed. When this value is given, the given script will override the default script of the command.- items
string
- items
- commandId required
RunCommandInputParameter
- RunCommandInputParameter
object
: Describes the properties of a run command parameter.- name required
string
: The run command parameter name. - value required
string
: The run command parameter value.
- name required
RunCommandListResult
- RunCommandListResult
object
: The List Virtual Machine operation response.- nextLink
string
: The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands. - value required
array
: The list of virtual machine run commands.- items RunCommandDocumentBase
- nextLink
RunCommandParameterDefinition
- RunCommandParameterDefinition
object
: Describes the properties of a run command parameter.- defaultValue
string
: The run command parameter default value. - name required
string
: The run command parameter name. - required
boolean
: The run command parameter required. - type required
string
: The run command parameter type.
- defaultValue
RunCommandResult
- RunCommandResult
object
- value
array
: Run command operation response.- items InstanceViewStatus
- value