VirtualHubsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:virtual_hubs> attribute.

Inheritance

builtins.object

VirtualHubsOperations

Constructor

VirtualHubsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.
begin_delete	Deletes a VirtualHub.
begin_get_effective_virtual_hub_routes	Gets the effective routes configured for the Virtual Hub resource or the specified resource .
begin_get_inbound_routes	Gets the inbound routes configured for the Virtual Hub on a particular connection.
begin_get_outbound_routes	Gets the outbound routes configured for the Virtual Hub on a particular connection.
get	Retrieves the details of a VirtualHub.
list	Lists all the VirtualHubs in a subscription.
list_by_resource_group	Lists all the VirtualHubs in a resource group.
update_tags	Updates VirtualHub tags.

begin_create_or_update

Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.

begin_create_or_update(resource_group_name: str, virtual_hub_name: str, virtual_hub_parameters: _models.VirtualHub, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualHub]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.
virtual_hub_name Required	str The name of the VirtualHub. Required.
virtual_hub_parameters Required	VirtualHub or IO[bytes] Parameters supplied to create or update VirtualHub. Is either a VirtualHub type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[VirtualHub]	An instance of LROPoller that returns either VirtualHub or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a VirtualHub.

begin_delete(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.
virtual_hub_name Required	str The name of the VirtualHub. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_get_effective_virtual_hub_routes

Gets the effective routes configured for the Virtual Hub resource or the specified resource .

begin_get_effective_virtual_hub_routes(resource_group_name: str, virtual_hub_name: str, effective_routes_parameters: _models.EffectiveRoutesParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualHubEffectiveRouteList]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.
virtual_hub_name Required	str The name of the VirtualHub. Required.
effective_routes_parameters Required	EffectiveRoutesParameters or IO[bytes] Parameters supplied to get the effective routes for a specific resource. Is either a EffectiveRoutesParameters type or a IO[bytes] type. Default value is None.

Returns

Type	Description
LROPoller[VirtualHubEffectiveRouteList]	An instance of LROPoller that returns either VirtualHubEffectiveRouteList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_get_inbound_routes

Gets the inbound routes configured for the Virtual Hub on a particular connection.

begin_get_inbound_routes(resource_group_name: str, virtual_hub_name: str, get_inbound_routes_parameters: _models.GetInboundRoutesParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.EffectiveRouteMapRouteList]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.
virtual_hub_name Required	str The name of the VirtualHub. Required.
get_inbound_routes_parameters Required	GetInboundRoutesParameters or IO[bytes] Parameters supplied to get the inbound routes for a connection resource. Is either a GetInboundRoutesParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[EffectiveRouteMapRouteList]	An instance of LROPoller that returns either EffectiveRouteMapRouteList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_get_outbound_routes

Gets the outbound routes configured for the Virtual Hub on a particular connection.

begin_get_outbound_routes(resource_group_name: str, virtual_hub_name: str, get_outbound_routes_parameters: _models.GetOutboundRoutesParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.EffectiveRouteMapRouteList]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.
virtual_hub_name Required	str The name of the VirtualHub. Required.
get_outbound_routes_parameters Required	GetOutboundRoutesParameters or IO[bytes] Parameters supplied to get the outbound routes for a connection resource. Is either a GetOutboundRoutesParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[EffectiveRouteMapRouteList]	An instance of LROPoller that returns either EffectiveRouteMapRouteList or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Retrieves the details of a VirtualHub.

get(resource_group_name: str, virtual_hub_name: str, **kwargs: Any) -> VirtualHub

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.
virtual_hub_name Required	str The name of the VirtualHub. Required.

Returns

Type	Description
VirtualHub	VirtualHub or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all the VirtualHubs in a subscription.

list(**kwargs: Any) -> Iterable[VirtualHub]

Returns

Type	Description
ItemPaged[VirtualHub]	An iterator like instance of either VirtualHub or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all the VirtualHubs in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualHub]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.

Returns

Type	Description
ItemPaged[VirtualHub]	An iterator like instance of either VirtualHub or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_tags

Updates VirtualHub tags.

update_tags(resource_group_name: str, virtual_hub_name: str, virtual_hub_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VirtualHub

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VirtualHub. Required.
virtual_hub_name Required	str The name of the VirtualHub. Required.
virtual_hub_parameters Required	TagsObject or IO[bytes] Parameters supplied to update VirtualHub tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
VirtualHub	VirtualHub or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>