Class: Azure::Compute::Mgmt::V2020_06_01::Models::VirtualMachineExtension

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

Overview

Describes a Virtual Machine Extension.

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

#auto_upgrade_minor_versionBoolean

minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

Returns:

  • (Boolean)

    Indicates whether the extension should use a newer



33
34
35
# File 'lib/2020-06-01/generated/azure_mgmt_compute/models/virtual_machine_extension.rb', line 33

def auto_upgrade_minor_version
  @auto_upgrade_minor_version
end

#enable_automatic_upgradeBoolean

automatically upgraded by the platform if there is a newer version of the extension available.

Returns:

  • (Boolean)

    Indicates whether the extension should be



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

def enable_automatic_upgrade
  @enable_automatic_upgrade
end

#force_update_tagString

even if the extension configuration has not changed.

Returns:

  • (String)

    How the extension handler should be forced to update



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

def force_update_tag
  @force_update_tag
end

#instance_viewVirtualMachineExtensionInstanceView

extension instance view.

Returns:



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

def instance_view
  @instance_view
end

#protected_settingsObject

protectedSettingsFromKeyVault or no protected settings at all.

Returns:

  • The extension can contain either protectedSettings or



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

def protected_settings
  @protected_settings
end

#provisioning_stateString

response.

Returns:

  • (String)

    The provisioning state, which only appears in the



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

def provisioning_state
  @provisioning_state
end

#publisherString

Returns The name of the extension handler publisher.

Returns:

  • (String)

    The name of the extension handler publisher.



20
21
22
# File 'lib/2020-06-01/generated/azure_mgmt_compute/models/virtual_machine_extension.rb', line 20

def publisher
  @publisher
end

#settingsObject

Returns Json formatted public settings for the extension.

Returns:

  • Json formatted public settings for the extension.



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

def settings
  @settings
end

#type_handler_versionString

Returns Specifies the version of the script handler.

Returns:

  • (String)

    Specifies the version of the script handler.



27
28
29
# File 'lib/2020-06-01/generated/azure_mgmt_compute/models/virtual_machine_extension.rb', line 27

def type_handler_version
  @type_handler_version
end

#virtual_machine_extension_typeString

“CustomScriptExtension”.

Returns:

  • (String)

    Specifies the type of the extension; an example is



24
25
26
# File 'lib/2020-06-01/generated/azure_mgmt_compute/models/virtual_machine_extension.rb', line 24

def virtual_machine_extension_type
  @virtual_machine_extension_type
end

Class Method Details

.mapperObject

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



60
61
62
63
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
# File 'lib/2020-06-01/generated/azure_mgmt_compute/models/virtual_machine_extension.rb', line 60

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualMachineExtension',
    type: {
      name: 'Composite',
      class_name: 'VirtualMachineExtension',
      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'
                }
            }
          }
        },
        force_update_tag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.forceUpdateTag',
          type: {
            name: 'String'
          }
        },
        publisher: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.publisher',
          type: {
            name: 'String'
          }
        },
        virtual_machine_extension_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.type',
          type: {
            name: 'String'
          }
        },
        type_handler_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.typeHandlerVersion',
          type: {
            name: 'String'
          }
        },
        auto_upgrade_minor_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoUpgradeMinorVersion',
          type: {
            name: 'Boolean'
          }
        },
        enable_automatic_upgrade: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableAutomaticUpgrade',
          type: {
            name: 'Boolean'
          }
        },
        settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.settings',
          type: {
            name: 'Object'
          }
        },
        protected_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.protectedSettings',
          type: {
            name: 'Object'
          }
        },
        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,
          serialized_name: 'properties.instanceView',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineExtensionInstanceView'
          }
        }
      }
    }
  }
end