Azure Native

v1.88.1 published on Thursday, Dec 1, 2022 by Pulumi

getExpressRouteGateway

ExpressRoute gateway resource. API Version: 2020-11-01.

Using getExpressRouteGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getExpressRouteGateway(args: GetExpressRouteGatewayArgs, opts?: InvokeOptions): Promise<GetExpressRouteGatewayResult>
function getExpressRouteGatewayOutput(args: GetExpressRouteGatewayOutputArgs, opts?: InvokeOptions): Output<GetExpressRouteGatewayResult>
def get_express_route_gateway(express_route_gateway_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetExpressRouteGatewayResult
def get_express_route_gateway_output(express_route_gateway_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetExpressRouteGatewayResult]
func LookupExpressRouteGateway(ctx *Context, args *LookupExpressRouteGatewayArgs, opts ...InvokeOption) (*LookupExpressRouteGatewayResult, error)
func LookupExpressRouteGatewayOutput(ctx *Context, args *LookupExpressRouteGatewayOutputArgs, opts ...InvokeOption) LookupExpressRouteGatewayResultOutput

> Note: This function is named LookupExpressRouteGateway in the Go SDK.

public static class GetExpressRouteGateway 
{
    public static Task<GetExpressRouteGatewayResult> InvokeAsync(GetExpressRouteGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetExpressRouteGatewayResult> Invoke(GetExpressRouteGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetExpressRouteGatewayResult> getExpressRouteGateway(GetExpressRouteGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:network:getExpressRouteGateway
  arguments:
    # arguments dictionary

The following arguments are supported:

ExpressRouteGatewayName string

The name of the ExpressRoute gateway.

ResourceGroupName string

The name of the resource group.

ExpressRouteGatewayName string

The name of the ExpressRoute gateway.

ResourceGroupName string

The name of the resource group.

expressRouteGatewayName String

The name of the ExpressRoute gateway.

resourceGroupName String

The name of the resource group.

expressRouteGatewayName string

The name of the ExpressRoute gateway.

resourceGroupName string

The name of the resource group.

express_route_gateway_name str

The name of the ExpressRoute gateway.

resource_group_name str

The name of the resource group.

expressRouteGatewayName String

The name of the ExpressRoute gateway.

resourceGroupName String

The name of the resource group.

getExpressRouteGateway Result

The following output properties are available:

Etag string

A unique read-only string that changes whenever the resource is updated.

ExpressRouteConnections List<Pulumi.AzureNative.Network.Outputs.ExpressRouteConnectionResponse>

List of ExpressRoute connections to the ExpressRoute gateway.

Name string

Resource name.

ProvisioningState string

The provisioning state of the express route gateway resource.

Type string

Resource type.

VirtualHub Pulumi.AzureNative.Network.Outputs.VirtualHubIdResponse

The Virtual Hub where the ExpressRoute gateway is or will be deployed.

AutoScaleConfiguration Pulumi.AzureNative.Network.Outputs.ExpressRouteGatewayPropertiesResponseAutoScaleConfiguration

Configuration for auto scaling.

Id string

Resource ID.

Location string

Resource location.

Tags Dictionary<string, string>

Resource tags.

Etag string

A unique read-only string that changes whenever the resource is updated.

ExpressRouteConnections []ExpressRouteConnectionResponse

List of ExpressRoute connections to the ExpressRoute gateway.

Name string

Resource name.

ProvisioningState string

The provisioning state of the express route gateway resource.

Type string

Resource type.

VirtualHub VirtualHubIdResponse

The Virtual Hub where the ExpressRoute gateway is or will be deployed.

AutoScaleConfiguration ExpressRouteGatewayPropertiesResponseAutoScaleConfiguration

Configuration for auto scaling.

Id string

Resource ID.

Location string

Resource location.

Tags map[string]string

Resource tags.

etag String

A unique read-only string that changes whenever the resource is updated.

expressRouteConnections List<ExpressRouteConnectionResponse>

List of ExpressRoute connections to the ExpressRoute gateway.

name String

Resource name.

provisioningState String

The provisioning state of the express route gateway resource.

type String

Resource type.

virtualHub VirtualHubIdResponse

The Virtual Hub where the ExpressRoute gateway is or will be deployed.

autoScaleConfiguration ExpressRouteGatewayPropertiesResponseAutoScaleConfiguration

Configuration for auto scaling.

id String

Resource ID.

location String

Resource location.

tags Map<String,String>

Resource tags.

etag string

A unique read-only string that changes whenever the resource is updated.

expressRouteConnections ExpressRouteConnectionResponse[]

List of ExpressRoute connections to the ExpressRoute gateway.

name string

Resource name.

provisioningState string

The provisioning state of the express route gateway resource.

type string

Resource type.

virtualHub VirtualHubIdResponse

The Virtual Hub where the ExpressRoute gateway is or will be deployed.

autoScaleConfiguration ExpressRouteGatewayPropertiesResponseAutoScaleConfiguration

Configuration for auto scaling.

id string

Resource ID.

location string

Resource location.

tags {[key: string]: string}

Resource tags.

etag str

A unique read-only string that changes whenever the resource is updated.

express_route_connections Sequence[ExpressRouteConnectionResponse]

List of ExpressRoute connections to the ExpressRoute gateway.

name str

Resource name.

provisioning_state str

The provisioning state of the express route gateway resource.

type str

Resource type.

virtual_hub VirtualHubIdResponse

The Virtual Hub where the ExpressRoute gateway is or will be deployed.

auto_scale_configuration ExpressRouteGatewayPropertiesResponseAutoScaleConfiguration

Configuration for auto scaling.

id str

Resource ID.

location str

Resource location.

tags Mapping[str, str]

Resource tags.

etag String

A unique read-only string that changes whenever the resource is updated.

expressRouteConnections List<Property Map>

List of ExpressRoute connections to the ExpressRoute gateway.

name String

Resource name.

provisioningState String

The provisioning state of the express route gateway resource.

type String

Resource type.

virtualHub Property Map

The Virtual Hub where the ExpressRoute gateway is or will be deployed.

autoScaleConfiguration Property Map

Configuration for auto scaling.

id String

Resource ID.

location String

Resource location.

tags Map<String>

Resource tags.

Supporting Types

ExpressRouteCircuitPeeringIdResponse

Id string

The ID of the ExpressRoute circuit peering.

Id string

The ID of the ExpressRoute circuit peering.

id String

The ID of the ExpressRoute circuit peering.

id string

The ID of the ExpressRoute circuit peering.

id str

The ID of the ExpressRoute circuit peering.

id String

The ID of the ExpressRoute circuit peering.

ExpressRouteConnectionResponse

ExpressRouteCircuitPeering Pulumi.AzureNative.Network.Inputs.ExpressRouteCircuitPeeringIdResponse

The ExpressRoute circuit peering.

Name string

The name of the resource.

ProvisioningState string

The provisioning state of the express route connection resource.

AuthorizationKey string

Authorization key to establish the connection.

EnableInternetSecurity bool

Enable internet security.

ExpressRouteGatewayBypass bool

Enable FastPath to vWan Firewall hub.

Id string

Resource ID.

RoutingConfiguration Pulumi.AzureNative.Network.Inputs.RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

RoutingWeight int

The routing weight associated to the connection.

ExpressRouteCircuitPeering ExpressRouteCircuitPeeringIdResponse

The ExpressRoute circuit peering.

Name string

The name of the resource.

ProvisioningState string

The provisioning state of the express route connection resource.

AuthorizationKey string

Authorization key to establish the connection.

EnableInternetSecurity bool

Enable internet security.

ExpressRouteGatewayBypass bool

Enable FastPath to vWan Firewall hub.

Id string

Resource ID.

RoutingConfiguration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

RoutingWeight int

The routing weight associated to the connection.

expressRouteCircuitPeering ExpressRouteCircuitPeeringIdResponse

The ExpressRoute circuit peering.

name String

The name of the resource.

provisioningState String

The provisioning state of the express route connection resource.

authorizationKey String

Authorization key to establish the connection.

enableInternetSecurity Boolean

Enable internet security.

expressRouteGatewayBypass Boolean

Enable FastPath to vWan Firewall hub.

id String

Resource ID.

routingConfiguration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

routingWeight Integer

The routing weight associated to the connection.

expressRouteCircuitPeering ExpressRouteCircuitPeeringIdResponse

The ExpressRoute circuit peering.

name string

The name of the resource.

provisioningState string

The provisioning state of the express route connection resource.

authorizationKey string

Authorization key to establish the connection.

enableInternetSecurity boolean

Enable internet security.

expressRouteGatewayBypass boolean

Enable FastPath to vWan Firewall hub.

id string

Resource ID.

routingConfiguration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

routingWeight number

The routing weight associated to the connection.

express_route_circuit_peering ExpressRouteCircuitPeeringIdResponse

The ExpressRoute circuit peering.

name str

The name of the resource.

provisioning_state str

The provisioning state of the express route connection resource.

authorization_key str

Authorization key to establish the connection.

enable_internet_security bool

Enable internet security.

express_route_gateway_bypass bool

Enable FastPath to vWan Firewall hub.

id str

Resource ID.

routing_configuration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

routing_weight int

The routing weight associated to the connection.

expressRouteCircuitPeering Property Map

The ExpressRoute circuit peering.

name String

The name of the resource.

provisioningState String

The provisioning state of the express route connection resource.

authorizationKey String

Authorization key to establish the connection.

enableInternetSecurity Boolean

Enable internet security.

expressRouteGatewayBypass Boolean

Enable FastPath to vWan Firewall hub.

id String

Resource ID.

routingConfiguration Property Map

The Routing Configuration indicating the associated and propagated route tables on this connection.

routingWeight Number

The routing weight associated to the connection.

ExpressRouteGatewayPropertiesResponseAutoScaleConfiguration

Bounds ExpressRouteGatewayPropertiesResponseBounds

Minimum and maximum number of scale units to deploy.

bounds ExpressRouteGatewayPropertiesResponseBounds

Minimum and maximum number of scale units to deploy.

bounds ExpressRouteGatewayPropertiesResponseBounds

Minimum and maximum number of scale units to deploy.

bounds ExpressRouteGatewayPropertiesResponseBounds

Minimum and maximum number of scale units to deploy.

bounds Property Map

Minimum and maximum number of scale units to deploy.

ExpressRouteGatewayPropertiesResponseBounds

Max int

Maximum number of scale units deployed for ExpressRoute gateway.

Min int

Minimum number of scale units deployed for ExpressRoute gateway.

Max int

Maximum number of scale units deployed for ExpressRoute gateway.

Min int

Minimum number of scale units deployed for ExpressRoute gateway.

max Integer

Maximum number of scale units deployed for ExpressRoute gateway.

min Integer

Minimum number of scale units deployed for ExpressRoute gateway.

max number

Maximum number of scale units deployed for ExpressRoute gateway.

min number

Minimum number of scale units deployed for ExpressRoute gateway.

max int

Maximum number of scale units deployed for ExpressRoute gateway.

min int

Minimum number of scale units deployed for ExpressRoute gateway.

max Number

Maximum number of scale units deployed for ExpressRoute gateway.

min Number

Minimum number of scale units deployed for ExpressRoute gateway.

PropagatedRouteTableResponse

Ids List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>

The list of resource ids of all the RouteTables.

Labels List<string>

The list of labels.

Ids []SubResourceResponse

The list of resource ids of all the RouteTables.

Labels []string

The list of labels.

ids List<SubResourceResponse>

The list of resource ids of all the RouteTables.

labels List<String>

The list of labels.

ids SubResourceResponse[]

The list of resource ids of all the RouteTables.

labels string[]

The list of labels.

ids Sequence[SubResourceResponse]

The list of resource ids of all the RouteTables.

labels Sequence[str]

The list of labels.

ids List<Property Map>

The list of resource ids of all the RouteTables.

labels List<String>

The list of labels.

RoutingConfigurationResponse

AssociatedRouteTable Pulumi.AzureNative.Network.Inputs.SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

PropagatedRouteTables Pulumi.AzureNative.Network.Inputs.PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

VnetRoutes Pulumi.AzureNative.Network.Inputs.VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

AssociatedRouteTable SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

PropagatedRouteTables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

VnetRoutes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associatedRouteTable SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

propagatedRouteTables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

vnetRoutes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associatedRouteTable SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

propagatedRouteTables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

vnetRoutes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associated_route_table SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

propagated_route_tables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

vnet_routes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associatedRouteTable Property Map

The resource id RouteTable associated with this RoutingConfiguration.

propagatedRouteTables Property Map

The list of RouteTables to advertise the routes to.

vnetRoutes Property Map

List of routes that control routing from VirtualHub into a virtual network connection.

StaticRouteResponse

AddressPrefixes List<string>

List of all address prefixes.

Name string

The name of the StaticRoute that is unique within a VnetRoute.

NextHopIpAddress string

The ip address of the next hop.

AddressPrefixes []string

List of all address prefixes.

Name string

The name of the StaticRoute that is unique within a VnetRoute.

NextHopIpAddress string

The ip address of the next hop.

addressPrefixes List<String>

List of all address prefixes.

name String

The name of the StaticRoute that is unique within a VnetRoute.

nextHopIpAddress String

The ip address of the next hop.

addressPrefixes string[]

List of all address prefixes.

name string

The name of the StaticRoute that is unique within a VnetRoute.

nextHopIpAddress string

The ip address of the next hop.

address_prefixes Sequence[str]

List of all address prefixes.

name str

The name of the StaticRoute that is unique within a VnetRoute.

next_hop_ip_address str

The ip address of the next hop.

addressPrefixes List<String>

List of all address prefixes.

name String

The name of the StaticRoute that is unique within a VnetRoute.

nextHopIpAddress String

The ip address of the next hop.

SubResourceResponse

Id string

Resource ID.

Id string

Resource ID.

id String

Resource ID.

id string

Resource ID.

id str

Resource ID.

id String

Resource ID.

VirtualHubIdResponse

Id string

The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.

Id string

The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.

id String

The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.

id string

The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.

id str

The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.

id String

The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription.

VnetRouteResponse

StaticRoutes []StaticRouteResponse

List of all Static Routes.

staticRoutes List<StaticRouteResponse>

List of all Static Routes.

staticRoutes StaticRouteResponse[]

List of all Static Routes.

staticRoutes List<Property Map>

List of all Static Routes.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0