Microsoft.DocumentDB databaseAccounts/networkSecurityPerimeterConfigurations

Bicep resource definition

The databaseAccounts/networkSecurityPerimeterConfigurations resource type is read-only and cannot be deployed. Existing instances can be retrieved through resource provider operations.

For a list of changed properties in each API version, see change log.

Property Values

Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: databaseAccounts
properties Network security configuration properties. NetworkSecurityPerimeterConfigurationProperties

AccessRule

Name Description Value
name Name of the access rule string
properties Properties of the access rule AccessRuleProperties

AccessRuleProperties

Name Description Value
addressPrefixes Address prefixes in the CIDR format for inbound rules string[]
direction Direction of the access rule 'Inbound'
'Outbound'
emailAddresses Email addresses for outbound rules string[]
fullyQualifiedDomainNames Fully qualified domain names (FQDN) for outbound rules string[]
networkSecurityPerimeters Network security perimeters for inbound rules NetworkSecurityPerimeter[]
phoneNumbers Phone numbers for outbound rules string[]
subscriptions Subscriptions for inbound rules AnonymousModel[]

AnonymousModel

Name Description Value
id The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') string

NetworkSecurityPerimeter

Name Description Value
id Fully qualified Azure resource ID of the NSP resource string
location Location of the network security perimeter string
perimeterGuid Universal unique ID (UUID) of the network security perimeter string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

NetworkSecurityPerimeterConfigurationProperties

Name Description Value
networkSecurityPerimeter Information about the network security perimeter (NSP) NetworkSecurityPerimeter
profile Network security perimeter configuration profile NetworkSecurityProfile
resourceAssociation Information about the resource association ResourceAssociation

NetworkSecurityProfile

Name Description Value
accessRules List of Access Rules AccessRule[]
accessRulesVersion Current access rules version int
diagnosticSettingsVersion Current diagnostic settings version int
enabledLogCategories List of log categories that are enabled string[]
name Name of the profile string

ResourceAssociation

Name Description Value
accessMode Access mode of the resource association 'Audit'
'Enforced'
'Learning'
name Name of the resource association string

ARM template resource definition

The databaseAccounts/networkSecurityPerimeterConfigurations resource type is read-only and cannot be deployed. Existing instances can be retrieved through resource provider operations.

For a list of changed properties in each API version, see change log.

Property Values

Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations

Name Description Value
apiVersion The api version '2026-04-01-preview'
name The resource name string

Constraints:
Pattern = ^.*$ (required)
properties Network security configuration properties. NetworkSecurityPerimeterConfigurationProperties
type The resource type 'Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations'

AccessRule

Name Description Value
name Name of the access rule string
properties Properties of the access rule AccessRuleProperties

AccessRuleProperties

Name Description Value
addressPrefixes Address prefixes in the CIDR format for inbound rules string[]
direction Direction of the access rule 'Inbound'
'Outbound'
emailAddresses Email addresses for outbound rules string[]
fullyQualifiedDomainNames Fully qualified domain names (FQDN) for outbound rules string[]
networkSecurityPerimeters Network security perimeters for inbound rules NetworkSecurityPerimeter[]
phoneNumbers Phone numbers for outbound rules string[]
subscriptions Subscriptions for inbound rules AnonymousModel[]

AnonymousModel

Name Description Value
id The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') string

NetworkSecurityPerimeter

Name Description Value
id Fully qualified Azure resource ID of the NSP resource string
location Location of the network security perimeter string
perimeterGuid Universal unique ID (UUID) of the network security perimeter string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

NetworkSecurityPerimeterConfigurationProperties

Name Description Value
networkSecurityPerimeter Information about the network security perimeter (NSP) NetworkSecurityPerimeter
profile Network security perimeter configuration profile NetworkSecurityProfile
resourceAssociation Information about the resource association ResourceAssociation

NetworkSecurityProfile

Name Description Value
accessRules List of Access Rules AccessRule[]
accessRulesVersion Current access rules version int
diagnosticSettingsVersion Current diagnostic settings version int
enabledLogCategories List of log categories that are enabled string[]
name Name of the profile string

ResourceAssociation

Name Description Value
accessMode Access mode of the resource association 'Audit'
'Enforced'
'Learning'
name Name of the resource association string

Terraform (AzAPI provider) resource definition

The databaseAccounts/networkSecurityPerimeterConfigurations resource type is read-only and cannot be deployed. Existing instances can be retrieved through resource provider operations.

For a list of changed properties in each API version, see change log.

Property Values

Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations

Name Description Value
name The resource name string

Constraints:
Pattern = ^.*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts
properties Network security configuration properties. NetworkSecurityPerimeterConfigurationProperties
type The resource type "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations@2026-04-01-preview"

AccessRule

Name Description Value
name Name of the access rule string
properties Properties of the access rule AccessRuleProperties

AccessRuleProperties

Name Description Value
addressPrefixes Address prefixes in the CIDR format for inbound rules string[]
direction Direction of the access rule 'Inbound'
'Outbound'
emailAddresses Email addresses for outbound rules string[]
fullyQualifiedDomainNames Fully qualified domain names (FQDN) for outbound rules string[]
networkSecurityPerimeters Network security perimeters for inbound rules NetworkSecurityPerimeter[]
phoneNumbers Phone numbers for outbound rules string[]
subscriptions Subscriptions for inbound rules AnonymousModel[]

AnonymousModel

Name Description Value
id The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') string

NetworkSecurityPerimeter

Name Description Value
id Fully qualified Azure resource ID of the NSP resource string
location Location of the network security perimeter string
perimeterGuid Universal unique ID (UUID) of the network security perimeter string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

NetworkSecurityPerimeterConfigurationProperties

Name Description Value
networkSecurityPerimeter Information about the network security perimeter (NSP) NetworkSecurityPerimeter
profile Network security perimeter configuration profile NetworkSecurityProfile
resourceAssociation Information about the resource association ResourceAssociation

NetworkSecurityProfile

Name Description Value
accessRules List of Access Rules AccessRule[]
accessRulesVersion Current access rules version int
diagnosticSettingsVersion Current diagnostic settings version int
enabledLogCategories List of log categories that are enabled string[]
name Name of the profile string

ResourceAssociation

Name Description Value
accessMode Access mode of the resource association 'Audit'
'Enforced'
'Learning'
name Name of the resource association string