VirtualNetworkGatewayResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Network.VirtualNetworkGatewayData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Network.VirtualNetworkGatewayData>
public class VirtualNetworkGatewayResource : Azure.ResourceManager.ArmResource
type VirtualNetworkGatewayResource = class
inherit ArmResource
interface IJsonModel<VirtualNetworkGatewayData>
interface IPersistableModel<VirtualNetworkGatewayData>
type VirtualNetworkGatewayResource = class
inherit ArmResource
Public Class VirtualNetworkGatewayResource
Inherits ArmResource
Implements IJsonModel(Of VirtualNetworkGatewayData), IPersistableModel(Of VirtualNetworkGatewayData)
Public Class VirtualNetworkGatewayResource
Inherits ArmResource
- Inheritance
- Implements
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.
|
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 of a VirtualNetworkGatewayResource instance. |
Delete(WaitUntil, CancellationToken) |
Deletes the specified virtual network gateway.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes the specified virtual network gateway.
|
DisconnectVirtualNetworkGatewayVpnConnections(WaitUntil, P2SVpnConnectionRequest, CancellationToken) |
Disconnect vpn connections of virtual network gateway in the specified resource group.
|
DisconnectVirtualNetworkGatewayVpnConnectionsAsync(WaitUntil, P2SVpnConnectionRequest, CancellationToken) |
Disconnect vpn connections of virtual network gateway in the specified resource group.
|
GenerateVpnClientPackage(WaitUntil, VpnClientContent, CancellationToken) |
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
|
GenerateVpnClientPackageAsync(WaitUntil, VpnClientContent, CancellationToken) |
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
|
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.
|
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.
|
Get(CancellationToken) |
Gets the specified virtual network gateway by resource group.
|
GetAdvertisedRoutes(WaitUntil, String, CancellationToken) |
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
|
GetAdvertisedRoutesAsync(WaitUntil, String, CancellationToken) |
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
|
GetAsync(CancellationToken) |
Gets the specified virtual network gateway by resource group.
|
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.
|
GetBgpPeerStatusAsync(WaitUntil, String, CancellationToken) |
The GetBgpPeerStatus operation retrieves the status of all BGP peers.
|
GetConnections(CancellationToken) |
Gets all the connections in a virtual network gateway.
|
GetConnectionsAsync(CancellationToken) |
Gets all the connections in a virtual network gateway.
|
GetLearnedRoutes(WaitUntil, CancellationToken) |
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.
|
GetLearnedRoutesAsync(WaitUntil, CancellationToken) |
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.
|
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
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.
|
GetVirtualNetworkGatewayNatRuleAsync(String, CancellationToken) |
Retrieves the details of a nat rule.
|
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.
|
GetVpnclientConnectionHealthAsync(WaitUntil, CancellationToken) |
Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
|
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.
|
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.
|
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.
|
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.
|
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.
|
ResetAsync(WaitUntil, String, CancellationToken) |
Resets the primary of the virtual network gateway in the specified resource group.
|
ResetVpnClientSharedKey(WaitUntil, CancellationToken) |
Resets the VPN client shared key of the virtual network gateway in the specified resource group.
|
ResetVpnClientSharedKeyAsync(WaitUntil, CancellationToken) |
Resets the VPN client shared key of the virtual network gateway in the specified resource group.
|
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.
|
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.
|
StartPacketCapture(WaitUntil, VpnPacketCaptureStartContent, CancellationToken) |
Starts packet capture on virtual network gateway in the specified resource group.
|
StartPacketCaptureAsync(WaitUntil, VpnPacketCaptureStartContent, CancellationToken) |
Starts packet capture on virtual network gateway in the specified resource group.
|
StopPacketCapture(WaitUntil, VpnPacketCaptureStopContent, CancellationToken) |
Stops packet capture on virtual network gateway in the specified resource group.
|
StopPacketCaptureAsync(WaitUntil, VpnPacketCaptureStopContent, CancellationToken) |
Stops packet capture on virtual network gateway in the specified resource group.
|
SupportedVpnDevices(CancellationToken) |
Gets a xml format representation for supported vpn devices.
|
SupportedVpnDevicesAsync(CancellationToken) |
Gets a xml format representation for supported vpn devices.
|
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.
|
UpdateAsync(WaitUntil, NetworkTagsObject, CancellationToken) |
Updates a virtual network gateway tags.
|
Explicit Interface Implementations
IJsonModel<VirtualNetworkGatewayData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<VirtualNetworkGatewayData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<VirtualNetworkGatewayData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<VirtualNetworkGatewayData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<VirtualNetworkGatewayData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Extension Methods
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |