Virtual Network Gateways - Get Vpnclient Ipsec Parameters

Service:

Network Gateway

API Version:

2023-09-01

A VpnclientIpsecParameters lekérése művelet a megadott erőforráscsoportban lévő virtuális hálózati átjáró P2S-ügyfélének vpnclient ipsec-házirendjéről kér le információkat a hálózati erőforrás-szolgáltatón keresztül.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
virtualNetworkGatewayName	path	True	string	A virtuális hálózati átjáró neve.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	VpnClientIPsecParameters	A kérés sikeres. A művelet a VirtualNetworkGateway erőforrás P2S-ügyfélének megadott vpnclient ipsec-paramétereit adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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	felhasználói fiók megszemélyesítése

Példák

Get VirtualNetworkGateway VpnClientIpsecParameters

Sample Request

HTTP

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

Python

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_get_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_get_vpnclient_ipsec_parameters(
        resource_group_name="rg1",
        virtual_network_gateway_name="vpngw",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.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/VirtualNetworkGatewayGetVpnClientIpsecParameters.json
func ExampleVirtualNetworkGatewaysClient_BeginGetVpnclientIPSecParameters() {
	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().BeginGetVpnclientIPSecParameters(ctx, "rg1", "vpngw", 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

JavaScript

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

/**
 * This sample demonstrates how to The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
 *
 * @summary The Get VpnclientIpsecParameters operation retrieves information about 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/VirtualNetworkGatewayGetVpnClientIpsecParameters.json
 */
async function getVirtualNetworkGatewayVpnClientIpsecParameters() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginGetVpnclientIpsecParametersAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
  );
  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 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/VirtualNetworkGatewayGetVpnClientIpsecParameters.json
// this example is just showing the usage of "VirtualNetworkGateways_GetVpnclientIpsecParameters" 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
ArmOperation<VpnClientIPsecParameters> lro = await virtualNetworkGateway.GetVpnclientIPsecParametersAsync(WaitUntil.Completed);
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:

200

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

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
DhGroup	Az IKE 1. fázisában a kezdeti SA-hoz használt DH-csoportok.
IkeEncryption	Az IKE titkosítási algoritmus (IKE 2. fázis).
IkeIntegrity	Az IKE integritási algoritmusa (IKE 2. fázis).
IpsecEncryption	Az IPSec titkosítási algoritmus (IKE 1. fázis).
IpsecIntegrity	Az IPSec integritási algoritmus (IKE 1. fázis).
PfsGroup	Az IKE 2. fázisában használt Pfs-csoportok az új gyermek sa-hoz.
VpnClientIPsecParameters	Egy virtuális hálózati átjáró P2S-kapcsolat IPSec-paraméterei.

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a hibás tulajdonság neve.

DhGroup

Az IKE 1. fázisában a kezdeti SA-hoz használt DH-csoportok.

Name	Típus	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

IkeEncryption

Az IKE titkosítási algoritmus (IKE 2. fázis).

Name	Típus	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

Az IKE integritási algoritmusa (IKE 2. fázis).

Name	Típus	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

Az IPSec titkosítási algoritmus (IKE 1. fázis).

Name	Típus	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

Az IPSec integritási algoritmus (IKE 1. fázis).

Name	Típus	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

PfsGroup

Az IKE 2. fázisában használt Pfs-csoportok az új gyermek sa-hoz.

Name	Típus	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

VpnClientIPsecParameters

Egy virtuális hálózati átjáró P2S-kapcsolat IPSec-paraméterei.

Name	Típus	Description
dhGroup	DhGroup	Az IKE 1. fázisában a kezdeti SA-hoz használt DH-csoport.
ikeEncryption	IkeEncryption	Az IKE titkosítási algoritmus (IKE 2. fázis).
ikeIntegrity	IkeIntegrity	Az IKE integritási algoritmusa (IKE 2. fázis).
ipsecEncryption	IpsecEncryption	Az IPSec titkosítási algoritmus (IKE 1. fázis).
ipsecIntegrity	IpsecIntegrity	Az IPSec integritási algoritmus (IKE 1. fázis).
pfsGroup	PfsGroup	Az IKE 2. fázisában használt Pfs-csoport az új gyermek sa-hoz.
saDataSizeKilobytes	integer	Az IPSec biztonsági társítás (más néven gyors mód vagy 2. fázisú SA) hasznos adatmennyisége a KB-ban a P2S-ügyfélhez.
saLifeTimeSeconds	integer	Az IPSec biztonsági társítás (más néven Gyors mód vagy 2. fázis sa) élettartama másodpercben a P2S-ügyfél esetében.