horizon_db_firewall_rules

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

Overview

Name	horizon_db_firewall_rules
Type	Resource
Id	azure.horizon_db.horizon_db_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.
description	string	The description of the HorizonDb firewall rule.
endIpAddress	string	The end IP address of the firewall rule (IPv4). Required.
provisioningState	string	The provisioning state of the firewall rule. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
startIpAddress	string	The start IP address of the firewall rule (IPv4). 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

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.
description	string	The description of the HorizonDb firewall rule.
endIpAddress	string	The end IP address of the firewall rule (IPv4). Required.
provisioningState	string	The provisioning state of the firewall rule. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", and "Provisioning". (Succeeded, Failed, Canceled, InProgress, Provisioning)
startIpAddress	string	The start IP address of the firewall rule (IPv4). 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, cluster_name, pool_name, firewall_rule_name, subscription_id		Gets information about a HorizonDb firewall rule.
list	select	resource_group_name, cluster_name, pool_name, subscription_id		Lists all HorizonDb firewall rules in a pool.
create_or_update	insert	resource_group_name, cluster_name, pool_name, firewall_rule_name, subscription_id		Creates a new HorizonDb firewall rule or updates an existing rule.
create_or_update	replace	resource_group_name, cluster_name, pool_name, firewall_rule_name, subscription_id		Creates a new HorizonDb firewall rule or updates an existing rule.
delete	delete	resource_group_name, cluster_name, pool_name, firewall_rule_name, subscription_id		Deletes a HorizonDb 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
cluster_name	string	The name of the HorizonDb cluster. Required.
firewall_rule_name	string	The name of the HorizonDb firewall rule. Required.
pool_name	string	The name of the HorizonDb pool. 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 HorizonDb firewall rule.

SELECT
id,
name,
description,
endIpAddress,
provisioningState,
startIpAddress,
systemData,
type
FROM azure.horizon_db.horizon_db_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND firewall_rule_name = '{{ firewall_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all HorizonDb firewall rules in a pool.

SELECT
id,
name,
description,
endIpAddress,
provisioningState,
startIpAddress,
systemData,
type
FROM azure.horizon_db.horizon_db_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new HorizonDb firewall rule or updates an existing rule.

INSERT INTO azure.horizon_db.horizon_db_firewall_rules (
properties,
resource_group_name,
cluster_name,
pool_name,
firewall_rule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ pool_name }}',
'{{ firewall_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

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

REPLACE examples

create_or_update

Creates a new HorizonDb firewall rule or updates an existing rule.

REPLACE azure.horizon_db.horizon_db_firewall_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND pool_name = '{{ pool_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 HorizonDb firewall rule.

DELETE FROM azure.horizon_db.horizon_db_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND firewall_rule_name = '{{ firewall_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;