Class: Azure::Compute::Mgmt::V2020_12_01::Models::RollingUpgradePolicy

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

Overview

The configuration parameters used while performing a rolling upgrade.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#enable_cross_zone_upgrade ⇒ Boolean

upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.

Returns:

  • (Boolean) —

    Allow VMSS to ignore AZ boundaries when constructing



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

def enable_cross_zone_upgrade
  @enable_cross_zone_upgrade
end

#max_batch_instance_percent ⇒ Integer

instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.

Returns:

  • (Integer) —

    The maximum percent of total virtual machine



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

def max_batch_instance_percent
  @max_batch_instance_percent
end

#max_unhealthy_instance_percent ⇒ Integer

instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.

Returns:

  • (Integer) —

    The maximum percentage of the total virtual machine



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

def max_unhealthy_instance_percent
  @max_unhealthy_instance_percent
end

#max_unhealthy_upgraded_instance_percent ⇒ Integer

instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.

Returns:

  • (Integer) —

    The maximum percentage of upgraded virtual machine



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

def max_unhealthy_upgraded_instance_percent
  @max_unhealthy_upgraded_instance_percent
end

#pause_time_between_batches ⇒ String

virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).

Returns:

  • (String) —

    The wait time between completing the update for all



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

def pause_time_between_batches
  @pause_time_between_batches
end

#prioritize_unhealthy_instances ⇒ Boolean

any healthy instances.

Returns:

  • (Boolean) —

    Upgrade all unhealthy instances in a scale set before



51
52
53
 
# File 'lib/2020-12-01/generated/azure_mgmt_compute/models/rolling_upgrade_policy.rb', line 51

def prioritize_unhealthy_instances
  @prioritize_unhealthy_instances
end

Class Method Details

.mapper ⇒ Object

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



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

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RollingUpgradePolicy',
    type: {
      name: 'Composite',
      class_name: 'RollingUpgradePolicy',
      model_properties: {
        max_batch_instance_percent: {
          client_side_validation: true,
          required: false,
          serialized_name: 'maxBatchInstancePercent',
          constraints: {
            InclusiveMaximum: 100,
            InclusiveMinimum: 5
          },
          type: {
            name: 'Number'
          }
        },
        max_unhealthy_instance_percent: {
          client_side_validation: true,
          required: false,
          serialized_name: 'maxUnhealthyInstancePercent',
          constraints: {
            InclusiveMaximum: 100,
            InclusiveMinimum: 5
          },
          type: {
            name: 'Number'
          }
        },
        max_unhealthy_upgraded_instance_percent: {
          client_side_validation: true,
          required: false,
          serialized_name: 'maxUnhealthyUpgradedInstancePercent',
          constraints: {
            InclusiveMaximum: 100,
            InclusiveMinimum: 0
          },
          type: {
            name: 'Number'
          }
        },
        pause_time_between_batches: {
          client_side_validation: true,
          required: false,
          serialized_name: 'pauseTimeBetweenBatches',
          type: {
            name: 'String'
          }
        },
        enable_cross_zone_upgrade: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enableCrossZoneUpgrade',
          type: {
            name: 'Boolean'
          }
        },
        prioritize_unhealthy_instances: {
          client_side_validation: true,
          required: false,
          serialized_name: 'prioritizeUnhealthyInstances',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end