Admin Rules - Create Or Update

Servicio:: Network Manager

Versión de la API:: 2025-05-01

Crea o actualiza una regla de administración.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}?api-version=2025-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
configurationName	path	True	string	Nombre de la configuración de seguridad del administrador de red.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Nombre del administrador de red.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
ruleCollectionName	path	True	string	Nombre de la colección de reglas de configuración de seguridad de Network Manager.
ruleName	path	True	string	Nombre de la regla.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre	Description
AdminRule	Regla de administración de red.
DefaultAdminRule	Regla de administración predeterminada de red.

AdminRule

Regla de administración de red.

Nombre	Requerido	Tipo	Description
kind	True	string: Custom	Si la regla es personalizada o predeterminada.
properties.access	True	SecurityConfigurationRuleAccess	Indica el acceso permitido para esta regla determinada.
properties.direction	True	SecurityConfigurationRuleDirection	Indica si el tráfico coincide con la regla de entrada o salida.
properties.priority	True	integer (int32) minimum: 1 maximum: 4096	Prioridad de la regla. El valor puede estar comprendido entre 1 y 4096. El número de prioridad debe ser único para cada regla de la colección. Cuanto menor sea el número de prioridad, mayor será la prioridad de la regla.
properties.protocol	True	SecurityConfigurationRuleProtocol	Protocolo de red al que se aplica esta regla.
properties.description		string	Descripción de esta regla. Restringido a 140 caracteres.
properties.destinationPortRanges		string[]	Intervalos de puertos de destino.
properties.destinations		AddressPrefixItem[]	Prefijos de dirección de destino. CIDR o intervalos IP de destino.
properties.sourcePortRanges		string[]	Intervalos de puertos de origen.
properties.sources		AddressPrefixItem[]	Los intervalos CIDR o IP de origen.

DefaultAdminRule

Regla de administración predeterminada de red.

Nombre	Requerido	Tipo	Description
kind	True	string: Default	Si la regla es personalizada o predeterminada.
properties.flag		string	Marca de regla predeterminada.

Respuestas

Nombre	Tipo	Description
200 OK	BaseAdminRule: AdminRule DefaultAdminRule	Operación de actualización del recurso 'BaseAdminRule' exitosa
201 Created	BaseAdminRule: AdminRule DefaultAdminRule	Resource 'BaseAdminRule' crear operación exitosa
Other Status Codes	CommonErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create a admin rule with network group as source or destination

Create an admin rule

Create a admin rule with network group as source or destination

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule?api-version=2025-05-01

{
  "kind": "Custom",
  "properties": {
    "description": "This is Sample Admin Rule",
    "access": "Deny",
    "destinationPortRanges": [
      "22"
    ],
    "destinations": [
      {
        "addressPrefix": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/ng1",
        "addressPrefixType": "NetworkGroup"
      }
    ],
    "direction": "Inbound",
    "priority": 1,
    "sourcePortRanges": [
      "0-65535"
    ],
    "sources": [
      {
        "addressPrefix": "Internet",
        "addressPrefixType": "ServiceTag"
      }
    ],
    "protocol": "Tcp"
  }
}

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

/**
 * This sample demonstrates how to Creates or updates an admin rule.
 *
 * @summary Creates or updates an admin rule.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkManagerAdminRulePut_NetworkGroupSource.json
 */
async function createAAdminRuleWithNetworkGroupAsSourceOrDestination() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkManagerName = "testNetworkManager";
  const configurationName = "myTestSecurityConfig";
  const ruleCollectionName = "testRuleCollection";
  const ruleName = "SampleAdminRule";
  const adminRule = {
    description: "This is Sample Admin Rule",
    access: "Deny",
    destinationPortRanges: ["22"],
    destinations: [
      {
        addressPrefix:
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/ng1",
        addressPrefixType: "NetworkGroup",
      },
    ],
    direction: "Inbound",
    kind: "Custom",
    priority: 1,
    sourcePortRanges: ["0-65535"],
    sources: [{ addressPrefix: "Internet", addressPrefixType: "ServiceTag" }],
    protocol: "Tcp",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.adminRules.createOrUpdate(
    resourceGroupName,
    networkManagerName,
    configurationName,
    ruleCollectionName,
    ruleName,
    adminRule,
  );
  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

Respuesta de muestra

status code:: 200

{
  "name": "SampleAdminRule",
  "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule",
  "kind": "Custom",
  "properties": {
    "description": "This is Sample Admin Rule using a network group as a source and destination.",
    "access": "Deny",
    "destinationPortRanges": [
      "22"
    ],
    "destinations": [
      {
        "addressPrefix": "*",
        "addressPrefixType": "IPPrefix"
      }
    ],
    "direction": "Inbound",
    "priority": 1,
    "provisioningState": "Succeeded",
    "sourcePortRanges": [
      "0-65535"
    ],
    "sources": [
      {
        "addressPrefix": "Internet",
        "addressPrefixType": "ServiceTag"
      }
    ],
    "protocol": "Tcp"
  },
  "systemData": {
    "createdAt": "2021-01-11T18:52:27Z",
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User"
  }
}

status code:: 201

{
  "name": "SampleAdminRule",
  "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule",
  "kind": "Custom",
  "properties": {
    "description": "This is Sample Admin Rule using a network group as a source and destination.",
    "access": "Deny",
    "destinationPortRanges": [
      "22"
    ],
    "destinations": [
      {
        "addressPrefix": "*",
        "addressPrefixType": "IPPrefix"
      }
    ],
    "direction": "Inbound",
    "priority": 1,
    "provisioningState": "Succeeded",
    "sourcePortRanges": [
      "0-65535"
    ],
    "sources": [
      {
        "addressPrefix": "Internet",
        "addressPrefixType": "ServiceTag"
      }
    ],
    "protocol": "Tcp"
  },
  "systemData": {
    "createdAt": "2021-01-11T18:52:27Z",
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User"
  }
}

Create an admin rule

Solicitud de ejemplo

HTTP
JavaScript

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule?api-version=2025-05-01

{
  "kind": "Custom",
  "properties": {
    "description": "This is Sample Admin Rule",
    "access": "Deny",
    "destinationPortRanges": [
      "22"
    ],
    "destinations": [
      {
        "addressPrefix": "*",
        "addressPrefixType": "IPPrefix"
      }
    ],
    "direction": "Inbound",
    "priority": 1,
    "sourcePortRanges": [
      "0-65535"
    ],
    "sources": [
      {
        "addressPrefix": "Internet",
        "addressPrefixType": "ServiceTag"
      }
    ],
    "protocol": "Tcp"
  }
}

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

/**
 * This sample demonstrates how to Creates or updates an admin rule.
 *
 * @summary Creates or updates an admin rule.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkManagerAdminRulePut.json
 */
async function createAnAdminRule() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkManagerName = "testNetworkManager";
  const configurationName = "myTestSecurityConfig";
  const ruleCollectionName = "testRuleCollection";
  const ruleName = "SampleAdminRule";
  const adminRule = {
    description: "This is Sample Admin Rule",
    access: "Deny",
    destinationPortRanges: ["22"],
    destinations: [{ addressPrefix: "*", addressPrefixType: "IPPrefix" }],
    direction: "Inbound",
    kind: "Custom",
    priority: 1,
    sourcePortRanges: ["0-65535"],
    sources: [{ addressPrefix: "Internet", addressPrefixType: "ServiceTag" }],
    protocol: "Tcp",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.adminRules.createOrUpdate(
    resourceGroupName,
    networkManagerName,
    configurationName,
    ruleCollectionName,
    ruleName,
    adminRule,
  );
  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

Respuesta de muestra

status code:: 200

{
  "name": "SampleAdminRule",
  "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule",
  "kind": "Custom",
  "properties": {
    "description": "This is Sample Admin Rule",
    "access": "Deny",
    "destinationPortRanges": [
      "22"
    ],
    "destinations": [
      {
        "addressPrefix": "*",
        "addressPrefixType": "IPPrefix"
      }
    ],
    "direction": "Inbound",
    "priority": 1,
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "sourcePortRanges": [
      "0-65535"
    ],
    "sources": [
      {
        "addressPrefix": "Internet",
        "addressPrefixType": "ServiceTag"
      }
    ],
    "protocol": "Tcp"
  },
  "systemData": {
    "createdAt": "2021-01-11T18:52:27Z",
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User"
  }
}

status code:: 201

{
  "name": "SampleAdminRule",
  "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule",
  "kind": "Custom",
  "properties": {
    "description": "This is Sample Admin Rule",
    "access": "Deny",
    "destinationPortRanges": [
      "22"
    ],
    "destinations": [
      {
        "addressPrefix": "*",
        "addressPrefixType": "IPPrefix"
      }
    ],
    "direction": "Inbound",
    "priority": 1,
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-000000000000",
    "sourcePortRanges": [
      "0-65535"
    ],
    "sources": [
      {
        "addressPrefix": "Internet",
        "addressPrefixType": "ServiceTag"
      }
    ],
    "protocol": "Tcp"
  },
  "systemData": {
    "createdAt": "2021-01-11T18:52:27Z",
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User"
  }
}

Definiciones

Nombre	Description
AddressPrefixItem	Elemento de prefijo de dirección.
AddressPrefixType	Tipo de prefijo de dirección.
AdminRule	Regla de administración de red.
AdminRuleKind	Si la regla es personalizada o predeterminada.
CommonErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
CommonErrorDetail	Detalle del error.
CommonErrorResponse	Respuesta de error
createdByType	Tipo de identidad que creó el recurso.
DefaultAdminRule	Regla de administración predeterminada de red.
ProvisioningState	Estados de aprovisionamiento de un recurso.
SecurityConfigurationRuleAccess	Si el tráfico de red está permitido o denegado.
SecurityConfigurationRuleDirection	Dirección de la regla. La dirección especifica si la regla se evaluará en el tráfico entrante o saliente.
SecurityConfigurationRuleProtocol	Protocolo de red al que se aplica esta regla.
systemData	Metadatos relativos a la creación y última modificación del recurso.

AddressPrefixItem

Objeto

Elemento de prefijo de dirección.

Nombre	Tipo	Description
addressPrefix	string	Prefijo de dirección.
addressPrefixType	AddressPrefixType	Tipo de prefijo de dirección.

AddressPrefixType

Enumeración

Tipo de prefijo de dirección.

Valor	Description
IPPrefix	IPPrefix
ServiceTag	ServiceTag
NetworkGroup	NetworkGroup

AdminRule

Objeto

Regla de administración de red.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
kind	string: Custom	Si la regla es personalizada o predeterminada.
name	string	Nombre del recurso.
properties.access	SecurityConfigurationRuleAccess	Indica el acceso permitido para esta regla determinada.
properties.description	string	Descripción de esta regla. Restringido a 140 caracteres.
properties.destinationPortRanges	string[]	Intervalos de puertos de destino.
properties.destinations	AddressPrefixItem[]	Prefijos de dirección de destino. CIDR o intervalos IP de destino.
properties.direction	SecurityConfigurationRuleDirection	Indica si el tráfico coincide con la regla de entrada o salida.
properties.priority	integer (int32) minimum: 1 maximum: 4096	Prioridad de la regla. El valor puede estar comprendido entre 1 y 4096. El número de prioridad debe ser único para cada regla de la colección. Cuanto menor sea el número de prioridad, mayor será la prioridad de la regla.
properties.protocol	SecurityConfigurationRuleProtocol	Protocolo de red al que se aplica esta regla.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
properties.resourceGuid	string	Identificador único de este recurso.
properties.sourcePortRanges	string[]	Intervalos de puertos de origen.
properties.sources	AddressPrefixItem[]	Los intervalos CIDR o IP de origen.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso.

AdminRuleKind

Enumeración

Si la regla es personalizada o predeterminada.

Valor	Description
Custom	Personalizada
Default	Predeterminado

CommonErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

CommonErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	CommonErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	CommonErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

CommonErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	CommonErrorDetail	Objeto de error.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultAdminRule

Objeto

Regla de administración predeterminada de red.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
kind	string: Default	Si la regla es personalizada o predeterminada.
name	string	Nombre del recurso.
properties.access	SecurityConfigurationRuleAccess	Indica el acceso permitido para esta regla determinada.
properties.description	string	Descripción de esta regla. Restringido a 140 caracteres.
properties.destinationPortRanges	string[]	Intervalos de puertos de destino.
properties.destinations	AddressPrefixItem[]	Prefijos de dirección de destino. CIDR o intervalos IP de destino.
properties.direction	SecurityConfigurationRuleDirection	Indica si el tráfico coincide con la regla de entrada o salida.
properties.flag	string	Marca de regla predeterminada.
properties.priority	integer (int32)	Prioridad de la regla. El valor puede estar comprendido entre 1 y 4096. El número de prioridad debe ser único para cada regla de la colección. Cuanto menor sea el número de prioridad, mayor será la prioridad de la regla.
properties.protocol	SecurityConfigurationRuleProtocol	Protocolo de red al que se aplica esta regla.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
properties.resourceGuid	string	Identificador único de este recurso.
properties.sourcePortRanges	string[]	Intervalos de puertos de origen.
properties.sources	AddressPrefixItem[]	Los intervalos CIDR o IP de origen.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso.

ProvisioningState

Enumeración

Estados de aprovisionamiento de un recurso.

Valor	Description
Failed	Fallido
Succeeded	Succeeded
Canceled	Cancelado
Creating	Creando
Updating	Actualización
Deleting	Eliminando

SecurityConfigurationRuleAccess

Enumeración

Si el tráfico de red está permitido o denegado.

Valor	Description
Allow	Permitir
Deny	Negar
AlwaysAllow	SiemprePermite

SecurityConfigurationRuleDirection

Enumeración

Dirección de la regla. La dirección especifica si la regla se evaluará en el tráfico entrante o saliente.

Valor	Description
Inbound	Entrante
Outbound	Outbound

SecurityConfigurationRuleProtocol

Enumeración

Protocolo de red al que se aplica esta regla.

Valor	Description
Tcp	TCP
Udp	UDP
Icmp	Icmp
Esp	Esp
Any	Cualquiera
Ah	Ah

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Admin Rules - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

AdminRule

DefaultAdminRule

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create a admin rule with network group as source or destination

Solicitud de ejemplo

Respuesta de muestra

Create an admin rule

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AddressPrefixItem

AddressPrefixType

AdminRule

AdminRuleKind

CommonErrorAdditionalInfo

CommonErrorDetail

CommonErrorResponse

createdByType

DefaultAdminRule

ProvisioningState

SecurityConfigurationRuleAccess

SecurityConfigurationRuleDirection

SecurityConfigurationRuleProtocol

systemData