Network Security Perimeter Configurations - Get

Služba:: Search Management

Verze rozhraní API:: 2025-05-01

Získá konfiguraci hraniční sítě.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	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]*$	Název konfigurace hraniční sítě.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Název služby Azure AI Search přidružené k zadané skupině prostředků.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	NetworkSecurityPerimeterConfiguration	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázková odpověď

Stavový kó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"
    }
  }
}

Definice

Name	Description
AccessRule	Pravidlo přístupu v konfiguračním profilu zabezpečení sítě
AccessRuleDirection	Směr pravidla přístupu
AccessRuleProperties	Vlastnosti pravidla přístupu
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
createdByType	Typ identity, která prostředek vytvořila.
IssueType	Typ problému
NetworkSecurityPerimeter	Informace o hraniční síti sítě (NSP)
NetworkSecurityPerimeterConfiguration	Prostředek konfigurace hraniční sítě (NSP)
NetworkSecurityPerimeterConfigurationProperties	Vlastnosti konfigurace zabezpečení sítě
NetworkSecurityPerimeterConfigurationProvisioningState	Stav zřizování hraniční konfigurace zabezpečení sítě, která se vytváří nebo aktualizuje.
NetworkSecurityProfile	Profil konfigurace hraniční sítě zabezpečení sítě
ProvisioningIssue	Popisuje problém se zřizováním konfigurace hraniční sítě zabezpečení sítě.
ProvisioningIssueProperties	Podrobnosti o problému se zřizováním konfigurace hraniční sítě (NSP) zabezpečení sítě Poskytovatelé prostředků by měli pro každý zjištěný samostatný problém generovat samostatné prvky problému zřizování a měly by obsahovat smysluplný a výrazný popis, stejně jako všechny vhodné navrhované IdentifikátoryResourceId a navrhované zásadyAccessRules.
ResourceAssociation	Informace o přidružení prostředků
ResourceAssociationAccessMode	Režim přístupu přidružení prostředků
Severity	Závažnost problému
Subscriptions	Předplatná pro příchozí pravidla
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AccessRule

Objekt

Pravidlo přístupu v konfiguračním profilu zabezpečení sítě

Name	Typ	Description
name	string	Název pravidla přístupu
properties	AccessRuleProperties	Vlastnosti pravidla přístupu

AccessRuleDirection

Výčet

Směr pravidla přístupu

Hodnota	Description
Inbound	Platí pro příchozí síťový provoz na zabezpečené prostředky.
Outbound	Platí pro odchozí síťový provoz ze zabezpečených prostředků.

AccessRuleProperties

Objekt

Vlastnosti pravidla přístupu

Name	Typ	Description
addressPrefixes	string[]	Předpony adres ve formátu CIDR pro příchozí pravidla
direction	AccessRuleDirection	Směr pravidla přístupu
emailAddresses	string[]	E-mailové adresy pro pravidla odchozích přenosů
fullyQualifiedDomainNames	string[]	Plně kvalifikované názvy domén (FQDN) pro pravidla odchozích přenosů
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Hraniční sítě pro příchozí pravidla
phoneNumbers	string[]	Telefonní čísla pro pravidla odchozích přenosů
subscriptions	Subscriptions[]	Předplatná pro příchozí pravidla

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
message	string	Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

IssueType

Výčet

Typ problému

Hodnota	Description
Unknown	Neznámý typ problému
ConfigurationPropagationFailure	Při použití konfigurace hraniční sítě (NSP) zabezpečení sítě došlo k chybě.
MissingPerimeterConfiguration	Na prostředku dochází k problému s připojením k síti, který je možné vyřešit přidáním nových prostředků do hraniční sítě (NSP) zabezpečení sítě nebo úpravou pravidel přístupu.
MissingIdentityConfiguration	Spravovaná identita nebyla přidružená k prostředku. Prostředek bude i nadále moct ověřit příchozí provoz z hraniční sítě (NSP) zabezpečení sítě nebo shodnými pravidly příchozího přístupu, ale nebude moct provádět odchozí přístup jako člen NSP.

NetworkSecurityPerimeter

Objekt

Informace o hraniční síti sítě (NSP)

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku Azure prostředku NSP
location	string	Umístění hraniční sítě
perimeterGuid	string (uuid)	Univerzální jedinečné ID (UUID) hraniční sítě

NetworkSecurityPerimeterConfiguration

Objekt

Prostředek konfigurace hraniční sítě (NSP)

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties	NetworkSecurityPerimeterConfigurationProperties	Vlastnosti konfigurace zabezpečení sítě
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

NetworkSecurityPerimeterConfigurationProperties

Objekt

Vlastnosti konfigurace zabezpečení sítě

Name	Typ	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Informace o hraniční síti sítě (NSP)
profile	NetworkSecurityProfile	Profil konfigurace hraniční sítě zabezpečení sítě
provisioningIssues	ProvisioningIssue[]	Seznam problémů se zřizováním, pokud existuje
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Stav zřizování hraniční konfigurace zabezpečení sítě, která se vytváří nebo aktualizuje.
resourceAssociation	ResourceAssociation	Informace o přidružení prostředků

NetworkSecurityPerimeterConfigurationProvisioningState

Výčet

Stav zřizování hraniční konfigurace zabezpečení sítě, která se vytváří nebo aktualizuje.

Hodnota	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Objekt

Profil konfigurace hraniční sítě zabezpečení sítě

Name	Typ	Description
accessRules	AccessRule[]	Seznam pravidel přístupu
accessRulesVersion	integer (int32)	Aktuální verze pravidel přístupu
diagnosticSettingsVersion	integer (int32)	Aktuální verze nastavení diagnostiky
enabledLogCategories	string[]	Seznam povolených kategorií protokolů
name	string	Název profilu

ProvisioningIssue

Objekt

Popisuje problém se zřizováním konfigurace hraniční sítě zabezpečení sítě.

Name	Typ	Description
name	string	Název problému
properties	ProvisioningIssueProperties	Podrobnosti o problému se zřizováním konfigurace hraniční sítě (NSP) zabezpečení sítě Poskytovatelé prostředků by měli pro každý zjištěný samostatný problém generovat samostatné prvky problému zřizování a měly by obsahovat smysluplný a výrazný popis, stejně jako všechny vhodné navrhované IdentifikátoryResourceId a navrhované zásadyAccessRules.

ProvisioningIssueProperties

Objekt

Podrobnosti o problému se zřizováním konfigurace hraniční sítě (NSP) zabezpečení sítě Poskytovatelé prostředků by měli pro každý zjištěný samostatný problém generovat samostatné prvky problému zřizování a měly by obsahovat smysluplný a výrazný popis, stejně jako všechny vhodné navrhované IdentifikátoryResourceId a navrhované zásadyAccessRules.

Name	Typ	Description
description	string	Popis problému
issueType	IssueType	Typ problému
severity	Severity	Závažnost problému
suggestedAccessRules	AccessRule[]	Pravidla přístupu, která je možné přidat do profilu zabezpečení sítě (NSP), aby se problém vyřešil.
suggestedResourceIds	string[] (arm-id)	Plně kvalifikované ID prostředků navrhovaných prostředků, které je možné přidružit k hraniční síti (NSP) zabezpečení sítě, aby se problém vyřešil.

ResourceAssociation

Objekt

Informace o přidružení prostředků

Name	Typ	Description
accessMode	ResourceAssociationAccessMode	Režim přístupu přidružení prostředků
name	string	Název přidružení zdroje

ResourceAssociationAccessMode

Výčet

Režim přístupu přidružení prostředků

Hodnota	Description
Enforced	Režim vynuceného přístupu – provoz do prostředku, u kterého se kontroly přístupu nezdařily, je blokovaný
Learning	Režim přístupu k učení – provoz do prostředku je povolený pro analýzu, ale není zablokovaný
Audit	Auditovat režim přístupu – provoz do prostředku, který selže kontroly přístupu, se protokoluje, ale není zablokovaný.

Severity

Výčet

Závažnost problému

Hodnota	Description
Warning
Error

Subscriptions

Objekt

Předplatná pro příchozí pravidla

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku Azure předplatného, např. (/subscriptions/00000000-0000-0000-0000-00000-0000000000000000000)

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.