Security User Rules - List

Serviço:: Network Manager

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

Lista todas as regras de usuário de segurança em uma coleção de regras.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules?api-version=2025-05-01&$top={$top}&$skipToken={$skipToken}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
configurationName	path	True	string pattern: ^[a-zA-Z0-9_.-]*$	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 pattern: ^[a-zA-Z0-9_.-]*$	O nome da coleção de regras de configuração de segurança do gerenciador de rede.
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.
$skipToken	query		string	SkipToken só será usado se uma operação anterior retornar um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skipToken que especifica um ponto de partida a ser usado para chamadas subsequentes.
$top	query		integer (int32) minimum: 1 maximum: 20	Um parâmetro de consulta opcional que especifica o número máximo de registros a serem retornados pelo servidor.

Respostas

Nome	Tipo	Description
200 OK	SecurityUserRuleListResult	A operação do Azure foi concluída com êxito.
Other Status Codes	CloudError	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

List security user rules

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

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

/**
 * This sample demonstrates how to Lists all Security User Rules in a rule collection.
 *
 * @summary Lists all Security User Rules in a rule collection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkManagerSecurityUserRuleList.json
 */
async function listSecurityUserRules() {
  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 credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.securityUserRules.list(
    resourceGroupName,
    networkManagerName,
    configurationName,
    ruleCollectionName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "nextLink": "https://management.azure.com/subscriptions/22222222-2222-2222-2222-222222222222/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules?api-version=2025-05-01&$skipToken=10",
  "value": [
    {
      "name": "SampleUserRule",
      "type": "Microsoft.Network/networkManagers/securityConfigurations/ruleCollections/rules",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkmanagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleUserRule",
      "properties": {
        "description": "Sample User Rule",
        "destinationPortRanges": [
          "22"
        ],
        "destinations": [
          {
            "addressPrefix": "*",
            "addressPrefixType": "IPPrefix"
          }
        ],
        "direction": "Inbound",
        "provisioningState": "Succeeded",
        "resourceGuid": "f930553b-f78d-48c5-9445-6cf86b85e615",
        "sourcePortRanges": [
          "0-65535"
        ],
        "sources": [
          {
            "addressPrefix": "*",
            "addressPrefixType": "IPPrefix"
          }
        ],
        "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.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
createdByType	O tipo de identidade que criou o recurso.
ProvisioningState	Provisionando estados de um recurso.
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.
SecurityUserRule	Regra do usuário de segurança de rede.
SecurityUserRuleListResult	A resposta de uma operação de lista SecurityUserRule.
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

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro da nuvem.

CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ProvisioningState

Enumeração

Provisionando estados de um recurso.

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

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