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)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (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). Поставщики ресурсов должны создавать отдельные элементы проблемы подготовки для каждой отдельной проблемы и включать понятное и отличительное описание, а также любое соответствующее предлагаемоеresourceIds и предлагаемыеAccessRules
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)	Полный идентификатор ресурса Azure ресурса NSP
location	string	Расположение периметра безопасности сети
perimeterGuid	string (uuid)	Универсальный уникальный идентификатор (UUID) периметра безопасности сети

NetworkSecurityPerimeterConfiguration

Object

Ресурс конфигурации периметра безопасности сети (NSP)

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties	NetworkSecurityPerimeterConfigurationProperties	Свойства конфигурации безопасности сети.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
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). Поставщики ресурсов должны создавать отдельные элементы проблемы подготовки для каждой отдельной проблемы и включать понятное и отличительное описание, а также любое соответствующее предлагаемоеresourceIds и предлагаемыеAccessRules

ProvisioningIssueProperties

Object

Сведения о проблеме подготовки конфигурации периметра безопасности сети (NSP). Поставщики ресурсов должны создавать отдельные элементы проблемы подготовки для каждой отдельной проблемы и включать понятное и отличительное описание, а также любое соответствующее предлагаемоеresourceIds и предлагаемыеAccessRules

Имя	Тип	Описание
description	string	Описание проблемы
issueType	IssueType	Тип проблемы
severity	Severity	Серьезность проблемы.
suggestedAccessRules	AccessRule[]	Правила доступа, которые можно добавить в профиль безопасности сети (NSP), чтобы устранить проблему.
suggestedResourceIds	string[] (arm-id)	Полные идентификаторы предлагаемых ресурсов, которые могут быть связаны с периметром безопасности сети (NSP), чтобы устранить проблему.

ResourceAssociation

Object

Сведения о сопоставлении ресурсов

Имя	Тип	Описание
accessMode	ResourceAssociationAccessMode	Режим доступа связи ресурсов
name	string	Имя связи ресурсов

ResourceAssociationAccessMode

Перечисление

Режим доступа связи ресурсов

Значение	Описание
Audit	Режим доступа аудита — трафик к ресурсу, который завершает проверку доступа, регистрируется, но не блокируется
Enforced	Режим принудительного доступа — трафик к ресурсу, который не удалось проверить доступ, заблокирован
Learning	Режим доступа к обучению — трафик к ресурсу включен для анализа, но не заблокирован

Severity

Перечисление

Серьезность проблемы.

Значение	Описание
Error
Warning

Subscriptions

Object

Подписки для правил входящего трафика

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса Azure для подписки, например ('/subscriptions/00000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000222)

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