Nat Rules - Create Or Update

Referencia

Servicio:: Virtual WAN

Versión de la API:: 2024-05-01

Crea una regla nat en una puerta de enlace de VPN escalable si no existe, actualiza las reglas nat existentes.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayName	path	True	string	Nombre de la puerta de enlace.
natRuleName	path	True	string	Nombre de la regla nat.
resourceGroupName	path	True	string	Nombre del grupo de recursos de VpnGateway.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.externalMappings	VpnNatRuleMapping[]	Asignación externa de dirección IP privada para NAT.
properties.internalMappings	VpnNatRuleMapping[]	Asignación interna de direcciones IP privadas para NAT.
properties.ipConfigurationId	string	El identificador de configuración de IP al que se aplica esta regla NAT.
properties.mode	VpnNatRuleMode	Dirección NAT de origen de una NAT de VPN.
properties.type	VpnNatRuleType	Tipo de regla NAT para VPN NAT.

Respuestas

Nombre	Tipo	Description
200 OK	VpnGatewayNatRule	Solicitud correcta. Devuelve los detalles de la regla nat creada o actualizada.
201 Created	VpnGatewayNatRule	Solicitud correcta. Devuelve los detalles de la regla nat creada o actualizada.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

NatRulePut

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1?api-version=2024-05-01

{
  "properties": {
    "type": "Static",
    "mode": "EgressSnat",
    "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default",
    "internalMappings": [
      {
        "addressSpace": "10.4.0.0/24"
      }
    ],
    "externalMappings": [
      {
        "addressSpace": "192.168.21.0/24"
      }
    ]
  }
}


import com.azure.resourcemanager.network.fluent.models.VpnGatewayNatRuleInner;
import com.azure.resourcemanager.network.models.VpnNatRuleMapping;
import com.azure.resourcemanager.network.models.VpnNatRuleMode;
import com.azure.resourcemanager.network.models.VpnNatRuleType;
import java.util.Arrays;

/**
 * Samples for NatRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NatRulePut.json
     */
    /**
     * Sample code: NatRulePut.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void natRulePut(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNatRules().createOrUpdate("rg1", "gateway1", "natRule1",
            new VpnGatewayNatRuleInner().withTypePropertiesType(VpnNatRuleType.STATIC)
                .withMode(VpnNatRuleMode.EGRESS_SNAT)
                .withInternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("10.4.0.0/24")))
                .withExternalMappings(Arrays.asList(new VpnNatRuleMapping().withAddressSpace("192.168.21.0/24")))
                .withIpConfigurationId(
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default"),
            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

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/NatRulePut.json
func ExampleNatRulesClient_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.NewNatRulesClient().BeginCreateOrUpdate(ctx, "rg1", "gateway1", "natRule1", armnetwork.VPNGatewayNatRule{
		Properties: &armnetwork.VPNGatewayNatRuleProperties{
			Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
			ExternalMappings: []*armnetwork.VPNNatRuleMapping{
				{
					AddressSpace: to.Ptr("192.168.21.0/24"),
				}},
			InternalMappings: []*armnetwork.VPNNatRuleMapping{
				{
					AddressSpace: to.Ptr("10.4.0.0/24"),
				}},
			IPConfigurationID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default"),
			Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
		},
	}, 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.VPNGatewayNatRule = armnetwork.VPNGatewayNatRule{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1"),
	// 	Name: to.Ptr("natRule1"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.VPNGatewayNatRuleProperties{
	// 		Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
	// 		EgressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1"),
	// 		}},
	// 		ExternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 			{
	// 				AddressSpace: to.Ptr("192.168.21.0/24"),
	// 		}},
	// 		IngressVPNSiteLinkConnections: []*armnetwork.SubResource{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2"),
	// 		}},
	// 		InternalMappings: []*armnetwork.VPNNatRuleMapping{
	// 			{
	// 				AddressSpace: to.Ptr("10.4.0.0/24"),
	// 		}},
	// 		IPConfigurationID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default"),
	// 		Mode: to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 	},
	// }
}

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 a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.
 *
 * @summary Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/NatRulePut.json
 */
async function natRulePut() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "gateway1";
  const natRuleName = "natRule1";
  const natRuleParameters = {
    typePropertiesType: "Static",
    externalMappings: [{ addressSpace: "192.168.21.0/24" }],
    internalMappings: [{ addressSpace: "10.4.0.0/24" }],
    ipConfigurationId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default",
    mode: "EgressSnat",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.natRules.beginCreateOrUpdateAndWait(
    resourceGroupName,
    gatewayName,
    natRuleName,
    natRuleParameters,
  );
  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 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/NatRulePut.json
// this example is just showing the usage of "NatRules_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 VpnGatewayResource created on azure
// for more information of creating VpnGatewayResource, please refer to the document of VpnGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string gatewayName = "gateway1";
ResourceIdentifier vpnGatewayResourceId = VpnGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
VpnGatewayResource vpnGateway = client.GetVpnGatewayResource(vpnGatewayResourceId);

// get the collection of this VpnGatewayNatRuleResource
VpnGatewayNatRuleCollection collection = vpnGateway.GetVpnGatewayNatRules();

// invoke the operation
string natRuleName = "natRule1";
VpnGatewayNatRuleData data = new VpnGatewayNatRuleData
{
    VpnNatRuleType = VpnNatRuleType.Static,
    Mode = VpnNatRuleMode.EgressSnat,
    InternalMappings = {new VpnNatRuleMapping
    {
    AddressSpace = "10.4.0.0/24",
    }},
    ExternalMappings = {new VpnNatRuleMapping
    {
    AddressSpace = "192.168.21.0/24",
    }},
    IPConfigurationId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default",
};
ArmOperation<VpnGatewayNatRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, natRuleName, data);
VpnGatewayNatRuleResource 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
VpnGatewayNatRuleData 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

Respuesta de muestra

status code:: 200

{
  "name": "natRule1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "properties": {
    "provisioningState": "Succeeded",
    "type": "Static",
    "mode": "EgressSnat",
    "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default",
    "internalMappings": [
      {
        "addressSpace": "10.4.0.0/24"
      }
    ],
    "externalMappings": [
      {
        "addressSpace": "192.168.21.0/24"
      }
    ],
    "egressVpnSiteLinkConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1"
      }
    ],
    "ingressVpnSiteLinkConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2"
      }
    ]
  }
}

status code:: 201

{
  "name": "natRule1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "properties": {
    "provisioningState": "Succeeded",
    "type": "Static",
    "mode": "EgressSnat",
    "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default",
    "internalMappings": [
      {
        "addressSpace": "10.4.0.0/24"
      }
    ],
    "externalMappings": [
      {
        "addressSpace": "192.168.21.0/24"
      }
    ],
    "egressVpnSiteLinkConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1"
      }
    ],
    "ingressVpnSiteLinkConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2"
      }
    ]
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
ProvisioningState	Estado de aprovisionamiento actual.
SubResource	Referencia a otro subrecurso.
VpnGatewayNatRule	Recurso VpnGatewayNatRule.
VpnNatRuleMapping	Asignación de NatRule de VPN.
VpnNatRuleMode	Dirección NAT de origen de una NAT de VPN.
VpnNatRuleType	Tipo de regla NAT para VPN NAT.

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

ProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Deleting
Failed
Succeeded
Updating

SubResource

Object

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador de recurso.

VpnGatewayNatRule

Object

Recurso VpnGatewayNatRule.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador de recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.egressVpnSiteLinkConnections	SubResource[]	Lista de salida VpnSiteLinkConnections.
properties.externalMappings	VpnNatRuleMapping[]	Asignación externa de dirección IP privada para NAT.
properties.ingressVpnSiteLinkConnections	SubResource[]	Lista de entradas VpnSiteLinkConnections.
properties.internalMappings	VpnNatRuleMapping[]	Asignación interna de direcciones IP privadas para NAT.
properties.ipConfigurationId	string	El identificador de configuración de IP al que se aplica esta regla NAT.
properties.mode	VpnNatRuleMode	Dirección NAT de origen de una NAT de VPN.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de regla NAT.
properties.type	VpnNatRuleType	Tipo de regla NAT para VPN NAT.
type	string	Tipo de recurso.

VpnNatRuleMapping

Object

Asignación de NatRule de VPN.

Nombre	Tipo	Description
addressSpace	string	Espacio de direcciones para la asignación de Vpn NatRule.
portRange	string	Intervalo de puertos para la asignación de NatRule de Vpn.

VpnNatRuleMode

Enumeración

Dirección NAT de origen de una NAT de VPN.

Valor	Description
EgressSnat
IngressSnat

VpnNatRuleType

Enumeración

Tipo de regla NAT para VPN NAT.

Valor	Description
Dynamic
Static

Compartir a través de

Nat Rules - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

NatRulePut

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorBody

ProvisioningState

SubResource

VpnGatewayNatRule

VpnNatRuleMapping

VpnNatRuleMode

VpnNatRuleType