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

Successful operation

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.
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Successful operation

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.
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			Gets a network manager security configuration admin rule.
list	select			List all network manager security configuration admin rules.
create_or_update	insert	data__kind		Creates or updates an admin rule.
delete	delete		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
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.

SELECT examples

get

Gets a network manager security configuration admin rule.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.network.admin_rules
;

list

List all network manager security configuration admin rules.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.network.admin_rules
;

INSERT examples

create_or_update

Creates or updates an admin rule.

INSERT INTO azure.network.admin_rules (
data__kind
)
SELECT 
'{{ kind }}' /* required */
RETURNING
id,
name,
etag,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: admin_rules
  props:
    - name: kind
      value: string
      description: |
        Whether the rule is custom or default.
      valid_values: ['Custom', 'Default']

DELETE examples

delete

Deletes an admin rule.

DELETE FROM azure.network.admin_rules
WHERE force = '{{ force }}'
;