VirtualHub Class

VirtualHub Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.network.models._models_py3.Resource

VirtualHub

Constructor

VirtualHub(*, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, virtual_wan: _models.SubResource | None = None, vpn_gateway: _models.SubResource | None = None, p2_s_vpn_gateway: _models.SubResource | None = None, express_route_gateway: _models.SubResource | None = None, azure_firewall: _models.SubResource | None = None, security_partner_provider: _models.SubResource | None = None, address_prefix: str | None = None, route_table: _models.VirtualHubRouteTable | None = None, security_provider_name: str | None = None, virtual_hub_route_table_v2_s: List[_models.VirtualHubRouteTableV2] | None = None, sku: str | None = None, virtual_router_asn: int | None = None, virtual_router_ips: List[str] | None = None, allow_branch_to_branch_traffic: bool | None = None, preferred_routing_gateway: str | _models.PreferredRoutingGateway | None = None, hub_routing_preference: str | _models.HubRoutingPreference | None = None, virtual_router_auto_scale_configuration: _models.VirtualRouterAutoScaleConfiguration | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID.
location	str Resource location.
tags	dict[str, str] Resource tags.
virtual_wan	SubResource The VirtualWAN to which the VirtualHub belongs.
vpn_gateway	SubResource The VpnGateway associated with this VirtualHub.
p2_s_vpn_gateway	SubResource The P2SVpnGateway associated with this VirtualHub.
express_route_gateway	SubResource The expressRouteGateway associated with this VirtualHub.
azure_firewall	SubResource The azureFirewall associated with this VirtualHub.
security_partner_provider	SubResource The securityPartnerProvider associated with this VirtualHub.
address_prefix	str Address-prefix for this VirtualHub.
route_table	VirtualHubRouteTable The routeTable associated with this virtual hub.
security_provider_name	str The Security Provider name.
virtual_hub_route_table_v2_s	list[VirtualHubRouteTableV2] List of all virtual hub route table v2s associated with this VirtualHub.
sku	str The sku of this VirtualHub.
virtual_router_asn	int VirtualRouter ASN.
virtual_router_ips	list[str] VirtualRouter IPs.
allow_branch_to_branch_traffic	bool Flag to control transit for VirtualRouter hub.
preferred_routing_gateway	str or PreferredRoutingGateway The preferred gateway to route on-prem traffic. Known values are: "ExpressRoute", "VpnGateway", and "None".
hub_routing_preference	str or HubRoutingPreference The hubRoutingPreference of this VirtualHub. Known values are: "ExpressRoute", "VpnGateway", and "ASPath".
virtual_router_auto_scale_configuration	VirtualRouterAutoScaleConfiguration The VirtualHub Router autoscale configuration.

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
location	str Resource location.
tags	dict[str, str] Resource tags.
etag	str A unique read-only string that changes whenever the resource is updated.
kind	str Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
virtual_wan	SubResource The VirtualWAN to which the VirtualHub belongs.
vpn_gateway	SubResource The VpnGateway associated with this VirtualHub.
p2_s_vpn_gateway	SubResource The P2SVpnGateway associated with this VirtualHub.
express_route_gateway	SubResource The expressRouteGateway associated with this VirtualHub.
azure_firewall	SubResource The azureFirewall associated with this VirtualHub.
security_partner_provider	SubResource The securityPartnerProvider associated with this VirtualHub.
address_prefix	str Address-prefix for this VirtualHub.
route_table	VirtualHubRouteTable The routeTable associated with this virtual hub.
provisioning_state	str or ProvisioningState The provisioning state of the virtual hub resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
security_provider_name	str The Security Provider name.
virtual_hub_route_table_v2_s	list[VirtualHubRouteTableV2] List of all virtual hub route table v2s associated with this VirtualHub.
sku	str The sku of this VirtualHub.
routing_state	str or RoutingState The routing state. Known values are: "None", "Provisioned", "Provisioning", and "Failed".
bgp_connections	list[SubResource] List of references to Bgp Connections.
ip_configurations	list[SubResource] List of references to IpConfigurations.
route_maps	list[SubResource] List of references to RouteMaps.
virtual_router_asn	int VirtualRouter ASN.
virtual_router_ips	list[str] VirtualRouter IPs.
allow_branch_to_branch_traffic	bool Flag to control transit for VirtualRouter hub.
preferred_routing_gateway	str or PreferredRoutingGateway The preferred gateway to route on-prem traffic. Known values are: "ExpressRoute", "VpnGateway", and "None".
hub_routing_preference	str or HubRoutingPreference The hubRoutingPreference of this VirtualHub. Known values are: "ExpressRoute", "VpnGateway", and "ASPath".
virtual_router_auto_scale_configuration	VirtualRouterAutoScaleConfiguration The VirtualHub Router autoscale configuration.