Admin Rules - Create Or Update

Service:: Network Manager

Version d'API:: 2025-05-01

Crée ou met à jour une règle d’administration.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
configurationName	path	True	string	Nom de la configuration de sécurité du gestionnaire de réseau.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Nom du gestionnaire de réseau.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
ruleCollectionName	path	True	string	Nom de la collection de règles de configuration de sécurité du gestionnaire de réseau.
ruleName	path	True	string	Nom de la règle.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
AdminRule	Règle d’administrateur réseau.
DefaultAdminRule	Règle d’administration par défaut du réseau.

AdminRule

Règle d’administrateur réseau.

Nom	Obligatoire	Type	Description
kind	True	string: Custom	Indique si la règle est personnalisée ou par défaut.
properties.access	True	SecurityConfigurationRuleAccess	Indique l’accès autorisé pour cette règle particulière
properties.direction	True	SecurityConfigurationRuleDirection	Indique si le trafic correspond à la règle entrante ou sortante.
properties.priority	True	integer (int32) minimum: 1 maximum: 4096	Priorité de la règle. La valeur peut être comprise entre 1 et 4096. Le numéro de priorité doit être unique pour chaque règle de la collection. Plus le numéro de priorité est inférieur, plus la priorité de la règle est élevée.
properties.protocol	True	SecurityConfigurationRuleProtocol	Protocole réseau auquel cette règle s’applique.
properties.description		string	Description de cette règle. Limité à 140 chars.
properties.destinationPortRanges		string[]	Plages de ports de destination.
properties.destinations		AddressPrefixItem[]	Préfixes d’adresse de destination. PLAGES d’adresses IP CIDR ou de destination.
properties.sourcePortRanges		string[]	Plages de ports sources.
properties.sources		AddressPrefixItem[]	Plages d’adresses IP CIDR ou sources.

DefaultAdminRule

Règle d’administration par défaut du réseau.

Nom	Obligatoire	Type	Description
kind	True	string: Default	Indique si la règle est personnalisée ou par défaut.
properties.flag		string	Indicateur de règle par défaut.

Réponses

Nom	Type	Description
200 OK	BaseAdminRule: AdminRule DefaultAdminRule	Opération de mise à jour de la ressource 'BaseAdminRule' réussie
201 Created	BaseAdminRule: AdminRule DefaultAdminRule	Ressource 'BaseAdminRule' créer l’opération réussie
Other Status Codes	CommonErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Définitions

Nom	Description
AddressPrefixItem	Élément de préfixe d’adresse.
AddressPrefixType	Type de préfixe d’adresse.
AdminRule	Règle d’administrateur réseau.
AdminRuleKind	Indique si la règle est personnalisée ou par défaut.
CommonErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
CommonErrorDetail	Détail de l’erreur.
CommonErrorResponse	Réponse d’erreur
createdByType	Type d’identité qui a créé la ressource.
DefaultAdminRule	Règle d’administration par défaut du réseau.
ProvisioningState	États de provisionnement d’une ressource.
SecurityConfigurationRuleAccess	Indique si le trafic réseau est autorisé ou refusé.
SecurityConfigurationRuleDirection	Direction de la règle. La direction spécifie si la règle sera évaluée sur le trafic entrant ou sortant.
SecurityConfigurationRuleProtocol	Protocole réseau auquel cette règle s’applique.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AddressPrefixItem

Objet

Élément de préfixe d’adresse.

Nom	Type	Description
addressPrefix	string	Préfixe d’adresse.
addressPrefixType	AddressPrefixType	Type de préfixe d’adresse.

AddressPrefixType

Énumération

Type de préfixe d’adresse.

Valeur	Description
IPPrefix	IPPrefix
ServiceTag	ServiceTag
NetworkGroup	NetworkGroup

AdminRule

Objet

Règle d’administrateur réseau.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
kind	string: Custom	Indique si la règle est personnalisée ou par défaut.
name	string	Nom de la ressource.
properties.access	SecurityConfigurationRuleAccess	Indique l’accès autorisé pour cette règle particulière
properties.description	string	Description de cette règle. Limité à 140 chars.
properties.destinationPortRanges	string[]	Plages de ports de destination.
properties.destinations	AddressPrefixItem[]	Préfixes d’adresse de destination. PLAGES d’adresses IP CIDR ou de destination.
properties.direction	SecurityConfigurationRuleDirection	Indique si le trafic correspond à la règle entrante ou sortante.
properties.priority	integer (int32) minimum: 1 maximum: 4096	Priorité de la règle. La valeur peut être comprise entre 1 et 4096. Le numéro de priorité doit être unique pour chaque règle de la collection. Plus le numéro de priorité est inférieur, plus la priorité de la règle est élevée.
properties.protocol	SecurityConfigurationRuleProtocol	Protocole réseau auquel cette règle s’applique.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource.
properties.resourceGuid	string	Identificateur unique pour cette ressource.
properties.sourcePortRanges	string[]	Plages de ports sources.
properties.sources	AddressPrefixItem[]	Plages d’adresses IP CIDR ou sources.
systemData	systemData	Métadonnées système associées à cette ressource.
type	string	Type de ressource.

AdminRuleKind

Énumération

Indique si la règle est personnalisée ou par défaut.

Valeur	Description
Custom	Personnalisée
Default	Par défaut

CommonErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires.
type	string	Type d’informations supplémentaire.

CommonErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	CommonErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	CommonErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

CommonErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	CommonErrorDetail	Objet d’erreur.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DefaultAdminRule

Objet

Règle d’administration par défaut du réseau.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
kind	string: Default	Indique si la règle est personnalisée ou par défaut.
name	string	Nom de la ressource.
properties.access	SecurityConfigurationRuleAccess	Indique l’accès autorisé pour cette règle particulière
properties.description	string	Description de cette règle. Limité à 140 chars.
properties.destinationPortRanges	string[]	Plages de ports de destination.
properties.destinations	AddressPrefixItem[]	Préfixes d’adresse de destination. PLAGES d’adresses IP CIDR ou de destination.
properties.direction	SecurityConfigurationRuleDirection	Indique si le trafic correspond à la règle entrante ou sortante.
properties.flag	string	Indicateur de règle par défaut.
properties.priority	integer (int32)	Priorité de la règle. La valeur peut être comprise entre 1 et 4096. Le numéro de priorité doit être unique pour chaque règle de la collection. Plus le numéro de priorité est inférieur, plus la priorité de la règle est élevée.
properties.protocol	SecurityConfigurationRuleProtocol	Protocole réseau auquel cette règle s’applique.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource.
properties.resourceGuid	string	Identificateur unique pour cette ressource.
properties.sourcePortRanges	string[]	Plages de ports sources.
properties.sources	AddressPrefixItem[]	Plages d’adresses IP CIDR ou sources.
systemData	systemData	Métadonnées système associées à cette ressource.
type	string	Type de ressource.

ProvisioningState

Énumération

États de provisionnement d’une ressource.

Valeur	Description
Failed	Échec
Succeeded	Réussi
Canceled	Opération annulée
Creating	Création
Updating	Mise à jour
Deleting	Suppression

SecurityConfigurationRuleAccess

Énumération

Indique si le trafic réseau est autorisé ou refusé.

Valeur	Description
Allow	Permettre
Deny	Deny
AlwaysAllow	AlwaysAllow

SecurityConfigurationRuleDirection

Énumération

Direction de la règle. La direction spécifie si la règle sera évaluée sur le trafic entrant ou sortant.

Valeur	Description
Inbound	Trafic entrant
Outbound	Sortant

SecurityConfigurationRuleProtocol

Énumération

Protocole réseau auquel cette règle s’applique.

Valeur	Description
Tcp	Tcp
Udp	Udp
Icmp	Icmp
Esp	Esp
Any	N'importe lequel
Ah	Ah

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Admin Rules - Create Or Update

Paramètres URI

Corps de la demande

AdminRule

DefaultAdminRule

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create a admin rule with network group as source or destination

Exemple de requête

Exemple de réponse

Create an admin rule

Exemple de requête

Exemple de réponse

Définitions

AddressPrefixItem

AddressPrefixType

AdminRule

AdminRuleKind

CommonErrorAdditionalInfo

CommonErrorDetail

CommonErrorResponse

createdByType

DefaultAdminRule

ProvisioningState

SecurityConfigurationRuleAccess

SecurityConfigurationRuleDirection

SecurityConfigurationRuleProtocol

systemData