admin_rules

Creates, updates, deletes, gets or lists an admin_rules resource.

Overview

Name	admin_rules
Type	Resource
Id	azure.network.admin_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
kind	string	Whether the rule is custom or default. Required. Known values are: "Custom" and "Default".
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
kind	string	Whether the rule is custom or default. Required. Known values are: "Custom" and "Default".
systemData	object	The system metadata related to this resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_manager_name, configuration_name, rule_collection_name, rule_name, subscription_id		Gets a network manager security configuration admin rule.
list	select	resource_group_name, network_manager_name, configuration_name, rule_collection_name, subscription_id	$top, $skipToken	List all network manager security configuration admin rules.
create_or_update	insert	resource_group_name, network_manager_name, configuration_name, rule_collection_name, rule_name, subscription_id, kind		Creates or updates an admin rule.
create_or_update	replace	resource_group_name, network_manager_name, configuration_name, rule_collection_name, rule_name, subscription_id, kind		Creates or updates an admin rule.
delete	delete	resource_group_name, network_manager_name, configuration_name, rule_collection_name, rule_name, subscription_id	force	Deletes an admin 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
configuration_name	string	The name of the network manager Security Configuration. Required.
network_manager_name	string	The name of the network manager. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_collection_name	string	The name of the network manager security Configuration rule collection. Required.
rule_name	string	The name of the rule. Required.
subscription_id	string
$skipToken	string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.
force	boolean	Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. Default value is None.

SELECT examples

get

Gets a network manager security configuration admin rule.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.network.admin_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND rule_collection_name = '{{ rule_collection_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all network manager security configuration admin rules.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.network.admin_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND rule_collection_name = '{{ rule_collection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates an admin rule.

INSERT INTO azure.network.admin_rules (
kind,
resource_group_name,
network_manager_name,
configuration_name,
rule_collection_name,
rule_name,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ configuration_name }}',
'{{ rule_collection_name }}',
'{{ rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: admin_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the admin_rules resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the admin_rules resource.
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the admin_rules resource.
  - name: rule_collection_name
    value: "{{ rule_collection_name }}"
    description: Required parameter for the admin_rules resource.
  - name: rule_name
    value: "{{ rule_name }}"
    description: Required parameter for the admin_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the admin_rules resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Whether the rule is custom or default. Required. Known values are: "Custom" and "Default".

REPLACE examples

create_or_update

Creates or updates an admin rule.

REPLACE azure.network.admin_rules
SET 
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND rule_collection_name = '{{ rule_collection_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
etag,
kind,
systemData,
type;

DELETE examples

delete

Deletes an admin rule.

DELETE FROM azure.network.admin_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND rule_collection_name = '{{ rule_collection_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;