Virtual Network Gateways - Set Vpnclient Ipsec Parameters

Referens

Service:: Network Gateway

API Version:: 2023-09-01

Åtgärden Ange VpnclientIpsecParameters anger vpnclient ipsec-principen för P2S-klienten för den virtuella nätverksgatewayen i den angivna resursgruppen via nätverksresursprovidern.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters?api-version=2023-09-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
virtualNetworkGatewayName	path	True	string	Namnet på den virtuella nätverksgatewayen.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
dhGroup	True	DhGroup	DH-gruppen som används i IKE Fas 1 för inledande SA.
ikeEncryption	True	IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
ikeIntegrity	True	IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
ipsecEncryption	True	IpsecEncryption	IPSec-krypteringsalgoritmen (IKE fas 1).
ipsecIntegrity	True	IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
pfsGroup	True	PfsGroup	Pfs-gruppen som används i IKE Fas 2 för ny underordnad SA.
saDataSizeKilobytes	True	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller Fas 2 SA) nyttolaststorlek i KB för P2S-klienten..
saLifeTimeSeconds	True	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller Fas 2 SA) livslängd i sekunder för P2S-klienten.

Svar

Name	Typ	Description
200 OK	VpnClientIPsecParameters	Begäran lyckades. Åtgärden anger de angivna vpnclient ipsec-parametrarna för P2S-klienten för den virtuella nätverksgatewayen.
202 Accepted		Åtgärden godkänns och slutförs asynkront.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Set VirtualNetworkGateway VpnClientIpsecParameters

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/setvpnclientipsecparameters?api-version=2023-09-01

{
  "saLifeTimeSeconds": 86473,
  "saDataSizeKilobytes": 429497,
  "ipsecEncryption": "AES256",
  "ipsecIntegrity": "SHA256",
  "ikeEncryption": "AES256",
  "ikeIntegrity": "SHA384",
  "dhGroup": "DHGroup2",
  "pfsGroup": "PFS2"
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_gateway_set_vpn_client_ipsec_parameters.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.virtual_network_gateways.begin_set_vpnclient_ipsec_parameters(
        resource_group_name="rg1",
        virtual_network_gateway_name="vpngw",
        vpnclient_ipsec_params={
            "dhGroup": "DHGroup2",
            "ikeEncryption": "AES256",
            "ikeIntegrity": "SHA384",
            "ipsecEncryption": "AES256",
            "ipsecIntegrity": "SHA256",
            "pfsGroup": "PFS2",
            "saDataSizeKilobytes": 429497,
            "saLifeTimeSeconds": 86473,
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.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/VirtualNetworkGatewaySetVpnClientIpsecParameters.json
func ExampleVirtualNetworkGatewaysClient_BeginSetVpnclientIPSecParameters() {
	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.NewVirtualNetworkGatewaysClient().BeginSetVpnclientIPSecParameters(ctx, "rg1", "vpngw", armnetwork.VPNClientIPsecParameters{
		DhGroup:             to.Ptr(armnetwork.DhGroupDHGroup2),
		IkeEncryption:       to.Ptr(armnetwork.IkeEncryptionAES256),
		IkeIntegrity:        to.Ptr(armnetwork.IkeIntegritySHA384),
		IPSecEncryption:     to.Ptr(armnetwork.IPSecEncryptionAES256),
		IPSecIntegrity:      to.Ptr(armnetwork.IPSecIntegritySHA256),
		PfsGroup:            to.Ptr(armnetwork.PfsGroupPFS2),
		SaDataSizeKilobytes: to.Ptr[int32](429497),
		SaLifeTimeSeconds:   to.Ptr[int32](86473),
	}, 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.VPNClientIPsecParameters = armnetwork.VPNClientIPsecParameters{
	// 	DhGroup: to.Ptr(armnetwork.DhGroupDHGroup2),
	// 	IkeEncryption: to.Ptr(armnetwork.IkeEncryptionAES256),
	// 	IkeIntegrity: to.Ptr(armnetwork.IkeIntegritySHA384),
	// 	IPSecEncryption: to.Ptr(armnetwork.IPSecEncryptionAES256),
	// 	IPSecIntegrity: to.Ptr(armnetwork.IPSecIntegritySHA256),
	// 	PfsGroup: to.Ptr(armnetwork.PfsGroupPFS2),
	// 	SaDataSizeKilobytes: to.Ptr[int32](429497),
	// 	SaLifeTimeSeconds: to.Ptr[int32](86473),
	// }
}

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 The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
 *
 * @summary The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json
 */
async function setVirtualNetworkGatewayVpnClientIpsecParameters() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const vpnclientIpsecParams = {
    dhGroup: "DHGroup2",
    ikeEncryption: "AES256",
    ikeIntegrity: "SHA384",
    ipsecEncryption: "AES256",
    ipsecIntegrity: "SHA256",
    pfsGroup: "PFS2",
    saDataSizeKilobytes: 429497,
    saLifeTimeSeconds: 86473,
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginSetVpnclientIpsecParametersAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
    vpnclientIpsecParams,
  );
  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/VirtualNetworkGatewaySetVpnClientIpsecParameters.json
// this example is just showing the usage of "VirtualNetworkGateways_SetVpnclientIpsecParameters" 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 VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "vpngw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
VpnClientIPsecParameters vpnclientIPsecParams = new VpnClientIPsecParameters(86473, 429497, IPsecEncryption.Aes256, IPsecIntegrity.Sha256, IkeEncryption.Aes256, IkeIntegrity.Sha384, DHGroup.DHGroup2, PfsGroup.Pfs2);
ArmOperation<VpnClientIPsecParameters> lro = await virtualNetworkGateway.SetVpnclientIPsecParametersAsync(WaitUntil.Completed, vpnclientIPsecParams);
VpnClientIPsecParameters result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-09-01

Status code:: 200

{
  "saLifeTimeSeconds": 86473,
  "saDataSizeKilobytes": 429497,
  "ipsecEncryption": "AES256",
  "ipsecIntegrity": "SHA256",
  "ikeEncryption": "AES256",
  "ikeIntegrity": "SHA384",
  "dhGroup": "DHGroup2",
  "pfsGroup": "PFS2"
}

Definitioner

Name	Description
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
DhGroup	De DH-grupper som används i IKE Fas 1 för inledande SA.
IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
IpsecEncryption	IPSec-krypteringsalgoritmen (IKE fas 1).
IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
PfsGroup	Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.
VpnClientIPsecParameters	En IPSec-parametrar för en P2S-anslutning för en virtuell nätverksgateway.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Molnfeltext.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

DhGroup

De DH-grupper som används i IKE Fas 1 för inledande SA.

Name	Typ	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

IkeEncryption

IKE-krypteringsalgoritmen (IKE fas 2).

Name	Typ	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE-integritetsalgoritmen (IKE fas 2).

Name	Typ	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

IPSec-krypteringsalgoritmen (IKE fas 1).

Name	Typ	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec-integritetsalgoritmen (IKE fas 1).

Name	Typ	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

PfsGroup

Pfs-grupper som används i IKE Fas 2 för ny underordnad SA.

Name	Typ	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

VpnClientIPsecParameters

En IPSec-parametrar för en P2S-anslutning för en virtuell nätverksgateway.

Name	Typ	Description
dhGroup	DhGroup	DH-gruppen som används i IKE Fas 1 för inledande SA.
ikeEncryption	IkeEncryption	IKE-krypteringsalgoritmen (IKE fas 2).
ikeIntegrity	IkeIntegrity	IKE-integritetsalgoritmen (IKE fas 2).
ipsecEncryption	IpsecEncryption	IPSec-krypteringsalgoritmen (IKE fas 1).
ipsecIntegrity	IpsecIntegrity	IPSec-integritetsalgoritmen (IKE fas 1).
pfsGroup	PfsGroup	Pfs-gruppen som används i IKE Fas 2 för ny underordnad SA.
saDataSizeKilobytes	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller Fas 2 SA) nyttolaststorlek i KB för P2S-klienten..
saLifeTimeSeconds	integer	IPSec-säkerhetsassociationen (kallas även snabbläge eller Fas 2 SA) livslängd i sekunder för P2S-klienten.

Dela via

Virtual Network Gateways - Set Vpnclient Ipsec Parameters

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Scopes

Exempel

Set VirtualNetworkGateway VpnClientIpsecParameters

Sample Request

Sample Response

Definitioner

CloudError

CloudErrorBody

DhGroup

IkeEncryption

IkeIntegrity

IpsecEncryption

IpsecIntegrity

PfsGroup

VpnClientIPsecParameters

Ytterligare resurser