WorkloadNetworksOperations Class

WorkloadNetworksOperations 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

WorkloadNetworksOperations

Constructor

WorkloadNetworksOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_dhcp	Create dhcp by id in a private cloud workload network. Create dhcp by id in a private cloud workload network.
begin_create_dns_service	Create a DNS service by id in a private cloud workload network. Create a DNS service by id in a private cloud workload network.
begin_create_dns_zone	Create a DNS zone by id in a private cloud workload network. Create a DNS zone by id in a private cloud workload network.
begin_create_port_mirroring	Create a port mirroring profile by id in a private cloud workload network. Create a port mirroring profile by id in a private cloud workload network.
begin_create_public_ip	Create a Public IP Block by id in a private cloud workload network. Create a Public IP Block by id in a private cloud workload network.
begin_create_segments	Create a segment by id in a private cloud workload network. Create a segment by id in a private cloud workload network.
begin_create_vm_group	Create a vm group by id in a private cloud workload network. Create a vm group by id in a private cloud workload network.
begin_delete_dhcp	Delete dhcp by id in a private cloud workload network. Delete dhcp by id in a private cloud workload network.
begin_delete_dns_service	Delete a DNS service by id in a private cloud workload network. Delete a DNS service by id in a private cloud workload network.
begin_delete_dns_zone	Delete a DNS zone by id in a private cloud workload network. Delete a DNS zone by id in a private cloud workload network.
begin_delete_port_mirroring	Delete a port mirroring profile by id in a private cloud workload network. Delete a port mirroring profile by id in a private cloud workload network.
begin_delete_public_ip	Delete a Public IP Block by id in a private cloud workload network. Delete a Public IP Block by id in a private cloud workload network.
begin_delete_segment	Delete a segment by id in a private cloud workload network. Delete a segment by id in a private cloud workload network.
begin_delete_vm_group	Delete a vm group by id in a private cloud workload network. Delete a vm group by id in a private cloud workload network.
begin_update_dhcp	Create or update dhcp by id in a private cloud workload network. Create or update dhcp by id in a private cloud workload network.
begin_update_dns_service	Create or update a DNS service by id in a private cloud workload network. Create or update a DNS service by id in a private cloud workload network.
begin_update_dns_zone	Create or update a DNS zone by id in a private cloud workload network. Create or update a DNS zone by id in a private cloud workload network.
begin_update_port_mirroring	Create or update a port mirroring profile by id in a private cloud workload network. Create or update a port mirroring profile by id in a private cloud workload network.
begin_update_segments	Create or update a segment by id in a private cloud workload network. Create or update a segment by id in a private cloud workload network.
begin_update_vm_group	Create or update a vm group by id in a private cloud workload network. Create or update a vm group by id in a private cloud workload network.
get_dhcp	Get dhcp by id in a private cloud workload network. Get dhcp by id in a private cloud workload network.
get_dns_service	Get a DNS service by id in a private cloud workload network. Get a DNS service by id in a private cloud workload network.
get_dns_zone	Get a DNS zone by id in a private cloud workload network. Get a DNS zone by id in a private cloud workload network.
get_gateway	Get a gateway by id in a private cloud workload network. Get a gateway by id in a private cloud workload network.
get_port_mirroring	Get a port mirroring profile by id in a private cloud workload network. Get a port mirroring profile by id in a private cloud workload network.
get_public_ip	Get a Public IP Block by id in a private cloud workload network. Get a Public IP Block by id in a private cloud workload network.
get_segment	Get a segment by id in a private cloud workload network. Get a segment by id in a private cloud workload network.
get_virtual_machine	Get a virtual machine by id in a private cloud workload network. Get a virtual machine by id in a private cloud workload network.
get_vm_group	Get a vm group by id in a private cloud workload network. Get a vm group by id in a private cloud workload network.
list_dhcp	List dhcp in a private cloud workload network. List dhcp in a private cloud workload network.
list_dns_services	List of DNS services in a private cloud workload network. List of DNS services in a private cloud workload network.
list_dns_zones	List of DNS zones in a private cloud workload network. List of DNS zones in a private cloud workload network.
list_gateways	List of gateways in a private cloud workload network. List of gateways in a private cloud workload network.
list_port_mirroring	List of port mirroring profiles in a private cloud workload network. List of port mirroring profiles in a private cloud workload network.
list_public_i_ps	List of Public IP Blocks in a private cloud workload network. List of Public IP Blocks in a private cloud workload network.
list_segments	List of segments in a private cloud workload network. List of segments in a private cloud workload network.
list_virtual_machines	List of virtual machines in a private cloud workload network. List of virtual machines in a private cloud workload network.
list_vm_groups	List of vm groups in a private cloud workload network. List of vm groups in a private cloud workload network.

begin_create_dhcp

Create dhcp by id in a private cloud workload network.

Create dhcp by id in a private cloud workload network.

begin_create_dhcp(resource_group_name: str, private_cloud_name: str, dhcp_id: str, workload_network_dhcp: _models.WorkloadNetworkDhcp, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkDhcp]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dhcp_id

str

Required

NSX DHCP identifier. Generally the same as the DHCP display name.

workload_network_dhcp

WorkloadNetworkDhcp

Required

NSX DHCP.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkDhcp]

Exceptions

HttpResponseError

begin_create_dns_service

Create a DNS service by id in a private cloud workload network.

Create a DNS service by id in a private cloud workload network.

begin_create_dns_service(resource_group_name: str, private_cloud_name: str, dns_service_id: str, workload_network_dns_service: _models.WorkloadNetworkDnsService, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkDnsService]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dns_service_id

str

Required

NSX DNS Service identifier. Generally the same as the DNS Service's display name.

workload_network_dns_service

WorkloadNetworkDnsService

Required

NSX DNS Service.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkDnsService]

Exceptions

HttpResponseError

begin_create_dns_zone

Create a DNS zone by id in a private cloud workload network.

Create a DNS zone by id in a private cloud workload network.

begin_create_dns_zone(resource_group_name: str, private_cloud_name: str, dns_zone_id: str, workload_network_dns_zone: _models.WorkloadNetworkDnsZone, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkDnsZone]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dns_zone_id

str

Required

NSX DNS Zone identifier. Generally the same as the DNS Zone's display name.

workload_network_dns_zone

WorkloadNetworkDnsZone

Required

NSX DNS Zone.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkDnsZone]

Exceptions

HttpResponseError

begin_create_port_mirroring

Create a port mirroring profile by id in a private cloud workload network.

Create a port mirroring profile by id in a private cloud workload network.

begin_create_port_mirroring(resource_group_name: str, private_cloud_name: str, port_mirroring_id: str, workload_network_port_mirroring: _models.WorkloadNetworkPortMirroring, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkPortMirroring]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

port_mirroring_id

str

Required

NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name.

workload_network_port_mirroring

WorkloadNetworkPortMirroring

Required

NSX port mirroring.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkPortMirroring]

Exceptions

HttpResponseError

begin_create_public_ip

Create a Public IP Block by id in a private cloud workload network.

Create a Public IP Block by id in a private cloud workload network.

begin_create_public_ip(resource_group_name: str, private_cloud_name: str, public_ip_id: str, workload_network_public_ip: _models.WorkloadNetworkPublicIP, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkPublicIP]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

public_ip_id

str

Required

NSX Public IP Block identifier. Generally the same as the Public IP Block's display name.

workload_network_public_ip

WorkloadNetworkPublicIP

Required

NSX Public IP Block.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkPublicIP]

Exceptions

HttpResponseError

begin_create_segments

Create a segment by id in a private cloud workload network.

Create a segment by id in a private cloud workload network.

begin_create_segments(resource_group_name: str, private_cloud_name: str, segment_id: str, workload_network_segment: _models.WorkloadNetworkSegment, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkSegment]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

segment_id

str

Required

NSX Segment identifier. Generally the same as the Segment's display name.

workload_network_segment

WorkloadNetworkSegment

Required

NSX Segment.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkSegment]

Exceptions

HttpResponseError

begin_create_vm_group

Create a vm group by id in a private cloud workload network.

Create a vm group by id in a private cloud workload network.

begin_create_vm_group(resource_group_name: str, private_cloud_name: str, vm_group_id: str, workload_network_vm_group: _models.WorkloadNetworkVMGroup, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkVMGroup]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

vm_group_id

str

Required

NSX VM Group identifier. Generally the same as the VM Group's display name.

workload_network_vm_group

WorkloadNetworkVMGroup

Required

NSX VM Group.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkVMGroup]

Exceptions

HttpResponseError

begin_delete_dhcp

Delete dhcp by id in a private cloud workload network.

Delete dhcp by id in a private cloud workload network.

begin_delete_dhcp(resource_group_name: str, private_cloud_name: str, dhcp_id: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dhcp_id

str

Required

NSX DHCP identifier. Generally the same as the DHCP display name.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

HttpResponseError

begin_delete_dns_service

Delete a DNS service by id in a private cloud workload network.

Delete a DNS service by id in a private cloud workload network.

begin_delete_dns_service(resource_group_name: str, dns_service_id: str, private_cloud_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

dns_service_id

str

Required

NSX DNS Service identifier. Generally the same as the DNS Service's display name.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

HttpResponseError

begin_delete_dns_zone

Delete a DNS zone by id in a private cloud workload network.

Delete a DNS zone by id in a private cloud workload network.

begin_delete_dns_zone(resource_group_name: str, dns_zone_id: str, private_cloud_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

dns_zone_id

str

Required

NSX DNS Zone identifier. Generally the same as the DNS Zone's display name.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

HttpResponseError

begin_delete_port_mirroring

Delete a port mirroring profile by id in a private cloud workload network.

Delete a port mirroring profile by id in a private cloud workload network.

begin_delete_port_mirroring(resource_group_name: str, port_mirroring_id: str, private_cloud_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

port_mirroring_id

str

Required

NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

HttpResponseError

begin_delete_public_ip

Delete a Public IP Block by id in a private cloud workload network.

Delete a Public IP Block by id in a private cloud workload network.

begin_delete_public_ip(resource_group_name: str, public_ip_id: str, private_cloud_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

public_ip_id

str

Required

NSX Public IP Block identifier. Generally the same as the Public IP Block's display name.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

HttpResponseError

begin_delete_segment

Delete a segment by id in a private cloud workload network.

Delete a segment by id in a private cloud workload network.

begin_delete_segment(resource_group_name: str, private_cloud_name: str, segment_id: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

segment_id

str

Required

NSX Segment identifier. Generally the same as the Segment's display name.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

HttpResponseError

begin_delete_vm_group

Delete a vm group by id in a private cloud workload network.

Delete a vm group by id in a private cloud workload network.

begin_delete_vm_group(resource_group_name: str, vm_group_id: str, private_cloud_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

vm_group_id

str

Required

NSX VM Group identifier. Generally the same as the VM Group's display name.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

HttpResponseError

begin_update_dhcp

Create or update dhcp by id in a private cloud workload network.

Create or update dhcp by id in a private cloud workload network.

begin_update_dhcp(resource_group_name: str, private_cloud_name: str, dhcp_id: str, workload_network_dhcp: _models.WorkloadNetworkDhcp, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkDhcp]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dhcp_id

str

Required

NSX DHCP identifier. Generally the same as the DHCP display name.

workload_network_dhcp

WorkloadNetworkDhcp

Required

NSX DHCP.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkDhcp]

Exceptions

HttpResponseError

begin_update_dns_service

Create or update a DNS service by id in a private cloud workload network.

Create or update a DNS service by id in a private cloud workload network.

begin_update_dns_service(resource_group_name: str, private_cloud_name: str, dns_service_id: str, workload_network_dns_service: _models.WorkloadNetworkDnsService, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkDnsService]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dns_service_id

str

Required

NSX DNS Service identifier. Generally the same as the DNS Service's display name.

workload_network_dns_service

WorkloadNetworkDnsService

Required

NSX DNS Service.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkDnsService]

Exceptions

HttpResponseError

begin_update_dns_zone

Create or update a DNS zone by id in a private cloud workload network.

Create or update a DNS zone by id in a private cloud workload network.

begin_update_dns_zone(resource_group_name: str, private_cloud_name: str, dns_zone_id: str, workload_network_dns_zone: _models.WorkloadNetworkDnsZone, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkDnsZone]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dns_zone_id

str

Required

NSX DNS Zone identifier. Generally the same as the DNS Zone's display name.

workload_network_dns_zone

WorkloadNetworkDnsZone

Required

NSX DNS Zone.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkDnsZone]

Exceptions

HttpResponseError

begin_update_port_mirroring

Create or update a port mirroring profile by id in a private cloud workload network.

Create or update a port mirroring profile by id in a private cloud workload network.

begin_update_port_mirroring(resource_group_name: str, private_cloud_name: str, port_mirroring_id: str, workload_network_port_mirroring: _models.WorkloadNetworkPortMirroring, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkPortMirroring]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

port_mirroring_id

str

Required

NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name.

workload_network_port_mirroring

WorkloadNetworkPortMirroring

Required

NSX port mirroring.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkPortMirroring]

Exceptions

HttpResponseError

begin_update_segments

Create or update a segment by id in a private cloud workload network.

Create or update a segment by id in a private cloud workload network.

begin_update_segments(resource_group_name: str, private_cloud_name: str, segment_id: str, workload_network_segment: _models.WorkloadNetworkSegment, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkSegment]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

segment_id

str

Required

NSX Segment identifier. Generally the same as the Segment's display name.

workload_network_segment

WorkloadNetworkSegment

Required

NSX Segment.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkSegment]

Exceptions

HttpResponseError

begin_update_vm_group

Create or update a vm group by id in a private cloud workload network.

Create or update a vm group by id in a private cloud workload network.

begin_update_vm_group(resource_group_name: str, private_cloud_name: str, vm_group_id: str, workload_network_vm_group: _models.WorkloadNetworkVMGroup, **kwargs: Any) -> LROPoller[_models.WorkloadNetworkVMGroup]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

vm_group_id

str

Required

NSX VM Group identifier. Generally the same as the VM Group's display name.

workload_network_vm_group

WorkloadNetworkVMGroup

Required

NSX VM Group.

cls

callable

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

continuation_token

str

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

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

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

Returns

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

Return type

LROPoller[WorkloadNetworkVMGroup]

Exceptions

HttpResponseError

get_dhcp

Get dhcp by id in a private cloud workload network.

Get dhcp by id in a private cloud workload network.

get_dhcp(resource_group_name: str, dhcp_id: str, private_cloud_name: str, **kwargs: Any) -> _models.WorkloadNetworkDhcp

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

dhcp_id

str

Required

NSX DHCP identifier. Generally the same as the DHCP display name.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

WorkloadNetworkDhcp, or the result of cls(response)

Return type

WorkloadNetworkDhcp

Exceptions

HttpResponseError

get_dns_service

Get a DNS service by id in a private cloud workload network.

Get a DNS service by id in a private cloud workload network.

get_dns_service(resource_group_name: str, private_cloud_name: str, dns_service_id: str, **kwargs: Any) -> _models.WorkloadNetworkDnsService

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dns_service_id

str

Required

NSX DNS Service identifier. Generally the same as the DNS Service's display name.

cls

callable

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

Returns

WorkloadNetworkDnsService, or the result of cls(response)

Return type

WorkloadNetworkDnsService

Exceptions

HttpResponseError

get_dns_zone

Get a DNS zone by id in a private cloud workload network.

Get a DNS zone by id in a private cloud workload network.

get_dns_zone(resource_group_name: str, private_cloud_name: str, dns_zone_id: str, **kwargs: Any) -> _models.WorkloadNetworkDnsZone

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

dns_zone_id

str

Required

NSX DNS Zone identifier. Generally the same as the DNS Zone's display name.

cls

callable

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

Returns

WorkloadNetworkDnsZone, or the result of cls(response)

Return type

WorkloadNetworkDnsZone

Exceptions

HttpResponseError

get_gateway

Get a gateway by id in a private cloud workload network.

Get a gateway by id in a private cloud workload network.

get_gateway(resource_group_name: str, private_cloud_name: str, gateway_id: str, **kwargs: Any) -> _models.WorkloadNetworkGateway

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

gateway_id

str

Required

NSX Gateway identifier. Generally the same as the Gateway's display name.

cls

callable

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

Returns

WorkloadNetworkGateway, or the result of cls(response)

Return type

WorkloadNetworkGateway

Exceptions

HttpResponseError

get_port_mirroring

Get a port mirroring profile by id in a private cloud workload network.

Get a port mirroring profile by id in a private cloud workload network.

get_port_mirroring(resource_group_name: str, private_cloud_name: str, port_mirroring_id: str, **kwargs: Any) -> _models.WorkloadNetworkPortMirroring

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

port_mirroring_id

str

Required

NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name.

cls

callable

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

Returns

WorkloadNetworkPortMirroring, or the result of cls(response)

Return type

WorkloadNetworkPortMirroring

Exceptions

HttpResponseError

get_public_ip

Get a Public IP Block by id in a private cloud workload network.

Get a Public IP Block by id in a private cloud workload network.

get_public_ip(resource_group_name: str, private_cloud_name: str, public_ip_id: str, **kwargs: Any) -> _models.WorkloadNetworkPublicIP

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

public_ip_id

str

Required

NSX Public IP Block identifier. Generally the same as the Public IP Block's display name.

cls

callable

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

Returns

WorkloadNetworkPublicIP, or the result of cls(response)

Return type

WorkloadNetworkPublicIP

Exceptions

HttpResponseError

get_segment

Get a segment by id in a private cloud workload network.

Get a segment by id in a private cloud workload network.

get_segment(resource_group_name: str, private_cloud_name: str, segment_id: str, **kwargs: Any) -> _models.WorkloadNetworkSegment

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

segment_id

str

Required

NSX Segment identifier. Generally the same as the Segment's display name.

cls

callable

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

Returns

WorkloadNetworkSegment, or the result of cls(response)

Return type

WorkloadNetworkSegment

Exceptions

HttpResponseError

get_virtual_machine

Get a virtual machine by id in a private cloud workload network.

Get a virtual machine by id in a private cloud workload network.

get_virtual_machine(resource_group_name: str, private_cloud_name: str, virtual_machine_id: str, **kwargs: Any) -> _models.WorkloadNetworkVirtualMachine

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

virtual_machine_id

str

Required

Virtual Machine identifier.

cls

callable

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

Returns

WorkloadNetworkVirtualMachine, or the result of cls(response)

Return type

WorkloadNetworkVirtualMachine

Exceptions

HttpResponseError

get_vm_group

Get a vm group by id in a private cloud workload network.

Get a vm group by id in a private cloud workload network.

get_vm_group(resource_group_name: str, private_cloud_name: str, vm_group_id: str, **kwargs: Any) -> _models.WorkloadNetworkVMGroup

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

vm_group_id

str

Required

NSX VM Group identifier. Generally the same as the VM Group's display name.

cls

callable

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

Returns

WorkloadNetworkVMGroup, or the result of cls(response)

Return type

WorkloadNetworkVMGroup

Exceptions

HttpResponseError

list_dhcp

List dhcp in a private cloud workload network.

List dhcp in a private cloud workload network.

list_dhcp(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkDhcpList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkDhcpList]

Exceptions

HttpResponseError

list_dns_services

List of DNS services in a private cloud workload network.

List of DNS services in a private cloud workload network.

list_dns_services(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkDnsServicesList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkDnsServicesList]

Exceptions

HttpResponseError

list_dns_zones

List of DNS zones in a private cloud workload network.

List of DNS zones in a private cloud workload network.

list_dns_zones(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkDnsZonesList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkDnsZonesList]

Exceptions

HttpResponseError

list_gateways

List of gateways in a private cloud workload network.

List of gateways in a private cloud workload network.

list_gateways(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkGatewayList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkGatewayList]

Exceptions

HttpResponseError

list_port_mirroring

List of port mirroring profiles in a private cloud workload network.

List of port mirroring profiles in a private cloud workload network.

list_port_mirroring(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkPortMirroringList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkPortMirroringList]

Exceptions

HttpResponseError

list_public_i_ps

List of Public IP Blocks in a private cloud workload network.

List of Public IP Blocks in a private cloud workload network.

list_public_i_ps(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkPublicIPsList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkPublicIPsList]

Exceptions

HttpResponseError

list_segments

List of segments in a private cloud workload network.

List of segments in a private cloud workload network.

list_segments(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkSegmentsList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkSegmentsList]

Exceptions

HttpResponseError

list_virtual_machines

List of virtual machines in a private cloud workload network.

List of virtual machines in a private cloud workload network.

list_virtual_machines(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkVirtualMachinesList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkVirtualMachinesList]

Exceptions

HttpResponseError

list_vm_groups

List of vm groups in a private cloud workload network.

List of vm groups in a private cloud workload network.

list_vm_groups(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.WorkloadNetworkVMGroupsList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[WorkloadNetworkVMGroupsList]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.avs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\avs\\models\\__init__.py'>