class Azure::Network::Mgmt::V2020_04_01::Models::ApplicationGatewayProbe

Probe of the application gateway.

Attributes

etag[RW]

@return [String] A unique read-only string that changes whenever the resource is updated.

host[RW]

@return [String] Host name to send the probe to.

interval[RW]

@return [Integer] The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

match[RW]

@return [ApplicationGatewayProbeHealthResponseMatch] Criterion for classifying a healthy probe response.

min_servers[RW]

@return [Integer] Minimum number of servers that are always marked healthy. Default value is 0.

name[RW]

@return [String] Name of the probe that is unique within an Application Gateway.

path[RW]

@return [String] Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>.

pick_host_name_from_backend_http_settings[RW]

@return [Boolean] Whether the host header should be picked from the backend http settings. Default value is false.

port[RW]

@return [Integer] Custom port which will be used for probing the 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.

protocol[RW]

@return [ApplicationGatewayProtocol] The protocol used for the probe. Possible values include: 'Http', 'Https'

provisioning_state[RW]

@return [ProvisioningState] The provisioning state of the probe resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

timeout[RW]

@return [Integer] The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

type[RW]

@return [String] Type of the resource.

unhealthy_threshold[RW]

@return [Integer] The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

Public Class Methods

mapper() click to toggle source

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

# File lib/2020-04-01/generated/azure_mgmt_network/models/application_gateway_probe.rb, line 80
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,
          read_only: true,
          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,
          read_only: true,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end