Network Security Perimeter Configurations - Get

Tjänst:: Search Management

API-version:: 2025-05-01

Hämtar en nätverkssäkerhetsperimeterkonfiguration.

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

URI-parametrar

Name	I	Obligatorisk	Typ	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]*$	Konfigurationsnamnet för nätverkssäkerhetsperimetern.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Namnet på azure AI Search-tjänsten som är associerad med den angivna resursgruppen.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	NetworkSecurityPerimeterConfiguration	Azure-åtgärden har slutförts.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

Statuskod:: 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"
    }
  }
}

Definitioner

Name	Description
AccessRule	Åtkomstregel i en konfigurationsprofil för nätverkssäkerhetsperimeter
AccessRuleDirection	Åtkomstregelns riktning
AccessRuleProperties	Egenskaper för åtkomstregel
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
createdByType	Den typ av identitet som skapade resursen.
IssueType	Typ av problem
NetworkSecurityPerimeter	Information om en nätverkssäkerhetsperimeter (NSP)
NetworkSecurityPerimeterConfiguration	Konfigurationsresurs för nätverkssäkerhetsperimeter (NSP)
NetworkSecurityPerimeterConfigurationProperties	Egenskaper för nätverkssäkerhetskonfiguration.
NetworkSecurityPerimeterConfigurationProvisioningState	Etableringstillstånd för en nätverkssäkerhetsperimeterkonfiguration som skapas eller uppdateras.
NetworkSecurityProfile	Konfigurationsprofil för nätverkssäkerhetsperimeter
ProvisioningIssue	Beskriver ett etableringsproblem för en nätverkssäkerhetsperimeterkonfiguration
ProvisioningIssueProperties	Information om ett etableringsproblem för en NSP-konfiguration (network security perimeter). Resursprovidrar bör generera separata etableringsproblemelement för varje separat problem som identifieras och innehålla en beskrivande och distinkt beskrivning, samt lämpliga föreslagnaResourceIds och föreslagnaAccessRules
ResourceAssociation	Information om resursassociation
ResourceAssociationAccessMode	Åtkomstläge för resursassociationen
Severity	Allvarlighetsgrad för problemet.
Subscriptions	Prenumerationer för regler för inkommande trafik
systemData	Metadata som rör skapande och senaste ändring av resursen.

AccessRule

Objekt

Åtkomstregel i en konfigurationsprofil för nätverkssäkerhetsperimeter

Name	Typ	Description
name	string	Namnet på åtkomstregeln
properties	AccessRuleProperties	Egenskaper för åtkomstregel

AccessRuleDirection

Uppräkning

Åtkomstregelns riktning

Värde	Description
Inbound	Gäller för inkommande nätverkstrafik för de skyddade resurserna.
Outbound	Gäller för utgående nätverkstrafik från skyddade resurser

AccessRuleProperties

Objekt

Egenskaper för åtkomstregel

Name	Typ	Description
addressPrefixes	string[]	Adressprefix i CIDR-format för inkommande regler
direction	AccessRuleDirection	Åtkomstregelns riktning
emailAddresses	string[]	E-postadresser för regler för utgående trafik
fullyQualifiedDomainNames	string[]	Fullständigt kvalificerade domännamn (FQDN) för utgående regler
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Nätverkssäkerhetsperimeter för inkommande regler
phoneNumbers	string[]	Telefonnummer för regler för utgående trafik
subscriptions	Subscriptions[]	Prenumerationer för regler för inkommande trafik

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

IssueType

Uppräkning

Typ av problem

Värde	Description
Unknown	Okänd problemtyp
ConfigurationPropagationFailure	Ett fel uppstod när nätverkssäkerhetsperimeterkonfigurationen (NSP) tillämpades.
MissingPerimeterConfiguration	Ett problem med nätverksanslutningen uppstår på resursen som kan åtgärdas antingen genom att lägga till nya resurser i nätverkssäkerhetsperimetern (NSP) eller genom att ändra åtkomstreglerna.
MissingIdentityConfiguration	En hanterad identitet har inte associerats med resursen. Resursen kommer fortfarande att kunna verifiera inkommande trafik från nätverkssäkerhetsperimetern (NSP) eller matchande regler för inkommande åtkomst, men den kommer inte att kunna utföra utgående åtkomst som medlem i NSP.

NetworkSecurityPerimeter

Objekt

Information om en nätverkssäkerhetsperimeter (NSP)

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat Azure-resurs-ID för NSP-resursen
location	string	Plats för nätverkssäkerhetsperimetern
perimeterGuid	string (uuid)	Universellt unikt ID (UUID) för nätverkssäkerhetsperimetern

NetworkSecurityPerimeterConfiguration

Objekt

Konfigurationsresurs för nätverkssäkerhetsperimeter (NSP)

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	NetworkSecurityPerimeterConfigurationProperties	Egenskaper för nätverkssäkerhetskonfiguration.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Objekt

Egenskaper för nätverkssäkerhetskonfiguration.

Name	Typ	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Information om en nätverkssäkerhetsperimeter (NSP)
profile	NetworkSecurityProfile	Konfigurationsprofil för nätverkssäkerhetsperimeter
provisioningIssues	ProvisioningIssue[]	Lista över eventuella etableringsproblem
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Etableringstillstånd för en nätverkssäkerhetsperimeterkonfiguration som skapas eller uppdateras.
resourceAssociation	ResourceAssociation	Information om resursassociation

NetworkSecurityPerimeterConfigurationProvisioningState

Uppräkning

Etableringstillstånd för en nätverkssäkerhetsperimeterkonfiguration som skapas eller uppdateras.

Värde	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Objekt

Konfigurationsprofil för nätverkssäkerhetsperimeter

Name	Typ	Description
accessRules	AccessRule[]	Lista över åtkomstregler
accessRulesVersion	integer (int32)	Aktuell version av åtkomstregler
diagnosticSettingsVersion	integer (int32)	Aktuell version av diagnostikinställningar
enabledLogCategories	string[]	Lista över loggkategorier som är aktiverade
name	string	Profilens namn

ProvisioningIssue

Objekt

Beskriver ett etableringsproblem för en nätverkssäkerhetsperimeterkonfiguration

Name	Typ	Description
name	string	Namnet på problemet
properties	ProvisioningIssueProperties	Information om ett etableringsproblem för en NSP-konfiguration (network security perimeter). Resursprovidrar bör generera separata etableringsproblemelement för varje separat problem som identifieras och innehålla en beskrivande och distinkt beskrivning, samt lämpliga föreslagnaResourceIds och föreslagnaAccessRules

ProvisioningIssueProperties

Objekt

Information om ett etableringsproblem för en NSP-konfiguration (network security perimeter). Resursprovidrar bör generera separata etableringsproblemelement för varje separat problem som identifieras och innehålla en beskrivande och distinkt beskrivning, samt lämpliga föreslagnaResourceIds och föreslagnaAccessRules

Name	Typ	Description
description	string	Beskrivning av problemet
issueType	IssueType	Typ av problem
severity	Severity	Allvarlighetsgrad för problemet.
suggestedAccessRules	AccessRule[]	Åtkomstregler som kan läggas till i nätverkssäkerhetsprofilen (NSP) för att åtgärda problemet.
suggestedResourceIds	string[] (arm-id)	Fullständigt kvalificerade resurs-ID:n för föreslagna resurser som kan associeras med nätverkssäkerhetsperimetern (NSP) för att åtgärda problemet.

ResourceAssociation

Objekt

Information om resursassociation

Name	Typ	Description
accessMode	ResourceAssociationAccessMode	Åtkomstläge för resursassociationen
name	string	Namnet på resursassociationen

ResourceAssociationAccessMode

Uppräkning

Åtkomstläge för resursassociationen

Värde	Description
Enforced	Framtvingat åtkomstläge – trafik till resursen som misslyckades med åtkomstkontroller blockeras
Learning	Inlärningsåtkomstläge – trafik till resursen är aktiverad för analys men blockeras inte
Audit	Granska åtkomstläge – trafik till resursen som inte kan komma åt kontroller loggas men blockeras inte

Severity

Uppräkning

Allvarlighetsgrad för problemet.

Värde	Description
Warning
Error

Subscriptions

Objekt

Prenumerationer för regler för inkommande trafik

Name	Typ	Description
id	string (arm-id)	Det fullständigt kvalificerade Azure-resurs-ID:t för prenumerationen, t.ex. ('/subscriptions/0000000-0000-0000-0000-00000000000')

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.