Route Filter Rules - Create Or Update

Referência

Service:: ExpressRoute

API Version:: 2023-09-01

Cria ou atualiza uma rota no filtro de rota especificado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}?api-version=2023-09-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
routeFilterName	path	True	string	O nome do filtro de rota.
ruleName	path	True	string	O nome da regra de filtro de rota.
subscriptionId	path	True	string	As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.access	True	Access	O tipo de acesso da regra.
properties.communities	True	string[]	A coleção de valores de comunidade bgp a filtrar. Por exemplo, ['12076:5010','12076:5020'].
properties.routeFilterRuleType	True	RouteFilterRuleType	O tipo de regra da regra.
id		string	ID do Recurso.
location		string	Localização do recurso.
name		string	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.

Respostas

Name	Tipo	Description
200 OK	RouteFilterRule	Atualização bem-sucedida. A operação devolve o recurso de Regra de Filtro de Rota resultante.
201 Created	RouteFilterRule	Crie com êxito. A operação devolve o recurso de Regra de Filtro de Rota resultante.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

RouteFilterRuleCreate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName?api-version=2023-09-01

{
  "properties": {
    "access": "Allow",
    "routeFilterRuleType": "Community",
    "communities": [
      "12076:5030",
      "12076:5040"
    ]
  }
}


import com.azure.resourcemanager.network.fluent.models.RouteFilterRuleInner;
import com.azure.resourcemanager.network.models.Access;
import com.azure.resourcemanager.network.models.RouteFilterRuleType;
import java.util.Arrays;

/**
 * Samples for RouteFilterRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterRuleCreate.json
     */
    /**
     * Sample code: RouteFilterRuleCreate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void routeFilterRuleCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getRouteFilterRules().createOrUpdate("rg1", "filterName", "ruleName",
            new RouteFilterRuleInner().withAccess(Access.ALLOW).withRouteFilterRuleType(RouteFilterRuleType.COMMUNITY)
                .withCommunities(Arrays.asList("12076:5030", "12076:5040")),
            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

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_rule_create.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_filter_rules.begin_create_or_update(
        resource_group_name="rg1",
        route_filter_name="filterName",
        rule_name="ruleName",
        route_filter_rule_parameters={
            "properties": {
                "access": "Allow",
                "communities": ["12076:5030", "12076:5040"],
                "routeFilterRuleType": "Community",
            }
        },
    ).result()
    print(response)


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

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/RouteFilterRuleCreate.json
func ExampleRouteFilterRulesClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewRouteFilterRulesClient().BeginCreateOrUpdate(ctx, "rg1", "filterName", "ruleName", armnetwork.RouteFilterRule{
		Properties: &armnetwork.RouteFilterRulePropertiesFormat{
			Access: to.Ptr(armnetwork.AccessAllow),
			Communities: []*string{
				to.Ptr("12076:5030"),
				to.Ptr("12076:5040")},
			RouteFilterRuleType: to.Ptr(armnetwork.RouteFilterRuleTypeCommunity),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.RouteFilterRule = 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

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

/**
 * This sample demonstrates how to Creates or updates a route in the specified route filter.
 *
 * @summary Creates or updates a route in the specified route filter.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/RouteFilterRuleCreate.json
 */
async function routeFilterRuleCreate() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const routeFilterName = "filterName";
  const ruleName = "ruleName";
  const routeFilterRuleParameters = {
    access: "Allow",
    communities: ["12076:5030", "12076:5040"],
    routeFilterRuleType: "Community",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.routeFilterRules.beginCreateOrUpdateAndWait(
    resourceGroupName,
    routeFilterName,
    ruleName,
    routeFilterRuleParameters,
  );
  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

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/RouteFilterRuleCreate.json
// this example is just showing the usage of "RouteFilterRules_CreateOrUpdate" 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 RouteFilterResource created on azure
// for more information of creating RouteFilterResource, please refer to the document of RouteFilterResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string routeFilterName = "filterName";
ResourceIdentifier routeFilterResourceId = RouteFilterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, routeFilterName);
RouteFilterResource routeFilter = client.GetRouteFilterResource(routeFilterResourceId);

// get the collection of this RouteFilterRuleResource
RouteFilterRuleCollection collection = routeFilter.GetRouteFilterRules();

// invoke the operation
string ruleName = "ruleName";
RouteFilterRuleData data = new RouteFilterRuleData()
{
    Access = NetworkAccess.Allow,
    RouteFilterRuleType = RouteFilterRuleType.Community,
    Communities =
    {
    "12076:5030","12076:5040"
    },
};
ArmOperation<RouteFilterRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, ruleName, data);
RouteFilterRuleResource result = lro.Value;

// 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
RouteFilterRuleData 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:: 201

{
  "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"
    ]
  }
}

Status code:: 200

{
  "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"
    ]
  }
}

Definições

Name	Description
Access	Acesso a ser permitido ou negado.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ProvisioningState	O estado de aprovisionamento atual.
RouteFilterRule	Recurso de Regra de Filtro de Rota.
RouteFilterRuleType	O tipo de regra da regra.

Access

Acesso a ser permitido ou negado.

Name	Tipo	Description
Allow	string
Deny	string

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro da cloud.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ProvisioningState

O estado de aprovisionamento atual.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RouteFilterRule

Recurso de Regra de Filtro de Rota.

Name	Tipo	Description
etag	string	Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.
id	string	ID do Recurso.
location	string	Localização do recurso.
name	string	O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.
properties.access	Access	O tipo de acesso da regra.
properties.communities	string[]	A coleção de valores de comunidade bgp a filtrar. Por exemplo, ['12076:5010','12076:5020'].
properties.provisioningState	ProvisioningState	O estado de aprovisionamento do recurso de regra de filtro de rota.
properties.routeFilterRuleType	RouteFilterRuleType	O tipo de regra da regra.

RouteFilterRuleType

O tipo de regra da regra.

Name	Tipo	Description
Community	string