Network Security Perimeter Configurations - Get

Servizio:: Search Management

Versione API:: 2025-05-01

Ottiene una configurazione perimetrale della sicurezza di rete.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
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]*$	Nome della configurazione del perimetro di sicurezza di rete.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nome del servizio Ricerca intelligenza artificiale di Azure associato al gruppo di risorse specificato.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	NetworkSecurityPerimeterConfiguration	L'operazione di Azure è stata completata correttamente.
Other Status Codes	CloudError	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Risposta di esempio

Codice di stato:: 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"
    }
  }
}

Definizioni

Nome	Descrizione
AccessRule	Regola di accesso in un profilo di configurazione del perimetro di sicurezza di rete
AccessRuleDirection	Direzione della regola di accesso
AccessRuleProperties	Proprietà della regola di accesso
CloudError	Contiene informazioni su un errore dell'API.
CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
createdByType	Tipo di identità che ha creato la risorsa.
IssueType	Tipo di problema
NetworkSecurityPerimeter	Informazioni su un perimetro di sicurezza di rete
NetworkSecurityPerimeterConfiguration	Risorsa di configurazione NSP (Network Security Perimeter)
NetworkSecurityPerimeterConfigurationProperties	Proprietà di configurazione della sicurezza di rete.
NetworkSecurityPerimeterConfigurationProvisioningState	Stato di provisioning di una configurazione perimetrale della sicurezza di rete che viene creata o aggiornata.
NetworkSecurityProfile	Profilo di configurazione del perimetro di sicurezza di rete
ProvisioningIssue	Descrive un problema di provisioning per una configurazione perimetrale della sicurezza di rete
ProvisioningIssueProperties	Dettagli di un problema di provisioning per una configurazione NSP (Network Security Perimeter). I provider di risorse devono generare elementi di problema di provisioning separati per ogni problema separato rilevato e includere una descrizione significativa e distintiva, nonché eventuali elementi suggeritiResourceIds e suggestedAccessRules appropriati
ResourceAssociation	Informazioni sull'associazione di risorse
ResourceAssociationAccessMode	Modalità di accesso dell'associazione di risorse
Severity	Gravità del problema.
Subscriptions	Sottoscrizioni per le regole in ingresso
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

AccessRule

Oggetto

Regola di accesso in un profilo di configurazione del perimetro di sicurezza di rete

Nome	Tipo	Descrizione
name	string	Nome della regola di accesso
properties	AccessRuleProperties	Proprietà della regola di accesso

AccessRuleDirection

Enumerazione

Direzione della regola di accesso

Valore	Descrizione
Inbound	Si applica al traffico di rete in ingresso alle risorse protette.
Outbound	Si applica al traffico di rete in uscita dalle risorse protette

AccessRuleProperties

Oggetto

Proprietà della regola di accesso

Nome	Tipo	Descrizione
addressPrefixes	string[]	Prefissi di indirizzo nel formato CIDR per le regole in ingresso
direction	AccessRuleDirection	Direzione della regola di accesso
emailAddresses	string[]	Indirizzi di posta elettronica per le regole in uscita
fullyQualifiedDomainNames	string[]	Nomi di dominio completi (FQDN) per le regole in uscita
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Perimetri di sicurezza di rete per le regole in ingresso
phoneNumbers	string[]	Numeri di telefono per le regole in uscita
subscriptions	Subscriptions[]	Sottoscrizioni per le regole in ingresso

CloudError

Oggetto

Contiene informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
message	string	Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/debug fare riferimento alla proprietà 'error.message').

CloudErrorBody

Oggetto

Descrive un particolare errore dell'API con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details	CloudErrorBody[]	Contiene errori annidati correlati a questo errore.
message	string	Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

IssueType

Enumerazione

Tipo di problema

Valore	Descrizione
Unknown	Tipo di problema sconosciuto
ConfigurationPropagationFailure	Si è verificato un errore durante l'applicazione della configurazione del perimetro di sicurezza di rete .
MissingPerimeterConfiguration	Si verifica un problema di connettività di rete nella risorsa che può essere risolto aggiungendo nuove risorse al perimetro di sicurezza di rete (NSP) o modificando le regole di accesso.
MissingIdentityConfiguration	Un'identità gestita non è stata associata alla risorsa. La risorsa sarà comunque in grado di convalidare il traffico in ingresso dal perimetro di sicurezza di rete (NSP) o le regole di accesso in ingresso corrispondenti, ma non sarà in grado di eseguire l'accesso in uscita come membro del provider di servizi di rete.

NetworkSecurityPerimeter

Oggetto

Informazioni su un perimetro di sicurezza di rete

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa di Azure completo della risorsa NSP
location	string	Posizione del perimetro di sicurezza di rete
perimeterGuid	string (uuid)	ID univoco universale (UUID) del perimetro di sicurezza di rete

NetworkSecurityPerimeterConfiguration

Oggetto

Risorsa di configurazione NSP (Network Security Perimeter)

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties	NetworkSecurityPerimeterConfigurationProperties	Proprietà di configurazione della sicurezza di rete.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Oggetto

Proprietà di configurazione della sicurezza di rete.

Nome	Tipo	Descrizione
networkSecurityPerimeter	NetworkSecurityPerimeter	Informazioni su un perimetro di sicurezza di rete
profile	NetworkSecurityProfile	Profilo di configurazione del perimetro di sicurezza di rete
provisioningIssues	ProvisioningIssue[]	Elenco dei problemi di provisioning, se presenti
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Stato di provisioning di una configurazione perimetrale della sicurezza di rete che viene creata o aggiornata.
resourceAssociation	ResourceAssociation	Informazioni sull'associazione di risorse

NetworkSecurityPerimeterConfigurationProvisioningState

Enumerazione

Stato di provisioning di una configurazione perimetrale della sicurezza di rete che viene creata o aggiornata.

Valore	Descrizione
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Oggetto

Profilo di configurazione del perimetro di sicurezza di rete

Nome	Tipo	Descrizione
accessRules	AccessRule[]	Elenco delle regole di accesso
accessRulesVersion	integer (int32)	Versione corrente delle regole di accesso
diagnosticSettingsVersion	integer (int32)	Versione corrente delle impostazioni di diagnostica
enabledLogCategories	string[]	Elenco delle categorie di log abilitate
name	string	Nome del profilo

ProvisioningIssue

Oggetto

Descrive un problema di provisioning per una configurazione perimetrale della sicurezza di rete

Nome	Tipo	Descrizione
name	string	Nome del problema
properties	ProvisioningIssueProperties	Dettagli di un problema di provisioning per una configurazione NSP (Network Security Perimeter). I provider di risorse devono generare elementi di problema di provisioning separati per ogni problema separato rilevato e includere una descrizione significativa e distintiva, nonché eventuali elementi suggeritiResourceIds e suggestedAccessRules appropriati

ProvisioningIssueProperties

Oggetto

Dettagli di un problema di provisioning per una configurazione NSP (Network Security Perimeter). I provider di risorse devono generare elementi di problema di provisioning separati per ogni problema separato rilevato e includere una descrizione significativa e distintiva, nonché eventuali elementi suggeritiResourceIds e suggestedAccessRules appropriati

Nome	Tipo	Descrizione
description	string	Descrizione del problema
issueType	IssueType	Tipo di problema
severity	Severity	Gravità del problema.
suggestedAccessRules	AccessRule[]	Regole di accesso che possono essere aggiunte al profilo di sicurezza di rete (NSP) per risolvere il problema.
suggestedResourceIds	string[] (arm-id)	ID risorsa completi delle risorse suggerite che possono essere associate al perimetro di sicurezza di rete (NSP) per risolvere il problema.

ResourceAssociation

Oggetto

Informazioni sull'associazione di risorse

Nome	Tipo	Descrizione
accessMode	ResourceAssociationAccessMode	Modalità di accesso dell'associazione di risorse
name	string	Nome dell'associazione di risorse

ResourceAssociationAccessMode

Enumerazione

Modalità di accesso dell'associazione di risorse

Valore	Descrizione
Enforced	Modalità di accesso applicata: il traffico verso la risorsa che non ha superato i controlli di accesso viene bloccato
Learning	Modalità di accesso all'apprendimento: il traffico verso la risorsa è abilitato per l'analisi ma non bloccato
Audit	Modalità di accesso di controllo: il traffico verso la risorsa che non supera i controlli di accesso viene registrato ma non bloccato

Severity

Enumerazione

Gravità del problema.

Valore	Descrizione
Warning
Error

Subscriptions

Oggetto

Sottoscrizioni per le regole in ingresso

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa di Azure completo della sottoscrizione, ad esempio ('/subscriptions/000000000-0000-0000-0000-000000000000000')

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.