NetworkInterfacesOperations Class

NetworkInterfacesOperations async 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

NetworkInterfacesOperations

Constructor

NetworkInterfacesOperations(client, config, serializer, deserializer) -> None

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 or updates a network interface.
begin_delete	Deletes the specified network interface.
begin_get_effective_route_table	Gets all route tables applied to a network interface.
begin_list_effective_network_security_groups	Gets all network security groups applied to a network interface.
begin_update_tags	Updates a network interface tags.
get	Gets information about the specified network interface.
get_virtual_machine_scale_set_ip_configuration	Get the specified network interface ip configuration in a virtual machine scale set.
get_virtual_machine_scale_set_network_interface	Get the specified network interface in a virtual machine scale set.
list	Gets all network interfaces in a resource group.
list_all	Gets all network interfaces in a subscription.
list_virtual_machine_scale_set_ip_configurations	Get the specified network interface ip configuration in a virtual machine scale set.
list_virtual_machine_scale_set_network_interfaces	Gets all network interfaces in a virtual machine scale set.
list_virtual_machine_scale_set_vm_network_interfaces	Gets information about all network interfaces in a virtual machine in a virtual machine scale set.

begin_create_or_update

Creates or updates a network interface.

begin_create_or_update(resource_group_name: str, network_interface_name: str, parameters: azure.mgmt.network.v2017_09_01.models._models_py3.NetworkInterface, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.NetworkInterface')]

Parameters

resource_group_name

str

Required

The name of the resource group.

network_interface_name

str

Required

The name of the network interface.

parameters

NetworkInterface

Required

Parameters supplied to the create or update network interface operation.

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 AsyncPollingMethod

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 AsyncLROPoller that returns either NetworkInterface or the result of cls(response)

Return type

AsyncLROPoller[NetworkInterface]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified network interface.

begin_delete(resource_group_name: str, network_interface_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name

str

Required

The name of the resource group.

network_interface_name

str

Required

The name of the network interface.

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 AsyncPollingMethod

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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_get_effective_route_table

Gets all route tables applied to a network interface.

begin_get_effective_route_table(resource_group_name: str, network_interface_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.EffectiveRouteListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

network_interface_name

str

Required

The name of the network interface.

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 AsyncPollingMethod

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 AsyncLROPoller that returns either EffectiveRouteListResult or the result of cls(response)

Return type

AsyncLROPoller[EffectiveRouteListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_list_effective_network_security_groups

Gets all network security groups applied to a network interface.

begin_list_effective_network_security_groups(resource_group_name: str, network_interface_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.EffectiveNetworkSecurityGroupListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

network_interface_name

str

Required

The name of the network interface.

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 AsyncPollingMethod

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 AsyncLROPoller that returns either EffectiveNetworkSecurityGroupListResult or the result of cls(response)

Return type

AsyncLROPoller[EffectiveNetworkSecurityGroupListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates a network interface tags.

begin_update_tags(resource_group_name: str, network_interface_name: str, parameters: azure.mgmt.network.v2017_09_01.models._models_py3.TagsObject, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.NetworkInterface')]

Parameters

resource_group_name

str

Required

The name of the resource group.

network_interface_name

str

Required

The name of the network interface.

parameters

TagsObject

Required

Parameters supplied to update network interface tags.

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 AsyncPollingMethod

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 AsyncLROPoller that returns either NetworkInterface or the result of cls(response)

Return type

AsyncLROPoller[NetworkInterface]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets information about the specified network interface.

get(resource_group_name: str, network_interface_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2017_09_01.models._models_py3.NetworkInterface

Parameters

resource_group_name

str

Required

The name of the resource group.

network_interface_name

str

Required

The name of the network interface.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

NetworkInterface, or the result of cls(response)

Return type

NetworkInterface

Exceptions

~azure.core.exceptions.HttpResponseError

get_virtual_machine_scale_set_ip_configuration

Get the specified network interface ip configuration in a virtual machine scale set.

get_virtual_machine_scale_set_ip_configuration(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, ip_configuration_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2017_09_01.models._models_py3.NetworkInterfaceIPConfiguration

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_machine_scale_set_name

str

Required

The name of the virtual machine scale set.

virtualmachine_index

str

Required

The virtual machine index.

network_interface_name

str

Required

The name of the network interface.

ip_configuration_name

str

Required

The name of the ip configuration.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

NetworkInterfaceIPConfiguration, or the result of cls(response)

Return type

NetworkInterfaceIPConfiguration

Exceptions

~azure.core.exceptions.HttpResponseError

get_virtual_machine_scale_set_network_interface

Get the specified network interface in a virtual machine scale set.

get_virtual_machine_scale_set_network_interface(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2017_09_01.models._models_py3.NetworkInterface

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_machine_scale_set_name

str

Required

The name of the virtual machine scale set.

virtualmachine_index

str

Required

The virtual machine index.

network_interface_name

str

Required

The name of the network interface.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

NetworkInterface, or the result of cls(response)

Return type

NetworkInterface

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all network interfaces in a resource group.

list(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.NetworkInterfaceListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[NetworkInterfaceListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all network interfaces in a subscription.

list_all(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.NetworkInterfaceListResult')]

Parameters

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[NetworkInterfaceListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_virtual_machine_scale_set_ip_configurations

Get the specified network interface ip configuration in a virtual machine scale set.

list_virtual_machine_scale_set_ip_configurations(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.NetworkInterfaceIPConfigurationListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_machine_scale_set_name

str

Required

The name of the virtual machine scale set.

virtualmachine_index

str

Required

The virtual machine index.

network_interface_name

str

Required

The name of the network interface.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[NetworkInterfaceIPConfigurationListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_virtual_machine_scale_set_network_interfaces

Gets all network interfaces in a virtual machine scale set.

list_virtual_machine_scale_set_network_interfaces(resource_group_name: str, virtual_machine_scale_set_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.NetworkInterfaceListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_machine_scale_set_name

str

Required

The name of the virtual machine scale set.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[NetworkInterfaceListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_virtual_machine_scale_set_vm_network_interfaces

Gets information about all network interfaces in a virtual machine in a virtual machine scale set.

list_virtual_machine_scale_set_vm_network_interfaces(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.NetworkInterfaceListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_machine_scale_set_name

str

Required

The name of the virtual machine scale set.

virtualmachine_index

str

Required

The virtual machine index.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[NetworkInterfaceListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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