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 參數

名稱	位於	必要	類型	Description
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 版本。

要求本文

名稱	類型	Description
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識別碼格式的訂用帳戶標識碼。

回應

名稱	類型	Description
200 OK	NspAccessRule	資源「NspAccessRule」更新操作成功
201 Created	NspAccessRule	資源 'NspAccessRule' 創建操作成功
Other Status Codes	Common.CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
AccessRuleDirection	指定存取規則是否為輸入/輸出的方向。
Common.CloudError	來自服務的錯誤回應。
Common.CloudErrorBody	來自服務的錯誤回應。
CreatedByType	建立資源的身分識別類型。
NspAccessRule	NSP 存取規則資源
NspProvisioningState	目前的布建狀態。
SecurityPerimeterSystemData	與建立和上次修改資源相關的元數據。

AccessRuleDirection

列舉型別

指定存取規則是否為輸入/輸出的方向。

值	Description
Inbound	Inbound
Outbound	Outbound

Common.CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	Common.CloudErrorBody	雲端錯誤內文。

Common.CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	Common.CloudErrorBody[]	有關錯誤的其他詳細資料清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

CreatedByType

列舉型別

建立資源的身分識別類型。

值	Description
User	使用者
Application	應用程式
ManagedIdentity	ManagedIdentity
Key	鑰匙

NspAccessRule

Object

NSP 存取規則資源

名稱	類型	Description
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	提供的 NSP 的位置。
properties.networkSecurityPerimeters.perimeterGuid	string	提供的 NSP 資源指南。
properties.phoneNumbers	string[]	電話號碼格式的輸出規則。此存取規則類型目前無法使用。
properties.provisioningState	NspProvisioningState	範圍指派資源的佈建狀態。
properties.serviceTags	string[]	服務標籤類型的輸入規則。此存取規則類型目前無法使用。
properties.subscriptions.id	string (arm-id)	ARM識別碼格式的訂用帳戶標識碼。
systemData	SecurityPerimeterSystemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的類型。例如「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」

NspProvisioningState

列舉型別

目前的布建狀態。

值	Description
Succeeded	成功
Creating	建立中
Updating	更新中
Deleting	刪除中
Accepted	已接受
Failed	失敗

SecurityPerimeterSystemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	CreatedByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	CreatedByType	上次修改資源的身分識別類型。