azure.mgmt.network.v2016_09_01.models module¶

class azure.mgmt.network.v2016_09_01.models.AddressSpace(*, address_prefixes=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Parameters: address_prefixes (list[str]) – A list of address blocks reserved for this virtual network in CIDR notation.

class azure.mgmt.network.v2016_09_01.models.ApplicationGateway(*, id: str = None, location: str = None, tags=None, sku=None, ssl_policy=None, gateway_ip_configurations=None, authentication_certificates=None, ssl_certificates=None, frontend_ip_configurations=None, frontend_ports=None, probes=None, backend_address_pools=None, backend_http_settings_collection=None, http_listeners=None, url_path_maps=None, request_routing_rules=None, web_application_firewall_configuration=None, resource_guid: str = None, provisioning_state: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

Application gateway resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
sku (ApplicationGatewaySku) – SKU of the application gateway resource.
ssl_policy (ApplicationGatewaySslPolicy) – SSL policy of the application gateway resource.
gateway_ip_configurations (list[ApplicationGatewayIPConfiguration]) – Subnets of application the gateway resource.
authentication_certificates (list[ApplicationGatewayAuthenticationCertificate]) – Authentication certificates of the application gateway resource.
ssl_certificates (list[ApplicationGatewaySslCertificate]) – SSL certificates of the application gateway resource.
frontend_ip_configurations (list[ApplicationGatewayFrontendIPConfiguration]) – Frontend IP addresses of the application gateway resource.
frontend_ports (list[ApplicationGatewayFrontendPort]) – Frontend ports of the application gateway resource.
probes (list[ApplicationGatewayProbe]) – Probes of the application gateway resource.
backend_address_pools (list[ApplicationGatewayBackendAddressPool]) – Backend address pool of the application gateway resource.
backend_http_settings_collection (list[ApplicationGatewayBackendHttpSettings]) – Backend http settings of the application gateway resource.
http_listeners (list[ApplicationGatewayHttpListener]) – Http listeners of the application gateway resource.
url_path_maps (list[ApplicationGatewayUrlPathMap]) – URL path map of the application gateway resource.
request_routing_rules (list[ApplicationGatewayRequestRoutingRule]) – Request routing rules of the application gateway resource.
web_application_firewall_configuration (ApplicationGatewayWebApplicationFirewallConfiguration) – Web application firewall configuration.
resource_guid (str) – Resource GUID property of the application gateway resource.
provisioning_state (str) – Provisioning state of the application gateway resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
operational_state (str or ApplicationGatewayOperationalState) – Operational state of the application gateway resource. Possible values are: ‘Stopped’, ‘Started’, ‘Running’, and ‘Stopping’. Possible values include: ‘Stopped’, ‘Starting’, ‘Running’, ‘Stopping’

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayAuthenticationCertificate(*, id: str = None, data: str = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Authentication certificates of an application gateway.

Parameters

id (str) – Resource ID.
data (str) – Certificate public data.
provisioning_state (str) – Provisioning state of the authentication certificate resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendAddress(*, fqdn: str = None, ip_address: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Backend address of an application gateway.

Parameters

fqdn (str) – Fully qualified domain name (FQDN).
ip_address (str) – IP address

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendAddressPool(*, id: str = None, backend_ip_configurations=None, backend_addresses=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Backend Address Pool of an application gateway.

Parameters

id (str) – Resource ID.
backend_ip_configurations (list[NetworkInterfaceIPConfiguration]) – Collection of references to IPs defined in network interfaces.
backend_addresses (list[ApplicationGatewayBackendAddress]) – Backend addresses
provisioning_state (str) – Provisioning state of the backend address pool resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendHealth(*, backend_address_pools=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

List of ApplicationGatewayBackendHealthPool resources.

Parameters: backend_address_pools (list[ApplicationGatewayBackendHealthPool]) –

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendHealthHttpSettings(*, backend_http_settings=None, servers=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application gateway BackendHealthHttp settings.

Parameters

backend_http_settings (ApplicationGatewayBackendHttpSettings) – Reference of an ApplicationGatewayBackendHttpSettings resource.
servers (list[ApplicationGatewayBackendHealthServer]) – List of ApplicationGatewayBackendHealthServer resources.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendHealthPool(*, backend_address_pool=None, backend_http_settings_collection=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application gateway BackendHealth pool.

Parameters

backend_address_pool (ApplicationGatewayBackendAddressPool) – Reference of an ApplicationGatewayBackendAddressPool resource.
backend_http_settings_collection (list[ApplicationGatewayBackendHealthHttpSettings]) – List of ApplicationGatewayBackendHealthHttpSettings resources.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendHealthServer(*, address: str = None, ip_configuration=None, health=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application gateway backendhealth http settings.

Parameters

address (str) – IP address or FQDN of backend server.
ip_configuration (SubResource) – Reference of IP configuration of backend server.
health (str or ApplicationGatewayBackendHealthServerHealth) – Health of backend server. Possible values are: ‘Unknown’, ‘Up’, ‘Down’, and ‘Partial’. Possible values include: ‘Unknown’, ‘Up’, ‘Down’, ‘Partial’

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendHttpSettings(*, id: str = None, port: int = None, protocol=None, cookie_based_affinity=None, request_timeout: int = None, probe=None, authentication_certificates=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Backend address pool settings of an application gateway.

Parameters

id (str) – Resource ID.
port (int) – Port
protocol (str or ApplicationGatewayProtocol) – Protocol. Possible values are: ‘Http’ and ‘Https’. Possible values include: ‘Http’, ‘Https’
cookie_based_affinity (str or ApplicationGatewayCookieBasedAffinity) – Cookie based affinity. Possible values are: ‘Enabled’ and ‘Disabled’. Possible values include: ‘Enabled’, ‘Disabled’
request_timeout (int) – Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.
probe (SubResource) – Probe resource of an application gateway.
authentication_certificates (list[SubResource]) – Array of references to application gateway authentication certificates.
provisioning_state (str) – Provisioning state of the backend http settings resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayFrontendIPConfiguration(*, id: str = None, private_ip_address: str = None, private_ip_allocation_method=None, subnet=None, public_ip_address=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Frontend IP configuration of an application gateway.

Parameters

id (str) – Resource ID.
private_ip_address (str) – PrivateIPAddress of the network interface IP Configuration.
private_ip_allocation_method (str or IPAllocationMethod) – PrivateIP allocation method. Possible values are: ‘Static’ and ‘Dynamic’. Possible values include: ‘Static’, ‘Dynamic’
subnet (SubResource) – Reference of the subnet resource.
public_ip_address (SubResource) – Reference of the PublicIP resource.
provisioning_state (str) – Provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayFrontendPort(*, id: str = None, port: int = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Frontend port of an application gateway.

Parameters

id (str) – Resource ID.
port (int) – Frontend port
provisioning_state (str) – Provisioning state of the frontend port resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayHttpListener(*, id: str = None, frontend_ip_configuration=None, frontend_port=None, protocol=None, host_name: str = None, ssl_certificate=None, require_server_name_indication: bool = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Http listener of an application gateway.

Parameters

id (str) – Resource ID.
frontend_ip_configuration (SubResource) – Frontend IP configuration resource of an application gateway.
frontend_port (SubResource) – Frontend port resource of an application gateway.
protocol (str or ApplicationGatewayProtocol) – Protocol. Possible values are: ‘Http’ and ‘Https’. Possible values include: ‘Http’, ‘Https’
host_name (str) – Host name of HTTP listener.
ssl_certificate (SubResource) – SSL certificate resource of an application gateway.
require_server_name_indication (bool) – Applicable only if protocol is https. Enables SNI for multi-hosting.
provisioning_state (str) – Provisioning state of the HTTP listener resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayIPConfiguration(*, id: str = None, subnet=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

Parameters

id (str) – Resource ID.
subnet (SubResource) – Reference of the subnet resource. A subnet from where application gateway gets its private address.
provisioning_state (str) – Provisioning state of the application gateway subnet resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayPathRule(*, id: str = None, paths=None, backend_address_pool=None, backend_http_settings=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Path rule of URL path map of an application gateway.

Parameters

id (str) – Resource ID.
paths (list[str]) – Path rules of URL path map.
backend_address_pool (SubResource) – Backend address pool resource of URL path map.
backend_http_settings (SubResource) – Backend http settings resource of URL path map.
provisioning_state (str) – Path rule of URL path map resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayProbe(*, id: str = None, protocol=None, host: str = None, path: str = None, interval: int = None, timeout: int = None, unhealthy_threshold: int = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Probe of the application gateway.

Parameters

id (str) – Resource ID.
protocol (str or ApplicationGatewayProtocol) – Protocol. Possible values are: ‘Http’ and ‘Https’. Possible values include: ‘Http’, ‘Https’
host (str) – Host name to send the probe to.
path (str) – Relative path of probe. Valid path starts from ‘/’. Probe is sent to <Protocol>://<host>:<port><path>
interval (int) – The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
timeout (int) – the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.
unhealthy_threshold (int) – The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.
provisioning_state (str) – Provisioning state of the backend http settings resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayRequestRoutingRule(*, id: str = None, rule_type=None, backend_address_pool=None, backend_http_settings=None, http_listener=None, url_path_map=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Request routing rule of an application gateway.

Parameters

id (str) – Resource ID.
rule_type (str or ApplicationGatewayRequestRoutingRuleType) – Rule type. Possible values are: ‘Basic’ and ‘PathBasedRouting’. Possible values include: ‘Basic’, ‘PathBasedRouting’
backend_address_pool (SubResource) – Backend address pool resource of the application gateway.
backend_http_settings (SubResource) – Frontend port resource of the application gateway.
http_listener (SubResource) – Http listener resource of the application gateway.
url_path_map (SubResource) – URL path map resource of the application gateway.
provisioning_state (str) – Provisioning state of the request routing rule resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewaySku(*, name=None, tier=None, capacity: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SKU of an application gateway.

Parameters

name (str or ApplicationGatewaySkuName) – Name of an application gateway SKU. Possible values are: ‘Standard_Small’, ‘Standard_Medium’, ‘Standard_Large’, ‘WAF_Medium’, and ‘WAF_Large’. Possible values include: ‘Standard_Small’, ‘Standard_Medium’, ‘Standard_Large’, ‘WAF_Medium’, ‘WAF_Large’
tier (str or ApplicationGatewayTier) – Tier of an application gateway. Possible values are: ‘Standard’ and ‘WAF’. Possible values include: ‘Standard’, ‘WAF’
capacity (int) – Capacity (instance count) of an application gateway.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewaySslCertificate(*, id: str = None, data: str = None, password: str = None, public_cert_data: str = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

SSL certificates of an application gateway.

Parameters

id (str) – Resource ID.
data (str) – Base-64 encoded pfx certificate. Only applicable in PUT Request.
password (str) – Password for the pfx file specified in data. Only applicable in PUT request.
public_cert_data (str) – Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.
provisioning_state (str) – Provisioning state of the SSL certificate resource Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewaySslPolicy(*, disabled_ssl_protocols=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application gateway SSL policy.

Parameters: disabled_ssl_protocols (list[str or ApplicationGatewaySslProtocol]) – SSL protocols to be disabled on application gateway. Possible values are: ‘TLSv1_0’, ‘TLSv1_1’, and ‘TLSv1_2’.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayUrlPathMap(*, id: str = None, default_backend_address_pool=None, default_backend_http_settings=None, path_rules=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

Parameters

id (str) – Resource ID.
default_backend_address_pool (SubResource) – Default backend address pool resource of URL path map.
default_backend_http_settings (SubResource) – Default backend http settings resource of URL path map.
path_rules (list[ApplicationGatewayPathRule]) – Path rule of URL path map resource.
provisioning_state (str) – Provisioning state of the backend http settings resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayWebApplicationFirewallConfiguration(*, enabled: bool, firewall_mode=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Application gateway web application firewall configuration.

All required parameters must be populated in order to send to Azure.

Parameters

enabled (bool) – Required. Whether the web application firewall is enabled.
firewall_mode (str or ApplicationGatewayFirewallMode) – Web application firewall mode. Possible values are: ‘Detection’ and ‘Prevention’. Possible values include: ‘Detection’, ‘Prevention’

class azure.mgmt.network.v2016_09_01.models.AzureAsyncOperationResult(*, status=None, error=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Parameters

status (str or NetworkOperationStatus) – Status of the Azure async operation. Possible values are: ‘InProgress’, ‘Succeeded’, and ‘Failed’. Possible values include: ‘InProgress’, ‘Succeeded’, ‘Failed’
error (Error) –

class azure.mgmt.network.v2016_09_01.models.BackendAddressPool(*, id: str = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Pool of backend IP addresses.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
provisioning_state (str) – Get provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

backend_ip_configurations (list[NetworkInterfaceIPConfiguration]) – Gets collection of references to IP addresses defined in network interfaces.
load_balancing_rules (list[SubResource]) – Gets load balancing rules that use this backend address pool.
outbound_nat_rule (SubResource) – Gets outbound rules that use this backend address pool.

class azure.mgmt.network.v2016_09_01.models.BgpPeerStatus(**kwargs)[source]¶

Bases: msrest.serialization.Model

BgpPeerStatus.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

local_address (str) – The virtual network gateway’s local address
neighbor (str) – The remote BGP peer
asn (int) – The autonomous system number of the remote BGP peer
state (str or BgpPeerState) – The BGP peer state. Possible values include: ‘Unknown’, ‘Stopped’, ‘Idle’, ‘Connecting’, ‘Connected’
connected_duration (str) – For how long the peering has been up
routes_received (long) – The number of routes learned from this peer
messages_sent (long) – The number of BGP messages sent
messages_received (long) – The number of BGP messages received

class azure.mgmt.network.v2016_09_01.models.BgpPeerStatusListResult(*, value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for list BGP peer status API service call.

Parameters: value (list[BgpPeerStatus]) – List of BGP peers

class azure.mgmt.network.v2016_09_01.models.BgpSettings(*, asn: int = None, bgp_peering_address: str = None, peer_weight: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

BgpSettings.

Parameters

asn (long) – The BGP speaker’s ASN.
bgp_peering_address (str) – The BGP peering address and BGP identifier of this BGP speaker.
peer_weight (int) – The weight added to routes learned from this BGP speaker.

class azure.mgmt.network.v2016_09_01.models.ConnectionResetSharedKey(*, key_length: int, **kwargs)[source]¶

Bases: msrest.serialization.Model

ConnectionResetSharedKey.

All required parameters must be populated in order to send to Azure.

Parameters: key_length (int) – Required. The virtual network connection reset shared key length, should between 1 and 128.

class azure.mgmt.network.v2016_09_01.models.ConnectionSharedKey(*, value: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for GetConnectionSharedKey API service call.

All required parameters must be populated in order to send to Azure.

Parameters: value (str) – Required. The virtual network connection shared key value.

class azure.mgmt.network.v2016_09_01.models.DhcpOptions(*, dns_servers=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.

Parameters: dns_servers (list[str]) – The list of DNS servers IP addresses.

class azure.mgmt.network.v2016_09_01.models.DnsNameAvailabilityResult(*, available: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for the CheckDnsNameAvailability API service call.

Parameters: available (bool) – Domain availability (True/False).

class azure.mgmt.network.v2016_09_01.models.EffectiveNetworkSecurityGroup(*, network_security_group=None, association=None, effective_security_rules=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Effective network security group.

Parameters

network_security_group (SubResource) – The ID of network security group that is applied.
association (EffectiveNetworkSecurityGroupAssociation) –
effective_security_rules (list[EffectiveNetworkSecurityRule]) – A collection of effective security rules.

class azure.mgmt.network.v2016_09_01.models.EffectiveNetworkSecurityGroupAssociation(*, subnet=None, network_interface=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The effective network security group association.

Parameters

subnet (SubResource) – The ID of the subnet if assigned.
network_interface (SubResource) – The ID of the network interface if assigned.

class azure.mgmt.network.v2016_09_01.models.EffectiveNetworkSecurityGroupListResult(*, value=None, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for list effective network security groups API service call.

Parameters

value (list[EffectiveNetworkSecurityGroup]) – A list of effective network security groups.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2016_09_01.models.EffectiveNetworkSecurityRule(*, name: str = None, protocol=None, source_port_range: str = None, destination_port_range: str = None, source_address_prefix: str = None, destination_address_prefix: str = None, expanded_source_address_prefix=None, expanded_destination_address_prefix=None, access=None, priority: int = None, direction=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Effective network security rules.

Parameters

name (str) – The name of the security rule specified by the user (if created by the user).
protocol (str or SecurityRuleProtocol) – The network protocol this rule applies to. Possible values are: ‘Tcp’, ‘Udp’, and ‘*’. Possible values include: ‘Tcp’, ‘Udp’, ‘*’
source_port_range (str) – The source port or range.
destination_port_range (str) – The destination port or range.
source_address_prefix (str) – The source address prefix.
destination_address_prefix (str) – The destination address prefix.
expanded_source_address_prefix (list[str]) – The expanded source address prefix.
expanded_destination_address_prefix (list[str]) – Expanded destination address prefix.
access (str or SecurityRuleAccess) – Whether network traffic is allowed or denied. Possible values are: ‘Allow’ and ‘Deny’. Possible values include: ‘Allow’, ‘Deny’
priority (int) – The priority of the rule.
direction (str or SecurityRuleDirection) – The direction of the rule. Possible values are: ‘Inbound and Outbound’. Possible values include: ‘Inbound’, ‘Outbound’

class azure.mgmt.network.v2016_09_01.models.EffectiveRoute(*, name: str = None, source=None, state=None, address_prefix=None, next_hop_ip_address=None, next_hop_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Effective Route.

Parameters

name (str) – The name of the user defined route. This is optional.
source (str or EffectiveRouteSource) – Who created the route. Possible values are: ‘Unknown’, ‘User’, ‘VirtualNetworkGateway’, and ‘Default’. Possible values include: ‘Unknown’, ‘User’, ‘VirtualNetworkGateway’, ‘Default’
state (str or EffectiveRouteState) – The value of effective route. Possible values are: ‘Active’ and ‘Invalid’. Possible values include: ‘Active’, ‘Invalid’
address_prefix (list[str]) – The address prefixes of the effective routes in CIDR notation.
next_hop_ip_address (list[str]) – The IP address of the next hop of the effective route.
next_hop_type (str or RouteNextHopType) – The type of Azure hop the packet should be sent to. Possible values are: ‘VirtualNetworkGateway’, ‘VnetLocal’, ‘Internet’, ‘VirtualAppliance’, and ‘None’. Possible values include: ‘VirtualNetworkGateway’, ‘VnetLocal’, ‘Internet’, ‘VirtualAppliance’, ‘None’

class azure.mgmt.network.v2016_09_01.models.EffectiveRouteListResult(*, value=None, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for list effective route API service call.

Parameters

value (list[EffectiveRoute]) – A list of effective routes.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2016_09_01.models.Error(*, code: str = None, message: str = None, target: str = None, details=None, inner_error: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Error.

Parameters

code (str) –
message (str) –
target (str) –
details (list[ErrorDetails]) –
inner_error (str) –

class azure.mgmt.network.v2016_09_01.models.ErrorDetails(*, code: str = None, target: str = None, message: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ErrorDetails.

Parameters

code (str) –
target (str) –
message (str) –

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuit(*, id: str = None, location: str = None, tags=None, sku=None, allow_classic_operations: bool = None, circuit_provisioning_state: str = None, service_provider_provisioning_state=None, authorizations=None, peerings=None, service_key: str = None, service_provider_notes: str = None, service_provider_properties=None, provisioning_state: str = None, gateway_manager_etag: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

ExpressRouteCircuit resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
sku (ExpressRouteCircuitSku) – The SKU.
allow_classic_operations (bool) – Allow classic operations
circuit_provisioning_state (str) – The CircuitProvisioningState state of the resource.
service_provider_provisioning_state (str or ServiceProviderProvisioningState) – The ServiceProviderProvisioningState state of the resource. Possible values are ‘NotProvisioned’, ‘Provisioning’, ‘Provisioned’, and ‘Deprovisioning’. Possible values include: ‘NotProvisioned’, ‘Provisioning’, ‘Provisioned’, ‘Deprovisioning’
authorizations (list[ExpressRouteCircuitAuthorization]) – The list of authorizations.
peerings (list[ExpressRouteCircuitPeering]) – The list of peerings.
service_key (str) – The ServiceKey.
service_provider_notes (str) – The ServiceProviderNotes.
service_provider_properties (ExpressRouteCircuitServiceProviderProperties) – The ServiceProviderProperties.
provisioning_state (str) – Gets the provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
gateway_manager_etag (str) – The GatewayManager Etag.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitArpTable(*, age: int = None, interface: str = None, ip_address: str = None, mac_address: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The ARP table associated with the ExpressRouteCircuit.

Parameters

age (int) – Age
interface (str) – Interface
ip_address (str) – The IP address.
mac_address (str) – The MAC address.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitAuthorization(*, id: str = None, authorization_key: str = None, authorization_use_status=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Authorization in an ExpressRouteCircuit resource.

Parameters

id (str) – Resource ID.
authorization_key (str) – The authorization key.
authorization_use_status (str or AuthorizationUseStatus) – AuthorizationUseStatus. Possible values are: ‘Available’ and ‘InUse’. Possible values include: ‘Available’, ‘InUse’
provisioning_state (str) – Gets the provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitPeering(*, id: str = None, peering_type=None, state=None, azure_asn: int = None, peer_asn: int = None, primary_peer_address_prefix: str = None, secondary_peer_address_prefix: str = None, primary_azure_port: str = None, secondary_azure_port: str = None, shared_key: str = None, vlan_id: int = None, microsoft_peering_config=None, stats=None, provisioning_state: str = None, gateway_manager_etag: str = None, last_modified_by: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Peering in an ExpressRouteCircuit resource.

Parameters

id (str) – Resource ID.
peering_type (str or ExpressRouteCircuitPeeringType) – The PeeringType. Possible values are: ‘AzurePublicPeering’, ‘AzurePrivatePeering’, and ‘MicrosoftPeering’. Possible values include: ‘AzurePublicPeering’, ‘AzurePrivatePeering’, ‘MicrosoftPeering’
state (str or ExpressRouteCircuitPeeringState) – The state of peering. Possible values are: ‘Disabled’ and ‘Enabled’. Possible values include: ‘Disabled’, ‘Enabled’
azure_asn (int) – The Azure ASN.
peer_asn (int) – The peer ASN.
primary_peer_address_prefix (str) – The primary address prefix.
secondary_peer_address_prefix (str) – The secondary address prefix.
primary_azure_port (str) – The primary port.
secondary_azure_port (str) – The secondary port.
shared_key (str) – The shared key.
vlan_id (int) – The VLAN ID.
microsoft_peering_config (ExpressRouteCircuitPeeringConfig) – The Microsoft peering configuration.
stats (ExpressRouteCircuitStats) – Gets peering stats.
provisioning_state (str) – Gets the provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
gateway_manager_etag (str) – The GatewayManager Etag.
last_modified_by (str) – Gets whether the provider or the customer last modified the peering.
name (str) – Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitPeeringConfig(*, advertised_public_prefixes=None, advertised_public_prefixes_state=None, customer_asn: int = None, routing_registry_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Specifies the peering configuration.

Parameters

advertised_public_prefixes (list[str]) – The reference of AdvertisedPublicPrefixes.
advertised_public_prefixes_state (str or ExpressRouteCircuitPeeringAdvertisedPublicPrefixState) – AdvertisedPublicPrefixState of the Peering resource. Possible values are ‘NotConfigured’, ‘Configuring’, ‘Configured’, and ‘ValidationNeeded’. Possible values include: ‘NotConfigured’, ‘Configuring’, ‘Configured’, ‘ValidationNeeded’
customer_asn (int) – The CustomerASN of the peering.
routing_registry_name (str) – The RoutingRegistryName of the configuration.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitRoutesTable(*, network: str = None, next_hop: str = None, loc_prf: str = None, weight: int = None, path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The routes table associated with the ExpressRouteCircuit.

Parameters

network (str) – network
next_hop (str) – nextHop
loc_prf (str) – locPrf
weight (int) – weight.
path (str) – path

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitRoutesTableSummary(*, neighbor: str = None, v: int = None, as_property: int = None, up_down: str = None, state_pfx_rcd: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The routes table associated with the ExpressRouteCircuit.

Parameters

neighbor (str) – Neighbor
v (int) – BGP version number spoken to the neighbor.
as_property (int) – Autonomous system number.
up_down (str) – The length of time that the BGP session has been in the Established state, or the current status if not in the Established state.
state_pfx_rcd (str) – Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitsArpTableListResult(*, value=None, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for ListArpTable associated with the Express Route Circuits API.

Parameters

value (list[ExpressRouteCircuitArpTable]) – Gets list of the ARP table.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitServiceProviderProperties(*, service_provider_name: str = None, peering_location: str = None, bandwidth_in_mbps: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains ServiceProviderProperties in an ExpressRouteCircuit.

Parameters

service_provider_name (str) – The serviceProviderName.
peering_location (str) – The peering location.
bandwidth_in_mbps (int) – The BandwidthInMbps.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitSku(*, name: str = None, tier=None, family=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains SKU in an ExpressRouteCircuit.

Parameters

name (str) – The name of the SKU.
tier (str or ExpressRouteCircuitSkuTier) – The tier of the SKU. Possible values are ‘Standard’ and ‘Premium’. Possible values include: ‘Standard’, ‘Premium’
family (str or ExpressRouteCircuitSkuFamily) – The family of the SKU. Possible values are: ‘UnlimitedData’ and ‘MeteredData’. Possible values include: ‘UnlimitedData’, ‘MeteredData’

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitsRoutesTableListResult(*, value=None, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for ListRoutesTable associated with the Express Route Circuits API.

Parameters

value (list[ExpressRouteCircuitRoutesTable]) – The list of routes table.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitsRoutesTableSummaryListResult(*, value=None, next_link: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for ListRoutesTable associated with the Express Route Circuits API.

Parameters

value (list[ExpressRouteCircuitRoutesTableSummary]) – A list of the routes table.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitStats(*, primarybytes_in: int = None, primarybytes_out: int = None, secondarybytes_in: int = None, secondarybytes_out: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains stats associated with the peering.

Parameters

primarybytes_in (long) – Gets BytesIn of the peering.
primarybytes_out (long) – Gets BytesOut of the peering.
secondarybytes_in (long) – Gets BytesIn of the peering.
secondarybytes_out (long) – Gets BytesOut of the peering.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteServiceProvider(*, id: str = None, location: str = None, tags=None, peering_locations=None, bandwidths_offered=None, provisioning_state: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

A ExpressRouteResourceProvider object.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
peering_locations (list[str]) – Get a list of peering locations.
bandwidths_offered (list[ExpressRouteServiceProviderBandwidthsOffered]) – Gets bandwidths offered.
provisioning_state (str) – Gets the provisioning state of the resource.

Variables

name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteServiceProviderBandwidthsOffered(*, offer_name: str = None, value_in_mbps: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains bandwidths offered in ExpressRouteServiceProvider resources.

Parameters

offer_name (str) – The OfferName.
value_in_mbps (int) – The ValueInMbps.

class azure.mgmt.network.v2016_09_01.models.FlowLogInformation(*, target_resource_id: str, storage_id: str, enabled: bool, retention_policy=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Information on the configuration of flow log.

All required parameters must be populated in order to send to Azure.

Parameters

target_resource_id (str) – Required. The ID of the resource to configure for flow logging.
storage_id (str) – Required. ID of the storage account which is used to store the flow log.
enabled (bool) – Required. Flag to enable/disable flow logging.
retention_policy (RetentionPolicyParameters) –

class azure.mgmt.network.v2016_09_01.models.FlowLogStatusParameters(*, target_resource_id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define a resource to query flow log status.

All required parameters must be populated in order to send to Azure.

Parameters: target_resource_id (str) – Required. The target resource where getting the flow logging status.

class azure.mgmt.network.v2016_09_01.models.FrontendIPConfiguration(*, id: str = None, private_ip_address: str = None, private_ip_allocation_method=None, subnet=None, public_ip_address=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Frontend IP address of the load balancer.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
private_ip_address (str) – The private IP address of the IP configuration.
private_ip_allocation_method (str or IPAllocationMethod) – The Private IP allocation method. Possible values are: ‘Static’ and ‘Dynamic’. Possible values include: ‘Static’, ‘Dynamic’
subnet (Subnet) – The reference of the subnet resource.
public_ip_address (PublicIPAddress) – The reference of the Public IP resource.
provisioning_state (str) – Gets the provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

inbound_nat_rules (list[SubResource]) – Read only. Inbound rules URIs that use this frontend IP.
inbound_nat_pools (list[SubResource]) – Read only. Inbound pools URIs that use this frontend IP.
outbound_nat_rules (list[SubResource]) – Read only. Outbound rules URIs that use this frontend IP.
load_balancing_rules (list[SubResource]) – Gets load balancing rules URIs that use this frontend IP.

class azure.mgmt.network.v2016_09_01.models.GatewayRoute(**kwargs)[source]¶

Bases: msrest.serialization.Model

GatewayRoute.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

local_address (str) – The gateway’s local address
network (str) – The route’s network prefix
next_hop (str) – The route’s next hop
source_peer (str) – The peer this route was learned from
origin (str) – The source this route was learned from
as_path (str) – The route’s AS path sequence
weight (int) – The route’s weight

class azure.mgmt.network.v2016_09_01.models.GatewayRouteListResult(*, value=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

List of virtual network gateway routes.

Parameters: value (list[GatewayRoute]) – List of gateway routes

class azure.mgmt.network.v2016_09_01.models.InboundNatPool(*, protocol, frontend_port_range_start: int, frontend_port_range_end: int, backend_port: int, id: str = None, frontend_ip_configuration=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Inbound NAT pool of the load balancer.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
frontend_ip_configuration (SubResource) – A reference to frontend IP addresses.
protocol (str or TransportProtocol) – Required. The transport protocol for the endpoint. Possible values are: ‘Udp’ or ‘Tcp’. Possible values include: ‘Udp’, ‘Tcp’
frontend_port_range_start (int) – Required. The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.
frontend_port_range_end (int) – Required. The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.
backend_port (int) – Required. The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
provisioning_state (str) – Gets the provisioning state of the PublicIP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.InboundNatRule(*, id: str = None, frontend_ip_configuration=None, protocol=None, frontend_port: int = None, backend_port: int = None, idle_timeout_in_minutes: int = None, enable_floating_ip: bool = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Inbound NAT rule of the load balancer.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
frontend_ip_configuration (SubResource) – A reference to frontend IP addresses.
protocol (str or TransportProtocol) – The transport protocol for the endpoint. Possible values are: ‘Udp’ or ‘Tcp’. Possible values include: ‘Udp’, ‘Tcp’
frontend_port (int) – The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
backend_port (int) – The port used for the internal endpoint. Acceptable values range from 1 to 65535.
idle_timeout_in_minutes (int) – The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.
enable_floating_ip (bool) – Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint.
provisioning_state (str) – Gets the provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

backend_ip_configuration (NetworkInterfaceIPConfiguration) – A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backed IP.

class azure.mgmt.network.v2016_09_01.models.IPAddressAvailabilityResult(*, available: bool = None, available_ip_addresses=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for CheckIPAddressAvailability API service call.

Parameters

available (bool) – Private IP address availability.
available_ip_addresses (list[str]) – Contains other available private IP addresses if the asked for address is taken.

class azure.mgmt.network.v2016_09_01.models.IPConfiguration(*, id: str = None, private_ip_address: str = None, private_ip_allocation_method=None, subnet=None, public_ip_address=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

IPConfiguration.

Parameters

id (str) – Resource ID.
private_ip_address (str) – The private IP address of the IP configuration.
private_ip_allocation_method (str or IPAllocationMethod) – The private IP allocation method. Possible values are ‘Static’ and ‘Dynamic’. Possible values include: ‘Static’, ‘Dynamic’
subnet (Subnet) – The reference of the subnet resource.
public_ip_address (PublicIPAddress) – The reference of the public IP resource.
provisioning_state (str) – Gets the provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.LoadBalancer(*, id: str = None, location: str = None, tags=None, frontend_ip_configurations=None, backend_address_pools=None, load_balancing_rules=None, probes=None, inbound_nat_rules=None, inbound_nat_pools=None, outbound_nat_rules=None, resource_guid: str = None, provisioning_state: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

LoadBalancer resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
frontend_ip_configurations (list[FrontendIPConfiguration]) – Object representing the frontend IPs to be used for the load balancer
backend_address_pools (list[BackendAddressPool]) – Collection of backend address pools used by a load balancer
load_balancing_rules (list[LoadBalancingRule]) – Object collection representing the load balancing rules Gets the provisioning
probes (list[Probe]) – Collection of probe objects used in the load balancer
inbound_nat_rules (list[InboundNatRule]) – Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.
inbound_nat_pools (list[InboundNatPool]) – Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.
outbound_nat_rules (list[OutboundNatRule]) – The outbound NAT rules.
resource_guid (str) – The resource GUID property of the load balancer resource.
provisioning_state (str) – Gets the provisioning state of the PublicIP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.network.v2016_09_01.models.LoadBalancingRule(*, protocol, frontend_port: int, id: str = None, frontend_ip_configuration=None, backend_address_pool=None, probe=None, load_distribution=None, backend_port: int = None, idle_timeout_in_minutes: int = None, enable_floating_ip: bool = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

A load balancing rule for a load balancer.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
frontend_ip_configuration (SubResource) – A reference to frontend IP addresses.
backend_address_pool (SubResource) – A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
probe (SubResource) – The reference of the load balancer probe used by the load balancing rule.
protocol (str or TransportProtocol) – Required. The transport protocol for the external endpoint. Possible values are ‘Udp’ or ‘Tcp’. Possible values include: ‘Udp’, ‘Tcp’
load_distribution (str or LoadDistribution) – The load distribution policy for this rule. Possible values are ‘Default’, ‘SourceIP’, and ‘SourceIPProtocol’. Possible values include: ‘Default’, ‘SourceIP’, ‘SourceIPProtocol’
frontend_port (int) – Required. The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.
backend_port (int) – The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
idle_timeout_in_minutes (int) – The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.
enable_floating_ip (bool) – Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint.
provisioning_state (str) – Gets the provisioning state of the PublicIP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.LocalNetworkGateway(*, local_network_address_space, id: str = None, location: str = None, tags=None, gateway_ip_address: str = None, bgp_settings=None, resource_guid: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

A common class for general resource information.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
local_network_address_space (AddressSpace) – Required. Local network site address space.
gateway_ip_address (str) – IP address of local network gateway.
bgp_settings (BgpSettings) – Local network gateway’s BGP speaker settings.
resource_guid (str) – The resource GUID property of the LocalNetworkGateway resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str) – The provisioning state of the LocalNetworkGateway resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2016_09_01.models.NetworkInterface(*, id: str = None, location: str = None, tags=None, virtual_machine=None, network_security_group=None, ip_configurations=None, dns_settings=None, mac_address: str = None, primary: bool = None, enable_accelerated_networking: bool = None, enable_ip_forwarding: bool = None, resource_guid: str = None, provisioning_state: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

A network interface in a resource group.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
virtual_machine (SubResource) – The reference of a virtual machine.
network_security_group (NetworkSecurityGroup) – The reference of the NetworkSecurityGroup resource.
ip_configurations (list[NetworkInterfaceIPConfiguration]) – A list of IPConfigurations of the network interface.
dns_settings (NetworkInterfaceDnsSettings) – The DNS settings in network interface.
mac_address (str) – The MAC address of the network interface.
primary (bool) – Gets whether this is a primary network interface on a virtual machine.
enable_accelerated_networking (bool) – If the network interface is accelerated networking enabled.
enable_ip_forwarding (bool) – Indicates whether IP forwarding is enabled on this network interface.
resource_guid (str) – The resource GUID property of the network interface resource.
provisioning_state (str) – The provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.network.v2016_09_01.models.NetworkInterfaceAssociation(*, security_rules=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Network interface and its custom security rules.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) – Network interface ID.
Parameters: security_rules (list[SecurityRule]) – Collection of custom security rules.

class azure.mgmt.network.v2016_09_01.models.NetworkInterfaceDnsSettings(*, dns_servers=None, applied_dns_servers=None, internal_dns_name_label: str = None, internal_fqdn: str = None, internal_domain_name_suffix: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

DNS settings of a network interface.

Parameters

dns_servers (list[str]) – List of DNS servers IP addresses. Use ‘AzureProvidedDNS’ to switch to azure provided DNS resolution. ‘AzureProvidedDNS’ value cannot be combined with other IPs, it must be the only value in dnsServers collection.
applied_dns_servers (list[str]) – If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.
internal_dns_name_label (str) – Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.
internal_fqdn (str) – Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
internal_domain_name_suffix (str) – Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.

class azure.mgmt.network.v2016_09_01.models.NetworkInterfaceIPConfiguration(*, id: str = None, application_gateway_backend_address_pools=None, load_balancer_backend_address_pools=None, load_balancer_inbound_nat_rules=None, private_ip_address: str = None, private_ip_allocation_method=None, private_ip_address_version=None, subnet=None, primary: bool = None, public_ip_address=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

IPConfiguration in a network interface.

Parameters

id (str) – Resource ID.
application_gateway_backend_address_pools (list[ApplicationGatewayBackendAddressPool]) – The reference of ApplicationGatewayBackendAddressPool resource.
load_balancer_backend_address_pools (list[BackendAddressPool]) – The reference of LoadBalancerBackendAddressPool resource.
load_balancer_inbound_nat_rules (list[InboundNatRule]) – A list of references of LoadBalancerInboundNatRules.
private_ip_address (str) –
private_ip_allocation_method (str or IPAllocationMethod) – Defines how a private IP address is assigned. Possible values are: ‘Static’ and ‘Dynamic’. Possible values include: ‘Static’, ‘Dynamic’
private_ip_address_version (str or IPVersion) – Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’. Possible values include: ‘IPv4’, ‘IPv6’
subnet (Subnet) –
primary (bool) – Gets whether this is a primary customer address on the network interface.
public_ip_address (PublicIPAddress) –
provisioning_state (str) –
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.NetworkSecurityGroup(*, id: str = None, location: str = None, tags=None, security_rules=None, default_security_rules=None, resource_guid: str = None, provisioning_state: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

NetworkSecurityGroup resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
security_rules (list[SecurityRule]) – A collection of security rules of the network security group.
default_security_rules (list[SecurityRule]) – The default security rules of network security group.
resource_guid (str) – The resource GUID property of the network security group resource.
provisioning_state (str) – The provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
network_interfaces (list[NetworkInterface]) – A collection of references to network interfaces.
subnets (list[Subnet]) – A collection of references to subnets.

class azure.mgmt.network.v2016_09_01.models.NetworkWatcher(*, id: str = None, location: str = None, tags=None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

Network watcher in a resource group.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str or ProvisioningState) – The provisioning state of the resource. Possible values include: ‘Succeeded’, ‘Updating’, ‘Deleting’, ‘Failed’

class azure.mgmt.network.v2016_09_01.models.NextHopParameters(*, target_resource_id: str, source_ip_address: str, destination_ip_address: str, target_nic_resource_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the source and destination endpoint.

All required parameters must be populated in order to send to Azure.

Parameters

target_resource_id (str) – Required. The resource identifier of the target resource against which the action is to be performed.
source_ip_address (str) – Required. The source IP address.
destination_ip_address (str) – Required. The destination IP address.
target_nic_resource_id (str) – The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional).

class azure.mgmt.network.v2016_09_01.models.NextHopResult(*, next_hop_type=None, next_hop_ip_address: str = None, route_table_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The information about next hop from the specified VM.

Parameters

next_hop_type (str or NextHopType) – Next hop type. Possible values include: ‘Internet’, ‘VirtualAppliance’, ‘VirtualNetworkGateway’, ‘VnetLocal’, ‘HyperNetGateway’, ‘None’
next_hop_ip_address (str) – Next hop IP Address
route_table_id (str) – The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string ‘System Route’.

class azure.mgmt.network.v2016_09_01.models.OutboundNatRule(*, backend_address_pool, id: str = None, allocated_outbound_ports: int = None, frontend_ip_configurations=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Outbound NAT pool of the load balancer.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
allocated_outbound_ports (int) – The number of outbound ports to be used for NAT.
frontend_ip_configurations (list[SubResource]) – The Frontend IP addresses of the load balancer.
backend_address_pool (SubResource) – Required. A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.
provisioning_state (str) – Gets the provisioning state of the PublicIP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.PacketCapture(*, target: str, storage_location, bytes_to_capture_per_packet: int = 0, total_bytes_per_session: int = 1073741824, time_limit_in_seconds: int = 18000, filters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the create packet capture operation.

All required parameters must be populated in order to send to Azure.

Parameters

target (str) – Required. The ID of the targeted resource, only VM is currently supported.
bytes_to_capture_per_packet (int) – Number of bytes captured per packet, the remaining bytes are truncated. Default value: 0 .
total_bytes_per_session (int) – Maximum size of the capture output. Default value: 1073741824 .
time_limit_in_seconds (int) – Maximum duration of the capture session in seconds. Default value: 18000 .
storage_location (PacketCaptureStorageLocation) – Required.
filters (list[PacketCaptureFilter]) –

class azure.mgmt.network.v2016_09_01.models.PacketCaptureFilter(*, protocol='Any', local_ip_address: str = None, remote_ip_address: str = None, local_port: str = None, remote_port: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Filter that is applied to packet capture request. Multiple filters can be applied.

Parameters

protocol (str or PcProtocol) – Protocol to be filtered on. Possible values include: ‘TCP’, ‘UDP’, ‘Any’. Default value: “Any” .
local_ip_address (str) – Local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5”? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.
remote_ip_address (str) – Local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.
local_port (str) – Local port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.
remote_port (str) – Remote port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.

class azure.mgmt.network.v2016_09_01.models.PacketCaptureParameters(*, target: str, storage_location, bytes_to_capture_per_packet: int = 0, total_bytes_per_session: int = 1073741824, time_limit_in_seconds: int = 18000, filters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the create packet capture operation.

All required parameters must be populated in order to send to Azure.

Parameters

target (str) – Required. The ID of the targeted resource, only VM is currently supported.
bytes_to_capture_per_packet (int) – Number of bytes captured per packet, the remaining bytes are truncated. Default value: 0 .
total_bytes_per_session (int) – Maximum size of the capture output. Default value: 1073741824 .
time_limit_in_seconds (int) – Maximum duration of the capture session in seconds. Default value: 18000 .
storage_location (PacketCaptureStorageLocation) – Required.
filters (list[PacketCaptureFilter]) –

class azure.mgmt.network.v2016_09_01.models.PacketCaptureQueryStatusResult(*, name: str = None, id: str = None, capture_start_time=None, packet_capture_status=None, stop_reason: str = None, packet_capture_error=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Status of packet capture session.

Parameters

name (str) – The name of the packet capture resource.
id (str) – The ID of the packet capture resource.
capture_start_time (datetime) – The start time of the packet capture session.
packet_capture_status (str or PcStatus) – The status of the packet capture session. Possible values include: ‘NotStarted’, ‘Running’, ‘Stopped’, ‘Error’, ‘Unknown’
stop_reason (str) – The reason the current packet capture session was stopped.
packet_capture_error (list[str or PcError]) – List of errors of packet capture session.

class azure.mgmt.network.v2016_09_01.models.PacketCaptureResult(*, target: str, storage_location, etag: str = 'A unique read-only string that changes whenever the resource is updated.', bytes_to_capture_per_packet: int = 0, total_bytes_per_session: int = 1073741824, time_limit_in_seconds: int = 18000, filters=None, provisioning_state=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Information about packet capture session.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Name of the packet capture session.
id (str) – ID of the packet capture operation.

Parameters

etag (str) – Default value: “A unique read-only string that changes whenever the resource is updated.” .
target (str) – Required. The ID of the targeted resource, only VM is currently supported.
bytes_to_capture_per_packet (int) – Number of bytes captured per packet, the remaining bytes are truncated. Default value: 0 .
total_bytes_per_session (int) – Maximum size of the capture output. Default value: 1073741824 .
time_limit_in_seconds (int) – Maximum duration of the capture session in seconds. Default value: 18000 .
storage_location (PacketCaptureStorageLocation) – Required.
filters (list[PacketCaptureFilter]) –
provisioning_state (str or ProvisioningState) – The provisioning state of the packet capture session. Possible values include: ‘Succeeded’, ‘Updating’, ‘Deleting’, ‘Failed’

class azure.mgmt.network.v2016_09_01.models.PacketCaptureStorageLocation(*, storage_id: str = None, storage_path: str = None, file_path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes the storage location for a packet capture session.

Parameters

storage_id (str) – The ID of the storage account to save the packet capture session. Required if no local file path is provided.
storage_path (str) – The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.
file_path (str) – A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.

class azure.mgmt.network.v2016_09_01.models.Probe(*, protocol, port: int, id: str = None, interval_in_seconds: int = None, number_of_probes: int = None, request_path: str = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

A load balancer probe.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
protocol (str or ProbeProtocol) – Required. The protocol of the end point. Possible values are: ‘Http’ or ‘Tcp’. If ‘Tcp’ is specified, a received ACK is required for the probe to be successful. If ‘Http’ is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Possible values include: ‘Http’, ‘Tcp’
port (int) – Required. The port for communicating the probe. Possible values range from 1 to 65535, inclusive.
interval_in_seconds (int) – The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.
number_of_probes (int) – The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.
request_path (str) – The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.
provisioning_state (str) – Gets the provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

load_balancing_rules (list[SubResource]) – The load balancer rules that use this probe.

class azure.mgmt.network.v2016_09_01.models.PublicIPAddress(*, id: str = None, location: str = None, tags=None, public_ip_allocation_method=None, public_ip_address_version=None, dns_settings=None, ip_address: str = None, idle_timeout_in_minutes: int = None, resource_guid: str = None, provisioning_state: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

Public IP address resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
public_ip_allocation_method (str or IPAllocationMethod) – The public IP allocation method. Possible values are: ‘Static’ and ‘Dynamic’. Possible values include: ‘Static’, ‘Dynamic’
public_ip_address_version (str or IPVersion) – The public IP address version. Possible values are: ‘IPv4’ and ‘IPv6’. Possible values include: ‘IPv4’, ‘IPv6’
dns_settings (PublicIPAddressDnsSettings) – The FQDN of the DNS record associated with the public IP address.
ip_address (str) –
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
resource_guid (str) – The resource GUID property of the public IP resource.
provisioning_state (str) – The provisioning state of the PublicIP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
ip_configuration (IPConfiguration) –

class azure.mgmt.network.v2016_09_01.models.PublicIPAddressDnsSettings(*, domain_name_label: str = None, fqdn: str = None, reverse_fqdn: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains FQDN of the DNS record associated with the public IP address.

Parameters

domain_name_label (str) – Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
fqdn (str) – Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.
reverse_fqdn (str) – Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

class azure.mgmt.network.v2016_09_01.models.QueryTroubleshootingParameters(*, target_resource_id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the resource to query the troubleshooting result.

All required parameters must be populated in order to send to Azure.

Parameters: target_resource_id (str) – Required. The target resource ID to query the troubleshooting result.

class azure.mgmt.network.v2016_09_01.models.Resource(*, id: str = None, location: str = None, tags=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.

Variables

name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.network.v2016_09_01.models.ResourceNavigationLink(*, id: str = None, linked_resource_type: str = None, link: str = None, name: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

ResourceNavigationLink resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
linked_resource_type (str) – Resource type of the linked resource.
link (str) – Link to the external resource
name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.

Variables

provisioning_state (str) – Provisioning state of the ResourceNavigationLink resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.RetentionPolicyParameters(*, days: int = 0, enabled: bool = False, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the retention policy for flow log.

Parameters

days (int) – Number of days to retain flow log records. Default value: 0 .
enabled (bool) – Flag to enable/disable retention. Default value: False .

class azure.mgmt.network.v2016_09_01.models.Route(*, next_hop_type, id: str = None, address_prefix: str = None, next_hop_ip_address: str = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Route resource.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
address_prefix (str) – The destination CIDR to which the route applies.
next_hop_type (str or RouteNextHopType) – Required. The type of Azure hop the packet should be sent to. Possible values are: ‘VirtualNetworkGateway’, ‘VnetLocal’, ‘Internet’, ‘VirtualAppliance’, and ‘None’. Possible values include: ‘VirtualNetworkGateway’, ‘VnetLocal’, ‘Internet’, ‘VirtualAppliance’, ‘None’
next_hop_ip_address (str) – The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
provisioning_state (str) – The provisioning state of the resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.RouteTable(*, id: str = None, location: str = None, tags=None, routes=None, provisioning_state: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

Route table resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
routes (list[Route]) – Collection of routes contained within a route table.
provisioning_state (str) – The provisioning state of the resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
subnets (list[Subnet]) – A collection of references to subnets.

class azure.mgmt.network.v2016_09_01.models.SecurityGroupNetworkInterface(*, id: str = None, security_rule_associations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Network interface and all its associated security rules.

Parameters

id (str) – ID of the network interface.
security_rule_associations (SecurityRuleAssociations) –

class azure.mgmt.network.v2016_09_01.models.SecurityGroupViewParameters(*, target_resource_id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the VM to check security groups for.

All required parameters must be populated in order to send to Azure.

Parameters: target_resource_id (str) – Required. ID of the target VM.

class azure.mgmt.network.v2016_09_01.models.SecurityGroupViewResult(*, network_interfaces=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The information about security rules applied to the specified VM.

Parameters: network_interfaces (list[SecurityGroupNetworkInterface]) – List of network interfaces on the specified VM.

class azure.mgmt.network.v2016_09_01.models.SecurityRule(*, protocol, source_address_prefix: str, destination_address_prefix: str, access, direction, id: str = None, description: str = None, source_port_range: str = None, destination_port_range: str = None, priority: int = None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Network security rule.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
description (str) – A description for this rule. Restricted to 140 chars.
protocol (str or SecurityRuleProtocol) – Required. Network protocol this rule applies to. Possible values are ‘Tcp’, ‘Udp’, and ‘*’. Possible values include: ‘Tcp’, ‘Udp’, ‘*’
source_port_range (str) – The source port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports.
destination_port_range (str) – The destination port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports.
source_address_prefix (str) – Required. The CIDR or source IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from.
destination_address_prefix (str) – Required. The destination address prefix. CIDR or source IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used.
access (str or SecurityRuleAccess) – Required. The network traffic is allowed or denied. Possible values are: ‘Allow’ and ‘Deny’. Possible values include: ‘Allow’, ‘Deny’
priority (int) – The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
direction (str or SecurityRuleDirection) – Required. The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: ‘Inbound’ and ‘Outbound’. Possible values include: ‘Inbound’, ‘Outbound’
provisioning_state (str) – The provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.SecurityRuleAssociations(*, network_interface_association=None, subnet_association=None, default_security_rules=None, effective_security_rules=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

All security rules associated with the network interface.

Parameters

network_interface_association (NetworkInterfaceAssociation) –
subnet_association (SubnetAssociation) –
default_security_rules (list[SecurityRule]) – Collection of default security rules of the network security group.
effective_security_rules (list[EffectiveNetworkSecurityRule]) – Collection of effective security rules.

class azure.mgmt.network.v2016_09_01.models.Subnet(*, id: str = None, address_prefix: str = None, network_security_group=None, route_table=None, resource_navigation_links=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Subnet in a virtual network resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
address_prefix (str) – The address prefix for the subnet.
network_security_group (NetworkSecurityGroup) – The reference of the NetworkSecurityGroup resource.
route_table (RouteTable) – The reference of the RouteTable resource.
resource_navigation_links (list[ResourceNavigationLink]) – Gets an array of references to the external resources using subnet.
provisioning_state (str) – The provisioning state of the resource.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

ip_configurations (list[IPConfiguration]) – Gets an array of references to the network interface IP configurations using subnet.

class azure.mgmt.network.v2016_09_01.models.SubnetAssociation(*, security_rules=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Network interface and its custom security rules.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) – Subnet ID.
Parameters: security_rules (list[SecurityRule]) – Collection of custom security rules.

class azure.mgmt.network.v2016_09_01.models.SubResource(*, id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SubResource.

Parameters: id (str) – Resource ID.

class azure.mgmt.network.v2016_09_01.models.Topology(*, resources=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Topology of the specified resource group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – GUID representing the operation id.
created_date_time (datetime) – The datetime when the topology was initially created for the resource group.
last_modified (datetime) – The datetime when the topology was last modified.

Parameters

resources (list[TopologyResource]) –

class azure.mgmt.network.v2016_09_01.models.TopologyAssociation(*, name: str = None, resource_id: str = None, association_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Resources that have an association with the parent resource.

Parameters

name (str) – The name of the resource that is associated with the parent resource.
resource_id (str) – The ID of the resource that is associated with the parent resource.
association_type (str or AssociationType) – The association type of the child resource to the parent resource. Possible values include: ‘Associated’, ‘Contains’

class azure.mgmt.network.v2016_09_01.models.TopologyParameters(*, target_resource_group_name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the representation of topology.

All required parameters must be populated in order to send to Azure.

Parameters: target_resource_group_name (str) – Required. The name of the target resource group to perform topology on.

class azure.mgmt.network.v2016_09_01.models.TopologyResource(*, name: str = None, id: str = None, location: str = None, associations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The network resource topology information for the given resource group.

Parameters

name (str) – Name of the resource.
id (str) – ID of the resource.
location (str) – Resource location.
associations (list[TopologyAssociation]) – Holds the associations the resource has with other resources in the resource group.

class azure.mgmt.network.v2016_09_01.models.TroubleshootingDetails(*, id: str = None, reason_type: str = None, summary: str = None, detail: str = None, recommended_actions=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Information gained from troubleshooting of specified resource.

Parameters

id (str) – The id of the get troubleshoot operation.
reason_type (str) – Reason type of failure.
summary (str) – A summary of troubleshooting.
detail (str) – Details on troubleshooting results.
recommended_actions (list[TroubleshootingRecommendedActions]) – List of recommended actions.

class azure.mgmt.network.v2016_09_01.models.TroubleshootingParameters(*, target_resource_id: str, storage_id: str, storage_path: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the resource to troubleshoot.

All required parameters must be populated in order to send to Azure.

Parameters

target_resource_id (str) – Required. The target resource to troubleshoot.
storage_id (str) – Required. The ID for the storage account to save the troubleshoot result.
storage_path (str) – Required. The path to the blob to save the troubleshoot result in.

class azure.mgmt.network.v2016_09_01.models.TroubleshootingRecommendedActions(*, action_id: str = None, action_text: str = None, action_uri: str = None, action_uri_text: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Recommended actions based on discovered issues.

Parameters

action_id (str) – ID of the recommended action.
action_text (str) – Description of recommended actions.
action_uri (str) – The uri linking to a documentation for the recommended troubleshooting actions.
action_uri_text (str) – The information from the URI for the recommended troubleshooting actions.

class azure.mgmt.network.v2016_09_01.models.TroubleshootingResult(*, start_time=None, end_time=None, code: str = None, results=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Troubleshooting information gained from specified resource.

Parameters

start_time (datetime) – The start time of the troubleshooting.
end_time (datetime) – The end time of the troubleshooting.
code (str) – The result code of the troubleshooting.
results (list[TroubleshootingDetails]) – Information from troubleshooting.

class azure.mgmt.network.v2016_09_01.models.TunnelConnectionHealth(**kwargs)[source]¶

Bases: msrest.serialization.Model

VirtualNetworkGatewayConnection properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

tunnel (str) – Tunnel name.
connection_status (str or VirtualNetworkGatewayConnectionStatus) – Virtual network Gateway connection status. Possible values include: ‘Unknown’, ‘Connecting’, ‘Connected’, ‘NotConnected’
ingress_bytes_transferred (long) – The Ingress Bytes Transferred in this connection
egress_bytes_transferred (long) – The Egress Bytes Transferred in this connection
last_connection_established_utc_time (str) – The time at which connection was established in Utc format.

class azure.mgmt.network.v2016_09_01.models.Usage(*, current_value: int, limit: int, name, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes network resource usage.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

unit (str) – Required. An enum describing the unit of measurement. Default value: “Count” .

Parameters

current_value (long) – Required. The current value of the usage.
limit (long) – Required. The limit of usage.
name (UsageName) – Required. The name of the type of usage.

unit = 'Count'¶

class azure.mgmt.network.v2016_09_01.models.UsageName(*, value: str = None, localized_value: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The usage names.

Parameters

value (str) – A string describing the resource name.
localized_value (str) – A localized string describing the resource name.

class azure.mgmt.network.v2016_09_01.models.VerificationIPFlowParameters(*, target_resource_id: str, direction, protocol, local_port: str, remote_port: str, local_ip_address: str, remote_ip_address: str, target_nic_resource_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters that define the IP flow to be verified.

All required parameters must be populated in order to send to Azure.

Parameters

target_resource_id (str) – Required. The ID of the target resource to perform next-hop on.
direction (str or Direction) – Required. The direction of the packet represented as a 5-tuple. Possible values include: ‘Inbound’, ‘Outbound’
protocol (str or Protocol) – Required. Protocol to be verified on. Possible values include: ‘TCP’, ‘UDP’
local_port (str) – Required. The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction.
remote_port (str) – Required. The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction.
local_ip_address (str) – Required. The local IP address. Acceptable values are valid IPv4 addresses.
remote_ip_address (str) – Required. The remote IP address. Acceptable values are valid IPv4 addresses.
target_nic_resource_id (str) – The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional).

class azure.mgmt.network.v2016_09_01.models.VerificationIPFlowResult(*, access=None, rule_name: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Results of IP flow verification on the target resource.

Parameters

access (str or Access) – Indicates whether the traffic is allowed or denied. Possible values include: ‘Allow’, ‘Deny’
rule_name (str) – Name of the rule. If input is not matched against any security rule, it is not displayed.

class azure.mgmt.network.v2016_09_01.models.VirtualNetwork(*, id: str = None, location: str = None, tags=None, address_space=None, dhcp_options=None, subnets=None, virtual_network_peerings=None, resource_guid: str = None, provisioning_state: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

Virtual Network resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
address_space (AddressSpace) – The AddressSpace that contains an array of IP address ranges that can be used by subnets.
dhcp_options (DhcpOptions) – The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.
subnets (list[Subnet]) – A list of subnets in a Virtual Network.
virtual_network_peerings (list[VirtualNetworkPeering]) – A list of peerings in a Virtual Network.
resource_guid (str) – The resourceGuid property of the Virtual Network resource.
provisioning_state (str) – The provisioning state of the PublicIP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGateway(*, ip_configurations, gateway_type, vpn_type, id: str = None, location: str = None, tags=None, enable_bgp: bool = None, active_active: bool = None, gateway_default_site=None, sku=None, vpn_client_configuration=None, bgp_settings=None, resource_guid: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

A common class for general resource information.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
ip_configurations (list[VirtualNetworkGatewayIPConfiguration]) – Required. IP configurations for virtual network gateway.
gateway_type (str or VirtualNetworkGatewayType) – Required. The type of this virtual network gateway. Possible values are: ‘Vpn’ and ‘ExpressRoute’. Possible values include: ‘Vpn’, ‘ExpressRoute’
vpn_type (str or VpnType) – Required. The type of this virtual network gateway. Possible values are: ‘PolicyBased’ and ‘RouteBased’. Possible values include: ‘PolicyBased’, ‘RouteBased’
enable_bgp (bool) – Whether BGP is enabled for this virtual network gateway or not.
active_active (bool) – ActiveActive flag
gateway_default_site (SubResource) – The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.
sku (VirtualNetworkGatewaySku) – The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
vpn_client_configuration (VpnClientConfiguration) – The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
bgp_settings (BgpSettings) – Virtual network gateway’s BGP speaker settings.
resource_guid (str) – The resource GUID property of the VirtualNetworkGateway resource.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str) – The provisioning state of the VirtualNetworkGateway resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewayConnection(*, virtual_network_gateway1, connection_type, id: str = None, location: str = None, tags=None, authorization_key: str = None, virtual_network_gateway2=None, local_network_gateway2=None, routing_weight: int = None, shared_key: str = None, peer=None, enable_bgp: bool = None, resource_guid: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.Resource

A common class for general resource information.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
authorization_key (str) – The authorizationKey.
virtual_network_gateway1 (VirtualNetworkGateway) – Required.
virtual_network_gateway2 (VirtualNetworkGateway) –
local_network_gateway2 (LocalNetworkGateway) –
connection_type (str or VirtualNetworkGatewayConnectionType) – Required. Gateway connection type. Possible values are: ‘IPsec’,’Vnet2Vnet’,’ExpressRoute’, and ‘VPNClient. Possible values include: ‘IPsec’, ‘Vnet2Vnet’, ‘ExpressRoute’, ‘VPNClient’
routing_weight (int) – The routing weight.
shared_key (str) – The IPSec shared key.
peer (SubResource) – The reference to peerings resource.
enable_bgp (bool) – EnableBgp flag
resource_guid (str) – The resource GUID property of the VirtualNetworkGatewayConnection resource.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

Variables

name (str) – Resource name.
type (str) – Resource type.
connection_status (str or VirtualNetworkGatewayConnectionStatus) – Virtual network Gateway connection status. Possible values are ‘Unknown’, ‘Connecting’, ‘Connected’ and ‘NotConnected’. Possible values include: ‘Unknown’, ‘Connecting’, ‘Connected’, ‘NotConnected’
tunnel_connection_status (list[TunnelConnectionHealth]) – Collection of all tunnels’ connection health status.
egress_bytes_transferred (long) – The egress bytes transferred in this connection.
ingress_bytes_transferred (long) – The ingress bytes transferred in this connection.
provisioning_state (str) – The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewayIPConfiguration(*, subnet, public_ip_address, id: str = None, private_ip_allocation_method=None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

IP configuration for virtual network gateway.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
private_ip_allocation_method (str or IPAllocationMethod) – The private IP allocation method. Possible values are: ‘Static’ and ‘Dynamic’. Possible values include: ‘Static’, ‘Dynamic’
subnet (SubResource) – Required. The reference of the subnet resource.
public_ip_address (SubResource) – Required. The reference of the public IP resource.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

provisioning_state (str) – The provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewaySku(*, name, tier, capacity: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

VirtualNetworkGatewaySku details.

All required parameters must be populated in order to send to Azure.

Parameters

name (str or VirtualNetworkGatewaySkuName) – Required. Gateway SKU name. Possible values are: ‘Basic’, ‘HighPerformance’,’Standard’, and ‘UltraPerformance’. Possible values include: ‘Basic’, ‘HighPerformance’, ‘Standard’, ‘UltraPerformance’
tier (str or VirtualNetworkGatewaySkuTier) – Required. Gateway SKU tier. Possible values are: ‘Basic’, ‘HighPerformance’,’Standard’, and ‘UltraPerformance’. Possible values include: ‘Basic’, ‘HighPerformance’, ‘Standard’, ‘UltraPerformance’
capacity (int) – The capacity.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkPeering(*, id: str = None, allow_virtual_network_access: bool = None, allow_forwarded_traffic: bool = None, allow_gateway_transit: bool = None, use_remote_gateways: bool = None, remote_virtual_network=None, peering_state=None, provisioning_state: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

Peerings in a virtual network resource.

Parameters

id (str) – Resource ID.
allow_virtual_network_access (bool) – Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.
allow_forwarded_traffic (bool) – Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.
allow_gateway_transit (bool) – If gateway links can be used in remote virtual networking to link to this virtual network.
use_remote_gateways (bool) – If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.
remote_virtual_network (SubResource) – The reference of the remote virtual network.
peering_state (str or VirtualNetworkPeeringState) – The status of the virtual network peering. Possible values are ‘Initiated’, ‘Connected’, and ‘Disconnected’. Possible values include: ‘Initiated’, ‘Connected’, ‘Disconnected’
provisioning_state (str) – The provisioning state of the resource.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2016_09_01.models.VpnClientConfiguration(*, vpn_client_address_pool=None, vpn_client_root_certificates=None, vpn_client_revoked_certificates=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

VpnClientConfiguration for P2S client.

Parameters

vpn_client_address_pool (AddressSpace) – The reference of the address space resource which represents Address space for P2S VpnClient.
vpn_client_root_certificates (list[VpnClientRootCertificate]) – VpnClientRootCertificate for virtual network gateway.
vpn_client_revoked_certificates (list[VpnClientRevokedCertificate]) – VpnClientRevokedCertificate for Virtual network gateway.

class azure.mgmt.network.v2016_09_01.models.VpnClientParameters(*, processor_architecture, **kwargs)[source]¶

Bases: msrest.serialization.Model

VpnClientParameters.

All required parameters must be populated in order to send to Azure.

Parameters: processor_architecture (str or ProcessorArchitecture) – Required. VPN client Processor Architecture. Possible values are: ‘AMD64’ and ‘X86’. Possible values include: ‘Amd64’, ‘X86’

class azure.mgmt.network.v2016_09_01.models.VpnClientRevokedCertificate(*, id: str = None, thumbprint: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

VPN client revoked certificate of virtual network gateway.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

id (str) – Resource ID.
thumbprint (str) – The revoked VPN client certificate thumbprint.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

provisioning_state (str) – The provisioning state of the VPN client revoked certificate resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2016_09_01.models.VpnClientRootCertificate(*, public_cert_data: str, id: str = None, name: str = None, etag: str = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2016_09_01.models._models_py3.SubResource

VPN client root certificate of virtual network gateway.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Resource ID.
public_cert_data (str) – Required. The certificate public data.
name (str) – The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag (str) – A unique read-only string that changes whenever the resource is updated.

Variables

provisioning_state (str) – The provisioning state of the VPN client root certificate resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2016_09_01.models.NetworkInterfacePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of NetworkInterface object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ApplicationGateway object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitAuthorizationPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ExpressRouteCircuitAuthorization object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitPeeringPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ExpressRouteCircuitPeering object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ExpressRouteCircuit object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.ExpressRouteServiceProviderPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ExpressRouteServiceProvider object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.LoadBalancerPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of LoadBalancer object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.NetworkSecurityGroupPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of NetworkSecurityGroup object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.SecurityRulePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of SecurityRule object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.NetworkWatcherPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of NetworkWatcher object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.PacketCaptureResultPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of PacketCaptureResult object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.PublicIPAddressPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of PublicIPAddress object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.RouteTablePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of RouteTable object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.RoutePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Route object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.UsagePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Usage object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualNetwork object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.SubnetPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Subnet object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkPeeringPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualNetworkPeering object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewayPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualNetworkGateway object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewayConnectionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualNetworkGatewayConnection object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.LocalNetworkGatewayPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of LocalNetworkGateway object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.network.v2016_09_01.models.RouteNextHopType[source]¶

Bases: str, enum.Enum

An enumeration.

internet = 'Internet'¶

none = 'None'¶

virtual_appliance = 'VirtualAppliance'¶

virtual_network_gateway = 'VirtualNetworkGateway'¶

vnet_local = 'VnetLocal'¶

class azure.mgmt.network.v2016_09_01.models.SecurityRuleProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

asterisk = '*'¶

tcp = 'Tcp'¶

udp = 'Udp'¶

class azure.mgmt.network.v2016_09_01.models.SecurityRuleAccess[source]¶

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'¶

deny = 'Deny'¶

class azure.mgmt.network.v2016_09_01.models.SecurityRuleDirection[source]¶

Bases: str, enum.Enum

An enumeration.

inbound = 'Inbound'¶

outbound = 'Outbound'¶

class azure.mgmt.network.v2016_09_01.models.TransportProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

tcp = 'Tcp'¶

udp = 'Udp'¶

class azure.mgmt.network.v2016_09_01.models.IPAllocationMethod[source]¶

Bases: str, enum.Enum

An enumeration.

dynamic = 'Dynamic'¶

static = 'Static'¶

class azure.mgmt.network.v2016_09_01.models.IPVersion[source]¶

Bases: str, enum.Enum

An enumeration.

ipv4 = 'IPv4'¶

ipv6 = 'IPv6'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

http = 'Http'¶

https = 'Https'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayCookieBasedAffinity[source]¶

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'¶

enabled = 'Enabled'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayBackendHealthServerHealth[source]¶

Bases: str, enum.Enum

An enumeration.

down = 'Down'¶

partial = 'Partial'¶

unknown = 'Unknown'¶

up = 'Up'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewaySkuName[source]¶

Bases: str, enum.Enum

An enumeration.

standard_large = 'Standard_Large'¶

standard_medium = 'Standard_Medium'¶

standard_small = 'Standard_Small'¶

waf_large = 'WAF_Large'¶

waf_medium = 'WAF_Medium'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayTier[source]¶

Bases: str, enum.Enum

An enumeration.

standard = 'Standard'¶

waf = 'WAF'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewaySslProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

tl_sv1_0 = 'TLSv1_0'¶

tl_sv1_1 = 'TLSv1_1'¶

tl_sv1_2 = 'TLSv1_2'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayRequestRoutingRuleType[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

path_based_routing = 'PathBasedRouting'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayOperationalState[source]¶

Bases: str, enum.Enum

An enumeration.

running = 'Running'¶

starting = 'Starting'¶

stopped = 'Stopped'¶

stopping = 'Stopping'¶

class azure.mgmt.network.v2016_09_01.models.ApplicationGatewayFirewallMode[source]¶

Bases: str, enum.Enum

An enumeration.

detection = 'Detection'¶

prevention = 'Prevention'¶

class azure.mgmt.network.v2016_09_01.models.AuthorizationUseStatus[source]¶

Bases: str, enum.Enum

An enumeration.

available = 'Available'¶

in_use = 'InUse'¶

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitPeeringAdvertisedPublicPrefixState[source]¶

Bases: str, enum.Enum

An enumeration.

configured = 'Configured'¶

configuring = 'Configuring'¶

not_configured = 'NotConfigured'¶

validation_needed = 'ValidationNeeded'¶

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitPeeringType[source]¶

Bases: str, enum.Enum

An enumeration.

azure_private_peering = 'AzurePrivatePeering'¶

azure_public_peering = 'AzurePublicPeering'¶

microsoft_peering = 'MicrosoftPeering'¶

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitPeeringState[source]¶

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'¶

enabled = 'Enabled'¶

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitSkuTier[source]¶

Bases: str, enum.Enum

An enumeration.

premium = 'Premium'¶

standard = 'Standard'¶

class azure.mgmt.network.v2016_09_01.models.ExpressRouteCircuitSkuFamily[source]¶

Bases: str, enum.Enum

An enumeration.

metered_data = 'MeteredData'¶

unlimited_data = 'UnlimitedData'¶

class azure.mgmt.network.v2016_09_01.models.ServiceProviderProvisioningState[source]¶

Bases: str, enum.Enum

An enumeration.

deprovisioning = 'Deprovisioning'¶

not_provisioned = 'NotProvisioned'¶

provisioned = 'Provisioned'¶

provisioning = 'Provisioning'¶

class azure.mgmt.network.v2016_09_01.models.LoadDistribution[source]¶

Bases: str, enum.Enum

An enumeration.

default = 'Default'¶

source_ip = 'SourceIP'¶

source_ip_protocol = 'SourceIPProtocol'¶

class azure.mgmt.network.v2016_09_01.models.ProbeProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

http = 'Http'¶

tcp = 'Tcp'¶

class azure.mgmt.network.v2016_09_01.models.NetworkOperationStatus[source]¶

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'¶

in_progress = 'InProgress'¶

succeeded = 'Succeeded'¶

class azure.mgmt.network.v2016_09_01.models.EffectiveRouteSource[source]¶

Bases: str, enum.Enum

An enumeration.

default = 'Default'¶

unknown = 'Unknown'¶

user = 'User'¶

virtual_network_gateway = 'VirtualNetworkGateway'¶

class azure.mgmt.network.v2016_09_01.models.EffectiveRouteState[source]¶

Bases: str, enum.Enum

An enumeration.

active = 'Active'¶

invalid = 'Invalid'¶

class azure.mgmt.network.v2016_09_01.models.ProvisioningState[source]¶

Bases: str, enum.Enum

An enumeration.

deleting = 'Deleting'¶

failed = 'Failed'¶

succeeded = 'Succeeded'¶

updating = 'Updating'¶

class azure.mgmt.network.v2016_09_01.models.AssociationType[source]¶

Bases: str, enum.Enum

An enumeration.

associated = 'Associated'¶

contains = 'Contains'¶

class azure.mgmt.network.v2016_09_01.models.Direction[source]¶

Bases: str, enum.Enum

An enumeration.

inbound = 'Inbound'¶

outbound = 'Outbound'¶

class azure.mgmt.network.v2016_09_01.models.Protocol[source]¶

Bases: str, enum.Enum

An enumeration.

tcp = 'TCP'¶

udp = 'UDP'¶

class azure.mgmt.network.v2016_09_01.models.Access[source]¶

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'¶

deny = 'Deny'¶

class azure.mgmt.network.v2016_09_01.models.NextHopType[source]¶

Bases: str, enum.Enum

An enumeration.

hyper_net_gateway = 'HyperNetGateway'¶

internet = 'Internet'¶

none = 'None'¶

virtual_appliance = 'VirtualAppliance'¶

virtual_network_gateway = 'VirtualNetworkGateway'¶

vnet_local = 'VnetLocal'¶

class azure.mgmt.network.v2016_09_01.models.PcProtocol[source]¶

Bases: str, enum.Enum

An enumeration.

any = 'Any'¶

tcp = 'TCP'¶

udp = 'UDP'¶

class azure.mgmt.network.v2016_09_01.models.PcStatus[source]¶

Bases: str, enum.Enum

An enumeration.

error = 'Error'¶

not_started = 'NotStarted'¶

running = 'Running'¶

stopped = 'Stopped'¶

unknown = 'Unknown'¶

class azure.mgmt.network.v2016_09_01.models.PcError[source]¶

Bases: str, enum.Enum

An enumeration.

agent_stopped = 'AgentStopped'¶

capture_failed = 'CaptureFailed'¶

internal_error = 'InternalError'¶

local_file_failed = 'LocalFileFailed'¶

storage_failed = 'StorageFailed'¶

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkPeeringState[source]¶

Bases: str, enum.Enum

An enumeration.

connected = 'Connected'¶

disconnected = 'Disconnected'¶

initiated = 'Initiated'¶

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewayType[source]¶

Bases: str, enum.Enum

An enumeration.

express_route = 'ExpressRoute'¶

vpn = 'Vpn'¶

class azure.mgmt.network.v2016_09_01.models.VpnType[source]¶

Bases: str, enum.Enum

An enumeration.

policy_based = 'PolicyBased'¶

route_based = 'RouteBased'¶

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewaySkuName[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

high_performance = 'HighPerformance'¶

standard = 'Standard'¶

ultra_performance = 'UltraPerformance'¶

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewaySkuTier[source]¶

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'¶

high_performance = 'HighPerformance'¶

standard = 'Standard'¶

ultra_performance = 'UltraPerformance'¶

class azure.mgmt.network.v2016_09_01.models.BgpPeerState[source]¶

Bases: str, enum.Enum

An enumeration.

connected = 'Connected'¶

connecting = 'Connecting'¶

idle = 'Idle'¶

stopped = 'Stopped'¶

unknown = 'Unknown'¶

class azure.mgmt.network.v2016_09_01.models.ProcessorArchitecture[source]¶

Bases: str, enum.Enum

An enumeration.

amd64 = 'Amd64'¶

x86 = 'X86'¶

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewayConnectionStatus[source]¶

Bases: str, enum.Enum

An enumeration.

connected = 'Connected'¶

connecting = 'Connecting'¶

not_connected = 'NotConnected'¶

unknown = 'Unknown'¶

class azure.mgmt.network.v2016_09_01.models.VirtualNetworkGatewayConnectionType[source]¶

Bases: str, enum.Enum

An enumeration.

express_route = 'ExpressRoute'¶

ipsec = 'IPsec'¶

vnet2_vnet = 'Vnet2Vnet'¶

vpn_client = 'VPNClient'¶