Class: Azure::Network::Mgmt::V2019_04_01::Models::ApplicationGatewayProbe

Inherits:
SubResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb

Overview

Probe of the application gateway.

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id

Class Method Summary collapse

Instance Attribute Details

#etagString

resource is updated.

Returns:

  • (String)

    A unique read-only string that changes whenever the


69
70
71
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 69

def etag
  @etag
end

#hostString

Returns Host name to send the probe to.

Returns:

  • (String)

    Host name to send the probe to.


20
21
22
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 20

def host
  @host
end

#intervalInteger

interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

Returns:

  • (Integer)

    The probing interval in seconds. This is the time


29
30
31
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 29

def interval
  @interval
end

#matchApplicationGatewayProbeHealthResponseMatch

classifying a healthy probe response.

Returns:


51
52
53
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 51

def match
  @match
end

#min_serversInteger

healthy. Default value is 0.

Returns:

  • (Integer)

    Minimum number of servers that are always marked


47
48
49
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 47

def min_servers
  @min_servers
end

#nameString

Gateway.

Returns:

  • (String)

    Name of the probe that is unique within an Application


65
66
67
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 65

def name
  @name
end

#pathString

Probe is sent to <Protocol>://<host>:<port><path>.

Returns:

  • (String)

    Relative path of probe. Valid path starts from '/'.


24
25
26
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 24

def path
  @path
end

#pick_host_name_from_backend_http_settingsBoolean

backend http settings. Default value is false.

Returns:

  • (Boolean)

    Whether the host header should be picked from the


43
44
45
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 43

def pick_host_name_from_backend_http_settings
  @pick_host_name_from_backend_http_settings
end

#portInteger

backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.

Returns:

  • (Integer)

    Custom port which will be used for probing the


61
62
63
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 61

def port
  @port
end

#protocolApplicationGatewayProtocol

Possible values include: 'Http', 'Https'

Returns:


17
18
19
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 17

def protocol
  @protocol
end

#provisioning_stateString

resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Returns:

  • (String)

    Provisioning state of the backend http settings


55
56
57
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 55

def provisioning_state
  @provisioning_state
end

#timeoutInteger

if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

Returns:

  • (Integer)

    The probe timeout in seconds. Probe marked as failed


34
35
36
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 34

def timeout
  @timeout
end

#typeString

Returns Type of the resource.

Returns:

  • (String)

    Type of the resource.


72
73
74
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 72

def type
  @type
end

#unhealthy_thresholdInteger

after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

Returns:

  • (Integer)

    The probe retry count. Backend server is marked down


39
40
41
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 39

def unhealthy_threshold
  @unhealthy_threshold
end

Class Method Details

.mapperObject

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


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
# File 'lib/2019-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb', line 79

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApplicationGatewayProbe',
    type: {
      name: 'Composite',
      class_name: 'ApplicationGatewayProbe',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        protocol: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.protocol',
          type: {
            name: 'String'
          }
        },
        host: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.host',
          type: {
            name: 'String'
          }
        },
        path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.path',
          type: {
            name: 'String'
          }
        },
        interval: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.interval',
          type: {
            name: 'Number'
          }
        },
        timeout: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.timeout',
          type: {
            name: 'Number'
          }
        },
        unhealthy_threshold: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.unhealthyThreshold',
          type: {
            name: 'Number'
          }
        },
        pick_host_name_from_backend_http_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.pickHostNameFromBackendHttpSettings',
          type: {
            name: 'Boolean'
          }
        },
        min_servers: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.minServers',
          type: {
            name: 'Number'
          }
        },
        match: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.match',
          type: {
            name: 'Composite',
            class_name: 'ApplicationGatewayProbeHealthResponseMatch'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        port: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.port',
          constraints: {
            InclusiveMaximum: 65535,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end