Route Maps - Create Or Update

Serviço:

Virtual WAN

Versão da API:

2024-05-01

Cria um RouteMap se ele não existir mais atualiza o existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}?api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos do grupo de recursos do RouteMap.
routeMapName	path	True	string	O nome do RouteMap.
subscriptionId	path	True	string	As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
virtualHubName	path	True	string	O nome do VirtualHub que contém o RouteMap.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
properties.associatedInboundConnections	string[]	Lista de conexões que têm esse RoutMap associado ao tráfego de entrada.
properties.associatedOutboundConnections	string[]	Lista de conexões que têm esse RoutMap associado ao tráfego de saída.
properties.rules	RouteMapRule[]	Lista de regras RouteMap a serem aplicadas.

Respostas

Nome	Tipo	Description
200 OK	RouteMap	Solicitação bem-sucedida. Retorna os detalhes do RouteMap criado ou atualizado.
201 Created	RouteMap	Solicitação bem-sucedida. Retorna os detalhes do RouteMap recuperado.
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

RouteMapPut

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1?api-version=2024-05-01

{
  "properties": {
    "rules": [
      {
        "name": "rule1",
        "matchCriteria": [
          {
            "matchCondition": "Contains",
            "routePrefix": [
              "10.0.0.0/8"
            ],
            "community": [],
            "asPath": []
          }
        ],
        "actions": [
          {
            "type": "Add",
            "parameters": [
              {
                "routePrefix": [],
                "community": [],
                "asPath": [
                  "22334"
                ]
              }
            ]
          }
        ],
        "nextStepIfMatched": "Continue"
      }
    ],
    "associatedInboundConnections": [
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"
    ],
    "associatedOutboundConnections": []
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.RouteMapInner;
import com.azure.resourcemanager.network.models.Action;
import com.azure.resourcemanager.network.models.Criterion;
import com.azure.resourcemanager.network.models.NextStep;
import com.azure.resourcemanager.network.models.Parameter;
import com.azure.resourcemanager.network.models.RouteMapActionType;
import com.azure.resourcemanager.network.models.RouteMapMatchCondition;
import com.azure.resourcemanager.network.models.RouteMapRule;
import java.util.Arrays;

/**
 * Samples for RouteMaps CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/RouteMapPut.json
     */
    /**
     * Sample code: RouteMapPut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void routeMapPut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getRouteMaps().createOrUpdate("rg1", "virtualHub1", "routeMap1",
            new RouteMapInner().withAssociatedInboundConnections(Arrays.asList(
                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"))
                .withAssociatedOutboundConnections(Arrays.asList()).withRules(
                    Arrays
                        .asList(new RouteMapRule().withName("rule1")
                            .withMatchCriteria(Arrays.asList(new Criterion()
                                .withRoutePrefix(Arrays.asList("10.0.0.0/8")).withCommunity(Arrays.asList())
                                .withAsPath(Arrays.asList()).withMatchCondition(RouteMapMatchCondition.CONTAINS)))
                            .withActions(Arrays.asList(new Action().withType(RouteMapActionType.ADD)
                                .withParameters(Arrays.asList(new Parameter().withRoutePrefix(Arrays.asList())
                                    .withCommunity(Arrays.asList()).withAsPath(Arrays.asList("22334"))))))
                            .withNextStepIfMatched(NextStep.CONTINUE))),
            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_map_put.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_maps.begin_create_or_update(
        resource_group_name="rg1",
        virtual_hub_name="virtualHub1",
        route_map_name="routeMap1",
        route_map_parameters={
            "properties": {
                "associatedInboundConnections": [
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"
                ],
                "associatedOutboundConnections": [],
                "rules": [
                    {
                        "actions": [
                            {"parameters": [{"asPath": ["22334"], "community": [], "routePrefix": []}], "type": "Add"}
                        ],
                        "matchCriteria": [
                            {"asPath": [], "community": [], "matchCondition": "Contains", "routePrefix": ["10.0.0.0/8"]}
                        ],
                        "name": "rule1",
                        "nextStepIfMatched": "Continue",
                    }
                ],
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/RouteMapPut.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/azcore/to"
	"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/RouteMapPut.json
func ExampleRouteMapsClient_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.NewRouteMapsClient().BeginCreateOrUpdate(ctx, "rg1", "virtualHub1", "routeMap1", armnetwork.RouteMap{
		Properties: &armnetwork.RouteMapProperties{
			AssociatedInboundConnections: []*string{
				to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1")},
			AssociatedOutboundConnections: []*string{},
			Rules: []*armnetwork.RouteMapRule{
				{
					Name: to.Ptr("rule1"),
					Actions: []*armnetwork.Action{
						{
							Type: to.Ptr(armnetwork.RouteMapActionTypeAdd),
							Parameters: []*armnetwork.Parameter{
								{
									AsPath: []*string{
										to.Ptr("22334")},
									Community:   []*string{},
									RoutePrefix: []*string{},
								}},
						}},
					MatchCriteria: []*armnetwork.Criterion{
						{
							AsPath:         []*string{},
							Community:      []*string{},
							MatchCondition: to.Ptr(armnetwork.RouteMapMatchConditionContains),
							RoutePrefix: []*string{
								to.Ptr("10.0.0.0/8")},
						}},
					NextStepIfMatched: to.Ptr(armnetwork.NextStepContinue),
				}},
		},
	}, 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.RouteMap = armnetwork.RouteMap{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
	// 	Name: to.Ptr("routeMap1"),
	// 	Type: to.Ptr("Microsoft.Network/virtualHubs/routeMaps"),
	// 	Etag: to.Ptr("W/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.RouteMapProperties{
	// 		AssociatedInboundConnections: []*string{
	// 			to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1")},
	// 			AssociatedOutboundConnections: []*string{
	// 			},
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			Rules: []*armnetwork.RouteMapRule{
	// 				{
	// 					Name: to.Ptr("rule1"),
	// 					Actions: []*armnetwork.Action{
	// 						{
	// 							Type: to.Ptr(armnetwork.RouteMapActionTypeAdd),
	// 							Parameters: []*armnetwork.Parameter{
	// 								{
	// 									AsPath: []*string{
	// 										to.Ptr("22334")},
	// 										Community: []*string{
	// 										},
	// 										RoutePrefix: []*string{
	// 										},
	// 								}},
	// 						}},
	// 						MatchCriteria: []*armnetwork.Criterion{
	// 							{
	// 								AsPath: []*string{
	// 								},
	// 								Community: []*string{
	// 								},
	// 								MatchCondition: to.Ptr(armnetwork.RouteMapMatchConditionContains),
	// 								RoutePrefix: []*string{
	// 									to.Ptr("10.0.0.0/8")},
	// 							}},
	// 							NextStepIfMatched: to.Ptr(armnetwork.NextStepContinue),
	// 					}},
	// 				},
	// 			}
}

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 Creates a RouteMap if it doesn't exist else updates the existing one.
 *
 * @summary Creates a RouteMap if it doesn't exist else updates the existing one.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/RouteMapPut.json
 */
async function routeMapPut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualHubName = "virtualHub1";
  const routeMapName = "routeMap1";
  const routeMapParameters = {
    associatedInboundConnections: [
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1",
    ],
    associatedOutboundConnections: [],
    rules: [
      {
        name: "rule1",
        actions: [
          {
            type: "Add",
            parameters: [{ asPath: ["22334"], community: [], routePrefix: [] }],
          },
        ],
        matchCriteria: [
          {
            asPath: [],
            community: [],
            matchCondition: "Contains",
            routePrefix: ["10.0.0.0/8"],
          },
        ],
        nextStepIfMatched: "Continue",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.routeMaps.beginCreateOrUpdateAndWait(
    resourceGroupName,
    virtualHubName,
    routeMapName,
    routeMapParameters,
  );
  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 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/RouteMapPut.json
// this example is just showing the usage of "RouteMaps_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 RouteMapResource created on azure
// for more information of creating RouteMapResource, please refer to the document of RouteMapResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualHubName = "virtualHub1";
string routeMapName = "routeMap1";
ResourceIdentifier routeMapResourceId = RouteMapResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualHubName, routeMapName);
RouteMapResource routeMap = client.GetRouteMapResource(routeMapResourceId);

// invoke the operation
RouteMapData data = new RouteMapData
{
    AssociatedInboundConnections = { "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" },
    AssociatedOutboundConnections = { },
    Rules = {new RouteMapRule
    {
    Name = "rule1",
    MatchCriteria = {new RouteCriterion
    {
    RoutePrefix = {"10.0.0.0/8"},
    Community = {},
    AsPath = {},
    MatchCondition = RouteMapMatchCondition.Contains,
    }},
    Actions = {new RouteMapAction
    {
    ActionType = RouteMapActionType.Add,
    Parameters = {new RouteMapActionParameter
    {
    RoutePrefix = {},
    Community = {},
    AsPath = {"22334"},
    }},
    }},
    NextStepIfMatched = RouteMapNextStepBehavior.Continue,
    }},
};
ArmOperation<RouteMapResource> lro = await routeMap.UpdateAsync(WaitUntil.Completed, data);
RouteMapResource 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
RouteMapData 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

Resposta de exemplo

Código de status:

200

{
  "name": "routeMap1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1",
  "etag": "W/\\00000000-0000-0000-0000-000000000000\\",
  "properties": {
    "provisioningState": "Succeeded",
    "rules": [
      {
        "name": "rule1",
        "matchCriteria": [
          {
            "matchCondition": "Contains",
            "routePrefix": [
              "10.0.0.0/8"
            ],
            "community": [],
            "asPath": []
          }
        ],
        "actions": [
          {
            "type": "Add",
            "parameters": [
              {
                "routePrefix": [],
                "community": [],
                "asPath": [
                  "22334"
                ]
              }
            ]
          }
        ],
        "nextStepIfMatched": "Continue"
      }
    ],
    "associatedInboundConnections": [
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"
    ],
    "associatedOutboundConnections": []
  },
  "type": "Microsoft.Network/virtualHubs/routeMaps"
}

Código de status:

201

{
  "name": "routeMap1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1",
  "etag": "W/\\00000000-0000-0000-0000-000000000000\\",
  "properties": {
    "provisioningState": "Succeeded",
    "rules": [
      {
        "name": "rule1",
        "matchCriteria": [
          {
            "matchCondition": "Contains",
            "routePrefix": [
              "10.0.0.0/8"
            ],
            "community": [],
            "asPath": []
          }
        ],
        "actions": [
          {
            "type": "Add",
            "parameters": [
              {
                "routePrefix": [],
                "community": [],
                "asPath": [
                  "22334"
                ]
              }
            ]
          }
        ],
        "nextStepIfMatched": "Continue"
      }
    ],
    "associatedInboundConnections": [
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1"
    ],
    "associatedOutboundConnections": []
  },
  "type": "Microsoft.Network/virtualHubs/routeMaps"
}

Definições

Nome	Description
Action	Ação a ser tomada em uma rota que corresponda a um critério RouteMap.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
Criterion	Um critério correspondente que corresponde a rotas com base no prefixo de rota, na comunidade e no caminho as.
NextStep	Comportamentos da próxima etapa com suporte depois que uma regra é aplicada a uma rota correspondente
Parameter	Parâmetros para uma ação.
ProvisioningState	O estado de provisionamento atual.
RouteMap	O recurso filho RouteMap de um hub virtual.
RouteMapActionType	Tipo de ações que podem ser executadas em uma rota correspondente. Adicionar, Substituir, Remover consulte parâmetros na rota, como comunidade ou prefixo
RouteMapMatchCondition	Condição de correspondência para aplicar regras RouteMap.
RouteMapRule	Uma regra routemap.

Action

Objeto

Ação a ser tomada em uma rota que corresponda a um critério RouteMap.

Nome	Tipo	Description
parameters	Parameter[]	Lista de parâmetros relevantes para a ação. Por exemplo, se o tipo for descartado, os parâmetros têm uma lista de prefixos a serem descartados. Se o tipo for adicionado, os parâmetros terão uma lista de números ASN a serem adicionados
type	RouteMapActionType	Tipo de ação a ser tomada. Os tipos com suporte são 'Remover', 'Adicionar', 'Substituir' e 'Soltar'.

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.

Criterion

Objeto

Um critério correspondente que corresponde a rotas com base no prefixo de rota, na comunidade e no caminho as.

Nome	Tipo	Description
asPath	string[]	Lista de caminhos AS que esses critérios correspondem.
community	string[]	Lista de comunidades BGP que esses critérios correspondem.
matchCondition	RouteMapMatchCondition	Condição de correspondência para aplicar regras RouteMap.
routePrefix	string[]	Lista de prefixos de rota que esses critérios correspondem.

NextStep

Enumeração

Comportamentos da próxima etapa com suporte depois que uma regra é aplicada a uma rota correspondente

Valor	Description
Continue
Terminate
Unknown

Parameter

Objeto

Parâmetros para uma ação.

Nome	Tipo	Description
asPath	string[]	Lista de caminhos as.
community	string[]	Lista de comunidades BGP.
routePrefix	string[]	Lista de prefixos de rota.

ProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Deleting
Failed
Succeeded
Updating

RouteMap

Objeto

O recurso filho RouteMap de um hub virtual.

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	O nome do recurso exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.associatedInboundConnections	string[]	Lista de conexões que têm esse RoutMap associado ao tráfego de entrada.
properties.associatedOutboundConnections	string[]	Lista de conexões que têm esse RoutMap associado ao tráfego de saída.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso RouteMap.
properties.rules	RouteMapRule[]	Lista de regras RouteMap a serem aplicadas.
type	string	Tipo de recurso.

RouteMapActionType

Enumeração

Tipo de ações que podem ser executadas em uma rota correspondente. Adicionar, Substituir, Remover consulte parâmetros na rota, como comunidade ou prefixo

Valor	Description
Add
Drop
Remove
Replace
Unknown

RouteMapMatchCondition

Enumeração

Condição de correspondência para aplicar regras RouteMap.

Valor	Description
Contains
Equals
NotContains
NotEquals
Unknown

RouteMapRule

Objeto

Uma regra routemap.

Nome	Tipo	Description
actions	Action[]	Lista de ações que serão aplicadas em uma correspondência.
matchCriteria	Criterion[]	Lista de critérios correspondentes que serão aplicados ao tráfego.
name	string	O nome exclusivo da regra.
nextStepIfMatched	NextStep	Próxima etapa após a avaliação da regra. Os comportamentos atuais com suporte são 'Continuar'(para a próxima regra) e 'Encerrar'.