Class: Azure::Network::Mgmt::V2018_04_01::Models::ApplicationGatewayBackendHttpSettings

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

Overview

Backend address pool settings of an application gateway.

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id

Class Method Summary collapse

Instance Attribute Details

Returns Cookie name to use for the affinity cookie.

Returns:

  • (String)

    Cookie name to use for the affinity cookie.


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

def affinity_cookie_name
  @affinity_cookie_name
end

#authentication_certificatesArray<SubResource>

authentication certificates.

Returns:

  • (Array<SubResource>)

    Array of references to application gateway


37
38
39
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 37

def authentication_certificates
  @authentication_certificates
end

#connection_drainingApplicationGatewayConnectionDraining

the backend http settings resource.

Returns:


41
42
43
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 41

def connection_draining
  @connection_draining
end

Possible values include: 'Enabled', 'Disabled'

Returns:


25
26
27
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 25

def cookie_based_affinity
  @cookie_based_affinity
end

#etagString

resource is updated.

Returns:

  • (String)

    A unique read-only string that changes whenever the


70
71
72
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 70

def etag
  @etag
end

#host_nameString

Returns Host header to be sent to the backend servers.

Returns:

  • (String)

    Host header to be sent to the backend servers.


44
45
46
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 44

def host_name
  @host_name
end

#nameString

within an Application Gateway.

Returns:

  • (String)

    Name of the backend http settings that is unique


66
67
68
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 66

def name
  @name
end

#pathString

requests. Null means no path will be prefixed. Default value is null.

Returns:

  • (String)

    Path which should be used as a prefix for all HTTP


58
59
60
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 58

def path
  @path
end

#pick_host_name_from_backend_addressBoolean

host name of the backend server. Default value is false.

Returns:

  • (Boolean)

    Whether to pick host header should be picked from the


48
49
50
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 48

def pick_host_name_from_backend_address
  @pick_host_name_from_backend_address
end

#portInteger

Returns The destination port on the backend.

Returns:

  • (Integer)

    The destination port on the backend.


16
17
18
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 16

def port
  @port
end

#probeSubResource

Returns Probe resource of an application gateway.

Returns:

  • (SubResource)

    Probe resource of an application gateway.


33
34
35
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 33

def probe
  @probe
end

#probe_enabledBoolean

Returns Whether the probe is enabled. Default value is false.

Returns:

  • (Boolean)

    Whether the probe is enabled. Default value is false.


54
55
56
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 54

def probe_enabled
  @probe_enabled
end

#protocolApplicationGatewayProtocol

with the backend. Possible values are 'Http' and 'Https'. Possible values include: 'Http', 'Https'

Returns:


21
22
23
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 21

def protocol
  @protocol
end

#provisioning_stateString

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

Returns:

  • (String)

    Provisioning state of the backend http settings


62
63
64
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 62

def provisioning_state
  @provisioning_state
end

#request_timeoutInteger

fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

Returns:

  • (Integer)

    Request timeout in seconds. Application Gateway will


30
31
32
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 30

def request_timeout
  @request_timeout
end

#typeString

Returns Type of the resource.

Returns:

  • (String)

    Type of the resource.


73
74
75
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 73

def type
  @type
end

Class Method Details

.mapperObject

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


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
239
# File 'lib/2018-04-01/generated/azure_mgmt_network/models/application_gateway_backend_http_settings.rb', line 80

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApplicationGatewayBackendHttpSettings',
    type: {
      name: 'Composite',
      class_name: 'ApplicationGatewayBackendHttpSettings',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        port: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.port',
          type: {
            name: 'Number'
          }
        },
        protocol: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.protocol',
          type: {
            name: 'String'
          }
        },
        cookie_based_affinity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.cookieBasedAffinity',
          type: {
            name: 'String'
          }
        },
        request_timeout: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.requestTimeout',
          type: {
            name: 'Number'
          }
        },
        probe: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.probe',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        authentication_certificates: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.authenticationCertificates',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SubResourceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SubResource'
                }
            }
          }
        },
        connection_draining: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.connectionDraining',
          type: {
            name: 'Composite',
            class_name: 'ApplicationGatewayConnectionDraining'
          }
        },
        host_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hostName',
          type: {
            name: 'String'
          }
        },
        pick_host_name_from_backend_address: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.pickHostNameFromBackendAddress',
          type: {
            name: 'Boolean'
          }
        },
        affinity_cookie_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.affinityCookieName',
          type: {
            name: 'String'
          }
        },
        probe_enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.probeEnabled',
          type: {
            name: 'Boolean'
          }
        },
        path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.path',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        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