Network Security Perimeter Configurations - List By Service

Reference

Service:: Search Management

API Version:: 2024-03-01-preview

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations?api-version=2024-03-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	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	path	True	string	The name of the Azure AI Search service associated with the specified resource group. Regex pattern: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
subscriptionId	path	True	string	The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.
api-version	query	True	string	The API version to use for each request.

Responses

Name	Type	Description
200 OK	NetworkSecurityPerimeterConfigurationListResult	Successfully retrieved the list of configurations.
Other Status Codes	CloudError	An unexpected error occurred during the operation.

Security

azure_auth

Specifies an implicit grant flow, as supported on the Microsoft Identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List NSP configs by search service

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations?api-version=2024-03-01-preview

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python network_security_perimeter_configurations_list_by_service.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.network_security_perimeter_configurations.list_by_service(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsListByService.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsListByService.json
func ExampleNetworkSecurityPerimeterConfigurationsClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().NewListByServicePager("rg1", "mysearchservice", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.NetworkSecurityPerimeterConfigurationListResult = armsearch.NetworkSecurityPerimeterConfigurationListResult{
		// 	Value: []*armsearch.NetworkSecurityPerimeterConfiguration{
		// 		{
		// 			Name: to.Ptr("00000001-2222-3333-4444-111144444444.assoc1"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1"),
		// 			Properties: &armsearch.NetworkSecurityPerimeterConfigurationProperties{
		// 				NetworkSecurityPerimeter: &armsearch.NSPConfigPerimeter{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1"),
		// 					Location: to.Ptr("westus"),
		// 				},
		// 				Profile: &armsearch.NSPConfigProfile{
		// 					Name: to.Ptr("profile1"),
		// 					AccessRules: []*armsearch.NSPConfigAccessRule{
		// 						{
		// 							Name: to.Ptr("rule1"),
		// 							Properties: &armsearch.NSPConfigAccessRuleProperties{
		// 								AddressPrefixes: []*string{
		// 									to.Ptr("148.0.0.0/8"),
		// 									to.Ptr("152.4.6.0/24")},
		// 									Direction: to.Ptr("Inbound"),
		// 								},
		// 						}},
		// 						AccessRulesVersion: to.Ptr("0"),
		// 					},
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 					ResourceAssociation: &armsearch.NSPConfigAssociation{
		// 						Name: to.Ptr("assoc1"),
		// 						AccessMode: to.Ptr("Enforced"),
		// 					},
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of network security perimeter configurations for a search service.
 *
 * @summary Gets a list of network security perimeter configurations for a search service.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsListByService.json
 */
async function listNspConfigsBySearchService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.networkSecurityPerimeterConfigurations.listByService(
    resourceGroupName,
    searchServiceName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsListByService.json
// this example is just showing the usage of "NetworkSecurityPerimeterConfigurations_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// get the collection of this NetworkSecurityPerimeterConfigurationResource
NetworkSecurityPerimeterConfigurationCollection collection = searchService.GetNetworkSecurityPerimeterConfigurations();

// invoke the operation and iterate over the result
await foreach (NetworkSecurityPerimeterConfigurationResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetworkSecurityPerimeterConfigurationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
      "name": "00000001-2222-3333-4444-111144444444.assoc1",
      "type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
      "properties": {
        "provisioningState": "Accepted",
        "networkSecurityPerimeter": {
          "id": "/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
          "location": "westus"
        },
        "resourceAssociation": {
          "name": "assoc1",
          "accessMode": "Enforced"
        },
        "profile": {
          "name": "profile1",
          "accessRulesVersion": "0",
          "accessRules": [
            {
              "name": "rule1",
              "properties": {
                "direction": "Inbound",
                "addressPrefixes": [
                  "148.0.0.0/8",
                  "152.4.6.0/24"
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

Definitions

Name	Description
CloudError	Contains information about an API error.
CloudErrorBody	Describes a particular API error with an error code and a message.
NetworkSecurityPerimeterConfiguration	Network security perimeter configuration for a server.
NetworkSecurityPerimeterConfigurationListResult	A list of network security perimeter configurations for a server.
NSPConfigAccessRule	An access rule for a network security perimeter configuration.
NSPConfigAccessRuleProperties	The properties for the access rules in a network security perimeter configuration.
NSPConfigAssociation	The resource association for the network security perimeter.
NSPConfigNetworkSecurityPerimeterRule	The network security perimeter properties present in a configuration rule.
NSPConfigPerimeter	The perimeter for a network security perimeter configuration.
NSPConfigProfile	The profile for a network security perimeter configuration.
NSPProvisioningIssue	An object to describe any issues with provisioning network security perimeters to a search service.
NSPProvisioningIssueProperties	The properties to describe any issues with provisioning network security perimeters to a search service.

CloudError

Contains information about an API error.

Name	Type	Description
error	CloudErrorBody	Describes a particular API error with an error code and a message.
message	string	A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property).

CloudErrorBody

Describes a particular API error with an error code and a message.

Name	Type	Description
code	string	An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.
details	CloudErrorBody[]	Contains nested errors that are related to this error.
message	string	A message that describes the error in detail and provides debugging information.
target	string	The target of the particular error (for example, the name of the property in error).

NetworkSecurityPerimeterConfiguration

Network security perimeter configuration for a server.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.networkSecurityPerimeter	NSPConfigPerimeter	The perimeter for a network security perimeter configuration.
properties.profile	NSPConfigProfile	The profile for a network security perimeter configuration.
properties.provisioningIssues	NSPProvisioningIssue[]	An object to describe any issues with provisioning network security perimeters to a search service.
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	The resource association for the network security perimeter.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationListResult

A list of network security perimeter configurations for a server.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	NetworkSecurityPerimeterConfiguration[]	Array of results.

NSPConfigAccessRule

An access rule for a network security perimeter configuration.

Name	Type	Description
name	string
properties	NSPConfigAccessRuleProperties	The properties for the access rules in a network security perimeter configuration.

NSPConfigAccessRuleProperties

The properties for the access rules in a network security perimeter configuration.

Name	Type	Description
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	The network security perimeter properties present in a configuration rule.
subscriptions	string[]

NSPConfigAssociation

The resource association for the network security perimeter.

Name	Type	Description
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

The network security perimeter properties present in a configuration rule.

Name	Type	Description
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

The perimeter for a network security perimeter configuration.

Name	Type	Description
id	string
location	string
perimeterGuid	string

NSPConfigProfile

The profile for a network security perimeter configuration.

Name	Type	Description
accessRules	NSPConfigAccessRule[]	An access rule for a network security perimeter configuration.
accessRulesVersion	string
name	string

NSPProvisioningIssue

An object to describe any issues with provisioning network security perimeters to a search service.

Name	Type	Description
name	string
properties	NSPProvisioningIssueProperties	The properties to describe any issues with provisioning network security perimeters to a search service.

NSPProvisioningIssueProperties

The properties to describe any issues with provisioning network security perimeters to a search service.

Name	Type	Description
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]

Share via

Network Security Perimeter Configurations - List By Service

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List NSP configs by search service

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

NetworkSecurityPerimeterConfiguration

NetworkSecurityPerimeterConfigurationListResult

NSPConfigAccessRule

NSPConfigAccessRuleProperties

NSPConfigAssociation

NSPConfigNetworkSecurityPerimeterRule

NSPConfigPerimeter

NSPConfigProfile

NSPProvisioningIssue

NSPProvisioningIssueProperties

Additional resources