Network Security Perimeter Access Rules - Create Or Update

Служба:: Network security perimeter

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

Создает или обновляет правило доступа к сети.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules/{accessRuleName}?api-version=2025-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
accessRuleName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Имя правила доступа NSP.
networkSecurityPerimeterName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Имя периметра безопасности сети.
profileName	path	True	string maxLength: 80 pattern: (^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)\|(^[a-zA-Z0-9]$)	Имя профиля NSP.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
properties.addressPrefixes	string[]	Префиксы входящих адресов (IPv4/IPv6)
properties.direction	AccessRuleDirection	Направление, указывающее, являются ли правила доступа входящими и исходящими.
properties.emailAddresses	string[]	Правила исходящего трафика в формате адреса электронной почты. Этот тип правила доступа в настоящее время недоступен для использования.
properties.fullyQualifiedDomainNames	string[]	Правила исходящего трафика в полном формате доменного имени.
properties.phoneNumbers	string[]	Правила исходящего трафика в формате номера телефона. Этот тип правила доступа в настоящее время недоступен для использования.
properties.serviceTags	string[]	Правила входящего трафика тега службы типа. Этот тип правила доступа в настоящее время недоступен для использования.
properties.subscriptions.id	string (arm-id)	Идентификатор подписки в формате идентификатора ARM.

Ответы

Имя	Тип	Описание
200 OK	NspAccessRule	Операция обновления ресурса 'NspAccessRule' успешно прошла
201 Created	NspAccessRule	Операция создания ресурса 'NspAccessRule' успешно выполнена
Other Status Codes	Common.CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

NspAccessRulePut

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1?api-version=2025-05-01

{
  "properties": {
    "addressPrefixes": [
      "10.11.0.0/16",
      "10.10.1.0/24"
    ],
    "direction": "Inbound"
  }
}

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates a network access rule.
 *
 * @summary Creates or updates a network access rule.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NspAccessRulePut.json
 */
async function nspAccessRulePut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityPerimeterName = "nsp1";
  const profileName = "profile1";
  const accessRuleName = "accessRule1";
  const parameters = {
    addressPrefixes: ["10.11.0.0/16", "10.10.1.0/24"],
    direction: "Inbound",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeterAccessRules.createOrUpdate(
    resourceGroupName,
    networkSecurityPerimeterName,
    profileName,
    accessRuleName,
    parameters,
  );
  console.log(result);
}

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": "accessRule1",
  "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1",
  "properties": {
    "addressPrefixes": [
      "10.11.0.0/16",
      "10.10.1.0/24"
    ],
    "direction": "Inbound",
    "emailAddresses": [],
    "fullyQualifiedDomainNames": [],
    "networkSecurityPerimeters": [],
    "phoneNumbers": [],
    "provisioningState": "Succeeded",
    "serviceTags": [],
    "subscriptions": []
  },
  "systemData": {
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "createdBy": "user",
    "createdByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User"
  }
}

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

{
  "name": "accessRule1",
  "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1",
  "properties": {
    "addressPrefixes": [
      "10.11.0.0/16",
      "10.10.1.0/24"
    ],
    "direction": "Inbound",
    "emailAddresses": [],
    "fullyQualifiedDomainNames": [],
    "networkSecurityPerimeters": [],
    "phoneNumbers": [],
    "provisioningState": "Succeeded",
    "serviceTags": [],
    "subscriptions": []
  },
  "systemData": {
    "createdAt": "2024-02-07T18:07:36.3446713Z",
    "createdBy": "user",
    "createdByType": "User",
    "lastModifiedAt": "2024-02-07T18:07:36.3446713Z",
    "lastModifiedBy": "user",
    "lastModifiedByType": "User"
  }
}

Определения

Имя	Описание
AccessRuleDirection	Направление, указывающее, являются ли правила доступа входящими и исходящими.
Common.CloudError	Ответ об ошибке от сервиса.
Common.CloudErrorBody	Ответ об ошибке от сервиса.
CreatedByType	Тип удостоверения, создавшего ресурс.
NspAccessRule	Ресурс правила доступа NSP
NspProvisioningState	Текущее состояние подготовки.
SecurityPerimeterSystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AccessRuleDirection

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

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

Значение	Описание
Inbound	Входящий трафик
Outbound	исходящий

Common.CloudError

Объект

Ответ об ошибке от сервиса.

Имя	Тип	Описание
error	Common.CloudErrorBody	Тело ошибки облака.

Common.CloudErrorBody

Объект

Ответ об ошибке от сервиса.

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

CreatedByType

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

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

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

NspAccessRule

Объект

Ресурс правила доступа NSP

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.addressPrefixes	string[]	Префиксы входящих адресов (IPv4/IPv6)
properties.direction	AccessRuleDirection	Направление, указывающее, являются ли правила доступа входящими и исходящими.
properties.emailAddresses	string[]	Правила исходящего трафика в формате адреса электронной почты. Этот тип правила доступа в настоящее время недоступен для использования.
properties.fullyQualifiedDomainNames	string[]	Правила исходящего трафика в полном формате доменного имени.
properties.networkSecurityPerimeters.id	string (arm-id)	NSP id в формате ARM id.
properties.networkSecurityPerimeters.location	string	Местонахождение НСП предоставлено.
properties.networkSecurityPerimeters.perimeterGuid	string	Предоставлен справочник ресурса NSP.
properties.phoneNumbers	string[]	Правила исходящего трафика в формате номера телефона. Этот тип правила доступа в настоящее время недоступен для использования.
properties.provisioningState	NspProvisioningState	Состояние подготовки ресурса назначения области.
properties.serviceTags	string[]	Правила входящего трафика тега службы типа. Этот тип правила доступа в настоящее время недоступен для использования.
properties.subscriptions.id	string (arm-id)	Идентификатор подписки в формате идентификатора ARM.
systemData	SecurityPerimeterSystemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

NspProvisioningState

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

Текущее состояние подготовки.

Значение	Описание
Succeeded	Succeeded
Creating	Создавать
Updating	Обновление
Deleting	Удаление
Accepted	Акцептировано
Failed	Неудача

SecurityPerimeterSystemData

Объект

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

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