Virtual Network Gateways - Disconnect Virtual Network Gateway Vpn Connections

Service:

Network Gateway

API Version:

2023-09-01

Koppla från VPN-anslutningar för virtuell nätverksgateway i den angivna resursgruppen.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/disconnectVirtualNetworkGatewayVpnConnections?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	Typ	Description
vpnConnectionIds	string[]	Lista över vpn-anslutnings-ID:t för p2s.

Svar

Name	Typ	Description
200 OK		Begäran lyckades. Åtgärden kopplar från de begärda VPN-anslutningarna.
202 Accepted		Accepterad och åtgärden 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

Disconnect VpnConnections from Virtual Network Gateway

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/vpn-gateway-test/providers/Microsoft.Network/virtualNetworkGateways/vpngateway/disconnectVirtualNetworkGatewayVpnConnections?api-version=2023-09-01

{
  "vpnConnectionIds": [
    "vpnconnId1",
    "vpnconnId2"
  ]
}

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_gateways_disconnect_p2s_vpn_connections.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",
    )

    client.virtual_network_gateways.begin_disconnect_virtual_network_gateway_vpn_connections(
        resource_group_name="vpn-gateway-test",
        virtual_network_gateway_name="vpngateway",
        request={"vpnConnectionIds": ["vpnconnId1", "vpnconnId2"]},
    ).result()


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.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/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/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json
func ExampleVirtualNetworkGatewaysClient_BeginDisconnectVirtualNetworkGatewayVPNConnections() {
	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().BeginDisconnectVirtualNetworkGatewayVPNConnections(ctx, "vpn-gateway-test", "vpngateway", armnetwork.P2SVPNConnectionRequest{
		VPNConnectionIDs: []*string{
			to.Ptr("vpnconnId1"),
			to.Ptr("vpnconnId2")},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 Disconnect vpn connections of virtual network gateway in the specified resource group.
 *
 * @summary Disconnect vpn connections of virtual network gateway in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json
 */
async function disconnectVpnConnectionsFromVirtualNetworkGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "vpn-gateway-test";
  const virtualNetworkGatewayName = "vpngateway";
  const request = {
    vpnConnectionIds: ["vpnconnId1", "vpnconnId2"],
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result =
    await client.virtualNetworkGateways.beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(
      resourceGroupName,
      virtualNetworkGatewayName,
      request,
    );
  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/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json
// this example is just showing the usage of "VirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections" 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 = "vpn-gateway-test";
string virtualNetworkGatewayName = "vpngateway";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
P2SVpnConnectionRequest request = new P2SVpnConnectionRequest()
{
    VpnConnectionIds =
    {
    "vpnconnId1","vpnconnId2"
    },
};
await virtualNetworkGateway.DisconnectVirtualNetworkGatewayVpnConnectionsAsync(WaitUntil.Completed, request);

Console.WriteLine($"Succeeded");

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

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

Definitioner

Name	Description
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
P2SVpnConnectionRequest	Lista över p2s vpn-anslutningar som ska kopplas från.

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.

P2SVpnConnectionRequest

Lista över p2s vpn-anslutningar som ska kopplas från.

Name	Typ	Description
vpnConnectionIds	string[]	Lista över vpn-anslutnings-ID:t för p2s.