Class: Ansible::Ruby::Modules::Azure_rm_loadbalancer

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb

Overview

Create, update and delete Azure load balancers

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#backend_address_pools ⇒ Array<Hash>, ...

Returns List of backend address pools.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of backend address pools



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 35

attribute :backend_address_pools

#backend_port ⇒ Object?

Returns (deprecated) Backend port that will be exposed for the load balancer.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.

Returns:

  • (Object, nil) —

    (deprecated) Backend port that will be exposed for the load balancer.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.



83
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 83

attribute :backend_port

#frontend_ip_configurations ⇒ Array<Hash>, ...

Returns List of frontend IPs to be used.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of frontend IPs to be used



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 31

attribute :frontend_ip_configurations

#frontend_port ⇒ Object?

Returns (deprecated) Frontend port that will be exposed for the load balancer.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.

Returns:

  • (Object, nil) —

    (deprecated) Frontend port that will be exposed for the load balancer.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.



80
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 80

attribute :frontend_port

#idle_timeout ⇒ Integer?

Returns (deprecated) Timeout for TCP idle connection in minutes.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.

Returns:

  • (Integer, nil) —

    (deprecated) Timeout for TCP idle connection in minutes.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.



86
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 86

attribute :idle_timeout

#inbound_nat_pools ⇒ Array<Hash>, ...

Returns Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer.,Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range.,Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules.,Inbound NAT pools are referenced from virtual machine scale sets.,NICs that are associated with individual virtual machines cannot reference an inbound NAT pool.,They have to reference individual inbound NAT rules.

Returns:

  • (Array<Hash>, Hash, nil) —

    Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer.,Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range.,Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules.,Inbound NAT pools are referenced from virtual machine scale sets.,NICs that are associated with individual virtual machines cannot reference an inbound NAT pool.,They have to reference individual inbound NAT rules.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 43

attribute :inbound_nat_pools

#load_balancing_rules ⇒ Array<Hash>, ...

Returns Object collection representing the load balancing rules Gets the provisioning.

Returns:

  • (Array<Hash>, Hash, nil) —

    Object collection representing the load balancing rules Gets the provisioning.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 47

attribute :load_balancing_rules

#load_distribution ⇒ :Default, ...

Returns (deprecated) The type of load distribution that the load balancer will employ.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.

Returns:

  • (:Default, :SourceIP, :SourceIPProtocol, nil) —

    (deprecated) The type of load distribution that the load balancer will employ.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.



76
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 76

attribute :load_distribution

#location ⇒ Object?

Returns Valid azure location. Defaults to location of the resource group.

Returns:

  • (Object, nil) —

    Valid azure location. Defaults to location of the resource group.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 24

attribute :location

#name ⇒ String

Returns Name of the load balancer.

Returns:

  • (String) —

    Name of the load balancer.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 16

attribute :name

#natpool_backend_port ⇒ Object?

Returns (deprecated) Backend port used by the NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.

Returns:

  • (Object, nil) —

    (deprecated) Backend port used by the NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.



96
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 96

attribute :natpool_backend_port

#natpool_frontend_port_end ⇒ Object?

Returns (deprecated) End of the port range for a NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.

Returns:

  • (Object, nil) —

    (deprecated) End of the port range for a NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.



93
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 93

attribute :natpool_frontend_port_end

#natpool_frontend_port_start ⇒ Object?

Returns (deprecated) Start of the port range for a NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.

Returns:

  • (Object, nil) —

    (deprecated) Start of the port range for a NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.



90
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 90

attribute :natpool_frontend_port_start

#natpool_protocol ⇒ Object?

Returns (deprecated) The protocol for the NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.

Returns:

  • (Object, nil) —

    (deprecated) The protocol for the NAT pool.,This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.



99
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 99

attribute :natpool_protocol

#probe_fail_count ⇒ Integer?

Returns (deprecated) The amount of probe failures for the load balancer to make a health determination.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.

Returns:

  • (Integer, nil) —

    (deprecated) The amount of probe failures for the load balancer to make a health determination.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 65

attribute :probe_fail_count

#probe_interval ⇒ Integer?

Returns (deprecated) Time (in seconds) between endpoint health probes.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.

Returns:

  • (Integer, nil) —

    (deprecated) Time (in seconds) between endpoint health probes.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 61

attribute :probe_interval

#probe_port ⇒ Object?

Returns (deprecated) The port that the health probe will use.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.

Returns:

  • (Object, nil) —

    (deprecated) The port that the health probe will use.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.



54
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 54

attribute :probe_port

#probe_protocol ⇒ :Tcp, ...

Returns (deprecated) The protocol to use for the health probe.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.

Returns:

  • (:Tcp, :Http, nil) —

    (deprecated) The protocol to use for the health probe.,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.



57
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 57

attribute :probe_protocol

#probe_request_path ⇒ Object?

Returns (deprecated) The URL that an HTTP probe will use (only relevant if probe_protocol is set to Http).,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.

Returns:

  • (Object, nil) —

    (deprecated) The URL that an HTTP probe will use (only relevant if probe_protocol is set to Http).,This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.



69
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 69

attribute :probe_request_path

#probes ⇒ Array<Hash>, ...

Returns List of probe definitions used to check endpoint health.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of probe definitions used to check endpoint health.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 39

attribute :probes

#protocol ⇒ :Tcp, ...

Returns (deprecated) The protocol (TCP or UDP) that the load balancer will use.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.

Returns:

  • (:Tcp, :Udp, nil) —

    (deprecated) The protocol (TCP or UDP) that the load balancer will use.,This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.



72
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 72

attribute :protocol

#public_ip_address_name ⇒ Object?

Returns (deprecated) Name of an existing public IP address object to associate with the security group.,This option has been deprecated, and will be removed in 2.9. Use I(frontend_ip_configurations) instead.

Returns:

  • (Object, nil) —

    (deprecated) Name of an existing public IP address object to associate with the security group.,This option has been deprecated, and will be removed in 2.9. Use I(frontend_ip_configurations) instead.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 51

attribute :public_ip_address_name

#resource_group ⇒ String

Returns Name of a resource group where the load balancer exists or will be created.

Returns:

  • (String) —

    Name of a resource group where the load balancer exists or will be created.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 12

attribute :resource_group

#sku ⇒ :Basic, ...

Returns The load balancer SKU.

Returns:

  • (:Basic, :Standard, nil) —

    The load balancer SKU.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 27

attribute :sku

#state ⇒ :absent, ...

Returns Assert the state of the load balancer. Use C(present) to create/update a load balancer, or C(absent) to delete one.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the load balancer. Use C(present) to create/update a load balancer, or C(absent) to delete one.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_loadbalancer.rb', line 20

attribute :state