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

Network Security Perimeter Configurations - List

参考

服务:: Cosmos DB Resource Provider

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

获取 cosmos db 帐户的有效网络安全外围配置列表

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations?api-version=2025-05-01-preview

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 数据库帐户名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	NetworkSecurityPerimeterConfigurationListResult	网络安全外围配置列表
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

示例

NamspaceNetworkSecurityPerimeterConfigurationList

示例请求

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/res4410/providers/Microsoft.DocumentDB/databaseAccounts/cosmosTest/networkSecurityPerimeterConfigurations?api-version=2025-05-01-preview

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/res4410/providers/Microsoft.DocumentDB/databaseAccounts/cosmosTest/networkSecurityPerimeterConfigurations/dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
      "name": "dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
      "type": "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations",
      "properties": {
        "provisioningState": "Succeeded",
        "networkSecurityPerimeter": {
          "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/res4794/providers/Microsoft.Network/networkSecurityPerimeters/nsp1",
          "perimeterGuid": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5",
          "location": "East US"
        },
        "resourceAssociation": {
          "name": "association1",
          "accessMode": "Enforced"
        },
        "profile": {
          "name": "profile1",
          "accessRulesVersion": 10,
          "accessRules": [
            {
              "name": "inVpnRule",
              "properties": {
                "direction": "Inbound",
                "addressPrefixes": [
                  "148.0.0.0/8",
                  "152.4.6.0/24"
                ]
              }
            }
          ],
          "diagnosticSettingsVersion": 5,
          "enabledLogCategories": [
            "NspPublicInboundPerimeterRulesAllowed",
            "NspPublicInboundPerimeterRulesDenied"
          ]
        }
      }
    }
  ]
}

定义

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

AccessRule

Object

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

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

AccessRuleDirection

枚举

访问规则的方向

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

AccessRuleProperties

Object

访问规则的属性

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

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

IssueType

枚举

问题类型

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

NetworkSecurityPerimeter

Object

有关网络安全外围（NSP）的信息

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

NetworkSecurityPerimeterConfiguration

Object

网络安全外围（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”

NetworkSecurityPerimeterConfigurationListResult

Object

列出 NSP（网络安全外围）配置请求的结果。

名称	类型	说明
nextLink	string (uri)	用于获取下一页结果的链接。
value	NetworkSecurityPerimeterConfiguration[]	网络安全外围结果数组。

NetworkSecurityPerimeterConfigurationProperties

Object

网络安全配置属性。

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

NetworkSecurityPerimeterConfigurationProvisioningState

枚举

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

值	说明
Accepted
Canceled
Creating
Deleting
Failed
Succeeded
Updating

NetworkSecurityProfile

Object

网络安全外围配置文件

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

ProvisioningIssue

Object

介绍网络安全外围配置的预配问题

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

ProvisioningIssueProperties

Object

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

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

ResourceAssociation

Object

有关资源关联的信息

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

ResourceAssociationAccessMode

枚举

资源关联的访问模式

值	说明
Audit	审核访问模式 - 记录访问检查失败但未阻止的资源的流量
Enforced	强制访问模式 - 阻止访问检查失败的资源的流量
Learning	学习访问模式 - 为分析启用到资源的流量，但未阻止

Severity

枚举

问题的严重性。

值	说明
Error
Warning

Subscriptions

Object

入站规则的订阅

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

systemData

Object

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

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

通过

Network Security Perimeter Configurations - List

URI 参数

响应

示例

NamspaceNetworkSecurityPerimeterConfigurationList

示例请求

示例响应

定义

AccessRule

AccessRuleDirection

AccessRuleProperties

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IssueType

NetworkSecurityPerimeter

NetworkSecurityPerimeterConfiguration

NetworkSecurityPerimeterConfigurationListResult

NetworkSecurityPerimeterConfigurationProperties

NetworkSecurityPerimeterConfigurationProvisioningState

NetworkSecurityProfile

ProvisioningIssue

ProvisioningIssueProperties

ResourceAssociation

ResourceAssociationAccessMode

Severity

Subscriptions

systemData