Route Filters - List

Service:

ExpressRoute

API Version:

2023-09-01

Ottiene tutti i filtri di route in una sottoscrizione.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters?api-version=2023-09-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione API client.

Risposte

Nome	Tipo	Descrizione
200 OK	RouteFilterListResult	Richiesta completata. L'operazione restituisce un elenco di risorse filtro route.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

RouteFilterList

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/routeFilters?api-version=2023-09-01

Java

/**
 * Samples for RouteFilters List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterList.json
     */
    /**
     * Sample code: RouteFilterList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void routeFilterList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getRouteFilters().list(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 route_filter_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="subid",
    )

    response = client.route_filters.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterList.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/RouteFilterList.json
func ExampleRouteFiltersClient_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.NewRouteFiltersClient().NewListPager(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.RouteFilterListResult = armnetwork.RouteFilterListResult{
		// 	Value: []*armnetwork.RouteFilter{
		// 		{
		// 			Name: to.Ptr("filterName"),
		// 			Type: to.Ptr("Microsoft.Network/routeFilters"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName"),
		// 			Location: to.Ptr("West US"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 			},
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.RouteFilterPropertiesFormat{
		// 				Peerings: []*armnetwork.ExpressRouteCircuitPeering{
		// 				},
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				Rules: []*armnetwork.RouteFilterRule{
		// 					{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName"),
		// 						Name: to.Ptr("ruleName"),
		// 						Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 						Properties: &armnetwork.RouteFilterRulePropertiesFormat{
		// 							Access: to.Ptr(armnetwork.AccessAllow),
		// 							Communities: []*string{
		// 								to.Ptr("12076:5030"),
		// 								to.Ptr("12076:5040")},
		// 								ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 								RouteFilterRuleType: to.Ptr(armnetwork.RouteFilterRuleTypeCommunity),
		// 							},
		// 					}},
		// 				},
		// 		}},
		// 	}
	}
}

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 Gets all route filters in a subscription.
 *
 * @summary Gets all route filters in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterList.json
 */
async function routeFilterList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.routeFilters.list()) {
    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 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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterList.json
// this example is just showing the usage of "RouteFilters_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (RouteFilterResource item in subscriptionResource.GetRouteFiltersAsync())
{
    // 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
    RouteFilterData 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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "filterName",
      "type": "Microsoft.Network/routeFilters",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "rules": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "name": "ruleName",
            "properties": {
              "provisioningState": "Succeeded",
              "access": "Allow",
              "routeFilterRuleType": "Community",
              "communities": [
                "12076:5030",
                "12076:5040"
              ]
            }
          }
        ],
        "peerings": []
      }
    }
  ]
}

Definizioni

Nome	Descrizione
Access	Accesso consentito o negato.
CircuitConnectionStatus	Stato di connessione del circuito ExpressRoute.
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
ExpressRouteCircuitConnection	Connessione circuito ExpressRoute in una risorsa ExpressRouteCircuitPeering.
ExpressRouteCircuitPeering	Peering in una risorsa ExpressRouteCircuit.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Stato del prefisso pubblico annunciato della risorsa peering.
ExpressRouteCircuitPeeringConfig	Specifica la configurazione del peering.
ExpressRouteCircuitPeeringState	Stato del peering.
ExpressRouteCircuitStats	Contiene le statistiche associate al peering.
ExpressRouteConnectionId	ID di ExpressRouteConnection.
ExpressRoutePeeringState	Stato del peering.
ExpressRoutePeeringType	Tipo di peering.
Ipv6CircuitConnectionConfig	Proprietà di connessione circuito IPv6 per copertura globale.
Ipv6ExpressRouteCircuitPeeringConfig	Contiene la configurazione del peering IPv6.
PeerExpressRouteCircuitConnection	Connessione circuito ExpressRoute Peer in una risorsa ExpressRouteCircuitPeering.
ProvisioningState	Stato di provisioning corrente.
RouteFilter	Risorsa filtro route.
RouteFilterListResult	Risposta per la chiamata al servizio API ListRouteFilters.
RouteFilterRule	Risorsa regola filtro route.
RouteFilterRuleType	Tipo di regola della regola.
SubResource	Riferimento a un'altra sottorisorsa.

Access

Accesso consentito o negato.

Nome	Tipo	Descrizione
Allow	string
Deny	string

CircuitConnectionStatus

Stato di connessione del circuito ExpressRoute.

Nome	Tipo	Descrizione
Connected	string
Connecting	string
Disconnected	string

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

ExpressRouteCircuitConnection

Connessione circuito ExpressRoute in una risorsa ExpressRouteCircuitPeering.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.addressPrefix	string	/29 spazio indirizzi IP per ritagliare gli indirizzi cliente per i tunnel.
properties.authorizationKey	string	Chiave di autorizzazione.
properties.circuitConnectionStatus	CircuitConnectionStatus	Stato di connessione del circuito ExpressRoute.
properties.expressRouteCircuitPeering	SubResource	Riferimento alla risorsa peering privato del circuito ExpressRoute dell'avvio della connessione.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Prefissi indirizzo IPv6 Proprietà della connessione del circuito expressroute.
properties.peerExpressRouteCircuitPeering	SubResource	Riferimento alla risorsa peering privato del circuito ExpressRoute del circuito con peering.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa di connessione del circuito ExpressRoute.
type	string	Tipo di risorsa.

ExpressRouteCircuitPeering

Peering in una risorsa ExpressRouteCircuit.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.azureASN	integer	AsN di Azure.
properties.connections	ExpressRouteCircuitConnection[]	Elenco delle connessioni di circuito associate al peering privato di Azure per questo circuito.
properties.expressRouteConnection	ExpressRouteConnectionId	Connessione ExpressRoute.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Configurazione del peering IPv6.
properties.lastModifiedBy	string	Ultima modifica del peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configurazione del peering Microsoft.
properties.peerASN	integer	ASN peer.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	Elenco delle connessioni di circuito con peering associate al peering privato di Azure per questo circuito.
properties.peeringType	ExpressRoutePeeringType	Tipo di peering.
properties.primaryAzurePort	string	Porta primaria.
properties.primaryPeerAddressPrefix	string	Prefisso dell'indirizzo primario.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa peering del circuito ExpressRoute.
properties.routeFilter	SubResource	Riferimento alla risorsa RouteFilter.
properties.secondaryAzurePort	string	Porta secondaria.
properties.secondaryPeerAddressPrefix	string	Prefisso dell'indirizzo secondario.
properties.sharedKey	string	Chiave condivisa.
properties.state	ExpressRoutePeeringState	Stato del peering.
properties.stats	ExpressRouteCircuitStats	Statistiche di peering del circuito ExpressRoute.
properties.vlanId	integer	ID VLAN.
type	string	Tipo di risorsa.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Stato del prefisso pubblico annunciato della risorsa peering.

Nome	Tipo	Descrizione
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Specifica la configurazione del peering.

Nome	Tipo	Descrizione
advertisedCommunities	string[]	Le comunità del peering bgp. Specificato per il peering Microsoft.
advertisedPublicPrefixes	string[]	Riferimento a AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Stato del prefisso pubblico annunciato della risorsa peering.
customerASN	integer	CustomerASN del peering.
legacyMode	integer	Modalità legacy del peering.
routingRegistryName	string	RoutingRegistryName della configurazione.

ExpressRouteCircuitPeeringState

Stato del peering.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

ExpressRouteCircuitStats

Contiene le statistiche associate al peering.

Nome	Tipo	Descrizione
primarybytesIn	integer	Byte primariIn del peering.
primarybytesOut	integer	Byteout primario del peering.
secondarybytesIn	integer	Byte secondarioIn del peering.
secondarybytesOut	integer	Byteout secondario del peering.

ExpressRouteConnectionId

ID di ExpressRouteConnection.

Nome	Tipo	Descrizione
id	string	ID di ExpressRouteConnection.

ExpressRoutePeeringState

Stato del peering.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

ExpressRoutePeeringType

Tipo di peering.

Nome	Tipo	Descrizione
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6CircuitConnectionConfig

Proprietà di connessione circuito IPv6 per copertura globale.

Nome	Tipo	Descrizione
addressPrefix	string	/125 spazio indirizzi IP per ritagliare gli indirizzi dei clienti per la copertura globale.
circuitConnectionStatus	CircuitConnectionStatus	Stato di connessione del circuito ExpressRoute.

Ipv6ExpressRouteCircuitPeeringConfig

Contiene la configurazione del peering IPv6.

Nome	Tipo	Descrizione
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configurazione del peering Microsoft.
primaryPeerAddressPrefix	string	Prefisso dell'indirizzo primario.
routeFilter	SubResource	Riferimento alla risorsa RouteFilter.
secondaryPeerAddressPrefix	string	Prefisso dell'indirizzo secondario.
state	ExpressRouteCircuitPeeringState	Stato del peering.

PeerExpressRouteCircuitConnection

Connessione circuito ExpressRoute Peer in una risorsa ExpressRouteCircuitPeering.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.addressPrefix	string	/29 spazio indirizzi IP per ritagliare gli indirizzi cliente per i tunnel.
properties.authResourceGuid	string	GUID della risorsa dell'autorizzazione usata per la connessione del circuito ExpressRoute.
properties.circuitConnectionStatus	CircuitConnectionStatus	Stato di connessione del circuito ExpressRoute.
properties.connectionName	string	Nome della risorsa di connessione del circuito ExpressRoute.
properties.expressRouteCircuitPeering	SubResource	Riferimento alla risorsa di peering privato del circuito ExpressRoute.
properties.peerExpressRouteCircuitPeering	SubResource	Riferimento alla risorsa peering privato del circuito ExpressRoute del circuito con peering.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa di connessione del circuito ExpressRoute peer.
type	string	Tipo di risorsa.

ProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Deleting	string
Failed	string
Succeeded	string
Updating	string

RouteFilter

Risorsa filtro route.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.ipv6Peerings	ExpressRouteCircuitPeering[]	Raccolta di riferimenti ai peering ipv6 del circuito ExpressRoute.
properties.peerings	ExpressRouteCircuitPeering[]	Raccolta di riferimenti ai peering del circuito ExpressRoute.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa del filtro di route.
properties.rules	RouteFilterRule[]	Raccolta di RouteFilterRules contenuta all'interno di un filtro di route.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

RouteFilterListResult

Risposta per la chiamata al servizio API ListRouteFilters.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set di risultati successivo.
value	RouteFilter[]	Elenco di filtri di route in un gruppo di risorse.

RouteFilterRule

Risorsa regola filtro route.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
location	string	Percorso della risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.access	Access	Tipo di accesso della regola.
properties.communities	string[]	Raccolta per i valori della community bgp da filtrare. ad esempio ['12076:5010','12076:5020'].
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa della regola di filtro di route.
properties.routeFilterRuleType	RouteFilterRuleType	Tipo di regola della regola.

RouteFilterRuleType

Tipo di regola della regola.

Nome	Tipo	Descrizione
Community	string

SubResource

Riferimento a un'altra sottorisorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa.