Security Rules - Get

Service:

Virtual Networks

API Version:

2023-09-01

Haal de opgegeven netwerkbeveiligingsregel op.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}?api-version=2023-09-01

URI-parameters

Name	In	Vereist	Type	Description
networkSecurityGroupName	path	True	string	De naam van de netwerkbeveiligingsgroep.
resourceGroupName	path	True	string	De naam van de resourcegroep.
securityRuleName	path	True	string	De naam van de beveiligingsregel.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	SecurityRule	De aanvraag is voltooid. De bewerking retourneert de resulterende SecurityRule-resource.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get network security rule in network security group

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1?api-version=2023-09-01

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_security_group_rule_get.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="subid",
    )

    response = client.security_rules.get(
        resource_group_name="rg1",
        network_security_group_name="testnsg",
        security_rule_name="rule1",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkSecurityGroupRuleGet.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkSecurityGroupRuleGet.json
func ExampleSecurityRulesClient_Get() {
	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)
	}
	res, err := clientFactory.NewSecurityRulesClient().Get(ctx, "rg1", "testnsg", "rule1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SecurityRule = armnetwork.SecurityRule{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1"),
	// 	Name: to.Ptr("rule1"),
	// 	Properties: &armnetwork.SecurityRulePropertiesFormat{
	// 		Access: to.Ptr(armnetwork.SecurityRuleAccessAllow),
	// 		DestinationAddressPrefix: to.Ptr("*"),
	// 		DestinationPortRange: to.Ptr("80"),
	// 		Direction: to.Ptr(armnetwork.SecurityRuleDirectionInbound),
	// 		Priority: to.Ptr[int32](130),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		SourceAddressPrefix: to.Ptr("*"),
	// 		SourcePortRange: to.Ptr("*"),
	// 		Protocol: to.Ptr(armnetwork.SecurityRuleProtocolAsterisk),
	// 	},
	// }
}

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 Get the specified network security rule.
 *
 * @summary Get the specified network security rule.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkSecurityGroupRuleGet.json
 */
async function getNetworkSecurityRuleInNetworkSecurityGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkSecurityGroupName = "testnsg";
  const securityRuleName = "rule1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.securityRules.get(
    resourceGroupName,
    networkSecurityGroupName,
    securityRuleName,
  );
  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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkSecurityGroupRuleGet.json
// this example is just showing the usage of "SecurityRules_Get" 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 SecurityRuleResource created on azure
// for more information of creating SecurityRuleResource, please refer to the document of SecurityRuleResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkSecurityGroupName = "testnsg";
string securityRuleName = "rule1";
ResourceIdentifier securityRuleResourceId = SecurityRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkSecurityGroupName, securityRuleName);
SecurityRuleResource securityRule = client.GetSecurityRuleResource(securityRuleResourceId);

// invoke the operation
SecurityRuleResource result = await securityRule.GetAsync();

// the variable result 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
SecurityRuleData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Sample Response

Status code:

200

{
  "name": "rule1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1",
  "properties": {
    "provisioningState": "Succeeded",
    "protocol": "*",
    "sourcePortRange": "*",
    "destinationPortRange": "80",
    "sourceAddressPrefix": "*",
    "destinationAddressPrefix": "*",
    "access": "Allow",
    "priority": 130,
    "direction": "Inbound"
  }
}

Definities

Name	Description
ApplicationSecurityGroup	Een toepassingsbeveiligingsgroep in een resourcegroep.
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
ProvisioningState	De huidige inrichtingsstatus.
SecurityRule	Netwerkbeveiligingsregel.
SecurityRuleAccess	Of netwerkverkeer is toegestaan of geweigerd.
SecurityRuleDirection	De richting van de regel. De richting geeft aan of de regel wordt geëvalueerd voor binnenkomend of uitgaand verkeer.
SecurityRuleProtocol	Netwerkprotocol waarop deze regel van toepassing is.

ApplicationSecurityGroup

Een toepassingsbeveiligingsgroep in een resourcegroep.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van de toepassingsbeveiligingsgroep.
properties.resourceGuid	string	De resource-GUID-eigenschap van de resourcebeveiligingsgroepresource. Het identificeert een resource op unieke wijze, zelfs als de gebruiker de naam wijzigt of de resource migreert tussen abonnementen of resourcegroepen.
tags	object	Resourcetags.
type	string	Resourcetype.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap fout.

ProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SecurityRule

Netwerkbeveiligingsregel.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.access	SecurityRuleAccess	Het netwerkverkeer wordt toegestaan of geweigerd.
properties.description	string	Een beschrijving voor deze regel. Beperkt tot 140 tekens.
properties.destinationAddressPrefix	string	Het voorvoegsel van het doeladres. CIDR of doel-IP-bereik. Het sterretje *kan ook worden gebruikt om alle bron-IP-adressen te vinden. Standaardtags zoals 'VirtualNetwork', 'AzureLoadBalancer' en 'Internet' kunnen ook worden gebruikt.
properties.destinationAddressPrefixes	string[]	De doeladresvoorvoegsels. CIDR- of doel-IP-bereiken.
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	De toepassingsbeveiligingsgroep die is opgegeven als bestemming.
properties.destinationPortRange	string	De doelpoort of het doelbereik. Geheel getal of bereik tussen 0 en 65535. Sterretje *kan ook worden gebruikt om alle poorten te vinden.
properties.destinationPortRanges	string[]	De doelpoortbereiken.
properties.direction	SecurityRuleDirection	De richting van de regel. De richting geeft aan of de regel wordt geëvalueerd voor binnenkomend of uitgaand verkeer.
properties.priority	integer	De prioriteit van de regel. De waarde kan tussen 100 en 4096 zijn. Het prioriteitsnummer moet uniek zijn voor elke regel in de verzameling. Hoe lager het prioriteitsnummer, hoe hoger de prioriteit van de regel.
properties.protocol	SecurityRuleProtocol	Netwerkprotocol waarop deze regel van toepassing is.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de beveiligingsregelresource.
properties.sourceAddressPrefix	string	Het CIDR- of bron-IP-bereik. Het sterretje *kan ook worden gebruikt om alle bron-IP-adressen te vinden. Standaardtags zoals 'VirtualNetwork', 'AzureLoadBalancer' en 'Internet' kunnen ook worden gebruikt. Als dit een regel voor inkomend verkeer is, geeft u op waar netwerkverkeer vandaan komt.
properties.sourceAddressPrefixes	string[]	De CIDR- of bron-IP-bereiken.
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	De toepassingsbeveiligingsgroep die is opgegeven als bron.
properties.sourcePortRange	string	De bronpoort of het bronbereik. Geheel getal of bereik tussen 0 en 65535. Sterretje *kan ook worden gebruikt om alle poorten te vinden.
properties.sourcePortRanges	string[]	De bronpoortbereiken.
type	string	Het type resource.

SecurityRuleAccess

Of netwerkverkeer is toegestaan of geweigerd.

Name	Type	Description
Allow	string
Deny	string

SecurityRuleDirection

De richting van de regel. De richting geeft aan of de regel wordt geëvalueerd voor binnenkomend of uitgaand verkeer.

Name	Type	Description
Inbound	string
Outbound	string

SecurityRuleProtocol

Netwerkprotocol waarop deze regel van toepassing is.

Name	Type	Description
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string