NetworkInterfacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:network_interfaces> attribute.

Inheritance

builtins.object

NetworkInterfacesOperations

Constructor

NetworkInterfacesOperations(*args, **kwargs)

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.
get	Gets information about the specified network interface.
get_cloud_service_network_interface	Get the specified network interface in a cloud service.
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_cloud_service_network_interfaces	Gets all network interfaces in a cloud service.
list_cloud_service_role_instance_network_interfaces	Gets information about all network interfaces in a role instance in a cloud service.
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.
update_tags	Updates a network interface tags.

begin_create_or_update

Creates or updates a network interface.

begin_create_or_update(resource_group_name: str, network_interface_name: str, parameters: _models.NetworkInterface, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_interface_name Required	str The name of the network interface. Required.
parameters Required	NetworkInterface or IO[bytes] Parameters supplied to the create or update network interface operation. Is either a NetworkInterface type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified network interface.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_interface_name Required	str The name of the network interface. 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_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: Any) -> LROPoller[EffectiveRouteListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_interface_name Required	str The name of the network interface. Required.

Returns

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

Exceptions

Type	Description
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: Any) -> LROPoller[EffectiveNetworkSecurityGroupListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_interface_name Required	str The name of the network interface. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets information about the specified network interface.

get(resource_group_name: str, network_interface_name: str, *, expand: str | None = None, **kwargs: Any) -> NetworkInterface

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_interface_name Required	str The name of the network interface. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_cloud_service_network_interface

Get the specified network interface in a cloud service.

get_cloud_service_network_interface(resource_group_name: str, cloud_service_name: str, role_instance_name: str, network_interface_name: str, *, expand: str | None = None, **kwargs: Any) -> NetworkInterface

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cloud_service_name Required	str The name of the cloud service. Required.
role_instance_name Required	str The name of role instance. Required.
network_interface_name Required	str The name of the network interface. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

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

Exceptions

Type	Description
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: str | None = None, **kwargs: Any) -> NetworkInterfaceIPConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.
virtualmachine_index Required	str The virtual machine index. Required.
network_interface_name Required	str The name of the network interface. Required.
ip_configuration_name Required	str The name of the ip configuration. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

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

Exceptions

Type	Description
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: str | None = None, **kwargs: Any) -> NetworkInterface

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.
virtualmachine_index Required	str The virtual machine index. Required.
network_interface_name Required	str The name of the network interface. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets all network interfaces in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[NetworkInterface]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_all

Gets all network interfaces in a subscription.

list_all(**kwargs: Any) -> Iterable[NetworkInterface]

Returns

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

Exceptions

Type	Description
HttpResponseError

list_cloud_service_network_interfaces

Gets all network interfaces in a cloud service.

list_cloud_service_network_interfaces(resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> Iterable[NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cloud_service_name Required	str The name of the cloud service. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_cloud_service_role_instance_network_interfaces

Gets information about all network interfaces in a role instance in a cloud service.

list_cloud_service_role_instance_network_interfaces(resource_group_name: str, cloud_service_name: str, role_instance_name: str, **kwargs: Any) -> Iterable[NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cloud_service_name Required	str The name of the cloud service. Required.
role_instance_name Required	str The name of role instance. Required.

Returns

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

Exceptions

Type	Description
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: str | None = None, **kwargs: Any) -> Iterable[NetworkInterfaceIPConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.
virtualmachine_index Required	str The virtual machine index. Required.
network_interface_name Required	str The name of the network interface. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

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

Exceptions

Type	Description
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: Any) -> Iterable[NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.

Returns

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

Exceptions

Type	Description
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: Any) -> Iterable[NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.
virtualmachine_index Required	str The virtual machine index. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

update_tags

Updates a network interface tags.

update_tags(resource_group_name: str, network_interface_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NetworkInterface

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_interface_name Required	str The name of the network interface. Required.
parameters Required	TagsObject or IO[bytes] Parameters supplied to update network interface tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
NetworkInterface	NetworkInterface 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'>