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.search.network_security_perimeter_configurations

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the configuration.

Name	Datatype	Description
properties	object	Resource properties.

list_by_service

Successfully retrieved the list of configurations.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, searchServiceName, nspConfigName, subscriptionId		Gets a network security perimeter configuration.
list_by_service	select	resourceGroupName, searchServiceName, subscriptionId		Gets a list of network security perimeter configurations for a search service.
reconcile	exec	resourceGroupName, searchServiceName, nspConfigName, subscriptionId		Reconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers a manual resync with network security perimeter configurations by ensuring the search service carries the latest 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
nspConfigName	string	The network security configuration name.
resourceGroupName	string	The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName	string	The name of the Azure AI Search service associated with the specified resource group.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.

SELECT examples

get

Gets a network security perimeter configuration.

SELECT
properties
FROM azure.search.network_security_perimeter_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND searchServiceName = '{{ searchServiceName }}' -- required
AND nspConfigName = '{{ nspConfigName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Gets a list of network security perimeter configurations for a search service.

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

Lifecycle Methods

reconcile

Reconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers a manual resync with network security perimeter configurations by ensuring the search service carries the latest configuration.

EXEC azure.search.network_security_perimeter_configurations.reconcile 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@searchServiceName='{{ searchServiceName }}' --required, 
@nspConfigName='{{ nspConfigName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;