你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
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 资源管理器 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 资源管理器 API 或门户获取此值。
api-version	query	True	string	要用于每个请求的 API 版本。

响应

名称	类型	说明
200 OK	NetworkSecurityPerimeterConfiguration	已成功检索配置。
Other Status Codes	CloudError	操作期间发生意外错误。

安全性

azure_auth

指定Microsoft标识平台上支持的隐式授权流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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"
            ]
          }
        }
      ]
    }
  }
}

定义

名称	说明
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
NetworkSecurityPerimeterConfiguration	服务器的网络安全外围配置。
NSPConfigAccessRule	网络安全外围配置的访问规则。
NSPConfigAccessRuleProperties	网络安全外围配置中访问规则的属性。
NSPConfigAssociation	网络安全外围的资源关联。
NSPConfigNetworkSecurityPerimeterRule	配置规则中存在的网络安全外围属性。
NSPConfigPerimeter	网络安全外围配置的外围。
NSPConfigProfile	网络安全外围配置的配置文件。
NSPProvisioningIssue	一个对象，用于描述将网络安全外围预配到搜索服务时出现任何问题。
NSPProvisioningIssueProperties	描述将网络安全外围预配到搜索服务时出现任何问题的属性。

CloudError

对象

包含有关 API 错误的信息。

名称	类型	说明
error	CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
message	string	提示出错的错误的简要说明（有关详细信息/调试信息，请参阅“error.message”属性）。

CloudErrorBody

对象

描述具有错误代码和消息的特定 API 错误。

名称	类型	说明
code	string	比 HTTP 状态代码更准确地描述错误条件的错误代码。可用于以编程方式处理特定错误案例。
details	CloudErrorBody[]	包含与此错误相关的嵌套错误。
message	string	详细说明错误并提供调试信息的消息。
target	string	特定错误的目标（例如，错误中属性的名称）。

NetworkSecurityPerimeterConfiguration

对象

服务器的网络安全外围配置。

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /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

对象

网络安全外围配置的访问规则。

名称	类型	说明
name	string
properties	NSPConfigAccessRuleProperties	网络安全外围配置中访问规则的属性。

NSPConfigAccessRuleProperties

对象

网络安全外围配置中访问规则的属性。

名称	类型	说明
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	配置规则中存在的网络安全外围属性。
subscriptions	string[]

NSPConfigAssociation

对象

网络安全外围的资源关联。

名称	类型	说明
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

对象

配置规则中存在的网络安全外围属性。

名称	类型	说明
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

对象

网络安全外围配置的外围。

名称	类型	说明
id	string
location	string
perimeterGuid	string

NSPConfigProfile

对象

网络安全外围配置的配置文件。

名称	类型	说明
accessRules	NSPConfigAccessRule[]	网络安全外围配置的访问规则。
accessRulesVersion	string
name	string

NSPProvisioningIssue

对象

一个对象，用于描述将网络安全外围预配到搜索服务时出现任何问题。

名称	类型	说明
name	string
properties	NSPProvisioningIssueProperties	描述将网络安全外围预配到搜索服务时出现任何问题的属性。

NSPProvisioningIssueProperties

对象

描述将网络安全外围预配到搜索服务时出现任何问题的属性。

名称	类型	说明
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]