Virtual Network Gateways - Generate Vpn Profile

Service:

Network Gateway

API Version:

2023-09-01

Gera o perfil VPN para o cliente P2S do gateway de rede virtual no grupo de recursos especificado. Utilizado para autenticação baseada em IKEV2 e radius.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
virtualNetworkGatewayName	path	True	string	O nome do gateway de rede virtual.
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Tipo	Description
authenticationMethod	AuthenticationMethod	Método de autenticação de cliente VPN.
clientRootCertificates	string[]	Uma lista de certificados de raiz de cliente de dados de certificados públicos codificados como cadeias base-64. Parâmetro opcional para autenticação baseada em radius externo com EAPTLS.
processorArchitecture	ProcessorArchitecture	Arquitetura do Processador do cliente VPN.
radiusServerAuthCertificate	string	Os dados do certificado público para o certificado de autenticação do servidor radius como uma cadeia codificada base-64. Necessário apenas se a autenticação radius externa tiver sido configurada com a autenticação EAPTLS.

Respostas

Name	Tipo	Description
200 OK	string	URL do pacote de perfil VPN.
202 Accepted		Aceite e a operação será concluída de forma assíncrona.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

GenerateVirtualNetworkGatewayVPNProfile

Sample Request

HTTP

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

{}

Java

import com.azure.resourcemanager.network.models.VpnClientParameters;

/**
 * Samples for VirtualNetworkGateways GenerateVpnProfile.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * VirtualNetworkGatewayGenerateVpnProfile.json
     */
    /**
     * Sample code: GenerateVirtualNetworkGatewayVPNProfile.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void generateVirtualNetworkGatewayVPNProfile(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().generateVpnProfile("rg1", "vpngw",
            new VpnClientParameters(), 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

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/VirtualNetworkGatewayGenerateVpnProfile.json
func ExampleVirtualNetworkGatewaysClient_BeginGenerateVPNProfile() {
	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().BeginGenerateVPNProfile(ctx, "rg1", "vpngw", armnetwork.VPNClientParameters{}, 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.Value = ""
}

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 Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
 *
 * @summary Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json
 */
async function generateVirtualNetworkGatewayVpnProfile() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const parameters = {};
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginGenerateVpnProfileAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
    parameters,
  );
  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/VirtualNetworkGatewayGenerateVpnProfile.json
// this example is just showing the usage of "VirtualNetworkGateways_GenerateVpnProfile" 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
VpnClientContent content = new VpnClientContent();
ArmOperation<string> lro = await virtualNetworkGateway.GenerateVpnProfileAsync(WaitUntil.Completed, content);
string 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

""

Definições

Name	Description
AuthenticationMethod	Método de autenticação de cliente VPN.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ProcessorArchitecture	Arquitetura do Processador do cliente VPN.
VpnClientParameters	Parâmetros de Cliente Vpn para a geração de pacotes.

AuthenticationMethod

Método de autenticação de cliente VPN.

Name	Tipo	Description
EAPMSCHAPv2	string
EAPTLS	string

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro da cloud.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ProcessorArchitecture

Arquitetura do Processador do cliente VPN.

Name	Tipo	Description
Amd64	string
X86	string

VpnClientParameters

Parâmetros de Cliente Vpn para a geração de pacotes.

Name	Tipo	Description
authenticationMethod	AuthenticationMethod	Método de autenticação de cliente VPN.
clientRootCertificates	string[]	Uma lista de certificados de raiz de cliente de dados de certificados públicos codificados como cadeias base-64. Parâmetro opcional para autenticação baseada em radius externo com EAPTLS.
processorArchitecture	ProcessorArchitecture	Arquitetura do Processador do cliente VPN.
radiusServerAuthCertificate	string	Os dados do certificado público para o certificado de autenticação do servidor radius como uma cadeia codificada base-64. Necessário apenas se a autenticação radius externa tiver sido configurada com a autenticação EAPTLS.