firewall_rules

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

Overview

Name	firewall_rules
Type	Resource
Id	azure_isv.mongo_db.firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_mongo_cluster

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, mongoClusterName, firewallRuleName		Gets information about a mongo cluster firewall rule.
list_by_mongo_cluster	select	subscriptionId, resourceGroupName, mongoClusterName		List all the firewall rules in a given mongo cluster.
create_or_update	insert	subscriptionId, resourceGroupName, mongoClusterName, firewallRuleName		Creates a new firewall rule or updates an existing firewall rule on a mongo cluster.
delete	delete	subscriptionId, resourceGroupName, mongoClusterName, firewallRuleName		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
firewallRuleName	string	The name of the mongo cluster firewall rule.
mongoClusterName	string	The name of the mongo cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about a mongo cluster firewall rule.

SELECT
properties
FROM azure_isv.mongo_db.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mongoClusterName = '{{ mongoClusterName }}' -- required
AND firewallRuleName = '{{ firewallRuleName }}' -- required
;

list_by_mongo_cluster

List all the firewall rules in a given mongo cluster.

SELECT
properties
FROM azure_isv.mongo_db.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mongoClusterName = '{{ mongoClusterName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_isv.mongo_db.firewall_rules (
data__properties,
subscriptionId,
resourceGroupName,
mongoClusterName,
firewallRuleName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ mongoClusterName }}',
'{{ firewallRuleName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: firewall_rules
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the firewall_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: mongoClusterName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: firewallRuleName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

DELETE examples

delete

Deletes a mongo cluster firewall rule.

DELETE FROM azure_isv.mongo_db.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mongoClusterName = '{{ mongoClusterName }}' --required
AND firewallRuleName = '{{ firewallRuleName }}' --required
;