Network Security Perimeter Configurations - Get

Service:: Search Management

Version d’API:: 2025-05-01

Obtient une configuration de périmètre de sécurité réseau.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	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]*$	Nom de la configuration du périmètre de sécurité réseau.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nom du service Recherche IA Azure associé au groupe de ressources spécifié.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	NetworkSecurityPerimeterConfiguration	L’opération Azure s’est terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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"
    }
  }
}

Définitions

Nom	Description
AccessRule	Règle d’accès dans un profil de configuration de périmètre de sécurité réseau
AccessRuleDirection	Direction de la règle d’accès
AccessRuleProperties	Propriétés de la règle d’accès
CloudError	Contient des informations sur une erreur d’API.
CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
createdByType	Type d’identité qui a créé la ressource.
IssueType	Type de problème
NetworkSecurityPerimeter	Informations sur un périmètre de sécurité réseau (NSP)
NetworkSecurityPerimeterConfiguration	Ressource de configuration de périmètre de sécurité réseau (NSP)
NetworkSecurityPerimeterConfigurationProperties	Propriétés de configuration de la sécurité réseau.
NetworkSecurityPerimeterConfigurationProvisioningState	État d’approvisionnement d’une configuration de périmètre de sécurité réseau en cours de création ou mise à jour.
NetworkSecurityProfile	Profil de configuration du périmètre de sécurité réseau
ProvisioningIssue	Décrit un problème d’approvisionnement pour une configuration de périmètre de sécurité réseau
ProvisioningIssueProperties	Détails d’un problème d’approvisionnement pour une configuration de périmètre de sécurité réseau (NSP). Les fournisseurs de ressources doivent générer des éléments de problème d’approvisionnement distincts pour chaque problème distinct détecté, et inclure une description significative et distinctive, ainsi que les suggestions appropriéesResourceIds et suggestedAccessRules
ResourceAssociation	Informations sur l’association de ressources
ResourceAssociationAccessMode	Mode d’accès de l’association de ressources
Severity	Gravité du problème.
Subscriptions	Abonnements pour les règles de trafic entrant
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AccessRule

Objet

Règle d’accès dans un profil de configuration de périmètre de sécurité réseau

Nom	Type	Description
name	string	Nom de la règle d’accès
properties	AccessRuleProperties	Propriétés de la règle d’accès

AccessRuleDirection

Énumération

Direction de la règle d’accès

Valeur	Description
Inbound	S’applique au trafic réseau entrant vers les ressources sécurisées.
Outbound	S’applique au trafic réseau sortant à partir des ressources sécurisées

AccessRuleProperties

Objet

Propriétés de la règle d’accès

Nom	Type	Description
addressPrefixes	string[]	Préfixes d’adresse au format CIDR pour les règles de trafic entrant
direction	AccessRuleDirection	Direction de la règle d’accès
emailAddresses	string[]	Adresses e-mail pour les règles de trafic sortant
fullyQualifiedDomainNames	string[]	Noms de domaine complets (FQDN) pour les règles de trafic sortant
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Périmètres de sécurité réseau pour les règles de trafic entrant
phoneNumbers	string[]	Numéros de téléphone pour les règles de trafic sortant
subscriptions	Subscriptions[]	Abonnements pour les règles de trafic entrant

CloudError

Objet

Contient des informations sur une erreur d’API.

Nom	Type	Description
error	CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
message	string	Brève description de l’erreur qui indique ce qui s’est passé (pour plus d’informations/débogage, reportez-vous à la propriété « error.message »).

CloudErrorBody

Objet

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code d’état HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	CloudErrorBody[]	Contient des erreurs imbriquées liées à cette erreur.
message	string	Message qui décrit en détail l’erreur et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

IssueType

Énumération

Type de problème

Valeur	Description
Unknown	Type de problème inconnu
ConfigurationPropagationFailure	Une erreur s’est produite lors de l’application de la configuration du périmètre de sécurité réseau (NSP).
MissingPerimeterConfiguration	Un problème de connectivité réseau se produit sur la ressource qui peut être traitée en ajoutant de nouvelles ressources au périmètre de sécurité réseau (NSP) ou en modifiant des règles d’accès.
MissingIdentityConfiguration	Une identité managée n’a pas été associée à la ressource. La ressource sera toujours en mesure de valider le trafic entrant à partir du périmètre de sécurité réseau (NSP) ou de correspondre aux règles d’accès entrantes, mais elle ne pourra pas effectuer d’accès sortant en tant que membre du fournisseur de services réseau.

NetworkSecurityPerimeter

Objet

Informations sur un périmètre de sécurité réseau (NSP)

Nom	Type	Description
id	string (arm-id)	ID de ressource Azure complet de la ressource NSP
location	string	Emplacement du périmètre de sécurité réseau
perimeterGuid	string (uuid)	ID unique universel (UUID) du périmètre de sécurité réseau

NetworkSecurityPerimeterConfiguration

Objet

Ressource de configuration de périmètre de sécurité réseau (NSP)

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties	NetworkSecurityPerimeterConfigurationProperties	Propriétés de configuration de la sécurité réseau.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

NetworkSecurityPerimeterConfigurationProperties

Objet

Propriétés de configuration de la sécurité réseau.

Nom	Type	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Informations sur un périmètre de sécurité réseau (NSP)
profile	NetworkSecurityProfile	Profil de configuration du périmètre de sécurité réseau
provisioningIssues	ProvisioningIssue[]	Liste des problèmes d’approvisionnement, le cas échéant
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	État d’approvisionnement d’une configuration de périmètre de sécurité réseau en cours de création ou mise à jour.
resourceAssociation	ResourceAssociation	Informations sur l’association de ressources

NetworkSecurityPerimeterConfigurationProvisioningState

Énumération

État d’approvisionnement d’une configuration de périmètre de sécurité réseau en cours de création ou mise à jour.

Valeur	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Objet

Profil de configuration du périmètre de sécurité réseau

Nom	Type	Description
accessRules	AccessRule[]	Liste des règles d’accès
accessRulesVersion	integer (int32)	Version actuelle des règles d’accès
diagnosticSettingsVersion	integer (int32)	Version actuelle des paramètres de diagnostic
enabledLogCategories	string[]	Liste des catégories de journaux activées
name	string	Nom du profil

ProvisioningIssue

Objet

Décrit un problème d’approvisionnement pour une configuration de périmètre de sécurité réseau

Nom	Type	Description
name	string	Nom du problème
properties	ProvisioningIssueProperties	Détails d’un problème d’approvisionnement pour une configuration de périmètre de sécurité réseau (NSP). Les fournisseurs de ressources doivent générer des éléments de problème d’approvisionnement distincts pour chaque problème distinct détecté, et inclure une description significative et distinctive, ainsi que les suggestions appropriéesResourceIds et suggestedAccessRules

ProvisioningIssueProperties

Objet

Détails d’un problème d’approvisionnement pour une configuration de périmètre de sécurité réseau (NSP). Les fournisseurs de ressources doivent générer des éléments de problème d’approvisionnement distincts pour chaque problème distinct détecté, et inclure une description significative et distinctive, ainsi que les suggestions appropriéesResourceIds et suggestedAccessRules

Nom	Type	Description
description	string	Description du problème
issueType	IssueType	Type de problème
severity	Severity	Gravité du problème.
suggestedAccessRules	AccessRule[]	Règles d’accès qui peuvent être ajoutées au profil de sécurité réseau (NSP) pour corriger le problème.
suggestedResourceIds	string[] (arm-id)	ID de ressources complets des ressources suggérées qui peuvent être associées au périmètre de sécurité réseau (NSP) pour corriger le problème.

ResourceAssociation

Objet

Informations sur l’association de ressources

Nom	Type	Description
accessMode	ResourceAssociationAccessMode	Mode d’accès de l’association de ressources
name	string	Nom de l’association de ressources

ResourceAssociationAccessMode

Énumération

Mode d’accès de l’association de ressources

Valeur	Description
Enforced	Mode d’accès appliqué : le trafic vers la ressource qui a échoué aux vérifications d’accès est bloqué
Learning	Mode d’accès d’apprentissage : le trafic vers la ressource est activé pour l’analyse, mais pas bloqué
Audit	Mode d’accès audit : le trafic vers la ressource qui échoue aux vérifications d’accès est journalisé, mais pas bloqué

Severity

Énumération

Gravité du problème.

Valeur	Description
Warning
Error

Subscriptions

Objet

Abonnements pour les règles de trafic entrant

Nom	Type	Description
id	string (arm-id)	ID de ressource Azure complet de l’abonnement, par exemple ('/subscriptions/00000000-0000-0000-0000-0000-00000000')

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.