Network Security Perimeter Configurations - Get

Service:: Search Management

API-versie:: 2025-05-01

Hiermee haalt u een perimeterconfiguratie voor netwerkbeveiliging op.

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

URI-parameters

Name	In	Vereist	Type	Description
nspConfigName	path	True	string minLength: 38 maxLength: 100 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\.[a-z][a-z0-9]*$	De naam van de netwerkbeveiligingsperimeterconfiguratie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	De naam van de Azure AI Search-service die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	NetworkSecurityPerimeterConfiguration	Azure-bewerking is voltooid.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get an NSP config by name

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2025-05-01

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/v2"
)

// Generated from example definition: 2025-05-01/NetworkSecurityPerimeterConfigurationsGet.json
func ExampleNetworkSecurityPerimeterConfigurationsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().Get(ctx, "rg1", "mysearchservice", "00000001-2222-3333-4444-111144444444.assoc1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.NetworkSecurityPerimeterConfigurationsClientGetResponse{
	// 	NetworkSecurityPerimeterConfiguration: &armsearch.NetworkSecurityPerimeterConfiguration{
	// 		Name: to.Ptr("00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Type: to.Ptr("Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Properties: &armsearch.NetworkSecurityPerimeterConfigurationProperties{
	// 			NetworkSecurityPerimeter: &armsearch.NetworkSecurityPerimeter{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1"),
	// 				Location: to.Ptr("westus"),
	// 			},
	// 			Profile: &armsearch.NetworkSecurityProfile{
	// 				Name: to.Ptr("profile1"),
	// 				AccessRules: []*armsearch.AccessRule{
	// 					{
	// 						Name: to.Ptr("rule1"),
	// 						Properties: &armsearch.AccessRuleProperties{
	// 							AddressPrefixes: []*string{
	// 								to.Ptr("148.0.0.0/8"),
	// 								to.Ptr("152.4.6.0/24"),
	// 							},
	// 							Direction: to.Ptr(armsearch.AccessRuleDirectionInbound),
	// 						},
	// 					},
	// 				},
	// 				AccessRulesVersion: to.Ptr[int32](0),
	// 			},
	// 			ProvisioningState: to.Ptr(armsearch.NetworkSecurityPerimeterConfigurationProvisioningStateAccepted),
	// 			ResourceAssociation: &armsearch.ResourceAssociation{
	// 				Name: to.Ptr("assoc1"),
	// 				AccessMode: to.Ptr(armsearch.ResourceAssociationAccessModeEnforced),
	// 			},
	// 		},
	// 	},
	// }
}

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
AccessRule	Toegangsregel in een perimeterconfiguratieprofiel voor netwerkbeveiliging
AccessRuleDirection	Richting van toegangsregel
AccessRuleProperties	Eigenschappen van toegangsregel
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
createdByType	Het type identiteit waarmee de resource is gemaakt.
IssueType	Type probleem
NetworkSecurityPerimeter	Informatie over een netwerkbeveiligingsperimeter (NSP)
NetworkSecurityPerimeterConfiguration	NSP-configuratieresource (Network Security Perimeter)
NetworkSecurityPerimeterConfigurationProperties	Eigenschappen van netwerkbeveiligingsconfiguratie.
NetworkSecurityPerimeterConfigurationProvisioningState	Inrichtingsstatus van een netwerkbeveiligingsperimeterconfiguratie die wordt gemaakt of bijgewerkt.
NetworkSecurityProfile	Configuratieprofiel voor netwerkbeveiligingsperimeter
ProvisioningIssue	Beschrijft een inrichtingsprobleem voor een perimeterconfiguratie voor netwerkbeveiliging
ProvisioningIssueProperties	Details van een inrichtingsprobleem voor een netwerkbeveiligingsperimeterconfiguratie (NSP). Resourceproviders moeten afzonderlijke elementen voor inrichtingsprobleem genereren voor elk afzonderlijk gedetecteerd probleem en een zinvolle en onderscheidende beschrijving bevatten, evenals eventuele relevante voorgesteldeResourceIds en suggestedAccessRules
ResourceAssociation	Informatie over resourcekoppeling
ResourceAssociationAccessMode	Toegangsmodus van de resourcekoppeling
Severity	Ernst van het probleem.
Subscriptions	Abonnementen voor binnenkomende regels
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AccessRule

Object

Toegangsregel in een perimeterconfiguratieprofiel voor netwerkbeveiliging

Name	Type	Description
name	string	Naam van de toegangsregel
properties	AccessRuleProperties	Eigenschappen van toegangsregel

AccessRuleDirection

Opsomming

Richting van toegangsregel

Waarde	Description
Inbound	Van toepassing op inkomend netwerkverkeer op de beveiligde resources.
Outbound	Van toepassing op uitgaand netwerkverkeer van de beveiligde resources

AccessRuleProperties

Object

Eigenschappen van toegangsregel

Name	Type	Description
addressPrefixes	string[]	Adresvoorvoegsels in de CIDR-indeling voor binnenkomende regels
direction	AccessRuleDirection	Richting van toegangsregel
emailAddresses	string[]	E-mailadressen voor uitgaande regels
fullyQualifiedDomainNames	string[]	FQDN (Fully Qualified Domain Names) voor uitgaande regels
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Netwerkbeveiligingsperimeter voor binnenkomende regels
phoneNumbers	string[]	Telefoonnummers voor uitgaande regels
subscriptions	Subscriptions[]	Abonnementen voor binnenkomende regels

CloudError

Object

Bevat informatie over een API-fout.

Name	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message	string	Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

IssueType

Opsomming

Type probleem

Waarde	Description
Unknown	Onbekend probleemtype
ConfigurationPropagationFailure	Er is een fout opgetreden tijdens het toepassen van de netwerkbeveiligingsperimeterconfiguratie (NSP).
MissingPerimeterConfiguration	Er treedt een probleem met de netwerkverbinding op in de resource die kan worden opgelost door nieuwe resources toe te voegen aan de netwerkbeveiligingsperimeter (NSP) of door toegangsregels te wijzigen.
MissingIdentityConfiguration	Er is geen beheerde identiteit gekoppeld aan de resource. De resource kan nog steeds binnenkomend verkeer van de netwerkbeveiligingsperimeter (NSP) valideren of overeenkomende regels voor binnenkomende toegang, maar kan geen uitgaande toegang uitvoeren als lid van de NSP.

NetworkSecurityPerimeter

Object

Informatie over een netwerkbeveiligingsperimeter (NSP)

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde Azure-resource-id van de NSP-resource
location	string	Locatie van de netwerkbeveiligingsperimeter
perimeterGuid	string (uuid)	Universal Unique ID (UUID) van de netwerkbeveiligingsperimeter

NetworkSecurityPerimeterConfiguration

Object

NSP-configuratieresource (Network Security Perimeter)

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties	NetworkSecurityPerimeterConfigurationProperties	Eigenschappen van netwerkbeveiligingsconfiguratie.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

NetworkSecurityPerimeterConfigurationProperties

Object

Eigenschappen van netwerkbeveiligingsconfiguratie.

Name	Type	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Informatie over een netwerkbeveiligingsperimeter (NSP)
profile	NetworkSecurityProfile	Configuratieprofiel voor netwerkbeveiligingsperimeter
provisioningIssues	ProvisioningIssue[]	Lijst met inrichtingsproblemen, indien van toepassing
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Inrichtingsstatus van een netwerkbeveiligingsperimeterconfiguratie die wordt gemaakt of bijgewerkt.
resourceAssociation	ResourceAssociation	Informatie over resourcekoppeling

NetworkSecurityPerimeterConfigurationProvisioningState

Opsomming

Inrichtingsstatus van een netwerkbeveiligingsperimeterconfiguratie die wordt gemaakt of bijgewerkt.

Waarde	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Object

Configuratieprofiel voor netwerkbeveiligingsperimeter

Name	Type	Description
accessRules	AccessRule[]	Lijst met toegangsregels
accessRulesVersion	integer (int32)	Huidige versie van toegangsregels
diagnosticSettingsVersion	integer (int32)	Huidige versie van diagnostische instellingen
enabledLogCategories	string[]	Lijst met logboekcategorieën die zijn ingeschakeld
name	string	Naam van het profiel

ProvisioningIssue

Object

Beschrijft een inrichtingsprobleem voor een perimeterconfiguratie voor netwerkbeveiliging

Name	Type	Description
name	string	Naam van het probleem
properties	ProvisioningIssueProperties	Details van een inrichtingsprobleem voor een netwerkbeveiligingsperimeterconfiguratie (NSP). Resourceproviders moeten afzonderlijke elementen voor inrichtingsprobleem genereren voor elk afzonderlijk gedetecteerd probleem en een zinvolle en onderscheidende beschrijving bevatten, evenals eventuele relevante voorgesteldeResourceIds en suggestedAccessRules

ProvisioningIssueProperties

Object

Details van een inrichtingsprobleem voor een netwerkbeveiligingsperimeterconfiguratie (NSP). Resourceproviders moeten afzonderlijke elementen voor inrichtingsprobleem genereren voor elk afzonderlijk gedetecteerd probleem en een zinvolle en onderscheidende beschrijving bevatten, evenals eventuele relevante voorgesteldeResourceIds en suggestedAccessRules

Name	Type	Description
description	string	Beschrijving van het probleem
issueType	IssueType	Type probleem
severity	Severity	Ernst van het probleem.
suggestedAccessRules	AccessRule[]	Toegangsregels die kunnen worden toegevoegd aan het netwerkbeveiligingsprofiel (NSP) om het probleem op te lossen.
suggestedResourceIds	string[] (arm-id)	Volledig gekwalificeerde resource-id's van voorgestelde resources die kunnen worden gekoppeld aan de netwerkbeveiligingsperimeter (NSP) om het probleem op te lossen.

ResourceAssociation

Object

Informatie over resourcekoppeling

Name	Type	Description
accessMode	ResourceAssociationAccessMode	Toegangsmodus van de resourcekoppeling
name	string	Naam van de resourcekoppeling

ResourceAssociationAccessMode

Opsomming

Toegangsmodus van de resourcekoppeling

Waarde	Description
Enforced	Afgedwongen toegangsmodus: verkeer naar de resource waarvoor mislukte toegangscontroles zijn geblokkeerd
Learning	Leertoegangsmodus: verkeer naar de resource is ingeschakeld voor analyse, maar niet geblokkeerd
Audit	Toegangsmodus controleren: verkeer naar de resource die mislukte toegangscontroles wordt vastgelegd, maar niet geblokkeerd

Severity

Opsomming

Ernst van het probleem.

Waarde	Description
Warning
Error

Subscriptions

Object

Abonnementen voor binnenkomende regels

Name	Type	Description
id	string (arm-id)	De volledig gekwalificeerde Azure-resource-id van het abonnement, bijvoorbeeld ('/subscriptions/00000000-0000-0000-0000-0000000000')

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.