Virtual Network Gateways - Get Vpnclient Ipsec Parameters

參考

Service:: Network Gateway

API Version:: 2023-09-01

取得 VpnclientIpsecParameters 作業會透過網路資源提供者，擷取指定資源群組中虛擬網路網關之 P2S 用戶端 vpnclient ipsec 原則的相關信息。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
virtualNetworkGatewayName	path	True	string	虛擬網路閘道名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	VpnClientIPsecParameters	要求成功。此作業會針對 VirtualNetworkGateway 資源的 P2S 用戶端傳回設定 vpnclient ipsec 參數。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get VirtualNetworkGateway VpnClientIpsecParameters

Sample Request

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

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

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

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

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

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
DhGroup	IKE 階段 1 中用於初始 SA 的 DH 群組。
IkeEncryption	IKE 加密演算法 (IKE 階段 2) 。
IkeIntegrity	IKE 完整性演算法 (IKE 階段 2) 。
IpsecEncryption	IPSec 加密演算法 (IKE 階段 1) 。
IpsecIntegrity	IPSec 完整性演算法 (IKE 階段 1) 。
PfsGroup	IKE 階段 2 中用於新子 SA 的 Pfs 群組。
VpnClientIPsecParameters	虛擬網路閘道 P2S 連線的IPSec參數。

CloudError

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程式碼不變，且要以程式設計方式使用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中屬性的名稱。

DhGroup

IKE 階段 1 中用於初始 SA 的 DH 群組。

名稱	類型	Description
DHGroup1	string
DHGroup14	string
DHGroup2	string
DHGroup2048	string
DHGroup24	string
ECP256	string
ECP384	string
None	string

IkeEncryption

IKE 加密演算法 (IKE 階段 2) 。

名稱	類型	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES256	string

IkeIntegrity

IKE 完整性演算法 (IKE 階段 2) 。

名稱	類型	Description
GCMAES128	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string
SHA384	string

IpsecEncryption

IPSec 加密演算法 (IKE 階段 1) 。

名稱	類型	Description
AES128	string
AES192	string
AES256	string
DES	string
DES3	string
GCMAES128	string
GCMAES192	string
GCMAES256	string
None	string

IpsecIntegrity

IPSec 完整性演算法 (IKE 階段 1) 。

名稱	類型	Description
GCMAES128	string
GCMAES192	string
GCMAES256	string
MD5	string
SHA1	string
SHA256	string

PfsGroup

IKE 階段 2 中用於新子 SA 的 Pfs 群組。

名稱	類型	Description
ECP256	string
ECP384	string
None	string
PFS1	string
PFS14	string
PFS2	string
PFS2048	string
PFS24	string
PFSMM	string

VpnClientIPsecParameters

虛擬網路閘道 P2S 連線的IPSec參數。

名稱	類型	Description
dhGroup	DhGroup	IKE 階段 1 中用於初始 SA 的 DH 群組。
ikeEncryption	IkeEncryption	IKE 加密演算法 (IKE 階段 2) 。
ikeIntegrity	IkeIntegrity	IKE 完整性演算法 (IKE 階段 2) 。
ipsecEncryption	IpsecEncryption	IPSec 加密演算法 (IKE 階段 1) 。
ipsecIntegrity	IpsecIntegrity	IPSec 完整性演算法 (IKE 階段 1) 。
pfsGroup	PfsGroup	IKE 階段 2 中用於新子 SA 的 Pfs 群組。
saDataSizeKilobytes	integer	IPSec 安全性關聯 (也稱為 P2S 用戶端的快速模式或階段 2 SA) 承載大小。
saLifeTimeSeconds	integer	IPSec 安全性關聯 (也稱為 P2S 用戶端的快速模式或階段 2 SA) 存留期。

Virtual Network Gateways - Get Vpnclient Ipsec Parameters

URI 參數

回應

安全性

azure_auth

Scopes

範例

Get VirtualNetworkGateway VpnClientIpsecParameters

Sample Request

Sample Response

定義

CloudError

CloudErrorBody

DhGroup

IkeEncryption

IkeIntegrity

IpsecEncryption

IpsecIntegrity

PfsGroup

VpnClientIPsecParameters

其他資源