firewall_rules

Creates, updates, deletes, gets or lists a firewall_rules resource.

Overview

Name	firewall_rules
Type	Resource
Id	azure.mongo_cluster.firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
endIpAddress	string	The end IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.
provisioningState	string	The provisioning state of the firewall rule. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". (Succeeded, Failed, Canceled, InProgress, Updating, Dropping)
startIpAddress	string	The start IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_mongo_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
endIpAddress	string	The end IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.
provisioningState	string	The provisioning state of the firewall rule. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". (Succeeded, Failed, Canceled, InProgress, Updating, Dropping)
startIpAddress	string	The start IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, mongo_cluster_name, firewall_rule_name, subscription_id		Gets information about a mongo cluster firewall rule.
list_by_mongo_cluster	select	resource_group_name, mongo_cluster_name, subscription_id		List all the firewall rules in a given mongo cluster.
create_or_update	insert	resource_group_name, mongo_cluster_name, firewall_rule_name, subscription_id		Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
create_or_update	replace	resource_group_name, mongo_cluster_name, firewall_rule_name, subscription_id		Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
delete	delete	resource_group_name, mongo_cluster_name, firewall_rule_name, subscription_id		Deletes a mongo cluster firewall rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
firewall_rule_name	string	The name of the mongo cluster firewall rule. Required.
mongo_cluster_name	string	The name of the mongo cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about a mongo cluster firewall rule.

SELECT
id,
name,
endIpAddress,
provisioningState,
startIpAddress,
systemData,
type
FROM azure.mongo_cluster.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND mongo_cluster_name = '{{ mongo_cluster_name }}' -- required
AND firewall_rule_name = '{{ firewall_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_mongo_cluster

List all the firewall rules in a given mongo cluster.

SELECT
id,
name,
endIpAddress,
provisioningState,
startIpAddress,
systemData,
type
FROM azure.mongo_cluster.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND mongo_cluster_name = '{{ mongo_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.

INSERT INTO azure.mongo_cluster.firewall_rules (
properties,
resource_group_name,
mongo_cluster_name,
firewall_rule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ mongo_cluster_name }}',
'{{ firewall_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: firewall_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the firewall_rules resource.
  - name: mongo_cluster_name
    value: "{{ mongo_cluster_name }}"
    description: Required parameter for the firewall_rules resource.
  - name: firewall_rule_name
    value: "{{ firewall_rule_name }}"
    description: Required parameter for the firewall_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the firewall_rules resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      startIpAddress: "{{ startIpAddress }}"
      endIpAddress: "{{ endIpAddress }}"

REPLACE examples

create_or_update

Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.

REPLACE azure.mongo_cluster.firewall_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND mongo_cluster_name = '{{ mongo_cluster_name }}' --required
AND firewall_rule_name = '{{ firewall_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a mongo cluster firewall rule.

DELETE FROM azure.mongo_cluster.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND mongo_cluster_name = '{{ mongo_cluster_name }}' --required
AND firewall_rule_name = '{{ firewall_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;