azure.azcollection.azure_rm_securitygroup module – Manage Azure network security groups — Ansible Documentation

ad_user

string

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

adfs_authority_url

string

added in azure.azcollection 0.0.1

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

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

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.

Choices:

• false

• true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

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.

Choices:

• "auto" ← (default)

• "cli"

• "credential_file"

• "env"

• "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

• "ignore"

• "validate"

client_id

string

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

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

default_rules

string

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.

location

string

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

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string

Name of the security group to operate on.

password

string

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

profile

string

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

purge_default_rules

boolean

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

Choices:

• false ← (default)

• true

purge_rules

boolean

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

Choices:

• false ← (default)

• true

resource_group

string / required

Name of the resource group the security group belongs to.

rules

string

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

access

string

Whether or not to allow the traffic flow.

Choices:

• "Allow" ← (default)

• "Deny"

description

string

Short description of the rule’s purpose.

destination_address_prefix

string

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.

Asterisk * and default tags can only be specified as single string type, not as a list of string.

Default: "*"

destination_application_security_groups

list / elements=any

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.

destination_port_range

string

Port or range of ports to which traffic is headed.

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

Default: "*"

direction

string

Indicates the direction of the traffic flow.

Choices:

• "Inbound" ← (default)

• "Outbound"

name

string / required

Unique name for the rule.

priority

string / required

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

protocol

string

Accepted traffic protocol.

Choices:

• "Udp"

• "Tcp"

• "Icmp"

• "*" ← (default)

source_address_prefix

string

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.

Asterisk * and default tags can only be specified as single string type, not as a list of string.

Default: "*"

source_application_security_groups

list / elements=any

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.

source_port_range

string

Port or range of ports from which traffic originates.

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

Default: "*"

secret

string

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

state

string

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.

Choices:

• "absent"

• "present" ← (default)

subscription_id

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.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

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

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.