Class: Azure::Compute::Mgmt::V2020_12_01::Models::VirtualMachineInstallPatchesResult

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

Overview

The result summary of an installation operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#error ⇒ ApiError

the operation. The details array contains the list of them.

Returns:

  • (ApiError) —

    The errors that were encountered during execution of



64
65
66
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_install_patches_result.rb', line 64

def error
  @error
end

#excluded_patch_count ⇒ Integer

the user blocking their installation.

Returns:

  • (Integer) —

    The number of patches that were not installed due to



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

def excluded_patch_count
  @excluded_patch_count
end

#failed_patch_count ⇒ Integer

to some issue. See errors for details.

Returns:

  • (Integer) —

    The number of patches that could not be installed due



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

def failed_patch_count
  @failed_patch_count
end

#installation_activity_id ⇒ String

result. It is used to correlate across CRP and extension logs.

Returns:

  • (String) —

    The activity ID of the operation that produced this



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

def installation_activity_id
  @installation_activity_id
end

#installed_patch_count ⇒ Integer

Returns The number of patches successfully installed.

Returns:

  • (Integer) —

    The number of patches successfully installed.



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

def installed_patch_count
  @installed_patch_count
end

#maintenance_window_exceeded ⇒ Boolean

completed all its intended actions.

Returns:

  • (Boolean) —

    Whether the operation ran out of time before it



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

def maintenance_window_exceeded
  @maintenance_window_exceeded
end

#not_selected_patch_count ⇒ Integer

for install, but did not meet the operation's criteria.

Returns:

  • (Integer) —

    The number of patches that were detected as available



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

def not_selected_patch_count
  @not_selected_patch_count
end

#patches ⇒ Array<PatchInstallationDetail>

installed during the operation.

Returns:



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

def patches
  @patches
end

#pending_patch_count ⇒ Integer

the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true.

Returns:

  • (Integer) —

    The number of patches that were identified as meeting



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

def pending_patch_count
  @pending_patch_count
end

#reboot_status ⇒ VMGuestPatchRebootStatus

completion of the operation. Possible values include: 'Unknown', 'NotNeeded', 'Required', 'Started', 'Failed', 'Completed'

Returns:



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

def reboot_status
  @reboot_status
end

#start_date_time ⇒ DateTime

Returns The UTC timestamp when the operation began.

Returns:

  • (DateTime) —

    The UTC timestamp when the operation began.



60
61
62
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_install_patches_result.rb', line 60

def start_date_time
  @start_date_time
end

#status ⇒ PatchOperationStatus

the operation. It remains “InProgress” until the operation completes. At that point it will become “Failed”, “Succeeded”, “Unknown” or “CompletedWithWarnings.”. Possible values include: 'Unknown', 'InProgress', 'Failed', 'Succeeded', 'CompletedWithWarnings'

Returns:



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

def status
  @status
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/virtual_machine_install_patches_result.rb', line 71

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualMachineInstallPatchesResult',
    type: {
      name: 'Composite',
      class_name: 'VirtualMachineInstallPatchesResult',
      model_properties: {
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'status',
          type: {
            name: 'String'
          }
        },
        installation_activity_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'installationActivityId',
          type: {
            name: 'String'
          }
        },
        reboot_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'rebootStatus',
          type: {
            name: 'String'
          }
        },
        maintenance_window_exceeded: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'maintenanceWindowExceeded',
          type: {
            name: 'Boolean'
          }
        },
        excluded_patch_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'excludedPatchCount',
          type: {
            name: 'Number'
          }
        },
        not_selected_patch_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'notSelectedPatchCount',
          type: {
            name: 'Number'
          }
        },
        pending_patch_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'pendingPatchCount',
          type: {
            name: 'Number'
          }
        },
        installed_patch_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'installedPatchCount',
          type: {
            name: 'Number'
          }
        },
        failed_patch_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'failedPatchCount',
          type: {
            name: 'Number'
          }
        },
        patches: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'patches',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'PatchInstallationDetailElementType',
                type: {
                  name: 'Composite',
                  class_name: 'PatchInstallationDetail'
                }
            }
          }
        },
        start_date_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'startDateTime',
          type: {
            name: 'DateTime'
          }
        },
        error: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'error',
          type: {
            name: 'Composite',
            class_name: 'ApiError'
          }
        }
      }
    }
  }
end