ExpressRouteGatewayResource Class

Definition

Namespace:: Azure.ResourceManager.Network

Assembly:: Azure.ResourceManager.Network.dll

Package:: Azure.ResourceManager.Network v1.17.0

Package:: Azure.ResourceManager.Network v1.11.0-beta.2

Source:: ExpressRouteGatewayResource.cs

Source:: ExpressRouteGatewayResource.cs

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 ExpressRouteGateway along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ExpressRouteGatewayResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetExpressRouteGateways method.

public class ExpressRouteGatewayResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Network.ExpressRouteGatewayData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Network.ExpressRouteGatewayData>

type ExpressRouteGatewayResource = class
    inherit ArmResource
    interface IJsonModel<ExpressRouteGatewayData>
    interface IPersistableModel<ExpressRouteGatewayData>

Public Class ExpressRouteGatewayResource
Inherits ArmResource
Implements IJsonModel(Of ExpressRouteGatewayData), IPersistableModel(Of ExpressRouteGatewayData)

Inheritance: Object

ArmResource
ExpressRouteGatewayResource

Implements: IJsonModel<ExpressRouteGatewayData> IPersistableModel<ExpressRouteGatewayData> IPersistableModel<T>

Constructors

Name	Description
ExpressRouteGatewayResource()	Initializes a new instance of ExpressRouteGatewayResource for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
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

Name	Description
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 ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}. Operation Id. : ExpressRouteGateways_Delete. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
DeleteAsync(WaitUntil, CancellationToken)	Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}. Operation Id. : ExpressRouteGateways_Delete. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
Get(CancellationToken)	Fetches the details of a ExpressRoute gateway in a resource group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}. Operation Id. : ExpressRouteGateways_Get. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetAsync(CancellationToken)	Fetches the details of a ExpressRoute gateway in a resource group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}. Operation Id. : ExpressRouteGateways_Get. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetExpressRouteConnection(String, CancellationToken)	Gets the specified ExpressRouteConnection.
GetExpressRouteConnectionAsync(String, CancellationToken)	Gets the specified ExpressRouteConnection.
GetExpressRouteConnections()	Gets a collection of ExpressRouteConnections in the ExpressRouteGatewayResource.
GetExpressRouteConnections(CancellationToken)	Lists ExpressRouteConnections. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections. Operation Id. : ExpressRouteGateways_List. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetExpressRouteConnectionsAsync(CancellationToken)	Lists ExpressRouteConnections. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections. Operation Id. : ExpressRouteGateways_List. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetFailoverAllTestsDetails(WaitUntil, String, Nullable<Boolean>, CancellationToken)	Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverAllTestsDetails. Operation Id. : ExpressRouteGateways_GetFailoverAllTestsDetails. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetFailoverAllTestsDetailsAsync(WaitUntil, String, Nullable<Boolean>, CancellationToken)	Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverAllTestsDetails. Operation Id. : ExpressRouteGateways_GetFailoverAllTestsDetails. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetFailoverSingleTestDetails(WaitUntil, String, String, CancellationToken)	Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverSingleTestDetails. Operation Id. : ExpressRouteGateways_GetFailoverSingleTestDetails. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetFailoverSingleTestDetailsAsync(WaitUntil, String, String, CancellationToken)	Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverSingleTestDetails. Operation Id. : ExpressRouteGateways_GetFailoverSingleTestDetails. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
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)
GetResiliencyInformation(WaitUntil, Nullable<Boolean>, CancellationToken)	Retrieves the resiliency information for the ExpressRoute gateway. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getResiliencyInformation. Operation Id. : ExpressRouteGateways_GetResiliencyInformation. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetResiliencyInformationAsync(WaitUntil, Nullable<Boolean>, CancellationToken)	Retrieves the resiliency information for the ExpressRoute gateway. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getResiliencyInformation. Operation Id. : ExpressRouteGateways_GetResiliencyInformation. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetRoutesInformation(WaitUntil, Nullable<Boolean>, CancellationToken)	Retrieves the route sets information for the ExpressRoute gateway. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getRoutesInformation. Operation Id. : ExpressRouteGateways_GetRoutesInformation. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetRoutesInformationAsync(WaitUntil, Nullable<Boolean>, CancellationToken)	Retrieves the route sets information for the ExpressRoute gateway. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getRoutesInformation. Operation Id. : ExpressRouteGateways_GetRoutesInformation. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource.
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource.
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.
StartSiteFailoverTest(WaitUntil, String, CancellationToken)	Starts failover simulation on the ExpressRoute gateway for the specified peering location. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/startSiteFailoverTest. Operation Id. : ExpressRouteGateways_StartSiteFailoverTest. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
StartSiteFailoverTestAsync(WaitUntil, String, CancellationToken)	Starts failover simulation on the ExpressRoute gateway for the specified peering location. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/startSiteFailoverTest. Operation Id. : ExpressRouteGateways_StartSiteFailoverTest. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
StopSiteFailoverTest(WaitUntil, StopSiteFailoverTestParameterBody, CancellationToken)	Stops failover simulation on the ExpressRoute gateway for the specified peering location. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/stopSiteFailoverTest. Operation Id. : ExpressRouteGateways_StopSiteFailoverTest. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
StopSiteFailoverTestAsync(WaitUntil, StopSiteFailoverTestParameterBody, CancellationToken)	Stops failover simulation on the ExpressRoute gateway for the specified peering location. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/stopSiteFailoverTest. Operation Id. : ExpressRouteGateways_StopSiteFailoverTest. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
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 express route gateway tags. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}. Operation Id. : ExpressRouteGateways_UpdateTags. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.
UpdateAsync(WaitUntil, NetworkTagsObject, CancellationToken)	Updates express route gateway tags. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}. Operation Id. : ExpressRouteGateways_UpdateTags. Default Api Version. : 2025-09-01. Resource. : ExpressRouteGatewayResource.

Explicit Interface Implementations

Name	Description
IJsonModel<ExpressRouteGatewayData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ExpressRouteGatewayData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ExpressRouteGatewayData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ExpressRouteGatewayData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ExpressRouteGatewayData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
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 RoleAssignmentCollection objects within the specified scope.
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 RoleAssignmentScheduleInstanceCollection objects within the specified scope.
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 RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
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 RoleEligibilityScheduleInstanceCollection objects within the specified scope.
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 RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
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 RoleManagementPolicyAssignmentCollection objects within the specified scope.
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 scope.

Applies to

Comentarios

¿Le ha resultado útil esta página?