Class: Ansible::Ruby::Modules::Azure_rm_securitygroup

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

Overview

Create, update or delete a network security group. A security group contains Access Control List (ACL) rules that allow or deny network traffic to subnets or individual network interfaces. A security group is created with a set of default security rules and an empty set of security rules. Shape traffic flow by adding rules to the empty set of security rules.

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

#default_rules ⇒ Object?

Returns The set of default rules automatically added to a security group at creation. In general default rules will not be modified. Modify rules to shape the flow of traffic to or from a subnet or NIC. See rules below for the makeup of a rule dict.

Returns:

  • (Object, nil) —

    The set of default rules automatically added to a security group at creation. In general default rules will not be modified. Modify rules to shape the flow of traffic to or from a subnet or NIC. See rules below for the makeup of a rule dict.



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

attribute :default_rules

#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.



15
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_securitygroup.rb', line 15

attribute :location

#name ⇒ String?

Returns Name of the security group to operate on.

Returns:

  • (String, nil) —

    Name of the security group to operate on.



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_securitygroup.rb', line 18

attribute :name

#purge_default_rules ⇒ :yes, ...

Returns Remove any existing rules not matching those defined in the default_rules parameter.

Returns:

  • (:yes, :no, nil) —

    Remove any existing rules not matching those defined in the default_rules parameter.



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_securitygroup.rb', line 22

attribute :purge_default_rules

#purge_rules ⇒ :yes, ...

Returns Remove any existing rules not matching those defined in the rules parameters.

Returns:

  • (:yes, :no, nil) —

    Remove any existing rules not matching those defined in the rules parameters.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_securitygroup.rb', line 26

attribute :purge_rules

#resource_group ⇒ String

Returns Name of the resource group the security group belongs to.

Returns:

  • (String) —

    Name of the resource group the security group belongs to.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_securitygroup.rb', line 30

attribute :resource_group

#rules ⇒ Array<Hash>, ...

Returns Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary.

Returns:

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

    Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_securitygroup.rb', line 34

attribute :rules

#state ⇒ :absent, ...

Returns Assert the state of the security group. Set to ‘present’ to create or update a security group. Set to ‘absent’ to remove a security group.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the security group. Set to ‘present’ to create or update a security group. Set to ‘absent’ to remove a security group.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_securitygroup.rb', line 38

attribute :state