VirtualHubsOperations Class

VirtualHubsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

VirtualHubsOperations

Constructor

VirtualHubsOperations(client, config, serializer, deserializer)

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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 .
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, virtual_hub_name, virtual_hub_parameters, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VirtualHub.

virtual_hub_name

str

Required

The name of the VirtualHub.

virtual_hub_parameters

VirtualHub

Required

Parameters supplied to create or update VirtualHub.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VirtualHub or the result of cls(response)

Return type

LROPoller[VirtualHub]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes a VirtualHub.

begin_delete(resource_group_name, virtual_hub_name, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VirtualHub.

virtual_hub_name

str

Required

The name of the VirtualHub.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

~azure.core.exceptions.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, virtual_hub_name, effective_routes_parameters=None, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VirtualHub.

virtual_hub_name

str

Required

The name of the VirtualHub.

effective_routes_parameters

EffectiveRoutesParameters

default value: None

Parameters supplied to get the effective routes for a specific resource.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Retrieves the details of a VirtualHub.

get(resource_group_name, virtual_hub_name, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VirtualHub.

virtual_hub_name

str

Required

The name of the VirtualHub.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

VirtualHub, or the result of cls(response)

Return type

VirtualHub

Exceptions

~azure.core.exceptions.HttpResponseError

list

Lists all the VirtualHubs in a subscription.

list(**kwargs)

Parameters

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ListVirtualHubsResult or the result of cls(response)

Return type

ItemPaged[ListVirtualHubsResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists all the VirtualHubs in a resource group.

list_by_resource_group(resource_group_name, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VirtualHub.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ListVirtualHubsResult or the result of cls(response)

Return type

ItemPaged[ListVirtualHubsResult]

Exceptions

~azure.core.exceptions.HttpResponseError

update_tags

Updates VirtualHub tags.

update_tags(resource_group_name, virtual_hub_name, virtual_hub_parameters, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VirtualHub.

virtual_hub_name

str

Required

The name of the VirtualHub.

virtual_hub_parameters

TagsObject

Required

Parameters supplied to update VirtualHub tags.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

VirtualHub, or the result of cls(response)

Return type

VirtualHub

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2020_06_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2020_06_01\\models\\__init__.py'>