Network Security Perimeter Configurations - Get

服務:: Search Management

API 版本:: 2025-02-01-preview

取得網路安全性周邊組態。

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

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	目前訂用帳戶內的資源組名。您可以從 Azure Resource Manager API 或入口網站取得此值。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	與指定資源群組相關聯的 Azure AI 搜尋服務名稱。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。您可以從 Azure Resource Manager API 或入口網站取得此值。
api-version	query	True	string	每個要求所使用的 API 版本。

回應

名稱	類型	Description
200 OK	NetworkSecurityPerimeterConfiguration	已成功擷取組態。
Other Status Codes	CloudError	作業期間發生未預期的錯誤。

安全性

azure_auth

指定Microsoft身分識別平台上支援的隱含授與流程。

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

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get an NSP config by name

範例要求

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2025-02-01-preview

範例回覆

狀態碼:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
  "name": "00000001-2222-3333-4444-111144444444.assoc1",
  "type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
  "properties": {
    "provisioningState": "Accepted",
    "networkSecurityPerimeter": {
      "id": "/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
      "location": "westus"
    },
    "resourceAssociation": {
      "name": "assoc1",
      "accessMode": "Enforced"
    },
    "profile": {
      "name": "profile1",
      "accessRulesVersion": "0",
      "accessRules": [
        {
          "name": "rule1",
          "properties": {
            "direction": "Inbound",
            "addressPrefixes": [
              "148.0.0.0/8",
              "152.4.6.0/24"
            ]
          }
        }
      ]
    }
  }
}

定義

名稱	Description
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
NetworkSecurityPerimeterConfiguration	伺服器的網路安全性周邊設定。
NSPConfigAccessRule	網路安全性周邊設定的存取規則。
NSPConfigAccessRuleProperties	網路安全性周邊組態中存取規則的屬性。
NSPConfigAssociation	網路安全性周邊的資源關聯。
NSPConfigNetworkSecurityPerimeterRule	組態規則中存在的網路安全性周邊屬性。
NSPConfigPerimeter	網路安全性周邊設定的周邊。
NSPConfigProfile	網路安全性周邊組態的配置檔。
NSPProvisioningIssue	物件，描述將網路安全性周邊布建至搜尋服務時發生任何問題。
NSPProvisioningIssueProperties	描述將網路安全性周邊布建至搜尋服務之任何問題的屬性。

CloudError

Object

包含 API 錯誤的相關信息。

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

CloudErrorBody

Object

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

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

NetworkSecurityPerimeterConfiguration

Object

伺服器的網路安全性周邊設定。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.networkSecurityPerimeter	NSPConfigPerimeter	網路安全性周邊設定的周邊。
properties.profile	NSPConfigProfile	網路安全性周邊組態的配置檔。
properties.provisioningIssues	NSPProvisioningIssue[]	物件，描述將網路安全性周邊布建至搜尋服務時發生任何問題。
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	網路安全性周邊的資源關聯。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

NSPConfigAccessRule

Object

網路安全性周邊設定的存取規則。

名稱	類型	Description
name	string
properties	NSPConfigAccessRuleProperties	網路安全性周邊組態中存取規則的屬性。

NSPConfigAccessRuleProperties

Object

網路安全性周邊組態中存取規則的屬性。

名稱	類型	Description
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	組態規則中存在的網路安全性周邊屬性。
subscriptions	string[]

NSPConfigAssociation

Object

網路安全性周邊的資源關聯。

名稱	類型	Description
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

Object

組態規則中存在的網路安全性周邊屬性。

名稱	類型	Description
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

Object

網路安全性周邊設定的周邊。

名稱	類型	Description
id	string
location	string
perimeterGuid	string

NSPConfigProfile

Object

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

名稱	類型	Description
accessRules	NSPConfigAccessRule[]	網路安全性周邊設定的存取規則。
accessRulesVersion	string
name	string

NSPProvisioningIssue

Object

物件，描述將網路安全性周邊布建至搜尋服務時發生任何問題。

名稱	類型	Description
name	string
properties	NSPProvisioningIssueProperties	描述將網路安全性周邊布建至搜尋服務之任何問題的屬性。

NSPProvisioningIssueProperties

Object

描述將網路安全性周邊布建至搜尋服務之任何問題的屬性。

名稱	類型	Description
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]