Class: Azure::Compute::Mgmt::V2020_12_01::Models::VirtualMachineRunCommand

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb

Overview

Describes a Virtual Machine run command.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#async_execution ⇒ Boolean

as soon as the script starts and will not wait for script to complete. Default value: false .

Returns:

  • (Boolean) —

    Optional. If set to true, provisioning will complete



30
31
32
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 30

def async_execution
  @async_execution
end

#error_blob_uri ⇒ String

stream will be uploaded.

Returns:

  • (String) —

    Specifies the Azure storage blob where script error



49
50
51
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 49

def error_blob_uri
  @error_blob_uri
end

#instance_view ⇒ VirtualMachineRunCommandInstanceView

command instance view.

Returns:



57
58
59
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 57

def instance_view
  @instance_view
end

#output_blob_uri ⇒ String

stream will be uploaded.

Returns:

  • (String) —

    Specifies the Azure storage blob where script output



45
46
47
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 45

def output_blob_uri
  @output_blob_uri
end

#parameters ⇒ Array<RunCommandInputParameter>

script.

Returns:



21
22
23
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 21

def parameters
  @parameters
end

#protected_parameters ⇒ Array<RunCommandInputParameter>

script.

Returns:



25
26
27
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 25

def protected_parameters
  @protected_parameters
end

#provisioning_state ⇒ String

response.

Returns:

  • (String) —

    The provisioning state, which only appears in the



53
54
55
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 53

def provisioning_state
  @provisioning_state
end

#run_as_password ⇒ String

executing the run command.

Returns:

  • (String) —

    Specifies the user account password on the VM when



38
39
40
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 38

def run_as_password
  @run_as_password
end

#run_as_user ⇒ String

the run command.

Returns:

  • (String) —

    Specifies the user account on the VM when executing



34
35
36
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 34

def run_as_user
  @run_as_user
end

#source ⇒ VirtualMachineRunCommandScriptSource

command script.

Returns:



17
18
19
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 17

def source
  @source
end

#timeout_in_seconds ⇒ Integer

Returns The timeout in seconds to execute the run command.

Returns:

  • (Integer) —

    The timeout in seconds to execute the run command.



41
42
43
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 41

def timeout_in_seconds
  @timeout_in_seconds
end

Class Method Details

.mapper ⇒ Object

Mapper for VirtualMachineRunCommand class as Ruby Hash. This will be used for serialization/deserialization.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_run_command.rb', line 64

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualMachineRunCommand',
    type: {
      name: 'Composite',
      class_name: 'VirtualMachineRunCommand',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        source: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.source',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineRunCommandScriptSource'
          }
        },
        parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.parameters',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RunCommandInputParameterElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RunCommandInputParameter'
                }
            }
          }
        },
        protected_parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.protectedParameters',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'RunCommandInputParameterElementType',
                type: {
                  name: 'Composite',
                  class_name: 'RunCommandInputParameter'
                }
            }
          }
        },
        async_execution: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.asyncExecution',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        run_as_user: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.runAsUser',
          type: {
            name: 'String'
          }
        },
        run_as_password: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.runAsPassword',
          type: {
            name: 'String'
          }
        },
        timeout_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.timeoutInSeconds',
          type: {
            name: 'Number'
          }
        },
        output_blob_uri: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.outputBlobUri',
          type: {
            name: 'String'
          }
        },
        error_blob_uri: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.errorBlobUri',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        instance_view: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.instanceView',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineRunCommandInstanceView'
          }
        }
      }
    }
  }
end