Network Security Perimeter Configurations - Get

Usługa:: Search Management

Wersja interfejsu API:: 2025-05-01

Pobiera konfigurację obwodu zabezpieczeń sieci.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
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]*$	Nazwa konfiguracji obwodowej zabezpieczeń sieci.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nazwa usługi Azure AI Search skojarzonej z określoną grupą zasobów.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NetworkSecurityPerimeterConfiguration	Operacja platformy Azure została ukończona pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  }
}

Definicje

Nazwa	Opis
AccessRule	Reguła dostępu w profilu konfiguracji obwodu zabezpieczeń sieci
AccessRuleDirection	Kierunek reguły dostępu
AccessRuleProperties	Właściwości reguły dostępu
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
createdByType	Typ tożsamości, która utworzyła zasób.
IssueType	Typ problemu
NetworkSecurityPerimeter	Informacje o obwodzie zabezpieczeń sieci (NSP)
NetworkSecurityPerimeterConfiguration	Zasób konfiguracji obwodu zabezpieczeń sieci (NSP)
NetworkSecurityPerimeterConfigurationProperties	Właściwości konfiguracji zabezpieczeń sieci.
NetworkSecurityPerimeterConfigurationProvisioningState	Stan aprowizacji konfiguracji obwodowej zabezpieczeń sieci, która jest tworzona lub aktualizowana.
NetworkSecurityProfile	Profil konfiguracji obwodu zabezpieczeń sieci
ProvisioningIssue	Opisuje problem z aprowizowaniem konfiguracji obwodowej zabezpieczeń sieci
ProvisioningIssueProperties	Szczegóły problemu z aprowizowaniem konfiguracji sieciowej sieci obwodowej (NSP). Dostawcy zasobów powinni wygenerować oddzielne elementy problemu z aprowizowaniem dla każdego wykrytego oddzielnego problemu i dołączyć zrozumiały i charakterystyczny opis, a także wszelkie odpowiednie sugerowane IdentyfikatoryResourceId i sugerowaneRulesy funkcjiAccess
ResourceAssociation	Informacje o skojarzeniu zasobów
ResourceAssociationAccessMode	Tryb dostępu skojarzenia zasobu
Severity	Ważność problemu.
Subscriptions	Subskrypcje dla reguł ruchu przychodzącego
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AccessRule

Objekt

Reguła dostępu w profilu konfiguracji obwodu zabezpieczeń sieci

Nazwa	Typ	Opis
name	string	Nazwa reguły dostępu
properties	AccessRuleProperties	Właściwości reguły dostępu

AccessRuleDirection

Wyliczenie

Kierunek reguły dostępu

Wartość	Opis
Inbound	Dotyczy przychodzącego ruchu sieciowego do zabezpieczonych zasobów.
Outbound	Dotyczy ruchu sieciowego wychodzącego z zabezpieczonych zasobów

AccessRuleProperties

Objekt

Właściwości reguły dostępu

Nazwa	Typ	Opis
addressPrefixes	string[]	Prefiksy adresów w formacie CIDR dla reguł ruchu przychodzącego
direction	AccessRuleDirection	Kierunek reguły dostępu
emailAddresses	string[]	Adresy e-mail dla reguł ruchu wychodzącego
fullyQualifiedDomainNames	string[]	W pełni kwalifikowane nazwy domen (FQDN) dla reguł ruchu wychodzącego
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Obwody zabezpieczeń sieci dla reguł ruchu przychodzącego
phoneNumbers	string[]	Numery telefonów dla reguł ruchu wychodzącego
subscriptions	Subscriptions[]	Subskrypcje dla reguł ruchu przychodzącego

CloudError

Objekt

Zawiera informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
message	string	Krótki opis błędu, który wskazuje, co poszło nie tak (aby uzyskać szczegółowe informacje/debugowanie, zapoznaj się z właściwością "error.message").

CloudErrorBody

Objekt

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.
details	CloudErrorBody[]	Zawiera zagnieżdżone błędy związane z tym błędem.
message	string	Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

IssueType

Wyliczenie

Typ problemu

Wartość	Opis
Unknown	Nieznany typ problemu
ConfigurationPropagationFailure	Wystąpił błąd podczas stosowania konfiguracji sieciowej sieci obwodowej (NSP).
MissingPerimeterConfiguration	Problem z łącznością sieciową występuje w zasobie, który można rozwiązać przez dodanie nowych zasobów do sieci obwodowej zabezpieczeń (NSP) lub przez zmodyfikowanie reguł dostępu.
MissingIdentityConfiguration	Tożsamość zarządzana nie została skojarzona z zasobem. Zasób nadal będzie mógł zweryfikować ruch przychodzący z obwodu zabezpieczeń sieci (NSP) lub pasujących reguł dostępu przychodzącego, ale nie będzie mógł wykonać dostępu wychodzącego jako członek NSP.

NetworkSecurityPerimeter

Objekt

Informacje o obwodzie zabezpieczeń sieci (NSP)

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu platformy Azure zasobu NSP
location	string	Lokalizacja obwodu zabezpieczeń sieci
perimeterGuid	string (uuid)	Uniwersalny unikatowy identyfikator (UUID) obwodu zabezpieczeń sieci

NetworkSecurityPerimeterConfiguration

Objekt

Zasób konfiguracji obwodu zabezpieczeń sieci (NSP)

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties	NetworkSecurityPerimeterConfigurationProperties	Właściwości konfiguracji zabezpieczeń sieci.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Objekt

Właściwości konfiguracji zabezpieczeń sieci.

Nazwa	Typ	Opis
networkSecurityPerimeter	NetworkSecurityPerimeter	Informacje o obwodzie zabezpieczeń sieci (NSP)
profile	NetworkSecurityProfile	Profil konfiguracji obwodu zabezpieczeń sieci
provisioningIssues	ProvisioningIssue[]	Lista problemów z aprowizowaniem, jeśli istnieje
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Stan aprowizacji konfiguracji obwodowej zabezpieczeń sieci, która jest tworzona lub aktualizowana.
resourceAssociation	ResourceAssociation	Informacje o skojarzeniu zasobów

NetworkSecurityPerimeterConfigurationProvisioningState

Wyliczenie

Stan aprowizacji konfiguracji obwodowej zabezpieczeń sieci, która jest tworzona lub aktualizowana.

Wartość	Opis
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Objekt

Profil konfiguracji obwodu zabezpieczeń sieci

Nazwa	Typ	Opis
accessRules	AccessRule[]	Lista reguł dostępu
accessRulesVersion	integer (int32)	Bieżąca wersja reguł dostępu
diagnosticSettingsVersion	integer (int32)	Bieżąca wersja ustawień diagnostycznych
enabledLogCategories	string[]	Lista kategorii dzienników, które są włączone
name	string	Nazwa profilu

ProvisioningIssue

Objekt

Opisuje problem z aprowizowaniem konfiguracji obwodowej zabezpieczeń sieci

Nazwa	Typ	Opis
name	string	Nazwa problemu
properties	ProvisioningIssueProperties	Szczegóły problemu z aprowizowaniem konfiguracji sieciowej sieci obwodowej (NSP). Dostawcy zasobów powinni wygenerować oddzielne elementy problemu z aprowizowaniem dla każdego wykrytego oddzielnego problemu i dołączyć zrozumiały i charakterystyczny opis, a także wszelkie odpowiednie sugerowane IdentyfikatoryResourceId i sugerowaneRulesy funkcjiAccess

ProvisioningIssueProperties

Objekt

Szczegóły problemu z aprowizowaniem konfiguracji sieciowej sieci obwodowej (NSP). Dostawcy zasobów powinni wygenerować oddzielne elementy problemu z aprowizowaniem dla każdego wykrytego oddzielnego problemu i dołączyć zrozumiały i charakterystyczny opis, a także wszelkie odpowiednie sugerowane IdentyfikatoryResourceId i sugerowaneRulesy funkcjiAccess

Nazwa	Typ	Opis
description	string	Opis problemu
issueType	IssueType	Typ problemu
severity	Severity	Ważność problemu.
suggestedAccessRules	AccessRule[]	Reguły dostępu, które można dodać do profilu zabezpieczeń sieci (NSP), aby rozwiązać ten problem.
suggestedResourceIds	string[] (arm-id)	W pełni kwalifikowane identyfikatory zasobów sugerowanych zasobów, które można skojarzyć z obwodem zabezpieczeń sieci w celu rozwiązania problemu.

ResourceAssociation

Objekt

Informacje o skojarzeniu zasobów

Nazwa	Typ	Opis
accessMode	ResourceAssociationAccessMode	Tryb dostępu skojarzenia zasobu
name	string	Nazwa skojarzenia zasobu

ResourceAssociationAccessMode

Wyliczenie

Tryb dostępu skojarzenia zasobu

Wartość	Opis
Enforced	Wymuszony tryb dostępu — ruch do zasobu, który zakończył się niepowodzeniem kontroli dostępu, jest blokowany
Learning	Tryb dostępu do nauki — ruch do zasobu jest włączony do analizy, ale nie jest blokowany
Audit	Tryb dostępu inspekcji — ruch do zasobu, który kończy się niepowodzeniem kontroli dostępu, jest rejestrowany, ale nie jest blokowany

Severity

Wyliczenie

Ważność problemu.

Wartość	Opis
Warning
Error

Subscriptions

Objekt

Subskrypcje dla reguł ruchu przychodzącego

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu platformy Azure subskrypcji, np. ('/subscriptions/000000000-0000-0000-0000-00000000000')

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.