Share via

VirtualNetworkGatewayResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Network
Assembly:
Azure.ResourceManager.Network.dll
Package:
Azure.ResourceManager.Network v1.7.0
Package:
Azure.ResourceManager.Network v1.6.0-beta.1
Source:
VirtualNetworkGatewayResource.cs
Source:
VirtualNetworkGatewayResource.cs

A Class representing a VirtualNetworkGateway along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a VirtualNetworkGatewayResource from an instance of ArmClient using the GetVirtualNetworkGatewayResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetVirtualNetworkGateway method.

public class VirtualNetworkGatewayResource : Azure.ResourceManager.ArmResource
type VirtualNetworkGatewayResource = class
    inherit ArmResource
Public Class VirtualNetworkGatewayResource
Inherits ArmResource
Inheritance
Object
ArmResource
VirtualNetworkGatewayResource

Constructors

VirtualNetworkGatewayResource()

Initializes a new instance of the VirtualNetworkGatewayResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
  • Operation Id: VirtualNetworkGateways_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
  • Operation Id: VirtualNetworkGateways_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
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 of a VirtualNetworkGatewayResource instance.
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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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)
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}
  • Operation Id: VirtualNetworkGatewayNatRules_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayNatRuleResource
GetVirtualNetworkGatewayNatRuleAsync(String, CancellationToken)

Retrieves the details of a nat rule.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}
  • Operation Id: VirtualNetworkGatewayNatRules_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayNatRuleResource
GetVirtualNetworkGatewayNatRules()

Gets a collection of VirtualNetworkGatewayNatRuleResources in the VirtualNetworkGateway.
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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
  • Operation Id: VirtualNetworkGateways_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
  • Operation Id: VirtualNetworkGateways_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
  • Operation Id: VirtualNetworkGateways_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}
  • Operation Id: VirtualNetworkGateways_Get
  • Default Api Version: 2023-09-01
  • Resource: VirtualNetworkGatewayResource
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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-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: 2023-09-01
  • Resource: VirtualNetworkGatewayResource

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to