Network Security Perimeter Configurations - Get

서비스:: Search Management

API 버전:: 2025-05-01

네트워크 보안 경계 구성을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	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]*$	네트워크 보안 경계 구성 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	지정된 리소스 그룹과 연결된 Azure AI Search 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	NetworkSecurityPerimeterConfiguration	Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes	CloudError	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

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

샘플 응답

상태 코드:: 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"
    }
  }
}

정의

Name	Description
AccessRule	네트워크 보안 경계 구성 프로필의 액세스 규칙
AccessRuleDirection	액세스 규칙 방향
AccessRuleProperties	액세스 규칙의 속성
CloudError	API 오류에 대한 정보를 포함합니다.
CloudErrorBody	오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.
createdByType	리소스를 만든 ID의 형식입니다.
IssueType	문제 유형
NetworkSecurityPerimeter	NSP(네트워크 보안 경계)에 대한 정보
NetworkSecurityPerimeterConfiguration	NSP(네트워크 보안 경계) 구성 리소스
NetworkSecurityPerimeterConfigurationProperties	네트워크 보안 구성 속성입니다.
NetworkSecurityPerimeterConfigurationProvisioningState	생성되거나 업데이트되는 네트워크 보안 경계 구성의 프로비전 상태입니다.
NetworkSecurityProfile	네트워크 보안 경계 구성 프로필
ProvisioningIssue	네트워크 보안 경계 구성에 대한 프로비전 문제를 설명합니다.
ProvisioningIssueProperties	NSP(네트워크 보안 경계) 구성에 대한 프로비저닝 문제에 대한 세부 정보입니다. 리소스 공급자는 검색된 각 개별 문제에 대해 별도의 프로비저닝 문제 요소를 생성해야 하며 의미 있고 고유한 설명과 적절한 suggestedResourceIds 및 suggestedAccessRules를 포함해야 합니다.
ResourceAssociation	리소스 연결에 대한 정보
ResourceAssociationAccessMode	리소스 연결의 액세스 모드
Severity	문제의 심각도입니다.
Subscriptions	인바운드 규칙에 대한 구독
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

AccessRule

Object

네트워크 보안 경계 구성 프로필의 액세스 규칙

Name	형식	Description
name	string	액세스 규칙의 이름
properties	AccessRuleProperties	액세스 규칙의 속성

AccessRuleDirection

열거형

액세스 규칙 방향

값	Description
Inbound	보안 리소스에 대한 인바운드 네트워크 트래픽에 적용됩니다.
Outbound	보안 리소스의 아웃바운드 네트워크 트래픽에 적용됩니다.

AccessRuleProperties

Object

액세스 규칙의 속성

Name	형식	Description
addressPrefixes	string[]	인바운드 규칙에 대한 CIDR 형식의 주소 접두사
direction	AccessRuleDirection	액세스 규칙 방향
emailAddresses	string[]	아웃바운드 규칙에 대한 이메일 주소
fullyQualifiedDomainNames	string[]	아웃바운드 규칙에 대한 FQDN(정규화된 도메인 이름)
networkSecurityPerimeters	NetworkSecurityPerimeter[]	인바운드 규칙에 대한 네트워크 보안 경계
phoneNumbers	string[]	아웃바운드 규칙의 전화 번호
subscriptions	Subscriptions[]	인바운드 규칙에 대한 구독

CloudError

Object

API 오류에 대한 정보를 포함합니다.

Name	형식	Description
error	CloudErrorBody	오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.
message	string	오류에 대한 간략한 설명은 무엇이 잘못되었는지를 암시합니다(세부 정보/디버깅 정보는 'error.message' 속성을 참조).

CloudErrorBody

Object

오류 코드 및 메시지를 사용하여 특정 API 오류를 설명합니다.

Name	형식	Description
code	string	HTTP 상태 코드보다 오류 조건을 보다 정확하게 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	CloudErrorBody[]	이 오류와 관련된 중첩된 오류를 포함합니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

IssueType

열거형

문제 유형

값	Description
Unknown	알 수 없는 문제 유형
ConfigurationPropagationFailure	NSP(네트워크 보안 경계) 구성을 적용하는 동안 오류가 발생했습니다.
MissingPerimeterConfiguration	NSP(네트워크 보안 경계)에 새 리소스를 추가하거나 액세스 규칙을 수정하여 해결할 수 있는 리소스에서 네트워크 연결 문제가 발생합니다.
MissingIdentityConfiguration	관리 ID가 리소스와 연결되지 않았습니다. 리소스는 여전히 NSP(네트워크 보안 경계) 또는 일치하는 인바운드 액세스 규칙에서 인바운드 트래픽의 유효성을 검사할 수 있지만 NSP의 멤버로 아웃바운드 액세스를 수행할 수는 없습니다.

NetworkSecurityPerimeter

Object

NSP(네트워크 보안 경계)에 대한 정보

Name	형식	Description
id	string (arm-id)	NSP 리소스의 정규화된 Azure 리소스 ID
location	string	네트워크 보안 경계의 위치
perimeterGuid	string (uuid)	네트워크 보안 경계의 UUID(유니버설 고유 ID)

NetworkSecurityPerimeterConfiguration

Object

NSP(네트워크 보안 경계) 구성 리소스

Name	형식	Description
id	string (arm-id)	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름
properties	NetworkSecurityPerimeterConfigurationProperties	네트워크 보안 구성 속성입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Object

네트워크 보안 구성 속성입니다.

Name	형식	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	NSP(네트워크 보안 경계)에 대한 정보
profile	NetworkSecurityProfile	네트워크 보안 경계 구성 프로필
provisioningIssues	ProvisioningIssue[]	프로비전 문제 목록(있는 경우)
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	생성되거나 업데이트되는 네트워크 보안 경계 구성의 프로비전 상태입니다.
resourceAssociation	ResourceAssociation	리소스 연결에 대한 정보

NetworkSecurityPerimeterConfigurationProvisioningState

열거형

생성되거나 업데이트되는 네트워크 보안 경계 구성의 프로비전 상태입니다.

값	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Object

네트워크 보안 경계 구성 프로필

Name	형식	Description
accessRules	AccessRule[]	액세스 규칙 목록
accessRulesVersion	integer (int32)	현재 액세스 규칙 버전
diagnosticSettingsVersion	integer (int32)	현재 진단 설정 버전
enabledLogCategories	string[]	사용하도록 설정된 로그 범주 목록
name	string	프로필의 이름

ProvisioningIssue

Object

네트워크 보안 경계 구성에 대한 프로비전 문제를 설명합니다.

Name	형식	Description
name	string	문제의 이름
properties	ProvisioningIssueProperties	NSP(네트워크 보안 경계) 구성에 대한 프로비저닝 문제에 대한 세부 정보입니다. 리소스 공급자는 검색된 각 개별 문제에 대해 별도의 프로비저닝 문제 요소를 생성해야 하며 의미 있고 고유한 설명과 적절한 suggestedResourceIds 및 suggestedAccessRules를 포함해야 합니다.

ProvisioningIssueProperties

Object

NSP(네트워크 보안 경계) 구성에 대한 프로비저닝 문제에 대한 세부 정보입니다. 리소스 공급자는 검색된 각 개별 문제에 대해 별도의 프로비저닝 문제 요소를 생성해야 하며 의미 있고 고유한 설명과 적절한 suggestedResourceIds 및 suggestedAccessRules를 포함해야 합니다.

Name	형식	Description
description	string	문제에 대한 설명
issueType	IssueType	문제 유형
severity	Severity	문제의 심각도입니다.
suggestedAccessRules	AccessRule[]	문제를 해결하기 위해 NSP(네트워크 보안 프로필)에 추가할 수 있는 액세스 규칙입니다.
suggestedResourceIds	string[] (arm-id)	문제를 해결하기 위해 NSP(네트워크 보안 경계)에 연결할 수 있는 제안된 리소스의 정규화된 리소스 ID입니다.

ResourceAssociation

Object

리소스 연결에 대한 정보

Name	형식	Description
accessMode	ResourceAssociationAccessMode	리소스 연결의 액세스 모드
name	string	리소스 연결의 이름

ResourceAssociationAccessMode

열거형

리소스 연결의 액세스 모드

값	Description
Enforced	액세스 모드 적용 - 액세스 검사에 실패한 리소스에 대한 트래픽이 차단됨
Learning	학습 액세스 모드 - 리소스에 대한 트래픽은 분석을 위해 사용하도록 설정되어 있지만 차단되지 않음
Audit	액세스 모드 감사 - 액세스 검사에 실패한 리소스에 대한 트래픽이 기록되지만 차단되지 않음

Severity

열거형

문제의 심각도입니다.

값	Description
Warning
Error

Subscriptions

Object

인바운드 규칙에 대한 구독

Name	형식	Description
id	string (arm-id)	구독의 정규화된 Azure 리소스 ID(예: '/subscriptions/00000000-0000-0000-0000-0000000000000')

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.