network_security_perimeter_configurations

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

Overview

Name	network_security_perimeter_configurations
Type	Resource
Id	azure.cosmos_db.network_security_perimeter_configurations

Fields

The following fields are returned by SELECT queries:

get

Network Security Perimeter Configuration

Name	Datatype	Description
properties	object	Network security configuration properties.

list

Network Security Perimeter Configuration List

Name	Datatype	Description
properties	object	Network security configuration properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, networkSecurityPerimeterConfigurationName		Gets effective Network Security Perimeter Configuration for association
list	select	subscriptionId, resourceGroupName, accountName		Gets list of effective Network Security Perimeter Configuration for cosmos db account
reconcile	exec	subscriptionId, resourceGroupName, accountName, networkSecurityPerimeterConfigurationName		Refreshes any information about the association.

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
accountName	string	Cosmos DB database account name.
networkSecurityPerimeterConfigurationName	string	The name for Network Security Perimeter configuration
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets effective Network Security Perimeter Configuration for association

SELECT
properties
FROM azure.cosmos_db.network_security_perimeter_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND networkSecurityPerimeterConfigurationName = '{{ networkSecurityPerimeterConfigurationName }}' -- required
;

list

Gets list of effective Network Security Perimeter Configuration for cosmos db account

SELECT
properties
FROM azure.cosmos_db.network_security_perimeter_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

Lifecycle Methods

reconcile

Refreshes any information about the association.

EXEC azure.cosmos_db.network_security_perimeter_configurations.reconcile 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@networkSecurityPerimeterConfigurationName='{{ networkSecurityPerimeterConfigurationName }}' --required
;