network_security_perimeters

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

Overview

Name	network_security_perimeters
Type	Resource
Id	azure.network.network_security_perimeters

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.
location	string	The geo-location where the resource lives. Required.
perimeterGuid	string	perimeter guid of the network security perimeter.
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", and "Failed". (Succeeded, Creating, Updating, Deleting, Accepted, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
location	string	The geo-location where the resource lives. Required.
perimeterGuid	string	perimeter guid of the network security perimeter.
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", and "Failed". (Succeeded, Creating, Updating, Deleting, Accepted, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
location	string	The geo-location where the resource lives. Required.
perimeterGuid	string	perimeter guid of the network security perimeter.
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", and "Failed". (Succeeded, Creating, Updating, Deleting, Accepted, Failed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, subscription_id		Gets the specified network security perimeter by the name.
list	select	resource_group_name, subscription_id	$top, $skipToken	List network security perimeters in a resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	List all network security perimeters in a subscription.
create_or_update	insert	resource_group_name, network_security_perimeter_name, subscription_id, location		Creates or updates a Network Security Perimeter.
create_or_update	replace	resource_group_name, network_security_perimeter_name, subscription_id, location		Creates or updates a Network Security Perimeter.
delete	delete	resource_group_name, network_security_perimeter_name, subscription_id	forceDeletion	Deletes a network security perimeter.
patch	exec	resource_group_name, network_security_perimeter_name, subscription_id		Patch Tags for a Network Security Perimeter.

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
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
$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.
forceDeletion	boolean	Deletes the resource even if it contains any child associations. Default value is None.

SELECT examples

get

Gets the specified network security perimeter by the name.

SELECT
id,
name,
location,
perimeterGuid,
provisioningState,
systemData,
tags,
type
FROM azure.network.network_security_perimeters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_perimeter_name = '{{ network_security_perimeter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List network security perimeters in a resource group.

SELECT
id,
name,
location,
perimeterGuid,
provisioningState,
systemData,
tags,
type
FROM azure.network.network_security_perimeters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

List all network security perimeters in a subscription.

SELECT
id,
name,
location,
perimeterGuid,
provisioningState,
systemData,
tags,
type
FROM azure.network.network_security_perimeters
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a Network Security Perimeter.

INSERT INTO azure.network.network_security_perimeters (
tags,
location,
properties,
resource_group_name,
network_security_perimeter_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_security_perimeter_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_security_perimeters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_security_perimeters resource.
  - name: network_security_perimeter_name
    value: "{{ network_security_perimeter_name }}"
    description: Required parameter for the network_security_perimeters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_security_perimeters resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The network security perimeter properties.
    value:
      provisioningState: "{{ provisioningState }}"
      perimeterGuid: "{{ perimeterGuid }}"

REPLACE examples

create_or_update

Creates or updates a Network Security Perimeter.

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

DELETE examples

delete

Deletes a network security perimeter.

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

Lifecycle Methods

patch

Patch Tags for a Network Security Perimeter.

EXEC azure.network.network_security_perimeters.patch 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_security_perimeter_name='{{ network_security_perimeter_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;