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	Имя группы ресурсов в текущей подписке. Это значение можно получить из API Azure Resource Manager или портала.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Имя службы поиска ИИ Azure, связанной с указанной группой ресурсов.
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure. Это значение можно получить из API Azure Resource Manager или портала.
api-version	query	True	string	Версия API, используемая для каждого запроса.

Ответы

Имя	Тип	Описание
200 OK	NetworkSecurityPerimeterConfiguration	Успешно получена конфигурация.
Other Status Codes	CloudError	Во время операции произошла непредвиденная ошибка.

Безопасность

azure_auth

Указывает неявный поток предоставления, как поддерживается на платформе удостоверений Майкрософт.

Тип: oauth2
Flow: 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	Полный идентификатор ресурса для ресурса. Пример - /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[]