NetworkInterfacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:network_interfaces> attribute.

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. The name is case insensitive. Required.
network_interface_name Required	str The name of the network interface. Required.
parameters Required	NetworkInterface or <xref:JSON> or IO[bytes] Parameters supplied to the create or update network interface operation. Is one of the following types: NetworkInterface, JSON, IO[bytes] Required.

Returns

Type	Description
LROPoller[NetworkInterface]	An instance of LROPoller that returns NetworkInterface. The NetworkInterface is compatible with MutableMapping

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. The name is case insensitive. Required.
network_interface_name Required	str The name of the network interface. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

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. The name is case insensitive. Required.
network_interface_name Required	str The name of the network interface. Required.

Returns

Type	Description
LROPoller[EffectiveRouteListResult]	An instance of LROPoller that returns EffectiveRouteListResult. The EffectiveRouteListResult is compatible with MutableMapping

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. The name is case insensitive. Required.
network_interface_name Required	str The name of the network interface. Required.

Returns

Type	Description
LROPoller[EffectiveNetworkSecurityGroupListResult]	An instance of LROPoller that returns EffectiveNetworkSecurityGroupListResult. The EffectiveNetworkSecurityGroupListResult is compatible with MutableMapping

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. The name is case insensitive. 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. Default value: None

Returns

Type	Description
NetworkInterface	NetworkInterface. The NetworkInterface is compatible with MutableMapping

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. The name is case insensitive. 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. Default value: None

Returns

Type	Description
NetworkInterface	NetworkInterface. The NetworkInterface is compatible with MutableMapping

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. The name is case insensitive. Required.
virtual_machine_scale_set_name Required	str Required.
virtualmachine_index Required	str Required.
network_interface_name Required	str Required.
ip_configuration_name Required	str Required.

Keyword-Only Parameters

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

Returns

Type	Description
NetworkInterfaceIPConfiguration	NetworkInterfaceIPConfiguration. The NetworkInterfaceIPConfiguration is compatible with MutableMapping

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. The name is case insensitive. Required.
virtual_machine_scale_set_name Required	str Required.
virtualmachine_index Required	str Required.
network_interface_name Required	str Required.

Keyword-Only Parameters

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

Returns

Type	Description
NetworkInterface	NetworkInterface. The NetworkInterface is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Gets all network interfaces in a resource group.

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

Parameters

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

Returns

Type	Description
ItemPaged[NetworkInterface]	An iterator like instance of NetworkInterface

Exceptions

Type	Description
HttpResponseError

list_all

Gets all network interfaces in a subscription.

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

Returns

Type	Description
ItemPaged[NetworkInterface]	An iterator like instance of NetworkInterface

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) -> ItemPaged[NetworkInterface]

Parameters

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

Returns

Type	Description
ItemPaged[NetworkInterface]	An iterator like instance of NetworkInterface

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) -> ItemPaged[NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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 NetworkInterface

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) -> ItemPaged[NetworkInterfaceIPConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
virtual_machine_scale_set_name Required	str Required.
virtualmachine_index Required	str Required.
network_interface_name Required	str Required.

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[NetworkInterfaceIPConfiguration]	An iterator like instance of NetworkInterfaceIPConfiguration

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) -> ItemPaged[NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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 NetworkInterface

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) -> ItemPaged[NetworkInterface]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
virtual_machine_scale_set_name Required	str Required.
virtualmachine_index Required	str Required.

Returns

Type	Description
ItemPaged[NetworkInterface]	An iterator like instance of NetworkInterface

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. The name is case insensitive. Required.
network_interface_name Required	str The name of the network interface. Required.
parameters Required	TagsObject or <xref:JSON> or IO[bytes] Parameters supplied to update network interface tags. Is one of the following types: TagsObject, JSON, IO[bytes] Required.

Returns

Type	Description
NetworkInterface	NetworkInterface. The NetworkInterface is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Feedback

War diese Seite hilfreich?