azure_rm_securitygroup – Manage Azure network security groups

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

string

added in 2.6

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

string

added in 2.5

"latest"

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object's metadata.

string

added in 2.5

Controls the source of the credentials to use for authentication.

If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.

auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.

When set to cli, the credentials will be sources from the default Azure CLI profile.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

string

added in 2.5

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

string

Azure client ID. Use when authenticating with a Service Principal.

string

added in 2.4

"AzureCloud"

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

-

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.

-

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

-

Name of the security group to operate on.

-

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

string

Security profile found in ~/.azure/credentials file.

boolean

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

boolean

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

- / required

Name of the resource group the security group belongs to.

-

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

-

Whether or not to allow the traffic flow.

-

Short description of the rule's purpose.

-

"*"

The destination address prefix.

CIDR or destination IP range.

Asterisk * can also be used to match all source IPs.

Default tags such as VirtualNetwork, AzureLoadBalancer and Internet can also be used.

It can accept string type or a list of string type.

list

List of the destination application security groups.

It could be list of resource id.

It could be list of names in same resource group.

It could be list of dict containing resource_group and name.

It is mutually exclusive with destination_address_prefix and destination_address_prefixes.

-

"*"

Port or range of ports to which traffic is headed.

It can accept string type or a list of string type.

-

Indicates the direction of the traffic flow.

- / required

Unique name for the rule.

- / required

Order in which to apply the rule. Must a unique integer between 100 and 4096 inclusive.

-

Accepted traffic protocol.

-

"*"

The CIDR or source IP range.

Asterisk * can also be used to match all source IPs.

Default tags such as VirtualNetwork, AzureLoadBalancer and Internet can also be used.

If this is an ingress rule, specifies where network traffic originates from.

It can accept string type or a list of string type.

list

List of the source application security groups.

It could be list of resource id.

It could be list of names in same resource group.

It could be list of dict containing resource_group and name.

It is mutually exclusive with source_address_prefix and source_address_prefixes.

-

"*"

Port or range of ports from which traffic originates.

It can accept string type or a list of string type.

string

Azure client secret. Use when authenticating with a Service Principal.

-

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.

string

Your Azure subscription Id.

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

string

Azure tenant ID. Use when authenticating with a Service Principal.

dictionary

Current state of the security group.

{'default_rules': [{'access': 'Allow', 'description': 'Allow inbound traffic from all VMs in VNET', 'destination_address_prefix': 'VirtualNetwork', 'destination_port_range': '*', 'direction': 'Inbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowVnetInBound', 'name': 'AllowVnetInBound', 'priority': 65000, 'protocol': '*', 'provisioning_state': 'Succeeded', 'source_address_prefix': 'VirtualNetwork', 'source_port_range': '*'}, {'access': 'Allow', 'description': 'Allow inbound traffic from azure load balancer', 'destination_address_prefix': '*', 'destination_port_range': '*', 'direction': 'Inbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowAzureLoadBalancerInBound', 'name': 'AllowAzureLoadBalancerInBound', 'priority': 65001, 'protocol': '*', 'provisioning_state': 'Succeeded', 'source_address_prefix': 'AzureLoadBalancer', 'source_port_range': '*'}, {'access': 'Deny', 'description': 'Deny all inbound traffic', 'destination_address_prefix': '*', 'destination_port_range': '*', 'direction': 'Inbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/DenyAllInBound', 'name': 'DenyAllInBound', 'priority': 65500, 'protocol': '*', 'provisioning_state': 'Succeeded', 'source_address_prefix': '*', 'source_port_range': '*'}, {'access': 'Allow', 'description': 'Allow outbound traffic from all VMs to all VMs in VNET', 'destination_address_prefix': 'VirtualNetwork', 'destination_port_range': '*', 'direction': 'Outbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowVnetOutBound', 'name': 'AllowVnetOutBound', 'priority': 65000, 'protocol': '*', 'provisioning_state': 'Succeeded', 'source_address_prefix': 'VirtualNetwork', 'source_port_range': '*'}, {'access': 'Allow', 'description': 'Allow outbound traffic from all VMs to Internet', 'destination_address_prefix': 'Internet', 'destination_port_range': '*', 'direction': 'Outbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowInternetOutBound', 'name': 'AllowInternetOutBound', 'priority': 65001, 'protocol': '*', 'provisioning_state': 'Succeeded', 'source_address_prefix': '*', 'source_port_range': '*'}, {'access': 'Deny', 'description': 'Deny all outbound traffic', 'destination_address_prefix': '*', 'destination_port_range': '*', 'direction': 'Outbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/DenyAllOutBound', 'name': 'DenyAllOutBound', 'priority': 65500, 'protocol': '*', 'provisioning_state': 'Succeeded', 'source_address_prefix': '*', 'source_port_range': '*'}], 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup', 'location': 'westus', 'name': 'mysecgroup', 'network_interfaces': [], 'rules': [{'access': 'Deny', 'description': None, 'destination_address_prefix': '*', 'destination_port_range': '22', 'direction': 'Inbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/securityRules/DenySSH', 'name': 'DenySSH', 'priority': 100, 'protocol': 'Tcp', 'provisioning_state': 'Succeeded', 'source_address_prefix': '*', 'source_port_range': '*'}, {'access': 'Allow', 'description': None, 'destination_address_prefix': '*', 'destination_port_range': '22', 'direction': 'Inbound', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/securityRules/AllowSSH', 'name': 'AllowSSH', 'priority': 101, 'protocol': 'Tcp', 'provisioning_state': 'Succeeded', 'source_address_prefix': '174.109.158.0/24', 'source_port_range': '*'}], 'subnets': [], 'tags': {'delete': 'on-exit', 'foo': 'bar', 'testing': 'testing'}, 'type': 'Microsoft.Network/networkSecurityGroups'}