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 參數

名稱	位於	必要	類型	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 搜尋服務名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	NetworkSecurityPerimeterConfiguration	Azure 作業已順利完成。
Other Status Codes	CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	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"
    }
  }
}

定義

名稱	Description
AccessRule	網路安全性周邊組態配置檔中的存取規則
AccessRuleDirection	存取規則的方向
AccessRuleProperties	存取規則的屬性
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
createdByType	建立資源的身分識別類型。
IssueType	問題類型
NetworkSecurityPerimeter	網路安全性周邊的相關信息（NSP）
NetworkSecurityPerimeterConfiguration	網路安全性周邊（NSP）設定資源
NetworkSecurityPerimeterConfigurationProperties	網路安全性組態屬性。
NetworkSecurityPerimeterConfigurationProvisioningState	正在建立或更新的網路安全性周邊設定布建狀態。
NetworkSecurityProfile	網路安全性周邊組態配置檔
ProvisioningIssue	描述網路安全性周邊設定的布建問題
ProvisioningIssueProperties	網路安全性周邊（NSP）設定的布建問題詳細數據。資源提供者應該為每個偵測到的不同問題產生個別的布建問題元素，並包含有意義且獨特的描述，以及任何適當的建議ResourceIds 和 suggestedAccessRules
ResourceAssociation	資源關聯的相關信息
ResourceAssociationAccessMode	資源關聯的存取模式
Severity	問題的嚴重性。
Subscriptions	輸入規則的訂用帳戶
systemData	與建立和上次修改資源相關的元數據。

AccessRule

Object

網路安全性周邊組態配置檔中的存取規則

名稱	類型	Description
name	string	存取規則的名稱
properties	AccessRuleProperties	存取規則的屬性

AccessRuleDirection

列舉型別

存取規則的方向

值	Description
Inbound	適用於安全資源的輸入網路流量。
Outbound	適用於來自受保護資源的輸出網路流量

AccessRuleProperties

Object

存取規則的屬性

名稱	類型	Description
addressPrefixes	string[]	輸入規則 CIDR 格式的位址前置詞
direction	AccessRuleDirection	存取規則的方向
emailAddresses	string[]	輸出規則的電子郵件位址
fullyQualifiedDomainNames	string[]	輸出規則的完整功能變數名稱（FQDN）
networkSecurityPerimeters	NetworkSecurityPerimeter[]	輸入規則的網路安全性周邊
phoneNumbers	string[]	輸出規則的電話號碼
subscriptions	Subscriptions[]	輸入規則的訂用帳戶

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
message	string	錯誤簡短描述，其中提示發生錯誤的原因（如需詳細數據/偵錯資訊，請參閱 'error.message' 屬性。

CloudErrorBody

Object

描述具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	比 HTTP 狀態代碼更精確地描述錯誤條件的錯誤碼。可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	特定錯誤的目標（例如，錯誤中的屬性名稱）。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

IssueType

列舉型別

問題類型

值	Description
Unknown	未知的問題類型
ConfigurationPropagationFailure	套用網路安全性周邊（NSP）組態時發生錯誤。
MissingPerimeterConfiguration	網路連線問題發生在資源上，您可以藉由將新的資源新增至網路安全性周邊（NSP）或修改存取規則來解決。
MissingIdentityConfiguration	受控識別尚未與資源相關聯。資源仍然可以驗證來自網路安全性周邊（NSP）或相符輸入存取規則的輸入流量，但無法以 NSP 的成員身分執行輸出存取。

NetworkSecurityPerimeter

Object

網路安全性周邊的相關信息（NSP）

名稱	類型	Description
id	string (arm-id)	NSP 資源的完整 Azure 資源識別碼
location	string	網路安全性周邊的位置
perimeterGuid	string (uuid)	網路安全性周邊的通用唯一標識碼（UUID）

NetworkSecurityPerimeterConfiguration

Object

網路安全性周邊（NSP）設定資源

名稱	類型	Description
id	string (arm-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

網路安全性組態屬性。

名稱	類型	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	網路安全性周邊的相關信息（NSP）
profile	NetworkSecurityProfile	網路安全性周邊組態配置檔
provisioningIssues	ProvisioningIssue[]	布建問題清單，如果有的話
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	正在建立或更新的網路安全性周邊設定布建狀態。
resourceAssociation	ResourceAssociation	資源關聯的相關信息

NetworkSecurityPerimeterConfigurationProvisioningState

列舉型別

正在建立或更新的網路安全性周邊設定布建狀態。

值	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Object

網路安全性周邊組態配置檔

名稱	類型	Description
accessRules	AccessRule[]	存取規則清單
accessRulesVersion	integer (int32)	目前的存取規則版本
diagnosticSettingsVersion	integer (int32)	目前的診斷設定版本
enabledLogCategories	string[]	已啟用的記錄類別清單
name	string	配置檔的名稱

ProvisioningIssue

Object

描述網路安全性周邊設定的布建問題

名稱	類型	Description
name	string	問題的名稱
properties	ProvisioningIssueProperties	網路安全性周邊（NSP）設定的布建問題詳細數據。資源提供者應該為每個偵測到的不同問題產生個別的布建問題元素，並包含有意義且獨特的描述，以及任何適當的建議ResourceIds 和 suggestedAccessRules

ProvisioningIssueProperties

Object

網路安全性周邊（NSP）設定的布建問題詳細數據。資源提供者應該為每個偵測到的不同問題產生個別的布建問題元素，並包含有意義且獨特的描述，以及任何適當的建議ResourceIds 和 suggestedAccessRules

名稱	類型	Description
description	string	問題的描述
issueType	IssueType	問題類型
severity	Severity	問題的嚴重性。
suggestedAccessRules	AccessRule[]	可新增至網路安全性配置檔（NSP）的存取規則，以補救問題。
suggestedResourceIds	string[] (arm-id)	建議資源的完整資源標識碼，這些資源可以與網路安全性周邊（NSP）相關聯，以補救問題。

ResourceAssociation

Object

資源關聯的相關信息

名稱	類型	Description
accessMode	ResourceAssociationAccessMode	資源關聯的存取模式
name	string	資源關聯的名稱

ResourceAssociationAccessMode

列舉型別

資源關聯的存取模式

值	Description
Enforced	強制存取模式 - 封鎖存取檢查失敗之資源的流量
Learning	學習存取模式 - 資源的流量已啟用以進行分析，但未封鎖
Audit	稽核存取模式 - 記錄存取檢查失敗但未封鎖之資源的流量

Severity

列舉型別

問題的嚴重性。

值	Description
Warning
Error

Subscriptions

Object

輸入規則的訂用帳戶

名稱	類型	Description
id	string (arm-id)	訂用帳戶的完整 Azure 資源標識符，例如（'/subscriptions/00000000-0000-0000-0000-000000000000000'）

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。