Network Security Perimeter Configurations - Get

Serviço:: Search Management

Versão da API:: 2025-05-01

Obtém uma configuração de perímetro de segurança de rede.

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

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
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]*$	O nome da configuração do perímetro de segurança de rede.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	NetworkSecurityPerimeterConfiguration	Operação do Azure concluída com êxito.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

Resposta da amostra

Código de estado:: 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"
    }
  }
}

Definições

Name	Descrição
AccessRule	Regra de acesso em um perfil de configuração de perímetro de segurança de rede
AccessRuleDirection	Direção da Regra de Acesso
AccessRuleProperties	Propriedades da regra de acesso
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
createdByType	O tipo de identidade que criou o recurso.
IssueType	Tipo de emissão
NetworkSecurityPerimeter	Informações sobre um perímetro de segurança de rede (NSP)
NetworkSecurityPerimeterConfiguration	Recurso de configuração de perímetro de segurança de rede (NSP)
NetworkSecurityPerimeterConfigurationProperties	Propriedades de configuração de segurança de rede.
NetworkSecurityPerimeterConfigurationProvisioningState	Estado de provisionamento de uma configuração de perímetro de segurança de rede que está sendo criada ou atualizada.
NetworkSecurityProfile	Perfil de configuração do perímetro de segurança de rede
ProvisioningIssue	Descreve um problema de provisionamento para uma configuração de perímetro de segurança de rede
ProvisioningIssueProperties	Detalhes de um problema de provisionamento para uma configuração de perímetro de segurança de rede (NSP). Os provedores de recursos devem gerar elementos de problema de provisionamento separados para cada problema separado detetado e incluir uma descrição significativa e distinta, bem como quaisquer ResourceIds sugeridos e AccessRules sugeridos apropriados
ResourceAssociation	Informações sobre a associação de recursos
ResourceAssociationAccessMode	Modo de acesso da associação de recursos
Severity	Gravidade do problema.
Subscriptions	Subscrições para regras de entrada
systemData	Metadados referentes à criação e última modificação do recurso.

AccessRule

Object

Regra de acesso em um perfil de configuração de perímetro de segurança de rede

Name	Tipo	Descrição
name	string	Nome da regra de acesso
properties	AccessRuleProperties	Propriedades da regra de acesso

AccessRuleDirection

Enumeração

Direção da Regra de Acesso

Valor	Descrição
Inbound	Aplica-se ao tráfego de rede de entrada para os recursos protegidos.
Outbound	Aplica-se ao tráfego de rede de saída dos recursos protegidos

AccessRuleProperties

Object

Propriedades da regra de acesso

Name	Tipo	Descrição
addressPrefixes	string[]	Prefixos de endereço no formato CIDR para regras de entrada
direction	AccessRuleDirection	Direção da Regra de Acesso
emailAddresses	string[]	Endereços de e-mail para regras de saída
fullyQualifiedDomainNames	string[]	Nomes de domínio totalmente qualificados (FQDN) para regras de saída
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Perímetros de segurança de rede para regras de entrada
phoneNumbers	string[]	Números de telefone para regras de saída
subscriptions	Subscriptions[]	Subscrições para regras de entrada

CloudError

Object

Contém informações sobre um erro de API.

Name	Tipo	Descrição
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que sugere o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Object

Descreve um erro de API específico com um código de erro e uma mensagem.

Name	Tipo	Descrição
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

IssueType

Enumeração

Tipo de emissão

Valor	Descrição
Unknown	Tipo de problema desconhecido
ConfigurationPropagationFailure	Ocorreu um erro ao aplicar a configuração de perímetro de segurança de rede (NSP).
MissingPerimeterConfiguration	Está a acontecer um problema de conectividade de rede no recurso que pode ser resolvido adicionando novos recursos ao perímetro de segurança de rede (NSP) ou modificando as regras de acesso.
MissingIdentityConfiguration	Uma identidade gerenciada não foi associada ao recurso. O recurso ainda poderá validar o tráfego de entrada do perímetro de segurança de rede (NSP) ou as regras de acesso de entrada correspondentes, mas não poderá executar o acesso de saída como membro do NSP.

NetworkSecurityPerimeter

Object

Informações sobre um perímetro de segurança de rede (NSP)

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso do Azure totalmente qualificada do recurso NSP
location	string	Localização do perímetro de segurança da rede
perimeterGuid	string (uuid)	ID universal exclusivo (UUID) do perímetro de segurança de rede

NetworkSecurityPerimeterConfiguration

Object

Recurso de configuração de perímetro de segurança de rede (NSP)

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties	NetworkSecurityPerimeterConfigurationProperties	Propriedades de configuração de segurança de rede.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Object

Propriedades de configuração de segurança de rede.

Name	Tipo	Descrição
networkSecurityPerimeter	NetworkSecurityPerimeter	Informações sobre um perímetro de segurança de rede (NSP)
profile	NetworkSecurityProfile	Perfil de configuração do perímetro de segurança de rede
provisioningIssues	ProvisioningIssue[]	Lista de problemas de provisionamento, se houver
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Estado de provisionamento de uma configuração de perímetro de segurança de rede que está sendo criada ou atualizada.
resourceAssociation	ResourceAssociation	Informações sobre a associação de recursos

NetworkSecurityPerimeterConfigurationProvisioningState

Enumeração

Estado de provisionamento de uma configuração de perímetro de segurança de rede que está sendo criada ou atualizada.

Valor	Descrição
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Object

Perfil de configuração do perímetro de segurança de rede

Name	Tipo	Descrição
accessRules	AccessRule[]	Lista de Regras de Acesso
accessRulesVersion	integer (int32)	Versão atual das regras de acesso
diagnosticSettingsVersion	integer (int32)	Versão atual das configurações de diagnóstico
enabledLogCategories	string[]	Lista de categorias de log habilitadas
name	string	Nome do perfil

ProvisioningIssue

Object

Descreve um problema de provisionamento para uma configuração de perímetro de segurança de rede

Name	Tipo	Descrição
name	string	Nome do problema
properties	ProvisioningIssueProperties	Detalhes de um problema de provisionamento para uma configuração de perímetro de segurança de rede (NSP). Os provedores de recursos devem gerar elementos de problema de provisionamento separados para cada problema separado detetado e incluir uma descrição significativa e distinta, bem como quaisquer ResourceIds sugeridos e AccessRules sugeridos apropriados

ProvisioningIssueProperties

Object

Detalhes de um problema de provisionamento para uma configuração de perímetro de segurança de rede (NSP). Os provedores de recursos devem gerar elementos de problema de provisionamento separados para cada problema separado detetado e incluir uma descrição significativa e distinta, bem como quaisquer ResourceIds sugeridos e AccessRules sugeridos apropriados

Name	Tipo	Descrição
description	string	Descrição do problema
issueType	IssueType	Tipo de emissão
severity	Severity	Gravidade do problema.
suggestedAccessRules	AccessRule[]	Regras de acesso que podem ser adicionadas ao perfil de segurança de rede (NSP) para corrigir o problema.
suggestedResourceIds	string[] (arm-id)	IDs de recursos totalmente qualificados de recursos sugeridos que podem ser associados ao perímetro de segurança de rede (NSP) para corrigir o problema.

ResourceAssociation

Object

Informações sobre a associação de recursos

Name	Tipo	Descrição
accessMode	ResourceAssociationAccessMode	Modo de acesso da associação de recursos
name	string	Nome da associação de recursos

ResourceAssociationAccessMode

Enumeração

Modo de acesso da associação de recursos

Valor	Descrição
Enforced	Modo de acesso imposto - o tráfego para o recurso que falhou nas verificações de acesso está bloqueado
Learning	Modo de acesso de aprendizagem - o tráfego para o recurso está habilitado para análise, mas não bloqueado
Audit	Modo de acesso de auditoria - o tráfego para o recurso que falha nas verificações de acesso é registrado, mas não bloqueado

Severity

Enumeração

Gravidade do problema.

Valor	Descrição
Warning
Error

Subscriptions

Object

Subscrições para regras de entrada

Name	Tipo	Descrição
id	string (arm-id)	A ID de recurso do Azure totalmente qualificada da assinatura, por exemplo ('/subscriptions/00000000-0000-0000-0000-000000000000')

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.