Network Security Perimeter Configurations - Get

Servicio:: Search Management

Versión de la API:: 2025-05-01

Obtiene una configuración perimetral de seguridad de red.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	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]*$	Nombre de configuración perimetral de seguridad de red.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	NetworkSecurityPerimeterConfiguration	La operación de Azure se completó correctamente.
Other Status Codes	CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

status code:: 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"
    }
  }
}

Definiciones

Nombre	Description
AccessRule	Regla de acceso en un perfil de configuración perimetral de seguridad de red
AccessRuleDirection	Dirección de la regla de acceso
AccessRuleProperties	Propiedades de la regla de acceso
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
createdByType	Tipo de identidad que creó el recurso.
IssueType	Tipo de problema
NetworkSecurityPerimeter	Información sobre un perímetro de seguridad de red (NSP)
NetworkSecurityPerimeterConfiguration	Recurso de configuración del perímetro de seguridad de red (NSP)
NetworkSecurityPerimeterConfigurationProperties	Propiedades de configuración de seguridad de red.
NetworkSecurityPerimeterConfigurationProvisioningState	Estado de aprovisionamiento de una configuración perimetral de seguridad de red que se está creando o actualizando.
NetworkSecurityProfile	Perfil de configuración perimetral de seguridad de red
ProvisioningIssue	Describe un problema de aprovisionamiento para una configuración perimetral de seguridad de red.
ProvisioningIssueProperties	Detalles de un problema de aprovisionamiento para una configuración del perímetro de seguridad de red (NSP). Los proveedores de recursos deben generar elementos de problema de aprovisionamiento independientes para cada problema independiente detectado e incluir una descripción significativa y distintiva, así como cualquier elemento sugerido y sugeridoResourceIds y suggestedAccessRules.
ResourceAssociation	Información sobre la asociación de recursos
ResourceAssociationAccessMode	Modo de acceso de la asociación de recursos
Severity	Gravedad del problema.
Subscriptions	Suscripciones para reglas de entrada
systemData	Metadatos relativos a la creación y última modificación del recurso.

AccessRule

Objeto

Regla de acceso en un perfil de configuración perimetral de seguridad de red

Nombre	Tipo	Description
name	string	Nombre de la regla de acceso
properties	AccessRuleProperties	Propiedades de la regla de acceso

AccessRuleDirection

Enumeración

Dirección de la regla de acceso

Valor	Description
Inbound	Se aplica al tráfico de red entrante a los recursos protegidos.
Outbound	Se aplica al tráfico de red saliente de los recursos protegidos.

AccessRuleProperties

Objeto

Propiedades de la regla de acceso

Nombre	Tipo	Description
addressPrefixes	string[]	Prefijos de dirección en el formato CIDR para las reglas de entrada
direction	AccessRuleDirection	Dirección de la regla de acceso
emailAddresses	string[]	Direcciones de correo electrónico para reglas de salida
fullyQualifiedDomainNames	string[]	Nombres de dominio completos (FQDN) para reglas de salida
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Perímetros de seguridad de red para reglas de entrada
phoneNumbers	string[]	Números de teléfono para reglas de salida
subscriptions	Subscriptions[]	Suscripciones para reglas de entrada

CloudError

Objeto

Contiene información sobre un error de API.

Nombre	Tipo	Description
error	CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
message	string	Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message").

CloudErrorBody

Objeto

Describe un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
details	CloudErrorBody[]	Contiene errores anidados relacionados con este error.
message	string	Mensaje que describe el error con detalle y proporciona información de depuración.
target	string	Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

IssueType

Enumeración

Tipo de problema

Valor	Description
Unknown	Tipo de problema desconocido
ConfigurationPropagationFailure	Error al aplicar la configuración del perímetro de seguridad de red (NSP).
MissingPerimeterConfiguration	Se produce un problema de conectividad de red en el recurso que podría solucionarse agregando nuevos recursos al perímetro de seguridad de red (NSP) o modificando las reglas de acceso.
MissingIdentityConfiguration	Una identidad administrada no se ha asociado al recurso. El recurso seguirá siendo capaz de validar el tráfico entrante desde el perímetro de seguridad de red (NSP) o las reglas de acceso entrantes coincidentes, pero no podrá realizar el acceso saliente como miembro del NSP.

NetworkSecurityPerimeter

Objeto

Información sobre un perímetro de seguridad de red (NSP)

Nombre	Tipo	Description
id	string (arm-id)	Identificador completo de recurso de Azure del recurso de NSP
location	string	Ubicación del perímetro de seguridad de red
perimeterGuid	string (uuid)	Identificador único universal (UUID) del perímetro de seguridad de red

NetworkSecurityPerimeterConfiguration

Objeto

Recurso de configuración del perímetro de seguridad de red (NSP)

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties	NetworkSecurityPerimeterConfigurationProperties	Propiedades de configuración de seguridad de red.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Objeto

Propiedades de configuración de seguridad de red.

Nombre	Tipo	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Información sobre un perímetro de seguridad de red (NSP)
profile	NetworkSecurityProfile	Perfil de configuración perimetral de seguridad de red
provisioningIssues	ProvisioningIssue[]	Lista de problemas de aprovisionamiento, si los hay
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Estado de aprovisionamiento de una configuración perimetral de seguridad de red que se está creando o actualizando.
resourceAssociation	ResourceAssociation	Información sobre la asociación de recursos

NetworkSecurityPerimeterConfigurationProvisioningState

Enumeración

Estado de aprovisionamiento de una configuración perimetral de seguridad de red que se está creando o actualizando.

Valor	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Objeto

Perfil de configuración perimetral de seguridad de red

Nombre	Tipo	Description
accessRules	AccessRule[]	Lista de reglas de acceso
accessRulesVersion	integer (int32)	Versión actual de las reglas de acceso
diagnosticSettingsVersion	integer (int32)	Versión actual de la configuración de diagnóstico
enabledLogCategories	string[]	Lista de categorías de registro habilitadas
name	string	Nombre del perfil

ProvisioningIssue

Objeto

Describe un problema de aprovisionamiento para una configuración perimetral de seguridad de red.

Nombre	Tipo	Description
name	string	Nombre del problema
properties	ProvisioningIssueProperties	Detalles de un problema de aprovisionamiento para una configuración del perímetro de seguridad de red (NSP). Los proveedores de recursos deben generar elementos de problema de aprovisionamiento independientes para cada problema independiente detectado e incluir una descripción significativa y distintiva, así como cualquier elemento sugerido y sugeridoResourceIds y suggestedAccessRules.

ProvisioningIssueProperties

Objeto

Detalles de un problema de aprovisionamiento para una configuración del perímetro de seguridad de red (NSP). Los proveedores de recursos deben generar elementos de problema de aprovisionamiento independientes para cada problema independiente detectado e incluir una descripción significativa y distintiva, así como cualquier elemento sugerido y sugeridoResourceIds y suggestedAccessRules.

Nombre	Tipo	Description
description	string	Descripción del problema
issueType	IssueType	Tipo de problema
severity	Severity	Gravedad del problema.
suggestedAccessRules	AccessRule[]	Reglas de acceso que se pueden agregar al perfil de seguridad de red (NSP) para corregir el problema.
suggestedResourceIds	string[] (arm-id)	Identificadores de recursos completos de recursos sugeridos que se pueden asociar al perímetro de seguridad de red (NSP) para corregir el problema.

ResourceAssociation

Objeto

Información sobre la asociación de recursos

Nombre	Tipo	Description
accessMode	ResourceAssociationAccessMode	Modo de acceso de la asociación de recursos
name	string	Nombre de la asociación de recursos

ResourceAssociationAccessMode

Enumeración

Modo de acceso de la asociación de recursos

Valor	Description
Enforced	Modo de acceso aplicado: se bloquea el tráfico al recurso que produjo un error en las comprobaciones de acceso.
Learning	Modo de acceso de aprendizaje: el tráfico al recurso está habilitado para el análisis, pero no bloqueado
Audit	Modo de acceso de auditoría: el tráfico al recurso que produce un error en las comprobaciones de acceso se registra, pero no está bloqueado.

Severity

Enumeración

Gravedad del problema.

Valor	Description
Warning
Error

Subscriptions

Objeto

Suscripciones para reglas de entrada

Nombre	Tipo	Description
id	string (arm-id)	El identificador de recurso completo de Azure de la suscripción, por ejemplo('/subscriptions/000000000-00000-0000-00000-0000000000000')

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.