network_security_perimeter_logging_configurations

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

Overview

Name	network_security_perimeter_logging_configurations
Type	Resource
Id	azure.network.network_security_perimeter_logging_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
enabledLogCategories	array	The log categories to enable in the NSP logging configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The version of the NSP logging configuration.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
enabledLogCategories	array	The log categories to enable in the NSP logging configuration.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	The version of the NSP logging configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_security_perimeter_name, logging_configuration_name, subscription_id		Gets the NSP logging configuration.
list	select	resource_group_name, network_security_perimeter_name, subscription_id		Lists the NSP logging configuration.
create_or_update	insert	resource_group_name, network_security_perimeter_name, logging_configuration_name, subscription_id		Creates or updates NSP logging configuration.
create_or_update	replace	resource_group_name, network_security_perimeter_name, logging_configuration_name, subscription_id		Creates or updates NSP logging configuration.
delete	delete	resource_group_name, network_security_perimeter_name, logging_configuration_name, subscription_id		Deletes an NSP Logging configuration.

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
logging_configuration_name	string	The name of the NSP logging configuration. Accepts 'instance' as name. Required.
network_security_perimeter_name	string	The name of the network security perimeter. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the NSP logging configuration.

SELECT
id,
name,
enabledLogCategories,
systemData,
type,
version
FROM azure.network.network_security_perimeter_logging_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND logging_configuration_name = '{{ logging_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the NSP logging configuration.

SELECT
id,
name,
enabledLogCategories,
systemData,
type,
version
FROM azure.network.network_security_perimeter_logging_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates NSP logging configuration.

INSERT INTO azure.network.network_security_perimeter_logging_configurations (
properties,
resource_group_name,
network_security_perimeter_name,
logging_configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_security_perimeter_name }}',
'{{ logging_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_security_perimeter_logging_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_security_perimeter_logging_configurations resource.
  - name: network_security_perimeter_name
    value: "{{ network_security_perimeter_name }}"
    description: Required parameter for the network_security_perimeter_logging_configurations resource.
  - name: logging_configuration_name
    value: "{{ logging_configuration_name }}"
    description: Required parameter for the network_security_perimeter_logging_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_security_perimeter_logging_configurations resource.
  - name: properties
    description: |
      Properties of the NSP logging configuration.
    value:
      enabledLogCategories:
        - "{{ enabledLogCategories }}"
      version: "{{ version }}"

REPLACE examples

create_or_update

Creates or updates NSP logging configuration.

REPLACE azure.network.network_security_perimeter_logging_configurations
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' --required
AND logging_configuration_name = '{{ logging_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an NSP Logging configuration.

DELETE FROM azure.network.network_security_perimeter_logging_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' --required
AND logging_configuration_name = '{{ logging_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;