Network Security Perimeter Configurations - Get

Szolgáltatás:: Search Management

API-verzió:: 2025-05-01

Lekéri a hálózati biztonsági szegélykonfigurációt.

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

URI-paraméterek

Név	In	Kötelező	Típus	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]*$	A hálózati biztonsági szegélykonfiguráció neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	A megadott erőforráscsoporthoz társított Azure AI Search szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Név	Típus	Description
200 OK	NetworkSecurityPerimeterConfiguration	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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

Mintaválasz

Állapotkód:: 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"
    }
  }
}

Definíciók

Név	Description
AccessRule	Hozzáférési szabály hálózati biztonsági szegélykonfigurációs profilban
AccessRuleDirection	A hozzáférési szabály iránya
AccessRuleProperties	A hozzáférési szabály tulajdonságai
CloudError	Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
createdByType	Az erőforrást létrehozó identitás típusa.
IssueType	A probléma típusa
NetworkSecurityPerimeter	Információk egy hálózati biztonsági szegélyről (NSP)
NetworkSecurityPerimeterConfiguration	Hálózati biztonsági szegély (NSP) konfigurációs erőforrás
NetworkSecurityPerimeterConfigurationProperties	Hálózati biztonsági konfiguráció tulajdonságai.
NetworkSecurityPerimeterConfigurationProvisioningState	A létrehozott vagy frissített hálózati biztonsági szegélykonfiguráció kiépítési állapota.
NetworkSecurityProfile	Hálózati biztonsági szegélykonfigurációs profil
ProvisioningIssue	A hálózati biztonsági szegélykonfiguráció kiépítésével kapcsolatos problémát ismerteti
ProvisioningIssueProperties	A hálózati biztonsági szegély (NSP) konfigurációjának kiépítésével kapcsolatos probléma részletei. Az erőforrás-szolgáltatóknak külön kiépítési problémaelemeket kell létrehozniuk minden észlelt különálló problémához, és tartalmazniuk kell egy értelmezhető és megkülönböztető leírást, valamint a megfelelő javasoltResourceId-eket és a suggestedAccessRules-eket
ResourceAssociation	Információ az erőforrás-társításról
ResourceAssociationAccessMode	Az erőforrástársítás hozzáférési módja
Severity	A probléma súlyossága.
Subscriptions	Bejövő szabályok előfizetései
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

AccessRule

Tárgy

Hozzáférési szabály hálózati biztonsági szegélykonfigurációs profilban

Név	Típus	Description
name	string	A hozzáférési szabály neve
properties	AccessRuleProperties	A hozzáférési szabály tulajdonságai

AccessRuleDirection

Felsorolás

A hozzáférési szabály iránya

Érték	Description
Inbound	A biztonságos erőforrások felé irányuló bejövő hálózati forgalomra vonatkozik.
Outbound	A biztonságos erőforrásokból kimenő hálózati forgalomra vonatkozik

AccessRuleProperties

Tárgy

A hozzáférési szabály tulajdonságai

Név	Típus	Description
addressPrefixes	string[]	Bejövő szabályok CIDR formátumú előtagjainak címe
direction	AccessRuleDirection	A hozzáférési szabály iránya
emailAddresses	string[]	Kimenő szabályok e-mail-címei
fullyQualifiedDomainNames	string[]	Teljes tartománynevek (FQDN) a kimenő szabályokhoz
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Bejövő szabályok hálózati biztonsági szegélyei
phoneNumbers	string[]	Kimenő szabályok telefonszámai
subscriptions	Subscriptions[]	Bejövő szabályok előfizetései

CloudError

Tárgy

Api-hibával kapcsolatos információkat tartalmaz.

Név	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
message	string	A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg a "error.message" tulajdonságot).

CloudErrorBody

Tárgy

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Név	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

IssueType

Felsorolás

A probléma típusa

Érték	Description
Unknown	Ismeretlen hibatípus
ConfigurationPropagationFailure	Hiba történt a hálózati biztonsági szegély (NSP) konfigurációjának alkalmazása közben.
MissingPerimeterConfiguration	Hálózati kapcsolati probléma merül fel az erőforráson, amely megoldható új erőforrások hálózati biztonsági szegélyhez (NSP) hozzáadásával vagy a hozzáférési szabályok módosításával.
MissingIdentityConfiguration	A felügyelt identitás nincs társítva az erőforrással. Az erőforrás továbbra is ellenőrizheti a hálózati biztonsági szegélyről (NSP) érkező forgalmat, vagy megfeleltetheti a bejövő hozzáférési szabályokat, de nem fog tudni kimenő hozzáférést végrehajtani az NSP tagjaként.

NetworkSecurityPerimeter

Tárgy

Információk egy hálózati biztonsági szegélyről (NSP)

Név	Típus	Description
id	string (arm-id)	Az NSP-erőforrás teljes Azure-erőforrás-azonosítója
location	string	A hálózati biztonsági szegély helye
perimeterGuid	string (uuid)	A hálózati biztonsági szegély univerzális egyedi azonosítója (UUID)

NetworkSecurityPerimeterConfiguration

Tárgy

Hálózati biztonsági szegély (NSP) konfigurációs erőforrás

Név	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties	NetworkSecurityPerimeterConfigurationProperties	Hálózati biztonsági konfiguráció tulajdonságai.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Tárgy

Hálózati biztonsági konfiguráció tulajdonságai.

Név	Típus	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Információk egy hálózati biztonsági szegélyről (NSP)
profile	NetworkSecurityProfile	Hálózati biztonsági szegélykonfigurációs profil
provisioningIssues	ProvisioningIssue[]	A kiépítési problémák listája, ha vannak ilyenek
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	A létrehozott vagy frissített hálózati biztonsági szegélykonfiguráció kiépítési állapota.
resourceAssociation	ResourceAssociation	Információ az erőforrás-társításról

NetworkSecurityPerimeterConfigurationProvisioningState

Felsorolás

A létrehozott vagy frissített hálózati biztonsági szegélykonfiguráció kiépítési állapota.

Érték	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Tárgy

Hálózati biztonsági szegélykonfigurációs profil

Név	Típus	Description
accessRules	AccessRule[]	Hozzáférési szabályok listája
accessRulesVersion	integer (int32)	A hozzáférési szabályok aktuális verziója
diagnosticSettingsVersion	integer (int32)	A diagnosztikai beállítások aktuális verziója
enabledLogCategories	string[]	Az engedélyezett naplókategóriák listája
name	string	A profil neve

ProvisioningIssue

Tárgy

A hálózati biztonsági szegélykonfiguráció kiépítésével kapcsolatos problémát ismerteti

Név	Típus	Description
name	string	A probléma neve
properties	ProvisioningIssueProperties	A hálózati biztonsági szegély (NSP) konfigurációjának kiépítésével kapcsolatos probléma részletei. Az erőforrás-szolgáltatóknak külön kiépítési problémaelemeket kell létrehozniuk minden észlelt különálló problémához, és tartalmazniuk kell egy értelmezhető és megkülönböztető leírást, valamint a megfelelő javasoltResourceId-eket és a suggestedAccessRules-eket

ProvisioningIssueProperties

Tárgy

A hálózati biztonsági szegély (NSP) konfigurációjának kiépítésével kapcsolatos probléma részletei. Az erőforrás-szolgáltatóknak külön kiépítési problémaelemeket kell létrehozniuk minden észlelt különálló problémához, és tartalmazniuk kell egy értelmezhető és megkülönböztető leírást, valamint a megfelelő javasoltResourceId-eket és a suggestedAccessRules-eket

Név	Típus	Description
description	string	A probléma leírása
issueType	IssueType	A probléma típusa
severity	Severity	A probléma súlyossága.
suggestedAccessRules	AccessRule[]	Hozzáférési szabályok, amelyek hozzáadhatók a hálózati biztonsági profilhoz (NSP) a probléma megoldásához.
suggestedResourceIds	string[] (arm-id)	A probléma megoldásához a hálózati biztonsági szegélyhez (NSP) társítható javasolt erőforrások teljes erőforrás-azonosítói.

ResourceAssociation

Tárgy

Információ az erőforrás-társításról

Név	Típus	Description
accessMode	ResourceAssociationAccessMode	Az erőforrástársítás hozzáférési módja
name	string	Az erőforrástársítás neve

ResourceAssociationAccessMode

Felsorolás

Az erőforrástársítás hozzáférési módja

Érték	Description
Enforced	Kényszerített hozzáférési mód – a sikertelen hozzáférés-ellenőrzéssel rendelkező erőforrás felé történő forgalom le van tiltva
Learning	Tanulási hozzáférési mód – Az erőforrás felé irányuló forgalom engedélyezve van az elemzéshez, de nincs letiltva
Audit	Naplózási hozzáférési mód – a rendszer naplózza a sikertelen hozzáférés-ellenőrzéseket végző erőforrás felé történő forgalmat, de nem tiltja le

Severity

Felsorolás

A probléma súlyossága.

Érték	Description
Warning
Error

Subscriptions

Tárgy

Bejövő szabályok előfizetései

Név	Típus	Description
id	string (arm-id)	Az előfizetés teljes Azure-erőforrás-azonosítója, például ('/subscriptions/00000000-0000-0000-0000-00000000000')

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Név	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.