|
AddTag(String, String, CancellationToken)
|
Add a tag to the current resource.
|
|
AddTagAsync(String, String, CancellationToken)
|
Add a tag to the current resource.
|
|
CanUseTagResource(CancellationToken)
|
Checks to see if the TagResource API is deployed in the current environment.
(Inherited from ArmResource)
|
|
CanUseTagResourceAsync(CancellationToken)
|
Checks to see if the TagResource API is deployed in the current environment.
(Inherited from ArmResource)
|
|
CreateResourceIdentifier(String, String, String)
|
Generate the resource identifier for this resource.
|
|
Delete(WaitUntil, CancellationToken)
|
Deletes the specified virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}.
- Operation Id. : VirtualNetworkGateways_Delete.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
DeleteAsync(WaitUntil, CancellationToken)
|
Deletes the specified virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}.
- Operation Id. : VirtualNetworkGateways_Delete.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
DisconnectVirtualNetworkGatewayVpnConnections(WaitUntil, P2SVpnConnectionRequest, CancellationToken)
|
Disconnect vpn connections of virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/disconnectVirtualNetworkGatewayVpnConnections.
- Operation Id. : VirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
DisconnectVirtualNetworkGatewayVpnConnectionsAsync(WaitUntil, P2SVpnConnectionRequest, CancellationToken)
|
Disconnect vpn connections of virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/disconnectVirtualNetworkGatewayVpnConnections.
- Operation Id. : VirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
Generatevpnclientpackage(WaitUntil, VpnClientContent, CancellationToken)
|
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage.
- Operation Id. : VirtualNetworkGateways_Generatevpnclientpackage.
- Default Api Version. : 2026-01-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GenerateVpnClientPackage(WaitUntil, VpnClientContent, CancellationToken)
|
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage.
- Operation Id. : VirtualNetworkGateways_Generatevpnclientpackage.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GeneratevpnclientpackageAsync(WaitUntil, VpnClientContent, CancellationToken)
|
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage.
- Operation Id. : VirtualNetworkGateways_Generatevpnclientpackage.
- Default Api Version. : 2026-01-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GenerateVpnClientPackageAsync(WaitUntil, VpnClientContent, CancellationToken)
|
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage.
- Operation Id. : VirtualNetworkGateways_Generatevpnclientpackage.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GenerateVpnProfile(WaitUntil, VpnClientContent, CancellationToken)
|
Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile.
- Operation Id. : VirtualNetworkGateways_GenerateVpnProfile.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GenerateVpnProfileAsync(WaitUntil, VpnClientContent, CancellationToken)
|
Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile.
- Operation Id. : VirtualNetworkGateways_GenerateVpnProfile.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
Get(CancellationToken)
|
Gets the specified virtual network gateway by resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}.
- Operation Id. : VirtualNetworkGateways_Get.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetAdvertisedRoutes(WaitUntil, String, CancellationToken)
|
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes.
- Operation Id. : VirtualNetworkGateways_GetAdvertisedRoutes.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetAdvertisedRoutesAsync(WaitUntil, String, CancellationToken)
|
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes.
- Operation Id. : VirtualNetworkGateways_GetAdvertisedRoutes.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetAsync(CancellationToken)
|
Gets the specified virtual network gateway by resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}.
- Operation Id. : VirtualNetworkGateways_Get.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetAvailableLocations(CancellationToken)
|
Lists all available geo-locations.
(Inherited from ArmResource)
|
|
GetAvailableLocationsAsync(CancellationToken)
|
Lists all available geo-locations.
(Inherited from ArmResource)
|
|
GetBgpPeerStatus(WaitUntil, String, CancellationToken)
|
The GetBgpPeerStatus operation retrieves the status of all BGP peers.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus.
- Operation Id. : VirtualNetworkGateways_GetBgpPeerStatus.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetBgpPeerStatusAsync(WaitUntil, String, CancellationToken)
|
The GetBgpPeerStatus operation retrieves the status of all BGP peers.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus.
- Operation Id. : VirtualNetworkGateways_GetBgpPeerStatus.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetConnections(CancellationToken)
|
Gets all the connections in a virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections.
- Operation Id. : VirtualNetworkGateways_ListConnections.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetConnectionsAsync(CancellationToken)
|
Gets all the connections in a virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections.
- Operation Id. : VirtualNetworkGateways_ListConnections.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetEffectiveRoutes(WaitUntil, CancellationToken)
|
This operation retrieves a list of effective routes for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getEffectiveRoutes.
- Operation Id. : VirtualNetworkGateways_GetEffectiveRoutes.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetEffectiveRoutesAsync(WaitUntil, CancellationToken)
|
This operation retrieves a list of effective routes for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getEffectiveRoutes.
- Operation Id. : VirtualNetworkGateways_GetEffectiveRoutes.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetFailoverAllTestDetails(WaitUntil, String, Boolean, CancellationToken)
|
This operation retrieves the details of all the failover tests performed on the gateway for different peering locations
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverAllTestsDetails.
- Operation Id. : VirtualNetworkGateways_GetFailoverAllTestDetails.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetFailoverAllTestDetailsAsync(WaitUntil, String, Boolean, CancellationToken)
|
This operation retrieves the details of all the failover tests performed on the gateway for different peering locations
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverAllTestsDetails.
- Operation Id. : VirtualNetworkGateways_GetFailoverAllTestDetails.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetFailoverSingleTestDetails(WaitUntil, String, String, CancellationToken)
|
This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverSingleTestDetails.
- Operation Id. : VirtualNetworkGateways_GetFailoverSingleTestDetails.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetFailoverSingleTestDetailsAsync(WaitUntil, String, String, CancellationToken)
|
This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverSingleTestDetails.
- Operation Id. : VirtualNetworkGateways_GetFailoverSingleTestDetails.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetLearnedRoutes(WaitUntil, CancellationToken)
|
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes.
- Operation Id. : VirtualNetworkGateways_GetLearnedRoutes.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetLearnedRoutesAsync(WaitUntil, CancellationToken)
|
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes.
- Operation Id. : VirtualNetworkGateways_GetLearnedRoutes.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetManagementLock(String, CancellationToken)
|
Get a management lock by scope.
- Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
- Operation Id: ManagementLocks_GetByScope
- Default Api Version: 2020-05-01
- Resource: ManagementLockResource
(Inherited from ArmResource)
|
|
GetManagementLockAsync(String, CancellationToken)
|
Get a management lock by scope.
- Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
- Operation Id: ManagementLocks_GetByScope
- Default Api Version: 2020-05-01
- Resource: ManagementLockResource
(Inherited from ArmResource)
|
|
GetManagementLocks()
|
Gets a collection of ManagementLockResources in the ArmResource.
(Inherited from ArmResource)
|
|
GetPolicyAssignment(String, CancellationToken)
|
This operation retrieves a single policy assignment, given its name and the scope it was created at.
- Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
- Operation Id: PolicyAssignments_Get
- Default Api Version: 2022-06-01
- Resource: PolicyAssignmentResource
(Inherited from ArmResource)
|
|
GetPolicyAssignmentAsync(String, CancellationToken)
|
This operation retrieves a single policy assignment, given its name and the scope it was created at.
- Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
- Operation Id: PolicyAssignments_Get
- Default Api Version: 2022-06-01
- Resource: PolicyAssignmentResource
(Inherited from ArmResource)
|
|
GetPolicyAssignments()
|
Gets a collection of PolicyAssignmentResources in the ArmResource.
(Inherited from ArmResource)
|
|
GetRadiusSecrets(CancellationToken)
|
List all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/listRadiusSecrets.
- Operation Id. : VirtualNetworkGateways_ListRadiusSecrets.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetRadiusSecretsAsync(CancellationToken)
|
List all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/listRadiusSecrets.
- Operation Id. : VirtualNetworkGateways_ListRadiusSecrets.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetResiliencyInformation(WaitUntil, Nullable<Boolean>, CancellationToken)
|
This operation retrieves the resiliency information for an Express Route Gateway, including the gateway's current resiliency score and recommendations to further improve the score
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getResiliencyInformation.
- Operation Id. : VirtualNetworkGateways_GetResiliencyInformation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetResiliencyInformationAsync(WaitUntil, Nullable<Boolean>, CancellationToken)
|
This operation retrieves the resiliency information for an Express Route Gateway, including the gateway's current resiliency score and recommendations to further improve the score
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getResiliencyInformation.
- Operation Id. : VirtualNetworkGateways_GetResiliencyInformation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetRoutesInformation(WaitUntil, Nullable<Boolean>, CancellationToken)
|
This operation retrieves the route set information for an Express Route Gateway based on their resiliency
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getRoutesInformation.
- Operation Id. : VirtualNetworkGateways_GetRoutesInformation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetRoutesInformationAsync(WaitUntil, Nullable<Boolean>, CancellationToken)
|
This operation retrieves the route set information for an Express Route Gateway based on their resiliency
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getRoutesInformation.
- Operation Id. : VirtualNetworkGateways_GetRoutesInformation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetTagResource()
|
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.
(Inherited from ArmResource)
|
|
GetVirtualNetworkGatewayNatRule(String, CancellationToken)
|
Retrieves the details of a nat rule.
|
|
GetVirtualNetworkGatewayNatRuleAsync(String, CancellationToken)
|
Retrieves the details of a nat rule.
|
|
GetVirtualNetworkGatewayNatRules()
|
Gets a collection of VirtualNetworkGatewayNatRules in the VirtualNetworkGatewayResource.
|
|
GetVpnclientConnectionHealth(WaitUntil, CancellationToken)
|
Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth.
- Operation Id. : VirtualNetworkGateways_GetVpnclientConnectionHealth.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetVpnclientConnectionHealthAsync(WaitUntil, CancellationToken)
|
Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth.
- Operation Id. : VirtualNetworkGateways_GetVpnclientConnectionHealth.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetVpnclientIPsecParameters(WaitUntil, CancellationToken)
|
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.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters.
- Operation Id. : VirtualNetworkGateways_GetVpnclientIpsecParameters.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetVpnclientIPsecParametersAsync(WaitUntil, CancellationToken)
|
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.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters.
- Operation Id. : VirtualNetworkGateways_GetVpnclientIpsecParameters.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetVpnProfilePackageUrl(WaitUntil, CancellationToken)
|
Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl.
- Operation Id. : VirtualNetworkGateways_GetVpnProfilePackageUrl.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
GetVpnProfilePackageUrlAsync(WaitUntil, CancellationToken)
|
Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl.
- Operation Id. : VirtualNetworkGateways_GetVpnProfilePackageUrl.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokeAbortMigration(WaitUntil, CancellationToken)
|
Trigger abort migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/abortMigration.
- Operation Id. : VirtualNetworkGateways_InvokeAbortMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokeAbortMigrationAsync(WaitUntil, CancellationToken)
|
Trigger abort migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/abortMigration.
- Operation Id. : VirtualNetworkGateways_InvokeAbortMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokeCommitMigration(WaitUntil, CancellationToken)
|
Trigger commit migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/commitMigration.
- Operation Id. : VirtualNetworkGateways_InvokeCommitMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokeCommitMigrationAsync(WaitUntil, CancellationToken)
|
Trigger commit migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/commitMigration.
- Operation Id. : VirtualNetworkGateways_InvokeCommitMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokeExecuteMigration(WaitUntil, CancellationToken)
|
Trigger execute migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/executeMigration.
- Operation Id. : VirtualNetworkGateways_InvokeExecuteMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokeExecuteMigrationAsync(WaitUntil, CancellationToken)
|
Trigger execute migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/executeMigration.
- Operation Id. : VirtualNetworkGateways_InvokeExecuteMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokePrepareMigration(WaitUntil, VirtualNetworkGatewayMigrationContent, CancellationToken)
|
Trigger prepare migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/prepareMigration.
- Operation Id. : VirtualNetworkGateways_InvokePrepareMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
InvokePrepareMigrationAsync(WaitUntil, VirtualNetworkGatewayMigrationContent, CancellationToken)
|
Trigger prepare migration for the virtual network gateway.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/prepareMigration.
- Operation Id. : VirtualNetworkGateways_InvokePrepareMigration.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
RemoveTag(String, CancellationToken)
|
Removes a tag by key from the resource.
|
|
RemoveTagAsync(String, CancellationToken)
|
Removes a tag by key from the resource.
|
|
Reset(WaitUntil, String, CancellationToken)
|
Resets the primary of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset.
- Operation Id. : VirtualNetworkGateways_Reset.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
ResetAsync(WaitUntil, String, CancellationToken)
|
Resets the primary of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset.
- Operation Id. : VirtualNetworkGateways_Reset.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
ResetVpnClientSharedKey(WaitUntil, CancellationToken)
|
Resets the VPN client shared key of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/resetvpnclientsharedkey.
- Operation Id. : VirtualNetworkGateways_ResetVpnClientSharedKey.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
ResetVpnClientSharedKeyAsync(WaitUntil, CancellationToken)
|
Resets the VPN client shared key of the virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/resetvpnclientsharedkey.
- Operation Id. : VirtualNetworkGateways_ResetVpnClientSharedKey.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
SetTags(IDictionary<String,String>, CancellationToken)
|
Replace the tags on the resource with the given set.
|
|
SetTagsAsync(IDictionary<String,String>, CancellationToken)
|
Replace the tags on the resource with the given set.
|
|
SetVpnclientIPsecParameters(WaitUntil, VpnClientIPsecParameters, CancellationToken)
|
The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters.
- Operation Id. : VirtualNetworkGateways_SetVpnclientIpsecParameters.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
SetVpnclientIPsecParametersAsync(WaitUntil, VpnClientIPsecParameters, CancellationToken)
|
The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters.
- Operation Id. : VirtualNetworkGateways_SetVpnclientIpsecParameters.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StartExpressRouteSiteFailoverSimulation(WaitUntil, String, CancellationToken)
|
This operation starts failover simulation on the gateway for the specified peering location
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startSiteFailoverTest.
- Operation Id. : VirtualNetworkGateways_StartExpressRouteSiteFailoverSimulation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StartExpressRouteSiteFailoverSimulationAsync(WaitUntil, String, CancellationToken)
|
This operation starts failover simulation on the gateway for the specified peering location
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startSiteFailoverTest.
- Operation Id. : VirtualNetworkGateways_StartExpressRouteSiteFailoverSimulation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StartPacketCapture(WaitUntil, VpnPacketCaptureStartContent, CancellationToken)
|
Starts packet capture on virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startPacketCapture.
- Operation Id. : VirtualNetworkGateways_StartPacketCapture.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StartPacketCaptureAsync(WaitUntil, VpnPacketCaptureStartContent, CancellationToken)
|
Starts packet capture on virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startPacketCapture.
- Operation Id. : VirtualNetworkGateways_StartPacketCapture.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StopExpressRouteSiteFailoverSimulation(WaitUntil, ExpressRouteFailoverStopApiContent, CancellationToken)
|
This operation stops failover simulation on the gateway for the specified peering location
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopSiteFailoverTest.
- Operation Id. : VirtualNetworkGateways_StopExpressRouteSiteFailoverSimulation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StopExpressRouteSiteFailoverSimulationAsync(WaitUntil, ExpressRouteFailoverStopApiContent, CancellationToken)
|
This operation stops failover simulation on the gateway for the specified peering location
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopSiteFailoverTest.
- Operation Id. : VirtualNetworkGateways_StopExpressRouteSiteFailoverSimulation.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StopPacketCapture(WaitUntil, VpnPacketCaptureStopContent, CancellationToken)
|
Stops packet capture on virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopPacketCapture.
- Operation Id. : VirtualNetworkGateways_StopPacketCapture.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
StopPacketCaptureAsync(WaitUntil, VpnPacketCaptureStopContent, CancellationToken)
|
Stops packet capture on virtual network gateway in the specified resource group.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopPacketCapture.
- Operation Id. : VirtualNetworkGateways_StopPacketCapture.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
SupportedVpnDevices(CancellationToken)
|
Gets a xml format representation for supported vpn devices.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices.
- Operation Id. : VirtualNetworkGateways_SupportedVpnDevices.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
SupportedVpnDevicesAsync(CancellationToken)
|
Gets a xml format representation for supported vpn devices.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices.
- Operation Id. : VirtualNetworkGateways_SupportedVpnDevices.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
TryGetApiVersion(ResourceType, String)
|
Gets the api version override if it has been set for the current client options.
(Inherited from ArmResource)
|
|
Update(WaitUntil, NetworkTagsObject, CancellationToken)
|
Updates a virtual network gateway tags.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}.
- Operation Id. : VirtualNetworkGateways_UpdateTags.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|
|
UpdateAsync(WaitUntil, NetworkTagsObject, CancellationToken)
|
Updates a virtual network gateway tags.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}.
- Operation Id. : VirtualNetworkGateways_UpdateTags.
- Default Api Version. : 2026-03-01.
- Resource. : VirtualNetworkGatewayResource.
|