Network Security Perimeter Configurations - Get

Служба:: Search Management

Версия API:: 2025-05-01

Возвращает конфигурацию периметра безопасности сети.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}?api-version=2025-05-01

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

Ответы

Имя	Тип	Описание
200 OK	NetworkSecurityPerimeterConfiguration	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get an NSP config by name

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2025-05-01

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/NetworkSecurityPerimeterConfigurationsGet.json
func ExampleNetworkSecurityPerimeterConfigurationsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().Get(ctx, "rg1", "mysearchservice", "00000001-2222-3333-4444-111144444444.assoc1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.NetworkSecurityPerimeterConfigurationsClientGetResponse{
	// 	NetworkSecurityPerimeterConfiguration: &armsearch.NetworkSecurityPerimeterConfiguration{
	// 		Name: to.Ptr("00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Type: to.Ptr("Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Properties: &armsearch.NetworkSecurityPerimeterConfigurationProperties{
	// 			NetworkSecurityPerimeter: &armsearch.NetworkSecurityPerimeter{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1"),
	// 				Location: to.Ptr("westus"),
	// 			},
	// 			Profile: &armsearch.NetworkSecurityProfile{
	// 				Name: to.Ptr("profile1"),
	// 				AccessRules: []*armsearch.AccessRule{
	// 					{
	// 						Name: to.Ptr("rule1"),
	// 						Properties: &armsearch.AccessRuleProperties{
	// 							AddressPrefixes: []*string{
	// 								to.Ptr("148.0.0.0/8"),
	// 								to.Ptr("152.4.6.0/24"),
	// 							},
	// 							Direction: to.Ptr(armsearch.AccessRuleDirectionInbound),
	// 						},
	// 					},
	// 				},
	// 				AccessRulesVersion: to.Ptr[int32](0),
	// 			},
	// 			ProvisioningState: to.Ptr(armsearch.NetworkSecurityPerimeterConfigurationProvisioningStateAccepted),
	// 			ResourceAssociation: &armsearch.ResourceAssociation{
	// 				Name: to.Ptr("assoc1"),
	// 				AccessMode: to.Ptr(armsearch.ResourceAssociationAccessModeEnforced),
	// 			},
	// 		},
	// 	},
	// }
}

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

Пример ответа

Код состояния:: 200

{
  "name": "00000001-2222-3333-4444-111144444444.assoc1",
  "type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
  "properties": {
    "networkSecurityPerimeter": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
      "location": "westus"
    },
    "profile": {
      "name": "profile1",
      "accessRules": [
        {
          "name": "rule1",
          "properties": {
            "addressPrefixes": [
              "148.0.0.0/8",
              "152.4.6.0/24"
            ],
            "direction": "Inbound"
          }
        }
      ],
      "accessRulesVersion": 0
    },
    "provisioningState": "Accepted",
    "resourceAssociation": {
      "name": "assoc1",
      "accessMode": "Enforced"
    }
  }
}

Определения

Имя	Описание
AccessRule	Правило доступа в профиле конфигурации периметра безопасности сети
AccessRuleDirection	Направление правила доступа
AccessRuleProperties	Свойства правила доступа
CloudError	Содержит сведения об ошибке API.
CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
createdByType	Тип удостоверения, создавшего ресурс.
IssueType	Тип проблемы
NetworkSecurityPerimeter	Сведения о периметре безопасности сети (NSP)
NetworkSecurityPerimeterConfiguration	Ресурс конфигурации периметра безопасности сети (NSP)
NetworkSecurityPerimeterConfigurationProperties	Свойства конфигурации безопасности сети.
NetworkSecurityPerimeterConfigurationProvisioningState	Состояние подготовки конфигурации периметра безопасности сети, которая создается или обновляется.
NetworkSecurityProfile	Профиль конфигурации периметра безопасности сети
ProvisioningIssue	Описание проблемы подготовки для конфигурации периметра безопасности сети
ProvisioningIssueProperties	Сведения о проблеме подготовки конфигурации периметра безопасности сети (NSP). Поставщики ресурсов должны создавать отдельные элементы проблемы подготовки для каждой отдельной проблемы и включать понятное и отличительное описание, а также любое соответствующее предлагаемоеresourceIds и предлагаемыеAccessRules
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[]	Подписки для правил входящего трафика

CloudError

Объект

Содержит сведения об ошибке API.

Имя	Тип	Описание
error	CloudErrorBody	Описывает определенную ошибку API с кодом ошибки и сообщением.
message	string	Краткое описание ошибки, которая указывает на то, что пошло не так (для получения сведений или отладки см. свойство error.message).

CloudErrorBody

Объект

Описывает определенную ошибку API с кодом ошибки и сообщением.

Имя	Тип	Описание
code	string	Код ошибки, описывающий условие ошибки точнее, чем код состояния HTTP. Можно использовать для программной обработки конкретных случаев ошибок.
details	CloudErrorBody[]	Содержит вложенные ошибки, связанные с этой ошибкой.
message	string	Сообщение, описывающее ошибку подробно и предоставляющее сведения об отладке.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке).

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

IssueType

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

Тип проблемы

Значение	Описание
Unknown	Неизвестный тип проблемы
ConfigurationPropagationFailure	Произошла ошибка при применении конфигурации периметра безопасности сети (NSP).
MissingPerimeterConfiguration	Проблема с сетевым подключением происходит на ресурсе, который можно устранить, добавив новые ресурсы в периметр безопасности сети (NSP) или изменив правила доступа.
MissingIdentityConfiguration	Управляемое удостоверение не связано с ресурсом. Ресурс по-прежнему сможет проверить входящий трафик из периметра безопасности сети (NSP) или сопоставить правила входящего доступа, но он не сможет выполнять исходящий доступ в качестве члена NSP.

NetworkSecurityPerimeter

Объект

Сведения о периметре безопасности сети (NSP)

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса Azure ресурса NSP
location	string	Расположение периметра безопасности сети
perimeterGuid	string (uuid)	Универсальный уникальный идентификатор (UUID) периметра безопасности сети

NetworkSecurityPerimeterConfiguration

Объект

Ресурс конфигурации периметра безопасности сети (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"

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). Поставщики ресурсов должны создавать отдельные элементы проблемы подготовки для каждой отдельной проблемы и включать понятное и отличительное описание, а также любое соответствующее предлагаемоеresourceIds и предлагаемыеAccessRules

ProvisioningIssueProperties

Объект

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

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

ResourceAssociation

Объект

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

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

ResourceAssociationAccessMode

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

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

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

Severity

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

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

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

Subscriptions

Объект

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

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

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.