Network Security Perimeter Configurations - Get

Dienst:: Search Management

API-Version:: 2025-05-01

Ruft eine Netzwerksicherheitsperimeterkonfiguration ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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]*$	Der Name der Netzwerksicherheitsperimeterkonfiguration.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	NetworkSecurityPerimeterConfiguration	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AccessRule	Zugriffsregel in einem Netzwerksicherheitsperimeterkonfigurationsprofil
AccessRuleDirection	Richtung der Zugriffsregel
AccessRuleProperties	Eigenschaften der Access-Regel
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
IssueType	Art des Problems
NetworkSecurityPerimeter	Informationen zu einem Netzwerksicherheitsperimeter (NSP)
NetworkSecurityPerimeterConfiguration	Netzwerksicherheitsperimeter (NSP)-Konfigurationsressource
NetworkSecurityPerimeterConfigurationProperties	Netzwerksicherheitskonfigurationseigenschaften.
NetworkSecurityPerimeterConfigurationProvisioningState	Bereitstellungsstatus einer Netzwerksicherheitsperimeterkonfiguration, die erstellt oder aktualisiert wird.
NetworkSecurityProfile	Netzwerksicherheitsperimeterkonfigurationsprofil
ProvisioningIssue	Beschreibt ein Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration
ProvisioningIssueProperties	Details zu einem Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration (NSP). Ressourcenanbieter sollten separate Bereitstellungsproblemelemente für jedes separate Problem generieren, das erkannt wurde, und eine aussagekräftige und unverwechselbare Beschreibung sowie alle geeigneten vorgeschlagenenResourceIds und suggestedAccessRules enthalten.
ResourceAssociation	Informationen zur Ressourcenzuordnung
ResourceAssociationAccessMode	Zugriffsmodus der Ressourcenzuordnung
Severity	Schweregrad des Problems.
Subscriptions	Abonnements für eingehende Regeln
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AccessRule

Objekt

Zugriffsregel in einem Netzwerksicherheitsperimeterkonfigurationsprofil

Name	Typ	Beschreibung
name	string	Name der Zugriffsregel
properties	AccessRuleProperties	Eigenschaften der Access-Regel

AccessRuleDirection

Enumeration

Richtung der Zugriffsregel

Wert	Beschreibung
Inbound	Gilt für eingehenden Netzwerkdatenverkehr für die gesicherten Ressourcen.
Outbound	Gilt für ausgehenden Netzwerkdatenverkehr von den gesicherten Ressourcen

AccessRuleProperties

Objekt

Eigenschaften der Access-Regel

Name	Typ	Beschreibung
addressPrefixes	string[]	Adresspräfixe im CIDR-Format für eingehende Regeln
direction	AccessRuleDirection	Richtung der Zugriffsregel
emailAddresses	string[]	E-Mail-Adressen für ausgehende Regeln
fullyQualifiedDomainNames	string[]	Vollqualifizierte Domänennamen (FQDN) für ausgehende Regeln
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Netzwerksicherheitsperimeter für eingehende Regeln
phoneNumbers	string[]	Telefonnummern für ausgehende Regeln
subscriptions	Subscriptions[]	Abonnements für eingehende Regeln

CloudError

Objekt

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
message	string	Eine kurze Beschreibung des Fehlers, der darauf hinweist, was schief gelaufen ist (details/Debugginginformationen beziehen sich auf die Eigenschaft "error.message").

CloudErrorBody

Objekt

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
message	string	Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

IssueType

Enumeration

Art des Problems

Wert	Beschreibung
Unknown	Unbekannter Problemtyp
ConfigurationPropagationFailure	Fehler beim Anwenden der Netzwerksicherheitsperimeterkonfiguration (NSP).
MissingPerimeterConfiguration	Ein Netzwerkkonnektivitätsproblem tritt auf der Ressource auf, die behoben werden kann, indem dem Netzwerksicherheitsperimeter (Network Security Perimeter, NSP) neue Ressourcen hinzugefügt werden, oder durch Ändern von Zugriffsregeln.
MissingIdentityConfiguration	Eine verwaltete Identität wurde der Ressource nicht zugeordnet. Die Ressource kann weiterhin eingehenden Datenverkehr vom Netzwerksicherheitsperimeter (NSP) oder übereinstimmenden Regeln für eingehenden Zugriff überprüfen, kann jedoch keinen ausgehenden Zugriff als Mitglied des NSP ausführen.

NetworkSecurityPerimeter

Objekt

Informationen zu einem Netzwerksicherheitsperimeter (NSP)

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Azure-Ressourcen-ID der NSP-Ressource
location	string	Speicherort des Netzwerksicherheitsperimeters
perimeterGuid	string (uuid)	Universelle eindeutige ID (UUID) des Netzwerksicherheitsperimeters

NetworkSecurityPerimeterConfiguration

Objekt

Netzwerksicherheitsperimeter (NSP)-Konfigurationsressource

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	NetworkSecurityPerimeterConfigurationProperties	Netzwerksicherheitskonfigurationseigenschaften.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Objekt

Netzwerksicherheitskonfigurationseigenschaften.

Name	Typ	Beschreibung
networkSecurityPerimeter	NetworkSecurityPerimeter	Informationen zu einem Netzwerksicherheitsperimeter (NSP)
profile	NetworkSecurityProfile	Netzwerksicherheitsperimeterkonfigurationsprofil
provisioningIssues	ProvisioningIssue[]	Liste der Bereitstellungsprobleme, falls vorhanden
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Bereitstellungsstatus einer Netzwerksicherheitsperimeterkonfiguration, die erstellt oder aktualisiert wird.
resourceAssociation	ResourceAssociation	Informationen zur Ressourcenzuordnung

NetworkSecurityPerimeterConfigurationProvisioningState

Enumeration

Bereitstellungsstatus einer Netzwerksicherheitsperimeterkonfiguration, die erstellt oder aktualisiert wird.

Wert	Beschreibung
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Objekt

Netzwerksicherheitsperimeterkonfigurationsprofil

Name	Typ	Beschreibung
accessRules	AccessRule[]	Liste der Zugriffsregeln
accessRulesVersion	integer (int32)	Aktuelle Version der Zugriffsregeln
diagnosticSettingsVersion	integer (int32)	Aktuelle Diagnoseeinstellungsversion
enabledLogCategories	string[]	Liste der aktivierten Protokollkategorien
name	string	Name des Profils

ProvisioningIssue

Objekt

Beschreibt ein Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration

Name	Typ	Beschreibung
name	string	Name des Problems
properties	ProvisioningIssueProperties	Details zu einem Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration (NSP). Ressourcenanbieter sollten separate Bereitstellungsproblemelemente für jedes separate Problem generieren, das erkannt wurde, und eine aussagekräftige und unverwechselbare Beschreibung sowie alle geeigneten vorgeschlagenenResourceIds und suggestedAccessRules enthalten.

ProvisioningIssueProperties

Objekt

Details zu einem Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration (NSP). Ressourcenanbieter sollten separate Bereitstellungsproblemelemente für jedes separate Problem generieren, das erkannt wurde, und eine aussagekräftige und unverwechselbare Beschreibung sowie alle geeigneten vorgeschlagenenResourceIds und suggestedAccessRules enthalten.

Name	Typ	Beschreibung
description	string	Beschreibung des Problems
issueType	IssueType	Art des Problems
severity	Severity	Schweregrad des Problems.
suggestedAccessRules	AccessRule[]	Zugriffsregeln, die dem Netzwerksicherheitsprofil (Network Security Profile, NSP) hinzugefügt werden können, um das Problem zu beheben.
suggestedResourceIds	string[] (arm-id)	Vollqualifizierte Ressourcen-IDs vorgeschlagener Ressourcen, die dem Netzwerksicherheitsperimeter (NSP) zugeordnet werden können, um das Problem zu beheben.

ResourceAssociation

Objekt

Informationen zur Ressourcenzuordnung

Name	Typ	Beschreibung
accessMode	ResourceAssociationAccessMode	Zugriffsmodus der Ressourcenzuordnung
name	string	Name der Ressourcenzuordnung

ResourceAssociationAccessMode

Enumeration

Zugriffsmodus der Ressourcenzuordnung

Wert	Beschreibung
Enforced	Erzwungener Zugriffsmodus – Datenverkehr zu der Ressource, für die Zugriffsprüfungen fehlgeschlagen sind, wird blockiert.
Learning	Lernzugriffsmodus – Datenverkehr zur Ressource ist für die Analyse aktiviert, aber nicht blockiert.
Audit	Überwachungszugriffsmodus – Datenverkehr zu der Ressource, bei der Zugriffsprüfungen fehlschlägt, wird protokolliert, aber nicht blockiert.

Severity

Enumeration

Schweregrad des Problems.

Wert	Beschreibung
Warning
Error

Subscriptions

Objekt

Abonnements für eingehende Regeln

Name	Typ	Beschreibung
id	string (arm-id)	Die vollqualifizierte Azure-Ressourcen-ID des Abonnements, z. B. ('/subscriptions/0000000-00000-0000-00000-0000000000')

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.