generatevirtualwanvpnserverconfigurationvpnprofile - generatevirtualwanvpnserverconfigurationvpnprofile

Referensi

Service:: Virtual WAN

API Version:: 2023-09-01

Menghasilkan profil VPN unik untuk klien P2S untuk VirtualWan dan kombinasi VpnServerConfiguration terkait dalam grup sumber daya yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
virtualWANName	path	True	string	Nama VirtualWAN yang diperlukan VpnServerConfigurations terkait.
api-version	query	True	string	Versi API klien.

Isi Permintaan

Nama	Jenis	Deskripsi
authenticationMethod	AuthenticationMethod	Metode autentikasi klien VPN.
vpnServerConfigurationResourceId	string	VpnServerConfiguration uri sumber daya parsial yang terkait dengan VirtualWan.

Respons

Nama	Jenis	Deskripsi
200 OK	VpnProfileResponse	URL paket profil VPN.
202 Accepted		Diterima dan operasi akan selesai secara asinkron.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

GenerateVirtualWanVpnServerConfigurationVpnProfile

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/wan1/GenerateVpnProfile?api-version=2023-09-01

{
  "vpnServerConfigurationResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1",
  "authenticationMethod": "EAPTLS"
}

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python generate_virtual_wan_vpn_server_configuration_vpn_profile.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.begin_generatevirtualwanvpnserverconfigurationvpnprofile(
        resource_group_name="rg1",
        virtual_wan_name="wan1",
        vpn_client_params={
            "authenticationMethod": "EAPTLS",
            "vpnServerConfigurationResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.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/GenerateVirtualWanVpnServerConfigurationVpnProfile.json
func ExampleManagementClient_BeginGeneratevirtualwanvpnserverconfigurationvpnprofile() {
	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.NewManagementClient().BeginGeneratevirtualwanvpnserverconfigurationvpnprofile(ctx, "rg1", "wan1", armnetwork.VirtualWanVPNProfileParameters{
		AuthenticationMethod:             to.Ptr(armnetwork.AuthenticationMethodEAPTLS),
		VPNServerConfigurationResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1"),
	}, 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.VPNProfileResponse = armnetwork.VPNProfileResponse{
	// 	ProfileURL: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaaaa"),
	// }
}

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 Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.
 *
 * @summary Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json
 */
async function generateVirtualWanVpnServerConfigurationVpnProfile() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualWANName = "wan1";
  const vpnClientParams = {
    authenticationMethod: "EAPTLS",
    vpnServerConfigurationResourceId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.beginGeneratevirtualwanvpnserverconfigurationvpnprofileAndWait(
    resourceGroupName,
    virtualWANName,
    vpnClientParams,
  );
  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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json
// this example is just showing the usage of "generatevirtualwanvpnserverconfigurationvpnprofile" 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 VirtualWanResource created on azure
// for more information of creating VirtualWanResource, please refer to the document of VirtualWanResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualWanName = "wan1";
ResourceIdentifier virtualWanResourceId = VirtualWanResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualWanName);
VirtualWanResource virtualWan = client.GetVirtualWanResource(virtualWanResourceId);

// invoke the operation
VirtualWanVpnProfileContent content = new VirtualWanVpnProfileContent()
{
    VpnServerConfigurationResourceId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1"),
    AuthenticationMethod = NetworkAuthenticationMethod.Eaptls,
};
ArmOperation<VpnProfileResponse> lro = await virtualWan.GenerateVirtualWanVpnServerConfigurationVpnProfileAsync(WaitUntil.Completed, content);
VpnProfileResponse 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

Status code:: 200

{
  "profileUrl": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Definisi

Nama	Deskripsi
AuthenticationMethod	Metode autentikasi klien VPN.
CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan.
VirtualWanVpnProfileParameters	Parameter profil Virtual Wan Vpn Pembuatan profil Vpn.
VpnProfileResponse	Respons Profil Vpn untuk pembuatan paket.

AuthenticationMethod

Metode autentikasi klien VPN.

Nama	Jenis	Deskripsi
EAPMSCHAPv2	string
EAPTLS	string

CloudError

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Isi kesalahan cloud.

CloudErrorBody

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

VirtualWanVpnProfileParameters

Parameter profil Virtual Wan Vpn Pembuatan profil Vpn.

Nama	Jenis	Deskripsi
authenticationMethod	AuthenticationMethod	Metode autentikasi klien VPN.
vpnServerConfigurationResourceId	string	VpnServerConfiguration uri sumber daya parsial yang terkait dengan VirtualWan.

VpnProfileResponse

Respons Profil Vpn untuk pembuatan paket.

Nama	Jenis	Deskripsi
profileUrl	string	URL ke profil VPN.

generatevirtualwanvpnserverconfigurationvpnprofile - generatevirtualwanvpnserverconfigurationvpnprofile

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

GenerateVirtualWanVpnServerConfigurationVpnProfile

Sample Request

Sample Response

Definisi

AuthenticationMethod

CloudError

CloudErrorBody

VirtualWanVpnProfileParameters

VpnProfileResponse

Sumber Daya Tambahan: