Class: Ansible::Ruby::Modules::Azure_rm_virtualnetwork

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

Overview

Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the azure_rm_subnet module to associate subnets with a virtual network.

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

#address_prefixes_cidr ⇒ Array<String>, ...

Returns List of IPv4 address ranges where each is formatted using CIDR notation. Required when creating a new virtual network or using purge_address_prefixes.

Returns:

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

    List of IPv4 address ranges where each is formatted using CIDR notation. Required when creating a new virtual network or using purge_address_prefixes.



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

attribute :address_prefixes_cidr

#dns_servers ⇒ Array<String>, ...

Returns Custom list of DNS servers. Maximum length of two. The first server in the list will be treated as the Primary server. This is an explicit list. Existing DNS servers will be replaced with the specified list. Use the purge_dns_servers option to remove all custom DNS servers and revert to default Azure servers.

Returns:

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

    Custom list of DNS servers. Maximum length of two. The first server in the list will be treated as the Primary server. This is an explicit list. Existing DNS servers will be replaced with the specified list. Use the purge_dns_servers option to remove all custom DNS servers and revert to default Azure servers.



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

attribute :dns_servers

#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_virtualnetwork.rb', line 24

attribute :location

#name ⇒ String

Returns name of the virtual network.

Returns:

  • (String) —

    name of the virtual network.



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

attribute :name

#purge_address_prefixes ⇒ :yes, ...

Returns Use with state present to remove any existing address_prefixes.

Returns:

  • (:yes, :no, nil) —

    Use with state present to remove any existing address_prefixes.



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

attribute :purge_address_prefixes

#purge_dns_servers ⇒ :yes, ...

Returns Use with state present to remove existing DNS servers, reverting to default Azure servers. Mutually exclusive with dns_servers.

Returns:

  • (:yes, :no, nil) —

    Use with state present to remove existing DNS servers, reverting to default Azure servers. Mutually exclusive with dns_servers.



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

attribute :purge_dns_servers

#resource_group ⇒ String

Returns name of resource group.

Returns:

  • (String) —

    name of resource group.



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

attribute :resource_group

#state ⇒ :absent, ...

Returns Assert the state of the virtual network. Use ‘present’ to create or update and ‘absent’ to delete.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the virtual network. Use ‘present’ to create or update and ‘absent’ to delete.



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

attribute :state