Azure Native v1.103.0, Jun 2 23

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.network.getVirtualHub

Explore with Pulumi AI

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

Using getVirtualHub

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 getVirtualHub(args: GetVirtualHubArgs, opts?: InvokeOptions): Promise<GetVirtualHubResult>
function getVirtualHubOutput(args: GetVirtualHubOutputArgs, opts?: InvokeOptions): Output<GetVirtualHubResult>

def get_virtual_hub(resource_group_name: Optional[str] = None,
                    virtual_hub_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetVirtualHubResult
def get_virtual_hub_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                    virtual_hub_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetVirtualHubResult]

func LookupVirtualHub(ctx *Context, args *LookupVirtualHubArgs, opts ...InvokeOption) (*LookupVirtualHubResult, error)
func LookupVirtualHubOutput(ctx *Context, args *LookupVirtualHubOutputArgs, opts ...InvokeOption) LookupVirtualHubResultOutput

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

public static class GetVirtualHub 
{
    public static Task<GetVirtualHubResult> InvokeAsync(GetVirtualHubArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualHubResult> Invoke(GetVirtualHubInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualHubResult> getVirtualHub(GetVirtualHubArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getVirtualHub
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The resource group name of the VirtualHub.
VirtualHubName string: The name of the VirtualHub.

ResourceGroupName string: The resource group name of the VirtualHub.
VirtualHubName string: The name of the VirtualHub.

resourceGroupName String: The resource group name of the VirtualHub.
virtualHubName String: The name of the VirtualHub.

resourceGroupName string: The resource group name of the VirtualHub.
virtualHubName string: The name of the VirtualHub.

resource_group_name str: The resource group name of the VirtualHub.
virtual_hub_name str: The name of the VirtualHub.

resourceGroupName String: The resource group name of the VirtualHub.
virtualHubName String: The name of the VirtualHub.

getVirtualHub Result

The following output properties are available:

BgpConnections List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>: List of references to Bgp Connections.
Etag string: A unique read-only string that changes whenever the resource is updated.
IpConfigurations List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>: List of references to IpConfigurations.
Location string: Resource location.
Name string: Resource name.
ProvisioningState string: The provisioning state of the virtual hub resource.
RoutingState string: The routing state.
Type string: Resource type.
AddressPrefix string: Address-prefix for this VirtualHub.
AllowBranchToBranchTraffic bool: Flag to control transit for VirtualRouter hub.
AzureFirewall Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The azureFirewall associated with this VirtualHub.
ExpressRouteGateway Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The expressRouteGateway associated with this VirtualHub.
Id string: Resource ID.
P2SVpnGateway Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The P2SVpnGateway associated with this VirtualHub.
RouteTable Pulumi.AzureNative.Network.Outputs.VirtualHubRouteTableResponse: The routeTable associated with this virtual hub.
SecurityPartnerProvider Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The securityPartnerProvider associated with this VirtualHub.
SecurityProviderName string: The Security Provider name.
Sku string: The sku of this VirtualHub.
Tags Dictionary<string, string>: Resource tags.
VirtualHubRouteTableV2s List<Pulumi.AzureNative.Network.Outputs.VirtualHubRouteTableV2Response>: List of all virtual hub route table v2s associated with this VirtualHub.
VirtualRouterAsn double: VirtualRouter ASN.
VirtualRouterIps List<string>: VirtualRouter IPs.
VirtualWan Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The VirtualWAN to which the VirtualHub belongs.
VpnGateway Pulumi.AzureNative.Network.Outputs.SubResourceResponse: The VpnGateway associated with this VirtualHub.

BgpConnections []SubResourceResponse: List of references to Bgp Connections.
Etag string: A unique read-only string that changes whenever the resource is updated.
IpConfigurations []SubResourceResponse: List of references to IpConfigurations.
Location string: Resource location.
Name string: Resource name.
ProvisioningState string: The provisioning state of the virtual hub resource.
RoutingState string: The routing state.
Type string: Resource type.
AddressPrefix string: Address-prefix for this VirtualHub.
AllowBranchToBranchTraffic bool: Flag to control transit for VirtualRouter hub.
AzureFirewall SubResourceResponse: The azureFirewall associated with this VirtualHub.
ExpressRouteGateway SubResourceResponse: The expressRouteGateway associated with this VirtualHub.
Id string: Resource ID.
P2SVpnGateway SubResourceResponse: The P2SVpnGateway associated with this VirtualHub.
RouteTable VirtualHubRouteTableResponse: The routeTable associated with this virtual hub.
SecurityPartnerProvider SubResourceResponse: The securityPartnerProvider associated with this VirtualHub.
SecurityProviderName string: The Security Provider name.
Sku string: The sku of this VirtualHub.
Tags map[string]string: Resource tags.
VirtualHubRouteTableV2s []VirtualHubRouteTableV2Response: List of all virtual hub route table v2s associated with this VirtualHub.
VirtualRouterAsn float64: VirtualRouter ASN.
VirtualRouterIps []string: VirtualRouter IPs.
VirtualWan SubResourceResponse: The VirtualWAN to which the VirtualHub belongs.
VpnGateway SubResourceResponse: The VpnGateway associated with this VirtualHub.

bgpConnections List<SubResourceResponse>: List of references to Bgp Connections.
etag String: A unique read-only string that changes whenever the resource is updated.
ipConfigurations List<SubResourceResponse>: List of references to IpConfigurations.
location String: Resource location.
name String: Resource name.
provisioningState String: The provisioning state of the virtual hub resource.
routingState String: The routing state.
type String: Resource type.
addressPrefix String: Address-prefix for this VirtualHub.
allowBranchToBranchTraffic Boolean: Flag to control transit for VirtualRouter hub.
azureFirewall SubResourceResponse: The azureFirewall associated with this VirtualHub.
expressRouteGateway SubResourceResponse: The expressRouteGateway associated with this VirtualHub.
id String: Resource ID.
p2SVpnGateway SubResourceResponse: The P2SVpnGateway associated with this VirtualHub.
routeTable VirtualHubRouteTableResponse: The routeTable associated with this virtual hub.
securityPartnerProvider SubResourceResponse: The securityPartnerProvider associated with this VirtualHub.
securityProviderName String: The Security Provider name.
sku String: The sku of this VirtualHub.
tags Map<String,String>: Resource tags.
virtualHubRouteTableV2s List<VirtualHubRouteTableV2Response>: List of all virtual hub route table v2s associated with this VirtualHub.
virtualRouterAsn Double: VirtualRouter ASN.
virtualRouterIps List<String>: VirtualRouter IPs.
virtualWan SubResourceResponse: The VirtualWAN to which the VirtualHub belongs.
vpnGateway SubResourceResponse: The VpnGateway associated with this VirtualHub.

bgpConnections SubResourceResponse[]: List of references to Bgp Connections.
etag string: A unique read-only string that changes whenever the resource is updated.
ipConfigurations SubResourceResponse[]: List of references to IpConfigurations.
location string: Resource location.
name string: Resource name.
provisioningState string: The provisioning state of the virtual hub resource.
routingState string: The routing state.
type string: Resource type.
addressPrefix string: Address-prefix for this VirtualHub.
allowBranchToBranchTraffic boolean: Flag to control transit for VirtualRouter hub.
azureFirewall SubResourceResponse: The azureFirewall associated with this VirtualHub.
expressRouteGateway SubResourceResponse: The expressRouteGateway associated with this VirtualHub.
id string: Resource ID.
p2SVpnGateway SubResourceResponse: The P2SVpnGateway associated with this VirtualHub.
routeTable VirtualHubRouteTableResponse: The routeTable associated with this virtual hub.
securityPartnerProvider SubResourceResponse: The securityPartnerProvider associated with this VirtualHub.
securityProviderName string: The Security Provider name.
sku string: The sku of this VirtualHub.
tags {[key: string]: string}: Resource tags.
virtualHubRouteTableV2s VirtualHubRouteTableV2Response[]: List of all virtual hub route table v2s associated with this VirtualHub.
virtualRouterAsn number: VirtualRouter ASN.
virtualRouterIps string[]: VirtualRouter IPs.
virtualWan SubResourceResponse: The VirtualWAN to which the VirtualHub belongs.
vpnGateway SubResourceResponse: The VpnGateway associated with this VirtualHub.

bgp_connections Sequence[SubResourceResponse]: List of references to Bgp Connections.
etag str: A unique read-only string that changes whenever the resource is updated.
ip_configurations Sequence[SubResourceResponse]: List of references to IpConfigurations.
location str: Resource location.
name str: Resource name.
provisioning_state str: The provisioning state of the virtual hub resource.
routing_state str: The routing state.
type str: Resource type.
address_prefix str: Address-prefix for this VirtualHub.
allow_branch_to_branch_traffic bool: Flag to control transit for VirtualRouter hub.
azure_firewall SubResourceResponse: The azureFirewall associated with this VirtualHub.
express_route_gateway SubResourceResponse: The expressRouteGateway associated with this VirtualHub.
id str: Resource ID.
p2_s_vpn_gateway SubResourceResponse: The P2SVpnGateway associated with this VirtualHub.
route_table VirtualHubRouteTableResponse: The routeTable associated with this virtual hub.
security_partner_provider SubResourceResponse: The securityPartnerProvider associated with this VirtualHub.
security_provider_name str: The Security Provider name.
sku str: The sku of this VirtualHub.
tags Mapping[str, str]: Resource tags.
virtual_hub_route_table_v2s Sequence[VirtualHubRouteTableV2Response]: List of all virtual hub route table v2s associated with this VirtualHub.
virtual_router_asn float: VirtualRouter ASN.
virtual_router_ips Sequence[str]: VirtualRouter IPs.
virtual_wan SubResourceResponse: The VirtualWAN to which the VirtualHub belongs.
vpn_gateway SubResourceResponse: The VpnGateway associated with this VirtualHub.

bgpConnections List<Property Map>: List of references to Bgp Connections.
etag String: A unique read-only string that changes whenever the resource is updated.
ipConfigurations List<Property Map>: List of references to IpConfigurations.
location String: Resource location.
name String: Resource name.
provisioningState String: The provisioning state of the virtual hub resource.
routingState String: The routing state.
type String: Resource type.
addressPrefix String: Address-prefix for this VirtualHub.
allowBranchToBranchTraffic Boolean: Flag to control transit for VirtualRouter hub.
azureFirewall Property Map: The azureFirewall associated with this VirtualHub.
expressRouteGateway Property Map: The expressRouteGateway associated with this VirtualHub.
id String: Resource ID.
p2SVpnGateway Property Map: The P2SVpnGateway associated with this VirtualHub.
routeTable Property Map: The routeTable associated with this virtual hub.
securityPartnerProvider Property Map: The securityPartnerProvider associated with this VirtualHub.
securityProviderName String: The Security Provider name.
sku String: The sku of this VirtualHub.
tags Map<String>: Resource tags.
virtualHubRouteTableV2s List<Property Map>: List of all virtual hub route table v2s associated with this VirtualHub.
virtualRouterAsn Number: VirtualRouter ASN.
virtualRouterIps List<String>: VirtualRouter IPs.
virtualWan Property Map: The VirtualWAN to which the VirtualHub belongs.
vpnGateway Property Map: The VpnGateway associated with this VirtualHub.

Supporting Types

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.

VirtualHubRouteResponse

AddressPrefixes List<string>: List of all addressPrefixes.
NextHopIpAddress string: NextHop ip address.

AddressPrefixes []string: List of all addressPrefixes.
NextHopIpAddress string: NextHop ip address.

addressPrefixes List<String>: List of all addressPrefixes.
nextHopIpAddress String: NextHop ip address.

addressPrefixes string[]: List of all addressPrefixes.
nextHopIpAddress string: NextHop ip address.

address_prefixes Sequence[str]: List of all addressPrefixes.
next_hop_ip_address str: NextHop ip address.

addressPrefixes List<String>: List of all addressPrefixes.
nextHopIpAddress String: NextHop ip address.

VirtualHubRouteTableResponse

Routes List<Pulumi.AzureNative.Network.Inputs.VirtualHubRouteResponse>: List of all routes.

Routes []VirtualHubRouteResponse: List of all routes.

routes List<VirtualHubRouteResponse>: List of all routes.

routes VirtualHubRouteResponse[]: List of all routes.

routes Sequence[VirtualHubRouteResponse]: List of all routes.

routes List<Property Map>: List of all routes.

VirtualHubRouteTableV2Response

Etag string: A unique read-only string that changes whenever the resource is updated.
ProvisioningState string: The provisioning state of the virtual hub route table v2 resource.
AttachedConnections List<string>: List of all connections attached to this route table v2.
Id string: Resource ID.
Name string: The name of the resource that is unique within a resource group. This name can be used to access the resource.
Routes List<Pulumi.AzureNative.Network.Inputs.VirtualHubRouteV2Response>: List of all routes.

Etag string: A unique read-only string that changes whenever the resource is updated.
ProvisioningState string: The provisioning state of the virtual hub route table v2 resource.
AttachedConnections []string: List of all connections attached to this route table v2.
Id string: Resource ID.
Name string: The name of the resource that is unique within a resource group. This name can be used to access the resource.
Routes []VirtualHubRouteV2Response: List of all routes.

etag String: A unique read-only string that changes whenever the resource is updated.
provisioningState String: The provisioning state of the virtual hub route table v2 resource.
attachedConnections List<String>: List of all connections attached to this route table v2.
id String: Resource ID.
name String: The name of the resource that is unique within a resource group. This name can be used to access the resource.
routes List<VirtualHubRouteV2Response>: List of all routes.

etag string: A unique read-only string that changes whenever the resource is updated.
provisioningState string: The provisioning state of the virtual hub route table v2 resource.
attachedConnections string[]: List of all connections attached to this route table v2.
id string: Resource ID.
name string: The name of the resource that is unique within a resource group. This name can be used to access the resource.
routes VirtualHubRouteV2Response[]: List of all routes.

etag str: A unique read-only string that changes whenever the resource is updated.
provisioning_state str: The provisioning state of the virtual hub route table v2 resource.
attached_connections Sequence[str]: List of all connections attached to this route table v2.
id str: Resource ID.
name str: The name of the resource that is unique within a resource group. This name can be used to access the resource.
routes Sequence[VirtualHubRouteV2Response]: List of all routes.

etag String: A unique read-only string that changes whenever the resource is updated.
provisioningState String: The provisioning state of the virtual hub route table v2 resource.
attachedConnections List<String>: List of all connections attached to this route table v2.
id String: Resource ID.
name String: The name of the resource that is unique within a resource group. This name can be used to access the resource.
routes List<Property Map>: List of all routes.

VirtualHubRouteV2Response

DestinationType string: The type of destinations.
Destinations List<string>: List of all destinations.
NextHopType string: The type of next hops.
NextHops List<string>: NextHops ip address.

DestinationType string: The type of destinations.
Destinations []string: List of all destinations.
NextHopType string: The type of next hops.
NextHops []string: NextHops ip address.

destinationType String: The type of destinations.
destinations List<String>: List of all destinations.
nextHopType String: The type of next hops.
nextHops List<String>: NextHops ip address.

destinationType string: The type of destinations.
destinations string[]: List of all destinations.
nextHopType string: The type of next hops.
nextHops string[]: NextHops ip address.

destination_type str: The type of destinations.
destinations Sequence[str]: List of all destinations.
next_hop_type str: The type of next hops.
next_hops Sequence[str]: NextHops ip address.

destinationType String: The type of destinations.
destinations List<String>: List of all destinations.
nextHopType String: The type of next hops.
nextHops List<String>: NextHops ip address.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getVirtualHub

On this page

On this page

Using getVirtualHub

getVirtualHub Result

Supporting Types

SubResourceResponse

VirtualHubRouteResponse

VirtualHubRouteTableResponse

VirtualHubRouteTableV2Response

VirtualHubRouteV2Response

Package Details

On this page

On this page