security_rules

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

Overview

Name	security_rules
Type	Resource
Id	azure.network.security_rules

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting SecurityRule resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the security rule.
type	string	The type of the resource.

list

Request successful. The operation returns a list of SecurityRule resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the security rule.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkSecurityGroupName, securityRuleName, subscriptionId		Get the specified network security rule.
list	select	resourceGroupName, networkSecurityGroupName, subscriptionId		Gets all security rules in a network security group.
create_or_update	insert	resourceGroupName, networkSecurityGroupName, securityRuleName, subscriptionId		Creates or updates a security rule in the specified network security group.
delete	delete	resourceGroupName, networkSecurityGroupName, securityRuleName, subscriptionId		Deletes the specified network security 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
networkSecurityGroupName	string	The name of the network security group.
resourceGroupName	string	The name of the resource group.
securityRuleName	string	The name of the security rule.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the specified network security rule.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.security_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkSecurityGroupName = '{{ networkSecurityGroupName }}' -- required
AND securityRuleName = '{{ securityRuleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all security rules in a network security group.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.security_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkSecurityGroupName = '{{ networkSecurityGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a security rule in the specified network security group.

INSERT INTO azure.network.security_rules (
data__properties,
data__name,
data__type,
data__id,
resourceGroupName,
networkSecurityGroupName,
securityRuleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ type }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ networkSecurityGroupName }}',
'{{ securityRuleName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the security_rules resource.
    - name: networkSecurityGroupName
      value: string
      description: Required parameter for the security_rules resource.
    - name: securityRuleName
      value: string
      description: Required parameter for the security_rules resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the security_rules resource.
    - name: properties
      value: object
      description: |
        Properties of the security rule.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: type
      value: string
      description: |
        The type of the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified network security rule.

DELETE FROM azure.network.security_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND networkSecurityGroupName = '{{ networkSecurityGroupName }}' --required
AND securityRuleName = '{{ securityRuleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;