Security User Rules - List

Serviço:

Network Manager

Versão da API:

2024-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=2024-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=2024-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: ^[a-zA-Z0-9_.-]*$	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	Operação bem-sucedida
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

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

Solicitação de exemplo

HTTP

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=2024-05-01

Java

/**
 * Samples for SecurityUserRules List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * NetworkManagerSecurityUserRuleList.json
     */
    /**
     * Sample code: List security user rules.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listSecurityUserRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getSecurityUserRules().list("rg1", "testNetworkManager",
            "myTestSecurityConfig", "testRuleCollection", null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_manager_security_user_rule_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.security_user_rules.list(
        resource_group_name="rg1",
        network_manager_name="testNetworkManager",
        configuration_name="myTestSecurityConfig",
        rule_collection_name="testRuleCollection",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerSecurityUserRuleList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerSecurityUserRuleList.json
func ExampleSecurityUserRulesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSecurityUserRulesClient().NewListPager("rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", &armnetwork.SecurityUserRulesClientListOptions{Top: nil,
		SkipToken: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SecurityUserRuleListResult = armnetwork.SecurityUserRuleListResult{
		// 	Value: []*armnetwork.SecurityUserRule{
		// 		{
		// 			Name: to.Ptr("SampleUserRule"),
		// 			Type: to.Ptr("Microsoft.Network/networkManagers/securityConfigurations/ruleCollections/rules"),
		// 			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkmanagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleUserRule"),
		// 			Properties: &armnetwork.SecurityUserRulePropertiesFormat{
		// 				Description: to.Ptr("Sample User Rule"),
		// 				DestinationPortRanges: []*string{
		// 					to.Ptr("22")},
		// 					Destinations: []*armnetwork.AddressPrefixItem{
		// 						{
		// 							AddressPrefix: to.Ptr("*"),
		// 							AddressPrefixType: to.Ptr(armnetwork.AddressPrefixTypeIPPrefix),
		// 					}},
		// 					Direction: to.Ptr(armnetwork.SecurityConfigurationRuleDirectionInbound),
		// 					ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 					ResourceGUID: to.Ptr("f930553b-f78d-48c5-9445-6cf86b85e615"),
		// 					SourcePortRanges: []*string{
		// 						to.Ptr("0-65535")},
		// 						Sources: []*armnetwork.AddressPrefixItem{
		// 							{
		// 								AddressPrefix: to.Ptr("*"),
		// 								AddressPrefixType: to.Ptr(armnetwork.AddressPrefixTypeIPPrefix),
		// 						}},
		// 						Protocol: to.Ptr(armnetwork.SecurityConfigurationRuleProtocolTCP),
		// 					},
		// 					SystemData: &armnetwork.SystemData{
		// 						CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 						CreatedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 						CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 						LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 						LastModifiedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 						LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

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

/**
 * 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/stable/2024-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 (let 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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NetworkManagerSecurityUserRuleList.json
// this example is just showing the usage of "SecurityUserRules_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetworkManagerSecurityUserRulesResource created on azure
// for more information of creating NetworkManagerSecurityUserRulesResource, please refer to the document of NetworkManagerSecurityUserRulesResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string networkManagerName = "testNetworkManager";
string configurationName = "myTestSecurityConfig";
string ruleCollectionName = "testRuleCollection";
ResourceIdentifier networkManagerSecurityUserRulesResourceId = NetworkManagerSecurityUserRulesResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkManagerName, configurationName, ruleCollectionName);
NetworkManagerSecurityUserRulesResource networkManagerSecurityUserRules = client.GetNetworkManagerSecurityUserRulesResource(networkManagerSecurityUserRulesResourceId);

// get the collection of this NetworkManagerSecurityUserRuleResource
NetworkManagerSecurityUserRuleCollection collection = networkManagerSecurityUserRules.GetNetworkManagerSecurityUserRules();

// invoke the operation and iterate over the result
await foreach (NetworkManagerSecurityUserRuleResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetworkManagerSecurityUserRuleData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkmanagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleUserRule",
      "type": "Microsoft.Network/networkManagers/securityConfigurations/ruleCollections/rules",
      "name": "SampleUserRule",
      "systemData": {
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "createdByType": "User",
        "createdAt": "2021-01-11T18:52:27Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-01-11T18:52:27Z"
      },
      "properties": {
        "description": "Sample User Rule",
        "protocol": "Tcp",
        "sources": [
          {
            "addressPrefixType": "IPPrefix",
            "addressPrefix": "*"
          }
        ],
        "destinations": [
          {
            "addressPrefixType": "IPPrefix",
            "addressPrefix": "*"
          }
        ],
        "sourcePortRanges": [
          "0-65535"
        ],
        "destinationPortRanges": [
          "22"
        ],
        "direction": "Inbound",
        "provisioningState": "Succeeded",
        "resourceGuid": "f930553b-f78d-48c5-9445-6cf86b85e615"
      }
    }
  ],
  "nextLink": "{baseurl}/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules?api-version=2024-05-01&$skipToken=10"
}

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	O estado de provisionamento atual.
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	resultado da lista de regras do usuário de segurança.
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
NetworkGroup
ServiceTag

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Corpo do erro de 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
Application
Key
ManagedIdentity
User

ProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Deleting
Failed
Succeeded
Updating

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
Outbound

SecurityConfigurationRuleProtocol

Enumeração

Protocolo de rede ao qual essa regra se aplica.

Valor	Description
Ah
Any
Esp
Icmp
Tcp
Udp

SecurityUserRule

Objeto

Regra do usuário de segurança 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.
name	string	Nome do recurso.
properties.description	string	Uma descrição para essa regra.
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.protocol	SecurityConfigurationRuleProtocol	Protocolo de rede ao qual essa regra se aplica.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de regra de usuário de configuração de segurança.
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.

SecurityUserRuleListResult

Objeto

resultado da lista de regras do usuário de segurança.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de resultados.
value	SecurityUserRule[]	Uma lista de regras de usuário de segurança

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 tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.