Admin Rules - Create Or Update

Serviço:: Network Manager

Versão da API:: 2025-05-01

Cria ou atualiza uma regra de administrador.

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 URI

Nome	Em	Obrigatório	Tipo	Description
configurationName	path	True	string	O nome da Configuração de Segurança do gerenciador de rede.
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	O nome do gerenciador de rede.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
ruleCollectionName	path	True	string	O nome da coleção de regras de configuração de segurança do gerenciador de rede.
ruleName	path	True	string	O nome da regra.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome	Description
AdminRule	Regra de administrador de rede.
DefaultAdminRule	Regra de administrador padrão de rede.

AdminRule

Regra de administrador de rede.

Nome	Obrigatório	Tipo	Description
kind	True	string: Custom	Se a regra é personalizada ou padrão.
properties.access	True	SecurityConfigurationRuleAccess	Indica o acesso permitido para esta regra específica
properties.direction	True	SecurityConfigurationRuleDirection	Indica se o tráfego correspondeu à regra de entrada ou saída.
properties.priority	True	integer (int32) minimum: 1 maximum: 4096	A prioridade da regra. O valor pode estar entre 1 e 4096. O número de prioridade deve ser exclusivo para cada regra na coleção. Quanto menor o número de prioridade, maior a prioridade da regra.
properties.protocol	True	SecurityConfigurationRuleProtocol	Protocolo de rede ao qual essa regra se aplica.
properties.description		string	Uma descrição para essa regra. Restrito a 140 chars.
properties.destinationPortRanges		string[]	Os intervalos de porta de destino.
properties.destinations		AddressPrefixItem[]	Os prefixos de endereço de destino. Intervalos DE IP de destino ou CIDR.
properties.sourcePortRanges		string[]	Os intervalos de porta de origem.
properties.sources		AddressPrefixItem[]	Os intervalos DE IP de origem ou CIDR.

DefaultAdminRule

Regra de administrador padrão de rede.

Nome	Obrigatório	Tipo	Description
kind	True	string: Default	Se a regra é personalizada ou padrão.
properties.flag		string	Sinalizador de regra padrão.

Respostas

Nome	Tipo	Description
200 OK	BaseAdminRule: AdminRule DefaultAdminRule	Operação de atualização do recurso 'BaseAdminRule' bem-sucedida
201 Created	BaseAdminRule: AdminRule DefaultAdminRule	Recurso 'BaseAdminRule' criar operação bem-sucedida
Other Status Codes	CommonErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Código de status:: 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"
  }
}

Definições

Nome	Description
AddressPrefixItem	Item de prefixo de endereço.
AddressPrefixType	Tipo de prefixo de endereço.
AdminRule	Regra de administrador de rede.
AdminRuleKind	Se a regra é personalizada ou padrão.
CommonErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
CommonErrorDetail	O detalhe do erro.
CommonErrorResponse	Resposta de erro
createdByType	O tipo de identidade que criou o recurso.
DefaultAdminRule	Regra de administrador padrão de rede.
ProvisioningState	Provisionando estados de um recurso.
SecurityConfigurationRuleAccess	Se o tráfego de rede é permitido ou negado.
SecurityConfigurationRuleDirection	A direção da regra. A direção especifica se a regra será avaliada no tráfego de entrada ou saída.
SecurityConfigurationRuleProtocol	Protocolo de rede ao qual essa regra se aplica.
systemData	Metadados relativos à criação e última modificação do recurso.

AddressPrefixItem

Objeto

Item de prefixo de endereço.

Nome	Tipo	Description
addressPrefix	string	Prefixo de endereço.
addressPrefixType	AddressPrefixType	Tipo de prefixo de endereço.

AddressPrefixType

Enumeração

Tipo de prefixo de endereço.

Valor	Description
IPPrefix	IPPrefix
ServiceTag	ServiceTag
NetworkGroup	NetworkGroup

AdminRule

Objeto

Regra de administrador de rede.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
kind	string: Custom	Se a regra é personalizada ou padrão.
name	string	Nome do recurso.
properties.access	SecurityConfigurationRuleAccess	Indica o acesso permitido para esta regra específica
properties.description	string	Uma descrição para essa regra. Restrito a 140 chars.
properties.destinationPortRanges	string[]	Os intervalos de porta de destino.
properties.destinations	AddressPrefixItem[]	Os prefixos de endereço de destino. Intervalos DE IP de destino ou CIDR.
properties.direction	SecurityConfigurationRuleDirection	Indica se o tráfego correspondeu à regra de entrada ou saída.
properties.priority	integer (int32) minimum: 1 maximum: 4096	A prioridade da regra. O valor pode estar entre 1 e 4096. O número de prioridade deve ser exclusivo para cada regra na coleção. Quanto menor o número de prioridade, maior a prioridade da regra.
properties.protocol	SecurityConfigurationRuleProtocol	Protocolo de rede ao qual essa regra se aplica.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso.
properties.resourceGuid	string	Identificador exclusivo para esse recurso.
properties.sourcePortRanges	string[]	Os intervalos de porta de origem.
properties.sources	AddressPrefixItem[]	Os intervalos DE IP de origem ou CIDR.
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	Tipo de recurso.

AdminRuleKind

Enumeração

Se a regra é personalizada ou padrão.

Valor	Description
Custom	Personalizado
Default	Default

CommonErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

CommonErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	CommonErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CommonErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

CommonErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	CommonErrorDetail	O objeto de erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultAdminRule

Objeto

Regra de administrador padrão de rede.

Nome	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do recurso.
kind	string: Default	Se a regra é personalizada ou padrão.
name	string	Nome do recurso.
properties.access	SecurityConfigurationRuleAccess	Indica o acesso permitido para esta regra específica
properties.description	string	Uma descrição para essa regra. Restrito a 140 chars.
properties.destinationPortRanges	string[]	Os intervalos de porta de destino.
properties.destinations	AddressPrefixItem[]	Os prefixos de endereço de destino. Intervalos DE IP de destino ou CIDR.
properties.direction	SecurityConfigurationRuleDirection	Indica se o tráfego correspondeu à regra de entrada ou saída.
properties.flag	string	Sinalizador de regra padrão.
properties.priority	integer (int32)	A prioridade da regra. O valor pode estar entre 1 e 4096. O número de prioridade deve ser exclusivo para cada regra na coleção. Quanto menor o número de prioridade, maior a prioridade da regra.
properties.protocol	SecurityConfigurationRuleProtocol	Protocolo de rede ao qual essa regra se aplica.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso.
properties.resourceGuid	string	Identificador exclusivo para esse recurso.
properties.sourcePortRanges	string[]	Os intervalos de porta de origem.
properties.sources	AddressPrefixItem[]	Os intervalos DE IP de origem ou CIDR.
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	Tipo de recurso.

ProvisioningState

Enumeração

Provisionando estados de um recurso.

Valor	Description
Failed	Falha
Succeeded	Succeeded
Canceled	Cancelado
Creating	Criando
Updating	Atualização
Deleting	Excluir

SecurityConfigurationRuleAccess

Enumeração

Se o tráfego de rede é permitido ou negado.

Valor	Description
Allow	Permitir
Deny	Negar
AlwaysAllow	SemprePermitir

SecurityConfigurationRuleDirection

Enumeração

A direção da regra. A direção especifica se a regra será avaliada no tráfego de entrada ou saída.

Valor	Description
Inbound	Entrada
Outbound	Saída

SecurityConfigurationRuleProtocol

Enumeração

Protocolo de rede ao qual essa regra se aplica.

Valor	Description
Tcp	Tcp
Udp	Udp
Icmp	Icmp
Esp	Esp
Any	Qualquer
Ah	Ah

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Admin Rules - Create Or Update

Parâmetros de URI

Corpo da solicitação

AdminRule

DefaultAdminRule

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create a admin rule with network group as source or destination

Solicitação de exemplo

Resposta de exemplo

Create an admin rule

Solicitação de exemplo

Resposta de exemplo

Definições

AddressPrefixItem

AddressPrefixType

AdminRule

AdminRuleKind

CommonErrorAdditionalInfo

CommonErrorDetail

CommonErrorResponse

createdByType

DefaultAdminRule

ProvisioningState

SecurityConfigurationRuleAccess

SecurityConfigurationRuleDirection

SecurityConfigurationRuleProtocol

systemData