network_manager_effective_security_admin_rules
Creates, updates, deletes, gets or lists a network_manager_effective_security_admin_rules resource.
Overview
| Name | network_manager_effective_security_admin_rules |
| Type | Resource |
| Id | azure.network.network_manager_effective_security_admin_rules |
Fields
The following fields are returned by SELECT queries:
- list_network_manager_effective_security_admin_rules
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
configurationDescription | string | A description of the security admin configuration. |
kind | string | Whether the rule is custom or default. Required. Known values are: "Custom" and "Default". |
ruleCollectionAppliesToGroups | array | Groups for rule collection. |
ruleCollectionDescription | string | A description of the rule collection. |
ruleGroups | array | Effective configuration groups. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_network_manager_effective_security_admin_rules | select | resource_group_name, virtual_network_name, subscription_id | $top | List all effective security admin rules applied on a virtual network. |
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 |
|---|---|---|
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string | |
virtual_network_name | string | The name of the virtual network. Required. |
$top | integer | An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None. |
SELECT examples
- list_network_manager_effective_security_admin_rules
List all effective security admin rules applied on a virtual network.
SELECT
id,
configurationDescription,
kind,
ruleCollectionAppliesToGroups,
ruleCollectionDescription,
ruleGroups
FROM azure.network.network_manager_effective_security_admin_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_name = '{{ virtual_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;