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

Workspaces - Get NSP

服务:: Log Analytics

API 版本:: 2025-07-01

获取网络安全外围配置。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}?api-version=2025-07-01

URI 参数

名称	在	必需	类型	说明
networkSecurityPerimeterConfigurationName	path	True	string minLength: 1 maxLength: 512 pattern: ^.*$	网络安全外围配置的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	工作区的名称。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	NetworkSecurityPerimeterConfiguration	已成功检索配置。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get NSP config by name for Scheduled Query Rule

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.OperationalInsights/workspaces/someWorkspace/networkSecurityPerimeterConfigurations/somePerimeterConfiguration?api-version=2025-07-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python nsp_for_workspaces_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = LogAnalyticsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.workspaces.get_nsp(
        resource_group_name="exampleRG",
        workspace_name="someWorkspace",
        network_security_perimeter_configuration_name="somePerimeterConfiguration",
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/OperationalInsights/stable/2025-07-01/examples/NSPForWorkspaces_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/exampleRG/providers/Microsoft.OperationalInsights/workspaces/someWorkspace/networkSecurityPerimeterConfigurations/somePerimeterConfiguration",
  "name": "somePerimeterConfiguration",
  "type": "Microsoft.OperationalInsights/workspaces/networkSecurityPerimeterConfigurations",
  "properties": {
    "provisioningState": "Accepted",
    "networkSecurityPerimeter": {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
      "location": "japaneast"
    },
    "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"
            ]
          }
        }
      ]
    }
  }
}

定义

名称	说明
AccessRule	网络安全外围配置文件中的访问规则
AccessRuleDirection	访问方向规则
AccessRuleProperties	访问规则的属性
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
IssueType	问题类型
NetworkSecurityPerimeter	有关网络安全边界（NSP）的信息
NetworkSecurityPerimeterConfiguration	网络安全外围（NSP）配置资源
NetworkSecurityPerimeterConfigurationProperties	网络安全配置属性。
NetworkSecurityPerimeterConfigurationProvisioningState	正在创建或更新的网络安全外围配置的预配状态。
NetworkSecurityProfile	网络安全外围配置文件
ProvisioningIssue	描述网络安全外围配置的预配问题
ProvisioningIssueProperties	网络安全外围（NSP）配置的预配问题的详细信息。资源提供程序应为检测到的每个单独问题生成单独的预配问题元素，并包含有意义且独特的说明，以及任何适当的 suggestedResourceIds 和 suggestedAccessRules
ResourceAssociation	有关资源关联的信息
ResourceAssociationAccessMode	资源关联的访问方式
Severity	问题的严重性。
Subscriptions	入站规则的订阅
systemData	与创建和上次修改资源相关的元数据。

AccessRule

对象

网络安全外围配置文件中的访问规则

名称	类型	说明
name	string	访问规则的名称
properties	AccessRuleProperties	访问规则的属性

AccessRuleDirection

枚举

访问方向规则

值	说明
Inbound	适用于到受保护资源的入站网络流量。
Outbound	适用于来自受保护资源的出站网络流量

AccessRuleProperties

对象

访问规则的属性

名称	类型	说明
addressPrefixes	string[]	入站规则的 CIDR 格式的地址前缀
direction	AccessRuleDirection	访问方向规则
emailAddresses	string[]	出站规则的电子邮件地址
fullyQualifiedDomainNames	string[]	出站规则的完全限定域名（FQDN）
networkSecurityPerimeters	NetworkSecurityPerimeter[]	入站规则的网络安全边界
phoneNumbers	string[]	出站规则的电话号码
subscriptions	Subscriptions[]	入站规则的订阅

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

IssueType

枚举

问题类型

值	说明
Unknown	未知问题类型
ConfigurationPropagationFailure	应用网络安全外围（NSP）配置时出错。
MissingPerimeterConfiguration	资源上发生网络连接问题，可以通过向网络安全外围（NSP）添加新资源或修改访问规则来解决。
MissingIdentityConfiguration	托管标识尚未与资源关联。该资源仍能够验证来自网络安全外围（NSP）或匹配的入站访问规则的入站流量，但无法作为 NSP 的成员执行出站访问。

NetworkSecurityPerimeter

对象

有关网络安全边界（NSP）的信息

名称	类型	说明
id	string (arm-id)	NSP 资源的完全限定的 Azure 资源 ID
location	string	网络安全边界的位置
perimeterGuid	string (uuid)	网络安全外围的通用唯一 ID （UUID）

NetworkSecurityPerimeterConfiguration

对象

网络安全外围（NSP）配置资源

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	NetworkSecurityPerimeterConfigurationProperties	网络安全配置属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

NetworkSecurityPerimeterConfigurationProperties

对象

网络安全配置属性。

名称	类型	说明
networkSecurityPerimeter	NetworkSecurityPerimeter	有关网络安全边界（NSP）的信息
profile	NetworkSecurityProfile	网络安全外围配置文件
provisioningIssues	ProvisioningIssue[]	预配问题列表（如果有）
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	正在创建或更新的网络安全外围配置的预配状态。
resourceAssociation	ResourceAssociation	有关资源关联的信息

NetworkSecurityPerimeterConfigurationProvisioningState

枚举

正在创建或更新的网络安全外围配置的预配状态。

值	说明
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

对象

网络安全外围配置文件

名称	类型	说明
accessRules	AccessRule[]	访问规则列表
accessRulesVersion	integer (int32)	当前访问规则版本
diagnosticSettingsVersion	integer (int32)	当前诊断设置版本
enabledLogCategories	string[]	已启用的日志类别列表
name	string	配置文件的名称

ProvisioningIssue

对象

描述网络安全外围配置的预配问题

名称	类型	说明
name	string	问题的名称
properties	ProvisioningIssueProperties	网络安全外围（NSP）配置的预配问题的详细信息。资源提供程序应为检测到的每个单独问题生成单独的预配问题元素，并包含有意义且独特的说明，以及任何适当的 suggestedResourceIds 和 suggestedAccessRules

ProvisioningIssueProperties

对象

网络安全外围（NSP）配置的预配问题的详细信息。资源提供程序应为检测到的每个单独问题生成单独的预配问题元素，并包含有意义且独特的说明，以及任何适当的 suggestedResourceIds 和 suggestedAccessRules

名称	类型	说明
description	string	问题说明
issueType	IssueType	问题类型
severity	Severity	问题的严重性。
suggestedAccessRules	AccessRule[]	可以添加到网络安全配置文件（NSP）以修复问题的访问规则。
suggestedResourceIds	string[] (arm-id)	建议资源的完全限定资源 ID，这些资源可与网络安全外围（NSP）相关联，以修正问题。

ResourceAssociation

对象

有关资源关联的信息

名称	类型	说明
accessMode	ResourceAssociationAccessMode	资源关联的访问方式
name	string	资源关联的名称

ResourceAssociationAccessMode

枚举

资源关联的访问方式

值	说明
Enforced	强制访问模式 - 阻止访问检查失败的资源的流量
Learning	学习访问模式 - 启用资源流量以进行分析，但未阻止
Audit	审核访问模式 - 记录未通过访问检查的资源的流量，但不会被阻止

Severity

枚举

问题的严重性。

值	说明
Warning
Error

Subscriptions

对象

入站规则的订阅

名称	类型	说明
id	string (arm-id)	订阅的完全限定 Azure 资源 ID，例如（'/subscriptions/00000000-0000-0000-0000-000000000000'）

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过