azure.mgmt.network.v2018_12_01.operations module¶

list_available_response_headers(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all available response headers.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[str] or ClientRawResponse

Raises

list_available_server_variables(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all available server variables.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[str] or ClientRawResponse

Raises

ApplicationGatewaySslPredefinedPolicyPaged[ApplicationGatewaySslPredefinedPolicy]

list_available_ssl_options(custom_headers=None, raw=False, **operation_config)[source]¶

Lists available Ssl options for configuring Ssl policy.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ApplicationGatewayAvailableSslOptions or ClientRawResponse if raw=true

Return type

ApplicationGatewayAvailableSslOptions or ClientRawResponse

Raises

CloudError

list_available_ssl_predefined_policies(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all SSL predefined policies for configuring Ssl policy.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationGatewaySslPredefinedPolicy

Return type

Raises

CloudError

list_available_waf_rule_sets(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all available web application firewall rule sets.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ApplicationGatewayAvailableWafRuleSetsResult or ClientRawResponse if raw=true

Return type

ApplicationGatewayAvailableWafRuleSetsResult or ClientRawResponse

Raises

CloudError

start(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Starts the specified application gateway.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

stop(resource_group_name, application_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Stops the specified application gateway in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

update_tags(resource_group_name, application_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates the specified application gateway tags.

Parameters

resource_group_name (str) – The name of the resource group.
application_gateway_name (str) – The name of the application gateway.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationGateway or ClientRawResponse<ApplicationGateway> if raw==True

Return type

AzureOperationPoller[ApplicationGateway] or AzureOperationPoller[ClientRawResponse[ApplicationGateway]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ApplicationSecurityGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApplicationSecurityGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, application_security_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an application security group.

Parameters

resource_group_name (str) – The name of the resource group.
application_security_group_name (str) – The name of the application security group.
parameters (ApplicationSecurityGroup) – Parameters supplied to the create or update ApplicationSecurityGroup operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationSecurityGroup or ClientRawResponse<ApplicationSecurityGroup> if raw==True

Return type

AzureOperationPoller[ApplicationSecurityGroup] or AzureOperationPoller[ClientRawResponse[ApplicationSecurityGroup]]

Raises

CloudError

delete(resource_group_name, application_security_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified application security group.

Parameters

resource_group_name (str) – The name of the resource group.
application_security_group_name (str) – The name of the application security group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, application_security_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about the specified application security group.

Parameters

resource_group_name (str) – The name of the resource group.
application_security_group_name (str) – The name of the application security group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ApplicationSecurityGroup or ClientRawResponse if raw=true

Return type

ApplicationSecurityGroup or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the application security groups in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationSecurityGroup

Return type

ApplicationSecurityGroupPaged[ApplicationSecurityGroup]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all application security groups in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApplicationSecurityGroup

Return type

ApplicationSecurityGroupPaged[ApplicationSecurityGroup]

Raises

CloudError

update_tags(resource_group_name, application_security_group_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an application security group’s tags.

Parameters

resource_group_name (str) – The name of the resource group.
application_security_group_name (str) – The name of the application security group.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationSecurityGroup or ClientRawResponse<ApplicationSecurityGroup> if raw==True

Return type

AzureOperationPoller[ApplicationSecurityGroup] or AzureOperationPoller[ClientRawResponse[ApplicationSecurityGroup]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.AvailableDelegationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AvailableDelegationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(location, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all of the available subnet delegations for this subscription in this region.

Parameters

location (str) – The location of the subnet.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AvailableDelegation

Return type

AvailableDelegationPaged[AvailableDelegation]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.AvailableEndpointServicesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AvailableEndpointServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(location, custom_headers=None, raw=False, **operation_config)[source]¶

List what values of endpoint services are available for use.

Parameters

location (str) – The location to check available endpoint services.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of EndpointServiceResult

Return type

EndpointServiceResultPaged[EndpointServiceResult]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.AvailableResourceGroupDelegationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AvailableResourceGroupDelegationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(location, resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all of the available subnet delegations for this resource group in this region.

Parameters

location (str) – The location of the domain name.
resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AvailableDelegation

Return type

AvailableDelegationPaged[AvailableDelegation]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.AzureFirewallFqdnTagsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AzureFirewallFqdnTagsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the Azure Firewall FQDN Tags in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AzureFirewallFqdnTag

Return type

AzureFirewallFqdnTagPaged[AzureFirewallFqdnTag]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.AzureFirewallsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AzureFirewallsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, azure_firewall_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates the specified Azure Firewall.

Parameters

resource_group_name (str) – The name of the resource group.
azure_firewall_name (str) – The name of the Azure Firewall.
parameters (AzureFirewall) – Parameters supplied to the create or update Azure Firewall operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AzureFirewall or ClientRawResponse<AzureFirewall> if raw==True

Return type

AzureOperationPoller[AzureFirewall] or AzureOperationPoller[ClientRawResponse[AzureFirewall]]

Raises

CloudError

delete(resource_group_name, azure_firewall_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified Azure Firewall.

Parameters

resource_group_name (str) – The name of the resource group.
azure_firewall_name (str) – The name of the Azure Firewall.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, azure_firewall_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified Azure Firewall.

Parameters

resource_group_name (str) – The name of the resource group.
azure_firewall_name (str) – The name of the Azure Firewall.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

AzureFirewall or ClientRawResponse if raw=true

Return type

AzureFirewall or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all Azure Firewalls in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AzureFirewall

Return type

AzureFirewallPaged[AzureFirewall]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the Azure Firewalls in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of AzureFirewall

Return type

AzureFirewallPaged[AzureFirewall]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.BgpServiceCommunitiesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

BgpServiceCommunitiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the available bgp service communities.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of BgpServiceCommunity

Return type

BgpServiceCommunityPaged[BgpServiceCommunity]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ConnectionMonitorsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ConnectionMonitorsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, network_watcher_name, connection_monitor_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or update a connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
connection_monitor_name (str) – The name of the connection monitor.
parameters (ConnectionMonitor) – Parameters that define the operation to create a connection monitor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectionMonitorResult or ClientRawResponse<ConnectionMonitorResult> if raw==True

Return type

AzureOperationPoller[ConnectionMonitorResult] or AzureOperationPoller[ClientRawResponse[ConnectionMonitorResult]]

Raises

delete(resource_group_name, network_watcher_name, connection_monitor_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
connection_monitor_name (str) – The name of the connection monitor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, network_watcher_name, connection_monitor_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a connection monitor by name.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
connection_monitor_name (str) – The name of the connection monitor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ConnectionMonitorResult or ClientRawResponse if raw=true

Return type

ConnectionMonitorResult or ClientRawResponse

Raises

ConnectionMonitorResultPaged[ConnectionMonitorResult]

list(resource_group_name, network_watcher_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all connection monitors for the specified Network Watcher.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ConnectionMonitorResult

Return type

Raises

query(resource_group_name, network_watcher_name, connection_monitor_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Query a snapshot of the most recent connection states.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
connection_monitor_name (str) – The name given to the connection monitor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectionMonitorQueryResult or ClientRawResponse<ConnectionMonitorQueryResult> if raw==True

Return type

AzureOperationPoller[ConnectionMonitorQueryResult] or AzureOperationPoller[ClientRawResponse[ConnectionMonitorQueryResult]]

Raises

start(resource_group_name, network_watcher_name, connection_monitor_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Starts the specified connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
connection_monitor_name (str) – The name of the connection monitor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

stop(resource_group_name, network_watcher_name, connection_monitor_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Stops the specified connection monitor.

Parameters

resource_group_name (str) – The name of the resource group containing Network Watcher.
network_watcher_name (str) – The name of the Network Watcher resource.
connection_monitor_name (str) – The name of the connection monitor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

DdosProtectionPlanPaged[DdosProtectionPlan]

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.DdosCustomPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DdosCustomPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, ddos_custom_policy_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a DDoS custom policy.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_custom_policy_name (str) – The name of the DDoS custom policy.
parameters (DdosCustomPolicy) – Parameters supplied to the create or update operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DdosCustomPolicy or ClientRawResponse<DdosCustomPolicy> if raw==True

Return type

AzureOperationPoller[DdosCustomPolicy] or AzureOperationPoller[ClientRawResponse[DdosCustomPolicy]]

Raises

CloudError

delete(resource_group_name, ddos_custom_policy_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified DDoS custom policy.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_custom_policy_name (str) – The name of the DDoS custom policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, ddos_custom_policy_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about the specified DDoS custom policy.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_custom_policy_name (str) – The name of the DDoS custom policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DdosCustomPolicy or ClientRawResponse if raw=true

Return type

DdosCustomPolicy or ClientRawResponse

Raises

CloudError

update_tags(resource_group_name, ddos_custom_policy_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Update a DDoS custom policy tags.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_custom_policy_name (str) – The name of the DDoS custom policy.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DdosCustomPolicy or ClientRawResponse<DdosCustomPolicy> if raw==True

Return type

AzureOperationPoller[DdosCustomPolicy] or AzureOperationPoller[ClientRawResponse[DdosCustomPolicy]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.DdosProtectionPlansOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DdosProtectionPlansOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, ddos_protection_plan_name, location=None, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a DDoS protection plan.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_protection_plan_name (str) – The name of the DDoS protection plan.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DdosProtectionPlan or ClientRawResponse<DdosProtectionPlan> if raw==True

Return type

AzureOperationPoller[DdosProtectionPlan] or AzureOperationPoller[ClientRawResponse[DdosProtectionPlan]]

Raises

CloudError

delete(resource_group_name, ddos_protection_plan_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified DDoS protection plan.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_protection_plan_name (str) – The name of the DDoS protection plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, ddos_protection_plan_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about the specified DDoS protection plan.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_protection_plan_name (str) – The name of the DDoS protection plan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DdosProtectionPlan or ClientRawResponse if raw=true

Return type

DdosProtectionPlan or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all DDoS protection plans in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DdosProtectionPlan

Return type

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the DDoS protection plans in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DdosProtectionPlan

Return type

DdosProtectionPlanPaged[DdosProtectionPlan]

Raises

CloudError

update_tags(resource_group_name, ddos_protection_plan_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Update a DDoS protection plan tags.

Parameters

resource_group_name (str) – The name of the resource group.
ddos_protection_plan_name (str) – The name of the DDoS protection plan.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DdosProtectionPlan or ClientRawResponse<DdosProtectionPlan> if raw==True

Return type

AzureOperationPoller[DdosProtectionPlan] or AzureOperationPoller[ClientRawResponse[DdosProtectionPlan]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.DefaultSecurityRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DefaultSecurityRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, network_security_group_name, default_security_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the specified default network security rule.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
default_security_rule_name (str) – The name of the default security rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SecurityRule or ClientRawResponse if raw=true

Return type

SecurityRule or ClientRawResponse

Raises

CloudError

list(resource_group_name, network_security_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all default security rules in a network security group.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SecurityRule

Return type

SecurityRulePaged[SecurityRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteCircuitAuthorizationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteCircuitAuthorizationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, circuit_name, authorization_name, authorization_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an authorization in the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
authorization_name (str) – The name of the authorization.
authorization_parameters (ExpressRouteCircuitAuthorization) – Parameters supplied to the create or update express route circuit authorization operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitAuthorization or ClientRawResponse<ExpressRouteCircuitAuthorization> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitAuthorization] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitAuthorization]]

Raises

CloudError

delete(resource_group_name, circuit_name, authorization_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified authorization from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
authorization_name (str) – The name of the authorization.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, circuit_name, authorization_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified authorization from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
authorization_name (str) – The name of the authorization.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCircuitAuthorization or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitAuthorization or ClientRawResponse

Raises

CloudError

list(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all authorizations in an express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the circuit.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuitAuthorization

Return type

ExpressRouteCircuitAuthorizationPaged[ExpressRouteCircuitAuthorization]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteCircuitConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteCircuitConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
connection_name (str) – The name of the express route circuit connection.
express_route_circuit_connection_parameters (ExpressRouteCircuitConnection) – Parameters supplied to the create or update express route circuit connection operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitConnection or ClientRawResponse<ExpressRouteCircuitConnection> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitConnection] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitConnection]]

Raises

CloudError

delete(resource_group_name, circuit_name, peering_name, connection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified Express Route Circuit Connection from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
connection_name (str) – The name of the express route circuit connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, circuit_name, peering_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified Express Route Circuit Connection from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
connection_name (str) – The name of the express route circuit connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCircuitConnection or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitConnection or ClientRawResponse

Raises

CloudError

list(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all global reach connections associated with a private peering in an express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the circuit.
peering_name (str) – The name of the peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuitConnection

Return type

ExpressRouteCircuitConnectionPaged[ExpressRouteCircuitConnection]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteCircuitPeeringsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteCircuitPeeringsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, circuit_name, peering_name, peering_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a peering in the specified express route circuits.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
peering_parameters (ExpressRouteCircuitPeering) – Parameters supplied to the create or update express route circuit peering operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitPeering or ClientRawResponse<ExpressRouteCircuitPeering> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitPeering] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitPeering]]

Raises

CloudError

delete(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified peering from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified peering for the express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCircuitPeering or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitPeering or ClientRawResponse

Raises

CloudError

list(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all peerings in a specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuitPeering

Return type

ExpressRouteCircuitPeeringPaged[ExpressRouteCircuitPeering]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteCircuitsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteCircuitsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, circuit_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the circuit.
parameters (ExpressRouteCircuit) – Parameters supplied to the create or update express route circuit operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuit or ClientRawResponse<ExpressRouteCircuit> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuit] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuit]]

Raises

CloudError

delete(resource_group_name, circuit_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of express route circuit.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCircuit or ClientRawResponse if raw=true

Return type

ExpressRouteCircuit or ClientRawResponse

Raises

CloudError

get_peering_stats(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all stats from an express route circuit in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCircuitStats or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitStats or ClientRawResponse

Raises

CloudError

get_stats(resource_group_name, circuit_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the stats from an express route circuit in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCircuitStats or ClientRawResponse if raw=true

Return type

ExpressRouteCircuitStats or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the express route circuits in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuit

Return type

ExpressRouteCircuitPaged[ExpressRouteCircuit]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the express route circuits in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCircuit

Return type

ExpressRouteCircuitPaged[ExpressRouteCircuit]

Raises

CloudError

list_arp_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the currently advertised ARP table associated with the express route circuit in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
device_path (str) – The path of the device.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsArpTableListResult or ClientRawResponse<ExpressRouteCircuitsArpTableListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsArpTableListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsArpTableListResult]]

Raises

CloudError

list_routes_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the currently advertised routes table associated with the express route circuit in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
device_path (str) – The path of the device.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsRoutesTableListResult or ClientRawResponse<ExpressRouteCircuitsRoutesTableListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsRoutesTableListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsRoutesTableListResult]]

Raises

CloudError

list_routes_table_summary(resource_group_name, circuit_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the currently advertised routes table summary associated with the express route circuit in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
device_path (str) – The path of the device.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsRoutesTableSummaryListResult or ClientRawResponse<ExpressRouteCircuitsRoutesTableSummaryListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsRoutesTableSummaryListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsRoutesTableSummaryListResult]]

Raises

CloudError

update_tags(resource_group_name, circuit_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an express route circuit tags.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the circuit.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuit or ClientRawResponse<ExpressRouteCircuit> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuit] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuit]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, express_route_gateway_name, connection_name, put_express_route_connection_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_gateway_name (str) – The name of the ExpressRoute gateway.
connection_name (str) – The name of the connection subresource.
put_express_route_connection_parameters (ExpressRouteConnection) – Parameters required in an ExpressRouteConnection PUT operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteConnection or ClientRawResponse<ExpressRouteConnection> if raw==True

Return type

AzureOperationPoller[ExpressRouteConnection] or AzureOperationPoller[ClientRawResponse[ExpressRouteConnection]]

Raises

CloudError

delete(resource_group_name, express_route_gateway_name, connection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a connection to a ExpressRoute circuit.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_gateway_name (str) – The name of the ExpressRoute gateway.
connection_name (str) – The name of the connection subresource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, express_route_gateway_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified ExpressRouteConnection.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_gateway_name (str) – The name of the ExpressRoute gateway.
connection_name (str) – The name of the ExpressRoute connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteConnection or ClientRawResponse if raw=true

Return type

ExpressRouteConnection or ClientRawResponse

Raises

CloudError

list(resource_group_name, express_route_gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists ExpressRouteConnections.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_gateway_name (str) – The name of the ExpressRoute gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteConnectionList or ClientRawResponse if raw=true

Return type

ExpressRouteConnectionList or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteCrossConnectionPeeringsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteCrossConnectionPeeringsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, cross_connection_name, peering_name, peering_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a peering in the specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
peering_name (str) – The name of the peering.
peering_parameters (ExpressRouteCrossConnectionPeering) – Parameters supplied to the create or update ExpressRouteCrossConnection peering operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCrossConnectionPeering or ClientRawResponse<ExpressRouteCrossConnectionPeering> if raw==True

Return type

AzureOperationPoller[ExpressRouteCrossConnectionPeering] or AzureOperationPoller[ClientRawResponse[ExpressRouteCrossConnectionPeering]]

Raises

CloudError

delete(resource_group_name, cross_connection_name, peering_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified peering from the ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
peering_name (str) – The name of the peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, cross_connection_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified peering for the ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
peering_name (str) – The name of the peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCrossConnectionPeering or ClientRawResponse if raw=true

Return type

ExpressRouteCrossConnectionPeering or ClientRawResponse

Raises

CloudError

list(resource_group_name, cross_connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all peerings in a specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCrossConnectionPeering

Return type

ExpressRouteCrossConnectionPeeringPaged[ExpressRouteCrossConnectionPeering]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteCrossConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteCrossConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, cross_connection_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Update the specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
parameters (ExpressRouteCrossConnection) – Parameters supplied to the update express route crossConnection operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCrossConnection or ClientRawResponse<ExpressRouteCrossConnection> if raw==True

Return type

AzureOperationPoller[ExpressRouteCrossConnection] or AzureOperationPoller[ClientRawResponse[ExpressRouteCrossConnection]]

Raises

CloudError

get(resource_group_name, cross_connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets details about the specified ExpressRouteCrossConnection.

Parameters

resource_group_name (str) – The name of the resource group (peering location of the circuit).
cross_connection_name (str) – The name of the ExpressRouteCrossConnection (service key of the circuit).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteCrossConnection or ClientRawResponse if raw=true

Return type

ExpressRouteCrossConnection or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all the ExpressRouteCrossConnections in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCrossConnection

Return type

ExpressRouteCrossConnectionPaged[ExpressRouteCrossConnection]

Raises

CloudError

list_arp_table(resource_group_name, cross_connection_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the currently advertised ARP table associated with the express route cross connection in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
peering_name (str) – The name of the peering.
device_path (str) – The path of the device
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsArpTableListResult or ClientRawResponse<ExpressRouteCircuitsArpTableListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsArpTableListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsArpTableListResult]]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all the ExpressRouteCrossConnections in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteCrossConnection

Return type

ExpressRouteCrossConnectionPaged[ExpressRouteCrossConnection]

Raises

CloudError

list_routes_table(resource_group_name, cross_connection_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the currently advertised routes table associated with the express route cross connection in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
peering_name (str) – The name of the peering.
device_path (str) – The path of the device.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCircuitsRoutesTableListResult or ClientRawResponse<ExpressRouteCircuitsRoutesTableListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCircuitsRoutesTableListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCircuitsRoutesTableListResult]]

Raises

CloudError

list_routes_table_summary(resource_group_name, cross_connection_name, peering_name, device_path, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the route table summary associated with the express route cross connection in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the ExpressRouteCrossConnection.
peering_name (str) – The name of the peering.
device_path (str) – The path of the device.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCrossConnectionsRoutesTableSummaryListResult or ClientRawResponse<ExpressRouteCrossConnectionsRoutesTableSummaryListResult> if raw==True

Return type

AzureOperationPoller[ExpressRouteCrossConnectionsRoutesTableSummaryListResult] or AzureOperationPoller[ClientRawResponse[ExpressRouteCrossConnectionsRoutesTableSummaryListResult]]

Raises

CloudError

update_tags(resource_group_name, cross_connection_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an express route cross connection tags.

Parameters

resource_group_name (str) – The name of the resource group.
cross_connection_name (str) – The name of the cross connection.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteCrossConnection or ClientRawResponse<ExpressRouteCrossConnection> if raw==True

Return type

AzureOperationPoller[ExpressRouteCrossConnection] or AzureOperationPoller[ClientRawResponse[ExpressRouteCrossConnection]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteGatewaysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a ExpressRoute gateway in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_gateway_name (str) – The name of the ExpressRoute gateway.
put_express_route_gateway_parameters (ExpressRouteGateway) – Parameters required in an ExpressRoute gateway PUT operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRouteGateway or ClientRawResponse<ExpressRouteGateway> if raw==True

Return type

AzureOperationPoller[ExpressRouteGateway] or AzureOperationPoller[ClientRawResponse[ExpressRouteGateway]]

Raises

CloudError

delete(resource_group_name, express_route_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_gateway_name (str) – The name of the ExpressRoute gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, express_route_gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Fetches the details of a ExpressRoute gateway in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_gateway_name (str) – The name of the ExpressRoute gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteGateway or ClientRawResponse if raw=true

Return type

ExpressRouteGateway or ClientRawResponse

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists ExpressRoute gateways in a given resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteGatewayList or ClientRawResponse if raw=true

Return type

ExpressRouteGatewayList or ClientRawResponse

Raises

CloudError

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]¶

Lists ExpressRoute gateways under a given subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteGatewayList or ClientRawResponse if raw=true

Return type

ExpressRouteGatewayList or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteLinksOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteLinksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, express_route_port_name, link_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the specified ExpressRouteLink resource.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of the ExpressRoutePort resource.
link_name (str) – The name of the ExpressRouteLink resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRouteLink or ClientRawResponse if raw=true

Return type

ExpressRouteLink or ClientRawResponse

Raises

CloudError

list(resource_group_name, express_route_port_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of the ExpressRoutePort resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteLink

Return type

ExpressRouteLinkPaged[ExpressRouteLink]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRoutePortsLocationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRoutePortsLocationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(location_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.

Parameters

location_name (str) – Name of the requested ExpressRoutePort peering location.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRoutePortsLocation or ClientRawResponse if raw=true

Return type

ExpressRoutePortsLocation or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRoutePortsLocation

Return type

ExpressRoutePortsLocationPaged[ExpressRoutePortsLocation]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRoutePortsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRoutePortsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, express_route_port_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates the specified ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of the ExpressRoutePort resource.
parameters (ExpressRoutePort) – Parameters supplied to the create ExpressRoutePort operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRoutePort or ClientRawResponse<ExpressRoutePort> if raw==True

Return type

AzureOperationPoller[ExpressRoutePort] or AzureOperationPoller[ClientRawResponse[ExpressRoutePort]]

Raises

CloudError

delete(resource_group_name, express_route_port_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of the ExpressRoutePort resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, express_route_port_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the requested ExpressRoutePort resource.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of ExpressRoutePort.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExpressRoutePort or ClientRawResponse if raw=true

Return type

ExpressRoutePort or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

List all the ExpressRoutePort resources in the specified subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRoutePort

Return type

ExpressRoutePortPaged[ExpressRoutePort]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

List all the ExpressRoutePort resources in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRoutePort

Return type

ExpressRoutePortPaged[ExpressRoutePort]

Raises

CloudError

update_tags(resource_group_name, express_route_port_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Update ExpressRoutePort tags.

Parameters

resource_group_name (str) – The name of the resource group.
express_route_port_name (str) – The name of the ExpressRoutePort resource.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExpressRoutePort or ClientRawResponse<ExpressRoutePort> if raw==True

Return type

AzureOperationPoller[ExpressRoutePort] or AzureOperationPoller[ClientRawResponse[ExpressRoutePort]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ExpressRouteServiceProvidersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExpressRouteServiceProvidersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the available express route service providers.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExpressRouteServiceProvider

Return type

ExpressRouteServiceProviderPaged[ExpressRouteServiceProvider]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.HubVirtualNetworkConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

HubVirtualNetworkConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, virtual_hub_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a HubVirtualNetworkConnection.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
connection_name (str) – The name of the vpn connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

HubVirtualNetworkConnection or ClientRawResponse if raw=true

Return type

HubVirtualNetworkConnection or ClientRawResponse

Raises

HubVirtualNetworkConnectionPaged[HubVirtualNetworkConnection]

list(resource_group_name, virtual_hub_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of all HubVirtualNetworkConnections.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of HubVirtualNetworkConnection

Return type

Raises

InboundNatRulePaged[InboundNatRule]

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.InboundNatRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

InboundNatRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, load_balancer_name, inbound_nat_rule_name, inbound_nat_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a load balancer inbound nat rule.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
inbound_nat_rule_name (str) – The name of the inbound nat rule.
inbound_nat_rule_parameters (InboundNatRule) – Parameters supplied to the create or update inbound nat rule operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InboundNatRule or ClientRawResponse<InboundNatRule> if raw==True

Return type

AzureOperationPoller[InboundNatRule] or AzureOperationPoller[ClientRawResponse[InboundNatRule]]

Raises

CloudError

delete(resource_group_name, load_balancer_name, inbound_nat_rule_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified load balancer inbound nat rule.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
inbound_nat_rule_name (str) – The name of the inbound nat rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, load_balancer_name, inbound_nat_rule_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified load balancer inbound nat rule.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
inbound_nat_rule_name (str) – The name of the inbound nat rule.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

InboundNatRule or ClientRawResponse if raw=true

Return type

InboundNatRule or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the inbound nat rules in a load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of InboundNatRule

Return type

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.InterfaceEndpointsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

InterfaceEndpointsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, interface_endpoint_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an interface endpoint in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
interface_endpoint_name (str) – The name of the interface endpoint.
parameters (InterfaceEndpoint) – Parameters supplied to the create or update interface endpoint operation
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InterfaceEndpoint or ClientRawResponse<InterfaceEndpoint> if raw==True

Return type

AzureOperationPoller[InterfaceEndpoint] or AzureOperationPoller[ClientRawResponse[InterfaceEndpoint]]

Raises

CloudError

delete(resource_group_name, interface_endpoint_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified interface endpoint.

Parameters

resource_group_name (str) – The name of the resource group.
interface_endpoint_name (str) – The name of the interface endpoint.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, interface_endpoint_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified interface endpoint by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
interface_endpoint_name (str) – The name of the interface endpoint.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

InterfaceEndpoint or ClientRawResponse if raw=true

Return type

InterfaceEndpoint or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all interface endpoints in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of InterfaceEndpoint

Return type

InterfaceEndpointPaged[InterfaceEndpoint]

Raises

CloudError

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all interface endpoints in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of InterfaceEndpoint

Return type

InterfaceEndpointPaged[InterfaceEndpoint]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LoadBalancerBackendAddressPoolsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerBackendAddressPoolsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, load_balancer_name, backend_address_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets load balancer backend address pool.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
backend_address_pool_name (str) – The name of the backend address pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

BackendAddressPool or ClientRawResponse if raw=true

Return type

BackendAddressPool or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the load balancer backed address pools.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of BackendAddressPool

Return type

BackendAddressPoolPaged[BackendAddressPool]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LoadBalancerFrontendIPConfigurationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerFrontendIPConfigurationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, load_balancer_name, frontend_ip_configuration_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets load balancer frontend IP configuration.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
frontend_ip_configuration_name (str) – The name of the frontend IP configuration.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

FrontendIPConfiguration or ClientRawResponse if raw=true

Return type

FrontendIPConfiguration or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the load balancer frontend IP configurations.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of FrontendIPConfiguration

Return type

FrontendIPConfigurationPaged[FrontendIPConfiguration]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LoadBalancerLoadBalancingRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerLoadBalancingRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, load_balancer_name, load_balancing_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified load balancer load balancing rule.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
load_balancing_rule_name (str) – The name of the load balancing rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

LoadBalancingRule or ClientRawResponse if raw=true

Return type

LoadBalancingRule or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the load balancing rules in a load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancingRule

Return type

LoadBalancingRulePaged[LoadBalancingRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LoadBalancerNetworkInterfacesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerNetworkInterfacesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets associated load balancer network interfaces.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

OutboundRulePaged[OutboundRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LoadBalancerOutboundRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerOutboundRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, load_balancer_name, outbound_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified load balancer outbound rule.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
outbound_rule_name (str) – The name of the outbound rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

OutboundRule or ClientRawResponse if raw=true

Return type

OutboundRule or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the outbound rules in a load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of OutboundRule

Return type

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LoadBalancerProbesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancerProbesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, load_balancer_name, probe_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets load balancer probe.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
probe_name (str) – The name of the probe.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Probe or ClientRawResponse if raw=true

Return type

Probe or ClientRawResponse

Raises

CloudError

list(resource_group_name, load_balancer_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the load balancer probes.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Probe

Return type

ProbePaged[Probe]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LoadBalancersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoadBalancersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, load_balancer_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
parameters (LoadBalancer) – Parameters supplied to the create or update load balancer operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LoadBalancer or ClientRawResponse<LoadBalancer> if raw==True

Return type

AzureOperationPoller[LoadBalancer] or AzureOperationPoller[ClientRawResponse[LoadBalancer]]

Raises

CloudError

delete(resource_group_name, load_balancer_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, load_balancer_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified load balancer.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

LoadBalancer or ClientRawResponse if raw=true

Return type

LoadBalancer or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the load balancers in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancer

Return type

LoadBalancerPaged[LoadBalancer]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the load balancers in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancer

Return type

LoadBalancerPaged[LoadBalancer]

Raises

CloudError

update_tags(resource_group_name, load_balancer_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a load balancer tags.

Parameters

resource_group_name (str) – The name of the resource group.
load_balancer_name (str) – The name of the load balancer.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LoadBalancer or ClientRawResponse<LoadBalancer> if raw==True

Return type

AzureOperationPoller[LoadBalancer] or AzureOperationPoller[ClientRawResponse[LoadBalancer]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.LocalNetworkGatewaysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LocalNetworkGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a local network gateway in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.
parameters (LocalNetworkGateway) – Parameters supplied to the create or update local network gateway operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LocalNetworkGateway or ClientRawResponse<LocalNetworkGateway> if raw==True

Return type

AzureOperationPoller[LocalNetworkGateway] or AzureOperationPoller[ClientRawResponse[LocalNetworkGateway]]

Raises

CloudError

delete(resource_group_name, local_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified local network gateway.

Parameters

resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, local_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified local network gateway in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

LocalNetworkGateway or ClientRawResponse if raw=true

Return type

LocalNetworkGateway or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the local network gateways in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LocalNetworkGateway

Return type

LocalNetworkGatewayPaged[LocalNetworkGateway]

Raises

CloudError

update_tags(resource_group_name, local_network_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a local network gateway tags.

Parameters

resource_group_name (str) – The name of the resource group.
local_network_gateway_name (str) – The name of the local network gateway.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LocalNetworkGateway or ClientRawResponse<LocalNetworkGateway> if raw==True

Return type

AzureOperationPoller[LocalNetworkGateway] or AzureOperationPoller[ClientRawResponse[LocalNetworkGateway]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.NetworkInterfaceIPConfigurationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkInterfaceIPConfigurationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, network_interface_name, ip_configuration_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified network interface ip configuration.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
ip_configuration_name (str) – The name of the ip configuration name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkInterfaceIPConfiguration or ClientRawResponse if raw=true

Return type

NetworkInterfaceIPConfiguration or ClientRawResponse

Raises

CloudError

list(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all ip configurations in a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterfaceIPConfiguration

Return type

NetworkInterfaceIPConfigurationPaged[NetworkInterfaceIPConfiguration]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.NetworkInterfaceLoadBalancersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkInterfaceLoadBalancersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)[source]¶

List all load balancers in a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LoadBalancer

Return type

LoadBalancerPaged[LoadBalancer]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.NetworkInterfaceTapConfigurationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkInterfaceTapConfigurationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, network_interface_name, tap_configuration_name, tap_configuration_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a Tap configuration in the specified NetworkInterface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
tap_configuration_name (str) – The name of the tap configuration.
tap_configuration_parameters (NetworkInterfaceTapConfiguration) – Parameters supplied to the create or update tap configuration operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkInterfaceTapConfiguration or ClientRawResponse<NetworkInterfaceTapConfiguration> if raw==True

Return type

AzureOperationPoller[NetworkInterfaceTapConfiguration] or AzureOperationPoller[ClientRawResponse[NetworkInterfaceTapConfiguration]]

Raises

CloudError

delete(resource_group_name, network_interface_name, tap_configuration_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified tap configuration from the NetworkInterface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
tap_configuration_name (str) – The name of the tap configuration.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, network_interface_name, tap_configuration_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the specified tap configuration on a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
tap_configuration_name (str) – The name of the tap configuration.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkInterfaceTapConfiguration or ClientRawResponse if raw=true

Return type

NetworkInterfaceTapConfiguration or ClientRawResponse

Raises

CloudError

list(resource_group_name, network_interface_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get all Tap configurations in a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterfaceTapConfiguration

Return type

NetworkInterfaceTapConfigurationPaged[NetworkInterfaceTapConfiguration]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.NetworkInterfacesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkInterfacesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name, network_interface_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
parameters (NetworkInterface) – Parameters supplied to the create or update network interface operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkInterface or ClientRawResponse<NetworkInterface> if raw==True

Return type

AzureOperationPoller[NetworkInterface] or AzureOperationPoller[ClientRawResponse[NetworkInterface]]

Raises

CloudError

delete(resource_group_name, network_interface_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, network_interface_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about the specified network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkInterface or ClientRawResponse if raw=true

Return type

NetworkInterface or ClientRawResponse

Raises

CloudError

get_effective_route_table(resource_group_name, network_interface_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets all route tables applied to a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns EffectiveRouteListResult or ClientRawResponse<EffectiveRouteListResult> if raw==True

Return type

AzureOperationPoller[EffectiveRouteListResult] or AzureOperationPoller[ClientRawResponse[EffectiveRouteListResult]]

Raises

CloudError

get_virtual_machine_scale_set_ip_configuration(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, ip_configuration_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
ip_configuration_name (str) – The name of the ip configuration.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkInterfaceIPConfiguration or ClientRawResponse if raw=true

Return type

NetworkInterfaceIPConfiguration or ClientRawResponse

Raises

CloudError

get_virtual_machine_scale_set_network_interface(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkInterface or ClientRawResponse if raw=true

Return type

NetworkInterface or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network interfaces in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network interfaces in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

NetworkInterfaceIPConfigurationPaged[NetworkInterfaceIPConfiguration]

Raises

CloudError

list_effective_network_security_groups(resource_group_name, network_interface_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets all network security groups applied to a network interface.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns EffectiveNetworkSecurityGroupListResult or ClientRawResponse<EffectiveNetworkSecurityGroupListResult> if raw==True

Return type

AzureOperationPoller[EffectiveNetworkSecurityGroupListResult] or AzureOperationPoller[ClientRawResponse[EffectiveNetworkSecurityGroupListResult]]

Raises

CloudError

list_virtual_machine_scale_set_ip_configurations(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterfaceIPConfiguration

Return type

Raises

CloudError

list_virtual_machine_scale_set_network_interfaces(resource_group_name, virtual_machine_scale_set_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network interfaces in a virtual machine scale set.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

Raises

CloudError

list_virtual_machine_scale_set_vm_network_interfaces(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, custom_headers=None, raw=False, **operation_config)[source]¶

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

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkInterface

Return type

Raises

CloudError

update_tags(resource_group_name, network_interface_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a network interface tags.

Parameters

resource_group_name (str) – The name of the resource group.
network_interface_name (str) – The name of the network interface.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkInterface or ClientRawResponse<NetworkInterface> if raw==True

Return type

AzureOperationPoller[NetworkInterface] or AzureOperationPoller[ClientRawResponse[NetworkInterface]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.NetworkManagementClientOperationsMixin[source]¶

Bases: object

check_dns_name_availability(location, domain_name_label, custom_headers=None, raw=False, **operation_config)[source]¶

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

Parameters

location (str) – The location of the domain name.
domain_name_label (str) – The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DnsNameAvailabilityResult or ClientRawResponse if raw=true

Return type

DnsNameAvailabilityResult or ClientRawResponse

Raises

CloudError

supported_security_providers(resource_group_name, virtual_wan_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gives the supported security providers for the virtual wan.

Parameters

resource_group_name (str) – The resource group name.
virtual_wan_name (str) – The name of the VirtualWAN for which supported security providers are needed.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualWanSecurityProviders or ClientRawResponse if raw=true

Return type

VirtualWanSecurityProviders or ClientRawResponse

Raises

NetworkProfilePaged[NetworkProfile]

class azure.mgmt.network.v2018_12_01.operations.NetworkProfilesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkProfilesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, network_profile_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a network profile.

Parameters

resource_group_name (str) – The name of the resource group.
network_profile_name (str) – The name of the network profile.
parameters (NetworkProfile) – Parameters supplied to the create or update network profile operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkProfile or ClientRawResponse<NetworkProfile> if raw==True

Return type

AzureOperationPoller[NetworkProfile] or AzureOperationPoller[ClientRawResponse[NetworkProfile]]

Raises

CloudError

delete(resource_group_name, network_profile_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified network profile.

Parameters

resource_group_name (str) – The name of the resource group.
network_profile_name (str) – The name of the NetworkProfile.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, network_profile_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified network profile in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_profile_name (str) – The name of the public IP prefix.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkProfile or ClientRawResponse if raw=true

Return type

NetworkProfile or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network profiles in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkProfile

Return type

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the network profiles in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkProfile

Return type

NetworkProfilePaged[NetworkProfile]

Raises

CloudError

update_tags(resource_group_name, network_profile_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates network profile tags.

Parameters

resource_group_name (str) – The name of the resource group.
network_profile_name (str) – The name of the network profile.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkProfile or ClientRawResponse<NetworkProfile> if raw==True

Return type

AzureOperationPoller[NetworkProfile] or AzureOperationPoller[ClientRawResponse[NetworkProfile]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.NetworkSecurityGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkSecurityGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, network_security_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a network security group in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
parameters (NetworkSecurityGroup) – Parameters supplied to the create or update network security group operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkSecurityGroup or ClientRawResponse<NetworkSecurityGroup> if raw==True

Return type

AzureOperationPoller[NetworkSecurityGroup] or AzureOperationPoller[ClientRawResponse[NetworkSecurityGroup]]

Raises

CloudError

delete(resource_group_name, network_security_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified network security group.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, network_security_group_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified network security group.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkSecurityGroup or ClientRawResponse if raw=true

Return type

NetworkSecurityGroup or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network security groups in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkSecurityGroup

Return type

NetworkSecurityGroupPaged[NetworkSecurityGroup]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network security groups in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkSecurityGroup

Return type

NetworkSecurityGroupPaged[NetworkSecurityGroup]

Raises

CloudError

update_tags(resource_group_name, network_security_group_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a network security group tags.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkSecurityGroup or ClientRawResponse<NetworkSecurityGroup> if raw==True

Return type

AzureOperationPoller[NetworkSecurityGroup] or AzureOperationPoller[ClientRawResponse[NetworkSecurityGroup]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.NetworkWatchersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkWatchersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

check_connectivity(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.

Parameters

resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (ConnectivityParameters) – Parameters that determine how the connectivity check will be performed.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectivityInformation or ClientRawResponse<ConnectivityInformation> if raw==True

Return type

AzureOperationPoller[ConnectivityInformation] or AzureOperationPoller[ClientRawResponse[ConnectivityInformation]]

Raises

create_or_update(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a network watcher in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (NetworkWatcher) – Parameters that define the network watcher resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkWatcher or ClientRawResponse if raw=true

Return type

NetworkWatcher or ClientRawResponse

Raises

delete(resource_group_name, network_watcher_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified network watcher resource.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, network_watcher_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified network watcher by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkWatcher or ClientRawResponse if raw=true

Return type

NetworkWatcher or ClientRawResponse

Raises

get_azure_reachability_report(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the relative latency score for internet service providers from a specified location to Azure regions.

Parameters

resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (AzureReachabilityReportParameters) – Parameters that determine Azure reachability report configuration.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AzureReachabilityReport or ClientRawResponse<AzureReachabilityReport> if raw==True

Return type

AzureOperationPoller[AzureReachabilityReport] or AzureOperationPoller[ClientRawResponse[AzureReachabilityReport]]

Raises

get_flow_log_status(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Queries status of flow log and traffic analytics (optional) on a specified resource.

Parameters

resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
target_resource_id (str) – The target resource where getting the flow log and traffic analytics (optional) status.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FlowLogInformation or ClientRawResponse<FlowLogInformation> if raw==True

Return type

AzureOperationPoller[FlowLogInformation] or AzureOperationPoller[ClientRawResponse[FlowLogInformation]]

Raises

get_network_configuration_diagnostic(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Get network configuration diagnostic.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (NetworkConfigurationDiagnosticParameters) – Parameters to get network configuration diagnostic.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NetworkConfigurationDiagnosticResponse or ClientRawResponse<NetworkConfigurationDiagnosticResponse> if raw==True

Return type

AzureOperationPoller[NetworkConfigurationDiagnosticResponse] or AzureOperationPoller[ClientRawResponse[NetworkConfigurationDiagnosticResponse]]

Raises

get_next_hop(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the next hop from the specified VM.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (NextHopParameters) – Parameters that define the source and destination endpoint.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NextHopResult or ClientRawResponse<NextHopResult> if raw==True

Return type

AzureOperationPoller[NextHopResult] or AzureOperationPoller[ClientRawResponse[NextHopResult]]

Raises

get_topology(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the current network topology by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (TopologyParameters) – Parameters that define the representation of topology.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Topology or ClientRawResponse if raw=true

Return type

Topology or ClientRawResponse

Raises

get_troubleshooting(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Initiate troubleshooting on a specified resource.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (TroubleshootingParameters) – Parameters that define the resource to troubleshoot.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns TroubleshootingResult or ClientRawResponse<TroubleshootingResult> if raw==True

Return type

AzureOperationPoller[TroubleshootingResult] or AzureOperationPoller[ClientRawResponse[TroubleshootingResult]]

Raises

get_troubleshooting_result(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Get the last completed troubleshooting result on a specified resource.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher resource.
target_resource_id (str) – The target resource ID to query the troubleshooting result.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns TroubleshootingResult or ClientRawResponse<TroubleshootingResult> if raw==True

Return type

AzureOperationPoller[TroubleshootingResult] or AzureOperationPoller[ClientRawResponse[TroubleshootingResult]]

Raises

get_vm_security_rules(resource_group_name, network_watcher_name, target_resource_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets the configured and effective security group rules on the specified VM.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
target_resource_id (str) – ID of the target VM.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SecurityGroupViewResult or ClientRawResponse<SecurityGroupViewResult> if raw==True

Return type

AzureOperationPoller[SecurityGroupViewResult] or AzureOperationPoller[ClientRawResponse[SecurityGroupViewResult]]

Raises

NetworkWatcherPaged[NetworkWatcher]

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network watchers by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkWatcher

Return type

Raises

NetworkWatcherPaged[NetworkWatcher]

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all network watchers by subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of NetworkWatcher

Return type

Raises

list_available_providers(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Lists all available internet service providers for a specified Azure region.

Parameters

resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (AvailableProvidersListParameters) – Parameters that scope the list of available providers.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AvailableProvidersList or ClientRawResponse<AvailableProvidersList> if raw==True

Return type

AzureOperationPoller[AvailableProvidersList] or AzureOperationPoller[ClientRawResponse[AvailableProvidersList]]

Raises

set_flow_log_configuration(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Configures flow log and traffic analytics (optional) on a specified resource.

Parameters

resource_group_name (str) – The name of the network watcher resource group.
network_watcher_name (str) – The name of the network watcher resource.
parameters (FlowLogInformation) – Parameters that define the configuration of flow log.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FlowLogInformation or ClientRawResponse<FlowLogInformation> if raw==True

Return type

AzureOperationPoller[FlowLogInformation] or AzureOperationPoller[ClientRawResponse[FlowLogInformation]]

Raises

update_tags(resource_group_name, network_watcher_name, tags=None, custom_headers=None, raw=False, **operation_config)[source]¶

Updates a network watcher tags.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

NetworkWatcher or ClientRawResponse if raw=true

Return type

NetworkWatcher or ClientRawResponse

Raises

verify_ip_flow(resource_group_name, network_watcher_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Verify IP flow from the specified VM to a location given the currently configured NSG rules.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
parameters (VerificationIPFlowParameters) – Parameters that define the IP flow to be verified.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VerificationIPFlowResult or ClientRawResponse<VerificationIPFlowResult> if raw==True

Return type

AzureOperationPoller[VerificationIPFlowResult] or AzureOperationPoller[ClientRawResponse[VerificationIPFlowResult]]

Raises

OperationPaged[Operation]

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.Operations(client, config, serializer, deserializer)[source]¶

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all of the available Network Rest API operations.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.P2sVpnGatewaysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

P2sVpnGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, gateway_name, p2_svpn_gateway_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a virtual wan p2s vpn gateway if it doesn’t exist else updates the existing gateway.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway.
gateway_name (str) – The name of the gateway.
p2_svpn_gateway_parameters (P2SVpnGateway) – Parameters supplied to create or Update a virtual wan p2s vpn gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns P2SVpnGateway or ClientRawResponse<P2SVpnGateway> if raw==True

Return type

AzureOperationPoller[P2SVpnGateway] or AzureOperationPoller[ClientRawResponse[P2SVpnGateway]]

Raises

delete(resource_group_name, gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a virtual wan p2s vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway.
gateway_name (str) – The name of the gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

generate_vpn_profile(resource_group_name, gateway_name, authentication_method=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
gateway_name (str) – The name of the P2SVpnGateway.
authentication_method (str or AuthenticationMethod) – VPN client Authentication Method. Possible values are: ‘EAPTLS’ and ‘EAPMSCHAPv2’. Possible values include: ‘EAPTLS’, ‘EAPMSCHAPv2’
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnProfileResponse or ClientRawResponse<VpnProfileResponse> if raw==True

Return type

AzureOperationPoller[VpnProfileResponse] or AzureOperationPoller[ClientRawResponse[VpnProfileResponse]]

Raises

CloudError

get(resource_group_name, gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a virtual wan p2s vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway.
gateway_name (str) – The name of the gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

P2SVpnGateway or ClientRawResponse if raw=true

Return type

P2SVpnGateway or ClientRawResponse

Raises

P2SVpnGatewayPaged[P2SVpnGateway]

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the P2SVpnGateways in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of P2SVpnGateway

Return type

Raises

P2SVpnGatewayPaged[P2SVpnGateway]

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the P2SVpnGateways in a resource group.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of P2SVpnGateway

Return type

Raises

update_tags(resource_group_name, gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates virtual wan p2s vpn gateway tags.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnGateway.
gateway_name (str) – The name of the gateway.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns P2SVpnGateway or ClientRawResponse<P2SVpnGateway> if raw==True

Return type

AzureOperationPoller[P2SVpnGateway] or AzureOperationPoller[ClientRawResponse[P2SVpnGateway]]

Raises

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.P2sVpnServerConfigurationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

P2sVpnServerConfigurationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, virtual_wan_name, p2_svpn_server_configuration_name, p2_svpn_server_configuration_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a P2SVpnServerConfiguration to associate with a VirtualWan if it doesn’t exist else updates the existing P2SVpnServerConfiguration.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWan.
p2_svpn_server_configuration_name (str) – The name of the P2SVpnServerConfiguration.
p2_svpn_server_configuration_parameters (P2SVpnServerConfiguration) – Parameters supplied to create or Update a P2SVpnServerConfiguration.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns P2SVpnServerConfiguration or ClientRawResponse<P2SVpnServerConfiguration> if raw==True

Return type

AzureOperationPoller[P2SVpnServerConfiguration] or AzureOperationPoller[ClientRawResponse[P2SVpnServerConfiguration]]

Raises

delete(resource_group_name, virtual_wan_name, p2_svpn_server_configuration_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a P2SVpnServerConfiguration.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnServerConfiguration.
virtual_wan_name (str) – The name of the VirtualWan.
p2_svpn_server_configuration_name (str) – The name of the P2SVpnServerConfiguration.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, virtual_wan_name, p2_svpn_server_configuration_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a P2SVpnServerConfiguration.

Parameters

resource_group_name (str) – The resource group name of the P2SVpnServerConfiguration.
virtual_wan_name (str) – The name of the VirtualWan.
p2_svpn_server_configuration_name (str) – The name of the P2SVpnServerConfiguration.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

P2SVpnServerConfiguration or ClientRawResponse if raw=true

Return type

P2SVpnServerConfiguration or ClientRawResponse

Raises

P2SVpnServerConfigurationPaged[P2SVpnServerConfiguration]

list_by_virtual_wan(resource_group_name, virtual_wan_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all P2SVpnServerConfigurations for a particular VirtualWan.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of P2SVpnServerConfiguration

Return type

Raises

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.PacketCapturesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PacketCapturesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create(resource_group_name, network_watcher_name, packet_capture_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create and start a packet capture on the specified VM.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.
parameters (PacketCapture) – Parameters that define the create packet capture operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PacketCaptureResult or ClientRawResponse<PacketCaptureResult> if raw==True

Return type

AzureOperationPoller[PacketCaptureResult] or AzureOperationPoller[ClientRawResponse[PacketCaptureResult]]

Raises

delete(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified packet capture session.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a packet capture session by name.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PacketCaptureResult or ClientRawResponse if raw=true

Return type

PacketCaptureResult or ClientRawResponse

Raises

get_status(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Query the status of a running packet capture session.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the Network Watcher resource.
packet_capture_name (str) – The name given to the packet capture session.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PacketCaptureQueryStatusResult or ClientRawResponse<PacketCaptureQueryStatusResult> if raw==True

Return type

AzureOperationPoller[PacketCaptureQueryStatusResult] or AzureOperationPoller[ClientRawResponse[PacketCaptureQueryStatusResult]]

Raises

PacketCaptureResultPaged[PacketCaptureResult]

list(resource_group_name, network_watcher_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all packet capture sessions within the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the Network Watcher resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PacketCaptureResult

Return type

Raises

stop(resource_group_name, network_watcher_name, packet_capture_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Stops a specified packet capture session.

Parameters

resource_group_name (str) – The name of the resource group.
network_watcher_name (str) – The name of the network watcher.
packet_capture_name (str) – The name of the packet capture session.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

PeerExpressRouteCircuitConnectionPaged[PeerExpressRouteCircuitConnection]

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.PeerExpressRouteCircuitConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PeerExpressRouteCircuitConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

get(resource_group_name, circuit_name, peering_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the express route circuit.
peering_name (str) – The name of the peering.
connection_name (str) – The name of the peer express route circuit connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PeerExpressRouteCircuitConnection or ClientRawResponse if raw=true

Return type

PeerExpressRouteCircuitConnection or ClientRawResponse

Raises

CloudError

list(resource_group_name, circuit_name, peering_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all global reach peer connections associated with a private peering in an express route circuit.

Parameters

resource_group_name (str) – The name of the resource group.
circuit_name (str) – The name of the circuit.
peering_name (str) – The name of the peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PeerExpressRouteCircuitConnection

Return type

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.PublicIPAddressesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PublicIPAddressesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name, public_ip_address_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a static or dynamic public IP address.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_address_name (str) – The name of the public IP address.
parameters (PublicIPAddress) – Parameters supplied to the create or update public IP address operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PublicIPAddress or ClientRawResponse<PublicIPAddress> if raw==True

Return type

AzureOperationPoller[PublicIPAddress] or AzureOperationPoller[ClientRawResponse[PublicIPAddress]]

Raises

CloudError

delete(resource_group_name, public_ip_address_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified public IP address.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_address_name (str) – The name of the subnet.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, public_ip_address_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified public IP address in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_address_name (str) – The name of the subnet.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PublicIPAddress or ClientRawResponse if raw=true

Return type

PublicIPAddress or ClientRawResponse

Raises

CloudError

get_virtual_machine_scale_set_public_ip_address(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, ip_configuration_name, public_ip_address_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Get the specified public IP address in a virtual machine scale set.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The name of the network interface.
ip_configuration_name (str) – The name of the IP configuration.
public_ip_address_name (str) – The name of the public IP Address.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PublicIPAddress or ClientRawResponse if raw=true

Return type

PublicIPAddress or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all public IP addresses in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the public IP addresses in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

Raises

CloudError

list_virtual_machine_scale_set_public_ip_addresses(resource_group_name, virtual_machine_scale_set_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about all public IP addresses on a virtual machine scale set level.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

Raises

CloudError

list_virtual_machine_scale_set_vm_public_ip_addresses(resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, ip_configuration_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_machine_scale_set_name (str) – The name of the virtual machine scale set.
virtualmachine_index (str) – The virtual machine index.
network_interface_name (str) – The network interface name.
ip_configuration_name (str) – The IP configuration name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPAddress

Return type

PublicIPPrefixPaged[PublicIPPrefix]

Raises

CloudError

update_tags(resource_group_name, public_ip_address_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates public IP address tags.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_address_name (str) – The name of the public IP address.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PublicIPAddress or ClientRawResponse<PublicIPAddress> if raw==True

Return type

AzureOperationPoller[PublicIPAddress] or AzureOperationPoller[ClientRawResponse[PublicIPAddress]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.PublicIPPrefixesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PublicIPPrefixesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, public_ip_prefix_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a static or dynamic public IP prefix.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_prefix_name (str) – The name of the public IP prefix.
parameters (PublicIPPrefix) – Parameters supplied to the create or update public IP prefix operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PublicIPPrefix or ClientRawResponse<PublicIPPrefix> if raw==True

Return type

AzureOperationPoller[PublicIPPrefix] or AzureOperationPoller[ClientRawResponse[PublicIPPrefix]]

Raises

CloudError

delete(resource_group_name, public_ip_prefix_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified public IP prefix.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_prefix_name (str) – The name of the PublicIpPrefix.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, public_ip_prefix_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified public IP prefix in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_prefix_name (str) – The name of the public IP prefix.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PublicIPPrefix or ClientRawResponse if raw=true

Return type

PublicIPPrefix or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all public IP prefixes in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPPrefix

Return type

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the public IP prefixes in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PublicIPPrefix

Return type

PublicIPPrefixPaged[PublicIPPrefix]

Raises

CloudError

update_tags(resource_group_name, public_ip_prefix_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates public IP prefix tags.

Parameters

resource_group_name (str) – The name of the resource group.
public_ip_prefix_name (str) – The name of the public IP prefix.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PublicIPPrefix or ClientRawResponse<PublicIPPrefix> if raw==True

Return type

AzureOperationPoller[PublicIPPrefix] or AzureOperationPoller[ClientRawResponse[PublicIPPrefix]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.RouteFilterRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RouteFilterRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a route in the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
rule_name (str) – The name of the route filter rule.
route_filter_rule_parameters (RouteFilterRule) – Parameters supplied to the create or update route filter rule operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilterRule or ClientRawResponse<RouteFilterRule> if raw==True

Return type

AzureOperationPoller[RouteFilterRule] or AzureOperationPoller[ClientRawResponse[RouteFilterRule]]

Raises

CloudError

delete(resource_group_name, route_filter_name, rule_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified rule from a route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
rule_name (str) – The name of the rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, route_filter_name, rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified rule from a route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
rule_name (str) – The name of the rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RouteFilterRule or ClientRawResponse if raw=true

Return type

RouteFilterRule or ClientRawResponse

Raises

CloudError

list_by_route_filter(resource_group_name, route_filter_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all RouteFilterRules in a route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RouteFilterRule

Return type

RouteFilterRulePaged[RouteFilterRule]

Raises

CloudError

update(resource_group_name, route_filter_name, rule_name, route_filter_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a route in the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
rule_name (str) – The name of the route filter rule.
route_filter_rule_parameters (PatchRouteFilterRule) – Parameters supplied to the update route filter rule operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilterRule or ClientRawResponse<RouteFilterRule> if raw==True

Return type

AzureOperationPoller[RouteFilterRule] or AzureOperationPoller[ClientRawResponse[RouteFilterRule]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.RouteFiltersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RouteFiltersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a route filter in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
route_filter_parameters (RouteFilter) – Parameters supplied to the create or update route filter operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilter or ClientRawResponse<RouteFilter> if raw==True

Return type

AzureOperationPoller[RouteFilter] or AzureOperationPoller[ClientRawResponse[RouteFilter]]

Raises

CloudError

delete(resource_group_name, route_filter_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, route_filter_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified route filter.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
expand (str) – Expands referenced express route bgp peering resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RouteFilter or ClientRawResponse if raw=true

Return type

RouteFilter or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all route filters in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RouteFilter

Return type

RouteFilterPaged[RouteFilter]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all route filters in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RouteFilter

Return type

RouteFilterPaged[RouteFilter]

Raises

CloudError

update(resource_group_name, route_filter_name, route_filter_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a route filter in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
route_filter_name (str) – The name of the route filter.
route_filter_parameters (PatchRouteFilter) – Parameters supplied to the update route filter operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteFilter or ClientRawResponse<RouteFilter> if raw==True

Return type

AzureOperationPoller[RouteFilter] or AzureOperationPoller[ClientRawResponse[RouteFilter]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.RouteTablesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RouteTablesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, route_table_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Create or updates a route table in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
parameters (RouteTable) – Parameters supplied to the create or update route table operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteTable or ClientRawResponse<RouteTable> if raw==True

Return type

AzureOperationPoller[RouteTable] or AzureOperationPoller[ClientRawResponse[RouteTable]]

Raises

CloudError

delete(resource_group_name, route_table_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, route_table_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RouteTable or ClientRawResponse if raw=true

Return type

RouteTable or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all route tables in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RouteTable

Return type

RouteTablePaged[RouteTable]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all route tables in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RouteTable

Return type

RouteTablePaged[RouteTable]

Raises

CloudError

update_tags(resource_group_name, route_table_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a route table tags.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RouteTable or ClientRawResponse<RouteTable> if raw==True

Return type

AzureOperationPoller[RouteTable] or AzureOperationPoller[ClientRawResponse[RouteTable]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.RoutesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RoutesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, route_table_name, route_name, route_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a route in the specified route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
route_name (str) – The name of the route.
route_parameters (Route) – Parameters supplied to the create or update route operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Route or ClientRawResponse<Route> if raw==True

Return type

AzureOperationPoller[Route] or AzureOperationPoller[ClientRawResponse[Route]]

Raises

CloudError

delete(resource_group_name, route_table_name, route_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified route from a route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
route_name (str) – The name of the route.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, route_table_name, route_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified route from a route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
route_name (str) – The name of the route.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Route or ClientRawResponse if raw=true

Return type

Route or ClientRawResponse

Raises

CloudError

list(resource_group_name, route_table_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all routes in a route table.

Parameters

resource_group_name (str) – The name of the resource group.
route_table_name (str) – The name of the route table.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Route

Return type

RoutePaged[Route]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.SecurityRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SecurityRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, network_security_group_name, security_rule_name, security_rule_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a security rule in the specified network security group.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
security_rule_name (str) – The name of the security rule.
security_rule_parameters (SecurityRule) – Parameters supplied to the create or update network security rule operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SecurityRule or ClientRawResponse<SecurityRule> if raw==True

Return type

AzureOperationPoller[SecurityRule] or AzureOperationPoller[ClientRawResponse[SecurityRule]]

Raises

CloudError

delete(resource_group_name, network_security_group_name, security_rule_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified network security rule.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
security_rule_name (str) – The name of the security rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, network_security_group_name, security_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the specified network security rule.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
security_rule_name (str) – The name of the security rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SecurityRule or ClientRawResponse if raw=true

Return type

SecurityRule or ClientRawResponse

Raises

CloudError

list(resource_group_name, network_security_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all security rules in a network security group.

Parameters

resource_group_name (str) – The name of the resource group.
network_security_group_name (str) – The name of the network security group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SecurityRule

Return type

SecurityRulePaged[SecurityRule]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ServiceEndpointPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServiceEndpointPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, service_endpoint_policy_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a service Endpoint Policies.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy.
parameters (ServiceEndpointPolicy) – Parameters supplied to the create or update service endpoint policy operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServiceEndpointPolicy or ClientRawResponse<ServiceEndpointPolicy> if raw==True

Return type

AzureOperationPoller[ServiceEndpointPolicy] or AzureOperationPoller[ClientRawResponse[ServiceEndpointPolicy]]

Raises

CloudError

delete(resource_group_name, service_endpoint_policy_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified service endpoint policy.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, service_endpoint_policy_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified service Endpoint Policies in a specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServiceEndpointPolicy or ClientRawResponse if raw=true

Return type

ServiceEndpointPolicy or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the service endpoint policies in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServiceEndpointPolicy

Return type

ServiceEndpointPolicyPaged[ServiceEndpointPolicy]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all service endpoint Policies in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServiceEndpointPolicy

Return type

ServiceEndpointPolicyPaged[ServiceEndpointPolicy]

Raises

CloudError

update(resource_group_name, service_endpoint_policy_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates service Endpoint Policies.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServiceEndpointPolicy or ClientRawResponse<ServiceEndpointPolicy> if raw==True

Return type

AzureOperationPoller[ServiceEndpointPolicy] or AzureOperationPoller[ClientRawResponse[ServiceEndpointPolicy]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.ServiceEndpointPolicyDefinitionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServiceEndpointPolicyDefinitionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, service_endpoint_policy_name, service_endpoint_policy_definition_name, service_endpoint_policy_definitions, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a service endpoint policy definition in the specified service endpoint policy.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy.
service_endpoint_policy_definition_name (str) – The name of the service endpoint policy definition name.
service_endpoint_policy_definitions (ServiceEndpointPolicyDefinition) – Parameters supplied to the create or update service endpoint policy operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServiceEndpointPolicyDefinition or ClientRawResponse<ServiceEndpointPolicyDefinition> if raw==True

Return type

AzureOperationPoller[ServiceEndpointPolicyDefinition] or AzureOperationPoller[ClientRawResponse[ServiceEndpointPolicyDefinition]]

Raises

CloudError

delete(resource_group_name, service_endpoint_policy_name, service_endpoint_policy_definition_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified ServiceEndpoint policy definitions.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the Service Endpoint Policy.
service_endpoint_policy_definition_name (str) – The name of the service endpoint policy definition.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, service_endpoint_policy_name, service_endpoint_policy_definition_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the specified service endpoint policy definitions from service endpoint policy.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy name.
service_endpoint_policy_definition_name (str) – The name of the service endpoint policy definition name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServiceEndpointPolicyDefinition or ClientRawResponse if raw=true

Return type

ServiceEndpointPolicyDefinition or ClientRawResponse

Raises

CloudError

list_by_resource_group(resource_group_name, service_endpoint_policy_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all service endpoint policy definitions in a service end point policy.

Parameters

resource_group_name (str) – The name of the resource group.
service_endpoint_policy_name (str) – The name of the service endpoint policy name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServiceEndpointPolicyDefinition

Return type

ServiceEndpointPolicyDefinitionPaged[ServiceEndpointPolicyDefinition]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.SubnetsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SubnetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, virtual_network_name, subnet_name, subnet_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a subnet in the specified virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
subnet_name (str) – The name of the subnet.
subnet_parameters (Subnet) – Parameters supplied to the create or update subnet operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Subnet or ClientRawResponse<Subnet> if raw==True

Return type

AzureOperationPoller[Subnet] or AzureOperationPoller[ClientRawResponse[Subnet]]

Raises

CloudError

delete(resource_group_name, virtual_network_name, subnet_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified subnet.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
subnet_name (str) – The name of the subnet.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, virtual_network_name, subnet_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified subnet by virtual network and resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
subnet_name (str) – The name of the subnet.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Subnet or ClientRawResponse if raw=true

Return type

Subnet or ClientRawResponse

Raises

CloudError

list(resource_group_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all subnets in a virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Subnet

Return type

SubnetPaged[Subnet]

Raises

CloudError

prepare_network_policies(resource_group_name, virtual_network_name, subnet_name, prepare_network_policies_request_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Prepares a subnet by applying network intent policies.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
subnet_name (str) – The name of the subnet.
prepare_network_policies_request_parameters (PrepareNetworkPoliciesRequest) – Parameters supplied to prepare subnet by applying network intent policies.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.UsagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

list(location, custom_headers=None, raw=False, **operation_config)[source]¶

List network usages for a subscription.

Parameters

location (str) – The location where resource usage is queried.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VirtualHubsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualHubsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, virtual_hub_name, virtual_hub_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a VirtualHub resource if it doesn’t exist else updates the existing VirtualHub.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
virtual_hub_parameters (VirtualHub) – Parameters supplied to create or update VirtualHub.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualHub or ClientRawResponse<VirtualHub> if raw==True

Return type

AzureOperationPoller[VirtualHub] or AzureOperationPoller[ClientRawResponse[VirtualHub]]

Raises

delete(resource_group_name, virtual_hub_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a VirtualHub.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, virtual_hub_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a VirtualHub.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualHub or ClientRawResponse if raw=true

Return type

VirtualHub or ClientRawResponse

Raises

VirtualHubPaged[VirtualHub]

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the VirtualHubs in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualHub

Return type

Raises

VirtualHubPaged[VirtualHub]

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the VirtualHubs in a resource group.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualHub

Return type

Raises

update_tags(resource_group_name, virtual_hub_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates VirtualHub tags.

Parameters

resource_group_name (str) – The resource group name of the VirtualHub.
virtual_hub_name (str) – The name of the VirtualHub.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualHub or ClientRawResponse<VirtualHub> if raw==True

Return type

AzureOperationPoller[VirtualHub] or AzureOperationPoller[ClientRawResponse[VirtualHub]]

Raises

VirtualNetworkGatewayConnectionPaged[VirtualNetworkGatewayConnection]

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VirtualNetworkGatewayConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualNetworkGatewayConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, virtual_network_gateway_connection_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a virtual network gateway connection in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.
parameters (VirtualNetworkGatewayConnection) – Parameters supplied to the create or update virtual network gateway connection operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGatewayConnection or ClientRawResponse<VirtualNetworkGatewayConnection> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGatewayConnection] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGatewayConnection]]

Raises

CloudError

delete(resource_group_name, virtual_network_gateway_connection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified virtual network Gateway connection.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, virtual_network_gateway_connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified virtual network gateway connection by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualNetworkGatewayConnection or ClientRawResponse if raw=true

Return type

VirtualNetworkGatewayConnection or ClientRawResponse

Raises

CloudError

get_shared_key(resource_group_name, virtual_network_gateway_connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The virtual network gateway connection shared key name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ConnectionSharedKey or ClientRawResponse if raw=true

Return type

ConnectionSharedKey or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkGatewayConnection

Return type

Raises

CloudError

reset_shared_key(resource_group_name, virtual_network_gateway_connection_name, key_length, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The virtual network gateway connection reset shared key Name.
key_length (int) – The virtual network connection reset shared key length, should between 1 and 128.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectionResetSharedKey or ClientRawResponse<ConnectionResetSharedKey> if raw==True

Return type

AzureOperationPoller[ConnectionResetSharedKey] or AzureOperationPoller[ClientRawResponse[ConnectionResetSharedKey]]

Raises

CloudError

set_shared_key(resource_group_name, virtual_network_gateway_connection_name, value, id=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The virtual network gateway connection name.
value (str) – The virtual network connection shared key value.
id (str) – Resource ID.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ConnectionSharedKey or ClientRawResponse<ConnectionSharedKey> if raw==True

Return type

AzureOperationPoller[ConnectionSharedKey] or AzureOperationPoller[ClientRawResponse[ConnectionSharedKey]]

Raises

CloudError

update_tags(resource_group_name, virtual_network_gateway_connection_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a virtual network gateway connection tags.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGatewayConnection or ClientRawResponse<VirtualNetworkGatewayConnection> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGatewayConnection] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGatewayConnection]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VirtualNetworkGatewaysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualNetworkGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, virtual_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a virtual network gateway in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
parameters (VirtualNetworkGateway) – Parameters supplied to create or update virtual network gateway operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGateway or ClientRawResponse<VirtualNetworkGateway> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGateway] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGateway]]

Raises

CloudError

delete(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified virtual network gateway.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

generate_vpn_profile(resource_group_name, virtual_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
parameters (VpnClientParameters) – Parameters supplied to the generate virtual network gateway VPN client package operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns str or ClientRawResponse<str> if raw==True

Return type

AzureOperationPoller[str] or AzureOperationPoller[ClientRawResponse[str]]

Raises

CloudError

generatevpnclientpackage(resource_group_name, virtual_network_gateway_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
parameters (VpnClientParameters) – Parameters supplied to the generate virtual network gateway VPN client package operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns str or ClientRawResponse<str> if raw==True

Return type

AzureOperationPoller[str] or AzureOperationPoller[ClientRawResponse[str]]

Raises

CloudError

get(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified virtual network gateway by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualNetworkGateway or ClientRawResponse if raw=true

Return type

VirtualNetworkGateway or ClientRawResponse

Raises

CloudError

get_advertised_routes(resource_group_name, virtual_network_gateway_name, peer, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
peer (str) – The IP address of the peer
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns GatewayRouteListResult or ClientRawResponse<GatewayRouteListResult> if raw==True

Return type

AzureOperationPoller[GatewayRouteListResult] or AzureOperationPoller[ClientRawResponse[GatewayRouteListResult]]

Raises

CloudError

get_bgp_peer_status(resource_group_name, virtual_network_gateway_name, peer=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
peer (str) – The IP address of the peer to retrieve the status of.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BgpPeerStatusListResult or ClientRawResponse<BgpPeerStatusListResult> if raw==True

Return type

AzureOperationPoller[BgpPeerStatusListResult] or AzureOperationPoller[ClientRawResponse[BgpPeerStatusListResult]]

Raises

CloudError

get_learned_routes(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns GatewayRouteListResult or ClientRawResponse<GatewayRouteListResult> if raw==True

Return type

AzureOperationPoller[GatewayRouteListResult] or AzureOperationPoller[ClientRawResponse[GatewayRouteListResult]]

Raises

CloudError

get_vpn_profile_package_url(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns str or ClientRawResponse<str> if raw==True

Return type

AzureOperationPoller[str] or AzureOperationPoller[ClientRawResponse[str]]

Raises

CloudError

get_vpnclient_ipsec_parameters(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The virtual network gateway name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnClientIPsecParameters or ClientRawResponse<VpnClientIPsecParameters> if raw==True

Return type

AzureOperationPoller[VpnClientIPsecParameters] or AzureOperationPoller[ClientRawResponse[VpnClientIPsecParameters]]

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all virtual network gateways by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkGateway

Return type

VirtualNetworkGatewayPaged[VirtualNetworkGateway]

Raises

CloudError

list_connections(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the connections in a virtual network gateway.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkGatewayConnectionListEntity

Return type

VirtualNetworkGatewayConnectionListEntityPaged[VirtualNetworkGatewayConnectionListEntity]

Raises

CloudError

reset(resource_group_name, virtual_network_gateway_name, gateway_vip=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Resets the primary of the virtual network gateway in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
gateway_vip (str) – Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGateway or ClientRawResponse<VirtualNetworkGateway> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGateway] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGateway]]

Raises

CloudError

reset_vpn_client_shared_key(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

set_vpnclient_ipsec_parameters(resource_group_name, virtual_network_gateway_name, vpnclient_ipsec_params, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
vpnclient_ipsec_params (VpnClientIPsecParameters) – Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnClientIPsecParameters or ClientRawResponse<VpnClientIPsecParameters> if raw==True

Return type

AzureOperationPoller[VpnClientIPsecParameters] or AzureOperationPoller[ClientRawResponse[VpnClientIPsecParameters]]

Raises

CloudError

supported_vpn_devices(resource_group_name, virtual_network_gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a xml format representation for supported vpn devices.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

update_tags(resource_group_name, virtual_network_gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a virtual network gateway tags.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_name (str) – The name of the virtual network gateway.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkGateway or ClientRawResponse<VirtualNetworkGateway> if raw==True

Return type

AzureOperationPoller[VirtualNetworkGateway] or AzureOperationPoller[ClientRawResponse[VirtualNetworkGateway]]

Raises

CloudError

vpn_device_configuration_script(resource_group_name, virtual_network_gateway_connection_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a xml format representation for vpn device configuration script.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_gateway_connection_name (str) – The name of the virtual network gateway connection for which the configuration script is generated.
parameters (VpnDeviceScriptParameters) – Parameters supplied to the generate vpn device script operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

str or ClientRawResponse if raw=true

Return type

str or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VirtualNetworkPeeringsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualNetworkPeeringsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, virtual_network_name, virtual_network_peering_name, virtual_network_peering_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a peering in the specified virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
virtual_network_peering_name (str) – The name of the peering.
virtual_network_peering_parameters (VirtualNetworkPeering) – Parameters supplied to the create or update virtual network peering operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkPeering or ClientRawResponse<VirtualNetworkPeering> if raw==True

Return type

AzureOperationPoller[VirtualNetworkPeering] or AzureOperationPoller[ClientRawResponse[VirtualNetworkPeering]]

Raises

CloudError

delete(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified virtual network peering.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
virtual_network_peering_name (str) – The name of the virtual network peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, virtual_network_name, virtual_network_peering_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified virtual network peering.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
virtual_network_peering_name (str) – The name of the virtual network peering.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualNetworkPeering or ClientRawResponse if raw=true

Return type

VirtualNetworkPeering or ClientRawResponse

Raises

CloudError

list(resource_group_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all virtual network peerings in a virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkPeering

Return type

VirtualNetworkPeeringPaged[VirtualNetworkPeering]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VirtualNetworkTapsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualNetworkTapsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, tap_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a Virtual Network Tap.

Parameters

resource_group_name (str) – The name of the resource group.
tap_name (str) – The name of the virtual network tap.
parameters (VirtualNetworkTap) – Parameters supplied to the create or update virtual network tap operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkTap or ClientRawResponse<VirtualNetworkTap> if raw==True

Return type

AzureOperationPoller[VirtualNetworkTap] or AzureOperationPoller[ClientRawResponse[VirtualNetworkTap]]

Raises

CloudError

delete(resource_group_name, tap_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified virtual network tap.

Parameters

resource_group_name (str) – The name of the resource group.
tap_name (str) – The name of the virtual network tap.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, tap_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets information about the specified virtual network tap.

Parameters

resource_group_name (str) – The name of the resource group.
tap_name (str) – The name of virtual network tap.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualNetworkTap or ClientRawResponse if raw=true

Return type

VirtualNetworkTap or ClientRawResponse

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the VirtualNetworkTaps in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkTap

Return type

VirtualNetworkTapPaged[VirtualNetworkTap]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all the VirtualNetworkTaps in a subscription.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkTap

Return type

VirtualNetworkTapPaged[VirtualNetworkTap]

Raises

CloudError

update_tags(resource_group_name, tap_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an VirtualNetworkTap tags.

Parameters

resource_group_name (str) – The name of the resource group.
tap_name (str) – The name of the tap.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkTap or ClientRawResponse<VirtualNetworkTap> if raw==True

Return type

AzureOperationPoller[VirtualNetworkTap] or AzureOperationPoller[ClientRawResponse[VirtualNetworkTap]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VirtualNetworksOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualNetworksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

check_ip_address_availability(resource_group_name, virtual_network_name, ip_address, custom_headers=None, raw=False, **operation_config)[source]¶

Checks whether a private IP address is available for use.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
ip_address (str) – The private IP address to be verified.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

IPAddressAvailabilityResult or ClientRawResponse if raw=true

Return type

IPAddressAvailabilityResult or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, virtual_network_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a virtual network in the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
parameters (VirtualNetwork) – Parameters supplied to the create or update virtual network operation
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetwork or ClientRawResponse<VirtualNetwork> if raw==True

Return type

AzureOperationPoller[VirtualNetwork] or AzureOperationPoller[ClientRawResponse[VirtualNetwork]]

Raises

CloudError

delete(resource_group_name, virtual_network_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the specified virtual network.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, virtual_network_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified virtual network by resource group.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
expand (str) – Expands referenced resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualNetwork or ClientRawResponse if raw=true

Return type

VirtualNetwork or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all virtual networks in a resource group.

Parameters

resource_group_name (str) – The name of the resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetwork

Return type

VirtualNetworkPaged[VirtualNetwork]

Raises

CloudError

list_all(custom_headers=None, raw=False, **operation_config)[source]¶

Gets all virtual networks in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetwork

Return type

VirtualNetworkPaged[VirtualNetwork]

Raises

CloudError

list_usage(resource_group_name, virtual_network_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists usage stats.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkUsage

Return type

VirtualNetworkUsagePaged[VirtualNetworkUsage]

Raises

CloudError

update_tags(resource_group_name, virtual_network_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a virtual network tags.

Parameters

resource_group_name (str) – The name of the resource group.
virtual_network_name (str) – The name of the virtual network.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetwork or ClientRawResponse<VirtualNetwork> if raw==True

Return type

AzureOperationPoller[VirtualNetwork] or AzureOperationPoller[ClientRawResponse[VirtualNetwork]]

Raises

CloudError

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VirtualWansOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualWansOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, virtual_wan_name, wan_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a VirtualWAN resource if it doesn’t exist else updates the existing VirtualWAN.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWAN being created or updated.
wan_parameters (VirtualWAN) – Parameters supplied to create or update VirtualWAN.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualWAN or ClientRawResponse<VirtualWAN> if raw==True

Return type

AzureOperationPoller[VirtualWAN] or AzureOperationPoller[ClientRawResponse[VirtualWAN]]

Raises

delete(resource_group_name, virtual_wan_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a VirtualWAN.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWAN being deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, virtual_wan_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a VirtualWAN.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWAN being retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualWAN or ClientRawResponse if raw=true

Return type

VirtualWAN or ClientRawResponse

Raises

VirtualWANPaged[VirtualWAN]

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the VirtualWANs in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualWAN

Return type

Raises

VirtualWANPaged[VirtualWAN]

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the VirtualWANs in a resource group.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualWAN

Return type

Raises

update_tags(resource_group_name, virtual_wan_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a VirtualWAN tags.

Parameters

resource_group_name (str) – The resource group name of the VirtualWan.
virtual_wan_name (str) – The name of the VirtualWAN being updated.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualWAN or ClientRawResponse<VirtualWAN> if raw==True

Return type

AzureOperationPoller[VirtualWAN] or AzureOperationPoller[ClientRawResponse[VirtualWAN]]

Raises

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VpnConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VpnConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, gateway_name, connection_name, vpn_connection_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a vpn connection to a scalable vpn gateway if it doesn’t exist else updates the existing connection.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
connection_name (str) – The name of the connection.
vpn_connection_parameters (VpnConnection) – Parameters supplied to create or Update a VPN Connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnConnection or ClientRawResponse<VpnConnection> if raw==True

Return type

AzureOperationPoller[VpnConnection] or AzureOperationPoller[ClientRawResponse[VpnConnection]]

Raises

delete(resource_group_name, gateway_name, connection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a vpn connection.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
connection_name (str) – The name of the connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, gateway_name, connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a vpn connection.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
connection_name (str) – The name of the vpn connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VpnConnection or ClientRawResponse if raw=true

Return type

VpnConnection or ClientRawResponse

Raises

VpnConnectionPaged[VpnConnection]

list_by_vpn_gateway(resource_group_name, gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves all vpn connections for a particular virtual wan vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VpnConnection

Return type

Raises

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VpnGatewaysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VpnGatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, gateway_name, vpn_gateway_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a virtual wan vpn gateway if it doesn’t exist else updates the existing gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
vpn_gateway_parameters (VpnGateway) – Parameters supplied to create or Update a virtual wan vpn gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnGateway or ClientRawResponse<VpnGateway> if raw==True

Return type

AzureOperationPoller[VpnGateway] or AzureOperationPoller[ClientRawResponse[VpnGateway]]

Raises

delete(resource_group_name, gateway_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a virtual wan vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, gateway_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a virtual wan vpn gateway.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VpnGateway or ClientRawResponse if raw=true

Return type

VpnGateway or ClientRawResponse

Raises

VpnGatewayPaged[VpnGateway]

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the VpnGateways in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VpnGateway

Return type

Raises

VpnGatewayPaged[VpnGateway]

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the VpnGateways in a resource group.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VpnGateway

Return type

Raises

update_tags(resource_group_name, gateway_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates virtual wan vpn gateway tags.

Parameters

resource_group_name (str) – The resource group name of the VpnGateway.
gateway_name (str) – The name of the gateway.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnGateway or ClientRawResponse<VpnGateway> if raw==True

Return type

AzureOperationPoller[VpnGateway] or AzureOperationPoller[ClientRawResponse[VpnGateway]]

Raises

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VpnSitesConfigurationOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VpnSitesConfigurationOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

download(resource_group_name, virtual_wan_name, vpn_sites=None, output_blob_sas_url=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Gives the sas-url to download the configurations for vpn-sites in a resource group.

Parameters

resource_group_name (str) – The resource group name.
virtual_wan_name (str) – The name of the VirtualWAN for which configuration of all vpn-sites is needed.
vpn_sites (list[str]) – List of resource-ids of the vpn-sites for which config is to be downloaded.
output_blob_sas_url (str) – The sas-url to download the configurations for vpn-sites
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

models = <module 'azure.mgmt.network.v2018_12_01.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-network/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/network/v2018_12_01/models/__init__.py'>¶

class azure.mgmt.network.v2018_12_01.operations.VpnSitesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VpnSitesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2018-12-01”.

create_or_update(resource_group_name, vpn_site_name, vpn_site_parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a VpnSite resource if it doesn’t exist else updates the existing VpnSite.

Parameters

resource_group_name (str) – The resource group name of the VpnSite.
vpn_site_name (str) – The name of the VpnSite being created or updated.
vpn_site_parameters (VpnSite) – Parameters supplied to create or update VpnSite.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnSite or ClientRawResponse<VpnSite> if raw==True

Return type

AzureOperationPoller[VpnSite] or AzureOperationPoller[ClientRawResponse[VpnSite]]

Raises

delete(resource_group_name, vpn_site_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a VpnSite.

Parameters

resource_group_name (str) – The resource group name of the VpnSite.
vpn_site_name (str) – The name of the VpnSite being deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

get(resource_group_name, vpn_site_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves the details of a VPN site.

Parameters

resource_group_name (str) – The resource group name of the VpnSite.
vpn_site_name (str) – The name of the VpnSite being retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VpnSite or ClientRawResponse if raw=true

Return type

VpnSite or ClientRawResponse

Raises

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the VpnSites in a subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VpnSite

Return type

VpnSitePaged[VpnSite]

Raises

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all the vpnSites in a resource group.

Parameters

resource_group_name (str) – The resource group name of the VpnSite.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VpnSite

Return type

VpnSitePaged[VpnSite]

Raises

update_tags(resource_group_name, vpn_site_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates VpnSite tags.

Parameters

resource_group_name (str) – The resource group name of the VpnSite.
vpn_site_name (str) – The name of the VpnSite being updated.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VpnSite or ClientRawResponse<VpnSite> if raw==True

Return type

AzureOperationPoller[VpnSite] or AzureOperationPoller[ClientRawResponse[VpnSite]]

Raises