security_user_rules
Creates, updates, deletes, gets or lists a security_user_rules
resource.
Overview
Name | security_user_rules |
Type | Resource |
Id | azure.network.security_user_rules |
Fields
The following fields are returned by SELECT
queries:
- get
- 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. |
properties | object | Indicates the properties of the security user rule |
systemData | object | The system metadata related to this resource. |
type | string | Resource type. |
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. |
properties | object | Indicates the properties of the security user rule |
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 security user rule. | ||
list | select | Lists all Security User Rules in a rule collection. | ||
create_or_update | insert | Creates or updates a security user rule. | ||
delete | delete | force | Deletes a security user 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
- list
Gets a security user rule.
SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.security_user_rules
;
Lists all Security User Rules in a rule collection.
SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.security_user_rules
;
INSERT
examples
- create_or_update
- Manifest
Creates or updates a security user rule.
INSERT INTO azure.network.security_user_rules (
data__properties
)
SELECT
'{{ properties }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;
# Description fields are for documentation purposes
- name: security_user_rules
props:
- name: properties
value: object
description: |
Indicates the properties of the security user rule
DELETE
examples
- delete
Deletes a security user rule.
DELETE FROM azure.network.security_user_rules
WHERE force = '{{ force }}'
;