azure.mgmt.network.v2017_03_01.models module

class azure.mgmt.network.v2017_03_01.models.Access(value)[source]

Bases: str, enum.Enum

Indicates whether the traffic is allowed or denied.

allow = 'Allow'
deny = 'Deny'
class azure.mgmt.network.v2017_03_01.models.AddressSpace(*, address_prefixes: Optional[List[str]] = 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.v2017_03_01.models.ApplicationGateway(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, sku: Optional[ApplicationGatewaySku] = None, ssl_policy: Optional[ApplicationGatewaySslPolicy] = None, gateway_ip_configurations: Optional[List[ApplicationGatewayIPConfiguration]] = None, authentication_certificates: Optional[List[ApplicationGatewayAuthenticationCertificate]] = None, ssl_certificates: Optional[List[ApplicationGatewaySslCertificate]] = None, frontend_ip_configurations: Optional[List[ApplicationGatewayFrontendIPConfiguration]] = None, frontend_ports: Optional[List[ApplicationGatewayFrontendPort]] = None, probes: Optional[List[ApplicationGatewayProbe]] = None, backend_address_pools: Optional[List[ApplicationGatewayBackendAddressPool]] = None, backend_http_settings_collection: Optional[List[ApplicationGatewayBackendHttpSettings]] = None, http_listeners: Optional[List[ApplicationGatewayHttpListener]] = None, url_path_maps: Optional[List[ApplicationGatewayUrlPathMap]] = None, request_routing_rules: Optional[List[ApplicationGatewayRequestRoutingRule]] = None, web_application_firewall_configuration: Optional[ApplicationGatewayWebApplicationFirewallConfiguration] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Application gateway resource.

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

Parameters
Variables

  • name (str) – Resource name.

  • type (str) – Resource type.

  • operational_state (str or ApplicationGatewayOperationalState) – Operational state of the application gateway resource. Possible values include: “Stopped”, “Starting”, “Running”, “Stopping”.

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

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

Authentication certificates of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • data (str) – Certificate public data.

  • provisioning_state (str) – Provisioning state of the authentication certificate resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayAvailableWafRuleSetsResult(*, value: Optional[List[ApplicationGatewayFirewallRuleSet]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ApplicationGatewayAvailableWafRuleSets API service call.

Parameters

value (list[ApplicationGatewayFirewallRuleSet]) – The list of application gateway rule sets.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayBackendAddress(*, fqdn: Optional[str] = None, ip_address: Optional[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.v2017_03_01.models.ApplicationGatewayBackendAddressPool(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, backend_ip_configurations: Optional[List[NetworkInterfaceIPConfiguration]] = None, backend_addresses: Optional[List[ApplicationGatewayBackendAddress]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Backend Address Pool of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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’.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayBackendHealth(*, backend_address_pools: Optional[List[ApplicationGatewayBackendHealthPool]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

List of ApplicationGatewayBackendHealthPool resources.

Parameters

backend_address_pools (list[ApplicationGatewayBackendHealthPool]) –

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayBackendHealthHttpSettings(*, backend_http_settings: Optional[ApplicationGatewayBackendHttpSettings] = None, servers: Optional[List[ApplicationGatewayBackendHealthServer]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Application gateway BackendHealthHttp settings.

Parameters
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayBackendHealthPool(*, backend_address_pool: Optional[ApplicationGatewayBackendAddressPool] = None, backend_http_settings_collection: Optional[List[ApplicationGatewayBackendHealthHttpSettings]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Application gateway BackendHealth pool.

Parameters
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayBackendHealthServer(*, address: Optional[str] = None, ip_configuration: Optional[SubResource] = None, health: Optional[Union[str, ApplicationGatewayBackendHealthServerHealth]] = 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 include: “Unknown”, “Up”, “Down”, “Partial”, “Draining”.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayBackendHealthServerHealth(value)[source]

Bases: str, enum.Enum

Health of backend server.

down = 'Down'
draining = 'Draining'
partial = 'Partial'
unknown = 'Unknown'
up = 'Up'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayBackendHttpSettings(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, port: Optional[int] = None, protocol: Optional[Union[str, ApplicationGatewayProtocol]] = None, cookie_based_affinity: Optional[Union[str, ApplicationGatewayCookieBasedAffinity]] = None, request_timeout: Optional[int] = None, probe: Optional[SubResource] = None, authentication_certificates: Optional[List[SubResource]] = None, provisioning_state: Optional[str] = None, connection_draining: Optional[ApplicationGatewayConnectionDraining] = None, **kwargs)[source]

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

Backend address pool settings of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • port (int) – Port.

  • protocol (str or ApplicationGatewayProtocol) – Protocol. Possible values include: “Http”, “Https”.

  • cookie_based_affinity (str or ApplicationGatewayCookieBasedAffinity) – Cookie based affinity. 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’.

  • connection_draining (ApplicationGatewayConnectionDraining) – Connection draining of the backend http settings resource.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayConnectionDraining(*, enabled: bool, drain_timeout_in_sec: int, **kwargs)[source]

Bases: msrest.serialization.Model

Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

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

Parameters

  • enabled (bool) – Required. Whether connection draining is enabled or not.

  • drain_timeout_in_sec (int) – Required. The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayCookieBasedAffinity(value)[source]

Bases: str, enum.Enum

Cookie based affinity.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayFirewallDisabledRuleGroup(*, rule_group_name: str, rules: Optional[List[int]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Allows to disable rules within a rule group or an entire rule group.

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

Parameters

  • rule_group_name (str) – Required. The name of the rule group that will be disabled.

  • rules (list[int]) – The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayFirewallMode(value)[source]

Bases: str, enum.Enum

Web application firewall mode.

detection = 'Detection'
prevention = 'Prevention'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayFirewallRule(*, rule_id: int, description: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A web application firewall rule.

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

Parameters

  • rule_id (int) – Required. The identifier of the web application firewall rule.

  • description (str) – The description of the web application firewall rule.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayFirewallRuleGroup(*, rule_group_name: str, rules: List[ApplicationGatewayFirewallRule], description: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A web application firewall rule group.

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

Parameters

  • rule_group_name (str) – Required. The name of the web application firewall rule group.

  • description (str) – The description of the web application firewall rule group.

  • rules (list[ApplicationGatewayFirewallRule]) – Required. The rules of the web application firewall rule group.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayFirewallRuleSet(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, provisioning_state: Optional[str] = None, rule_set_type: Optional[str] = None, rule_set_version: Optional[str] = None, rule_groups: Optional[List[ApplicationGatewayFirewallRuleGroup]] = None, **kwargs)[source]

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

A web application firewall rule set.

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]) – A set of tags. Resource tags.

  • provisioning_state (str) – The provisioning state of the web application firewall rule set.

  • rule_set_type (str) – The type of the web application firewall rule set.

  • rule_set_version (str) – The version of the web application firewall rule set type.

  • rule_groups (list[ApplicationGatewayFirewallRuleGroup]) – The rule groups of the web application firewall rule set.

Variables
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayFrontendIPConfiguration(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, private_ip_address: Optional[str] = None, private_ip_allocation_method: Optional[Union[str, IPAllocationMethod]] = None, subnet: Optional[SubResource] = None, public_ip_address: Optional[SubResource] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Frontend IP configuration of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • private_ip_address (str) – PrivateIPAddress of the network interface IP Configuration.

  • private_ip_allocation_method (str or IPAllocationMethod) – PrivateIP allocation method. 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’.

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

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

Frontend port of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • port (int) – Frontend port.

  • provisioning_state (str) – Provisioning state of the frontend port resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

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

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

Http listener of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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 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’.

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

Bases: azure.mgmt.network.v2017_03_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.

  • 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.

  • 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’.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayListResult(*, value: Optional[List[ApplicationGateway]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListApplicationGateways API service call.

Parameters

  • value (list[ApplicationGateway]) – List of an application gateways in a resource group.

  • next_link (str) – URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayOperationalState(value)[source]

Bases: str, enum.Enum

Operational state of the application gateway resource.

running = 'Running'
starting = 'Starting'
stopped = 'Stopped'
stopping = 'Stopping'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayPathRule(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, paths: Optional[List[str]] = None, backend_address_pool: Optional[SubResource] = None, backend_http_settings: Optional[SubResource] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Path rule of URL path map of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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’.

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

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

Probe of the application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • protocol (str or ApplicationGatewayProtocol) – Protocol. 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’.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayProtocol(value)[source]

Bases: str, enum.Enum

Protocol.

http = 'Http'
https = 'Https'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayRequestRoutingRule(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, rule_type: Optional[Union[str, ApplicationGatewayRequestRoutingRuleType]] = None, backend_address_pool: Optional[SubResource] = None, backend_http_settings: Optional[SubResource] = None, http_listener: Optional[SubResource] = None, url_path_map: Optional[SubResource] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Request routing rule of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • rule_type (str or ApplicationGatewayRequestRoutingRuleType) – Rule type. 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’.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayRequestRoutingRuleType(value)[source]

Bases: str, enum.Enum

Rule type.

basic = 'Basic'
path_based_routing = 'PathBasedRouting'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewaySku(*, name: Optional[Union[str, ApplicationGatewaySkuName]] = None, tier: Optional[Union[str, ApplicationGatewayTier]] = None, capacity: Optional[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 include: “Standard_Small”, “Standard_Medium”, “Standard_Large”, “WAF_Medium”, “WAF_Large”.

  • tier (str or ApplicationGatewayTier) – Tier of an application gateway. Possible values include: “Standard”, “WAF”.

  • capacity (int) – Capacity (instance count) of an application gateway.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewaySkuName(value)[source]

Bases: str, enum.Enum

Name of an application gateway SKU.

standard_large = 'Standard_Large'
standard_medium = 'Standard_Medium'
standard_small = 'Standard_Small'
waf_large = 'WAF_Large'
waf_medium = 'WAF_Medium'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewaySslCertificate(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, data: Optional[str] = None, password: Optional[str] = None, public_cert_data: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

SSL certificates of an application gateway.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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’.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewaySslPolicy(*, disabled_ssl_protocols: Optional[List[Union[str, ApplicationGatewaySslProtocol]]] = 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.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewaySslProtocol(value)[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.v2017_03_01.models.ApplicationGatewayTier(value)[source]

Bases: str, enum.Enum

Tier of an application gateway.

standard = 'Standard'
waf = 'WAF'
class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayUrlPathMap(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, default_backend_address_pool: Optional[SubResource] = None, default_backend_http_settings: Optional[SubResource] = None, path_rules: Optional[List[ApplicationGatewayPathRule]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

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

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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’.

class azure.mgmt.network.v2017_03_01.models.ApplicationGatewayWebApplicationFirewallConfiguration(*, enabled: bool, firewall_mode: Union[str, ApplicationGatewayFirewallMode], rule_set_type: str, rule_set_version: str, disabled_rule_groups: Optional[List[ApplicationGatewayFirewallDisabledRuleGroup]] = 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 or not.

  • firewall_mode (str or ApplicationGatewayFirewallMode) – Required. Web application firewall mode. Possible values include: “Detection”, “Prevention”.

  • rule_set_type (str) – Required. The type of the web application firewall rule set. Possible values are: ‘OWASP’.

  • rule_set_version (str) – Required. The version of the rule set type.

  • disabled_rule_groups (list[ApplicationGatewayFirewallDisabledRuleGroup]) – The disabled rule groups.

class azure.mgmt.network.v2017_03_01.models.AssociationType(value)[source]

Bases: str, enum.Enum

The association type of the child resource to the parent resource.

associated = 'Associated'
contains = 'Contains'
class azure.mgmt.network.v2017_03_01.models.AuthorizationListResult(*, value: Optional[List[ExpressRouteCircuitAuthorization]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit.

Parameters
class azure.mgmt.network.v2017_03_01.models.AuthorizationUseStatus(value)[source]

Bases: str, enum.Enum

AuthorizationUseStatus. Possible values are: ‘Available’ and ‘InUse’.

available = 'Available'
in_use = 'InUse'
class azure.mgmt.network.v2017_03_01.models.AzureAsyncOperationResult(*, status: Optional[Union[str, NetworkOperationStatus]] = None, error: Optional[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.v2017_03_01.models.BGPCommunity(*, service_supported_region: Optional[str] = None, community_name: Optional[str] = None, community_value: Optional[str] = None, community_prefixes: Optional[List[str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Contains bgp community information offered in Service Community resources.

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

Bases: azure.mgmt.network.v2017_03_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.

  • 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.

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

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.v2017_03_01.models.BgpPeerState(value)[source]

Bases: str, enum.Enum

The BGP peer state

connected = 'Connected'
connecting = 'Connecting'
idle = 'Idle'
stopped = 'Stopped'
unknown = 'Unknown'
class azure.mgmt.network.v2017_03_01.models.BgpPeerStatus(**kwargs)[source]

Bases: msrest.serialization.Model

BGP peer status details.

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.v2017_03_01.models.BgpPeerStatusListResult(*, value: Optional[List[BgpPeerStatus]] = 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.v2017_03_01.models.BgpServiceCommunity(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, service_name: Optional[str] = None, bgp_communities: Optional[List[BGPCommunity]] = None, **kwargs)[source]

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

Service Community Properties.

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]) – A set of tags. Resource tags.

  • service_name (str) – The name of the bgp community. e.g. Skype.

  • bgp_communities (list[BGPCommunity]) – Get a list of bgp communities.

Variables
class azure.mgmt.network.v2017_03_01.models.BgpServiceCommunityListResult(*, value: Optional[List[BgpServiceCommunity]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListServiceCommunity API service call.

Parameters

  • value (list[BgpServiceCommunity]) – A list of service community resources.

  • next_link (str) – The URL to get the next set of results.

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

Bases: msrest.serialization.Model

BGP settings details.

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.v2017_03_01.models.ConnectionResetSharedKey(*, key_length: int, **kwargs)[source]

Bases: msrest.serialization.Model

The virtual network connection reset shared key.

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.v2017_03_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.v2017_03_01.models.ConnectionStatus(value)[source]

Bases: str, enum.Enum

The connection status.

connected = 'Connected'
degraded = 'Degraded'
disconnected = 'Disconnected'
unknown = 'Unknown'
class azure.mgmt.network.v2017_03_01.models.ConnectivityDestination(*, resource_id: Optional[str] = None, address: Optional[str] = None, port: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters that define destination of connection.

Parameters

  • resource_id (str) – The ID of the resource to which a connection attempt will be made.

  • address (str) – The IP address or URI the resource to which a connection attempt will be made.

  • port (int) – Port on which check connectivity will be performed.

class azure.mgmt.network.v2017_03_01.models.ConnectivityHop(**kwargs)[source]

Bases: msrest.serialization.Model

Information about a hop between the source and the destination.

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

Variables

  • type (str) – The type of the hop.

  • id (str) – The ID of the hop.

  • address (str) – The IP address of the hop.

  • resource_id (str) – The ID of the resource corresponding to this hop.

  • next_hop_ids (list[str]) – List of next hop identifiers.

  • issues (list[ConnectivityIssue]) – List of issues.

class azure.mgmt.network.v2017_03_01.models.ConnectivityInformation(**kwargs)[source]

Bases: msrest.serialization.Model

Information on the connectivity status.

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

Variables

  • hops (list[ConnectivityHop]) – List of hops between the source and the destination.

  • connection_status (str or ConnectionStatus) – The connection status. Possible values include: “Unknown”, “Connected”, “Disconnected”, “Degraded”.

  • avg_latency_in_ms (int) – Average latency in milliseconds.

  • min_latency_in_ms (int) – Minimum latency in milliseconds.

  • max_latency_in_ms (int) – Maximum latency in milliseconds.

  • probes_sent (int) – Total number of probes sent.

  • probes_failed (int) – Number of failed probes.

class azure.mgmt.network.v2017_03_01.models.ConnectivityIssue(**kwargs)[source]

Bases: msrest.serialization.Model

Information about an issue encountered in the process of checking for connectivity.

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

Variables

  • origin (str or Origin) – The origin of the issue. Possible values include: “Local”, “Inbound”, “Outbound”.

  • severity (str or Severity) – The severity of the issue. Possible values include: “Error”, “Warning”.

  • type (str or IssueType) – The type of issue. Possible values include: “Unknown”, “AgentStopped”, “GuestFirewall”, “DnsResolution”, “SocketBind”, “NetworkSecurityRule”, “UserDefinedRoute”, “PortThrottled”, “Platform”.

  • context (list[dict[str, str]]) – Provides additional context on the issue.

class azure.mgmt.network.v2017_03_01.models.ConnectivityParameters(*, source: azure.mgmt.network.v2017_03_01.models._models_py3.ConnectivitySource, destination: azure.mgmt.network.v2017_03_01.models._models_py3.ConnectivityDestination, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters that determine how the connectivity check will be performed.

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

Parameters
class azure.mgmt.network.v2017_03_01.models.ConnectivitySource(*, resource_id: str, port: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters that define the source of the connection.

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

Parameters

  • resource_id (str) – Required. The ID of the resource from which a connectivity check will be initiated.

  • port (int) – The source port from which a connectivity check will be performed.

class azure.mgmt.network.v2017_03_01.models.DhGroup(value)[source]

Bases: str, enum.Enum

The DH Groups used in IKE Phase 1 for initial SA.

dh_group1 = 'DHGroup1'
dh_group14 = 'DHGroup14'
dh_group2 = 'DHGroup2'
dh_group2048 = 'DHGroup2048'
dh_group24 = 'DHGroup24'
ecp256 = 'ECP256'
ecp384 = 'ECP384'
none = 'None'
class azure.mgmt.network.v2017_03_01.models.DhcpOptions(*, dns_servers: Optional[List[str]] = 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.v2017_03_01.models.Direction(value)[source]

Bases: str, enum.Enum

The direction of the packet represented as a 5-tuple.

inbound = 'Inbound'
outbound = 'Outbound'
class azure.mgmt.network.v2017_03_01.models.DnsNameAvailabilityResult(*, available: Optional[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.v2017_03_01.models.EffectiveNetworkSecurityGroup(*, network_security_group: Optional[SubResource] = None, association: Optional[EffectiveNetworkSecurityGroupAssociation] = None, effective_security_rules: Optional[List[EffectiveNetworkSecurityRule]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Effective network security group.

Parameters
class azure.mgmt.network.v2017_03_01.models.EffectiveNetworkSecurityGroupAssociation(*, subnet: Optional[SubResource] = None, network_interface: Optional[SubResource] = 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.v2017_03_01.models.EffectiveNetworkSecurityGroupListResult(*, value: Optional[List[EffectiveNetworkSecurityGroup]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for list effective network security groups API service call.

Parameters
class azure.mgmt.network.v2017_03_01.models.EffectiveNetworkSecurityRule(*, name: Optional[str] = None, protocol: Optional[Union[str, SecurityRuleProtocol]] = None, source_port_range: Optional[str] = None, destination_port_range: Optional[str] = None, source_address_prefix: Optional[str] = None, destination_address_prefix: Optional[str] = None, expanded_source_address_prefix: Optional[List[str]] = None, expanded_destination_address_prefix: Optional[List[str]] = None, access: Optional[Union[str, SecurityRuleAccess]] = None, priority: Optional[int] = None, direction: Optional[Union[str, SecurityRuleDirection]] = 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.v2017_03_01.models.EffectiveRoute(*, name: Optional[str] = None, source: Optional[Union[str, EffectiveRouteSource]] = None, state: Optional[Union[str, EffectiveRouteState]] = None, address_prefix: Optional[List[str]] = None, next_hop_ip_address: Optional[List[str]] = None, next_hop_type: Optional[Union[str, RouteNextHopType]] = 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.v2017_03_01.models.EffectiveRouteListResult(*, value: Optional[List[EffectiveRoute]] = None, next_link: Optional[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.v2017_03_01.models.EffectiveRouteSource(value)[source]

Bases: str, enum.Enum

Who created the route. Possible values are: ‘Unknown’, ‘User’, ‘VirtualNetworkGateway’, and ‘Default’.

default = 'Default'
unknown = 'Unknown'
user = 'User'
virtual_network_gateway = 'VirtualNetworkGateway'
class azure.mgmt.network.v2017_03_01.models.EffectiveRouteState(value)[source]

Bases: str, enum.Enum

The value of effective route. Possible values are: ‘Active’ and ‘Invalid’.

active = 'Active'
invalid = 'Invalid'
class azure.mgmt.network.v2017_03_01.models.Error(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[ErrorDetails]] = None, inner_error: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Error.

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

Bases: msrest.serialization.Model

ErrorDetails.

Parameters

  • code (str) –

  • target (str) –

  • message (str) –

class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuit(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[ExpressRouteCircuitSku] = None, allow_classic_operations: Optional[bool] = None, circuit_provisioning_state: Optional[str] = None, service_provider_provisioning_state: Optional[Union[str, ServiceProviderProvisioningState]] = None, authorizations: Optional[List[ExpressRouteCircuitAuthorization]] = None, peerings: Optional[List[ExpressRouteCircuitPeering]] = None, service_key: Optional[str] = None, service_provider_notes: Optional[str] = None, service_provider_properties: Optional[ExpressRouteCircuitServiceProviderProperties] = None, provisioning_state: Optional[str] = None, gateway_manager_etag: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. 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.

Variables

  • name (str) – Resource name.

  • type (str) – Resource type.

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitArpTable(*, age: Optional[int] = None, interface: Optional[str] = None, ip_address: Optional[str] = None, mac_address: Optional[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.v2017_03_01.models.ExpressRouteCircuitAuthorization(*, id: Optional[str] = None, name: Optional[str] = None, authorization_key: Optional[str] = None, authorization_use_status: Optional[Union[str, AuthorizationUseStatus]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Authorization in an ExpressRouteCircuit resource.

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

Parameters

  • id (str) – Resource ID.

  • name (str) – Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

  • 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’.

Variables

etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitListResult(*, value: Optional[List[ExpressRouteCircuit]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListExpressRouteCircuit API service call.

Parameters

  • value (list[ExpressRouteCircuit]) – A list of ExpressRouteCircuits in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitPeering(*, id: Optional[str] = None, name: Optional[str] = None, peering_type: Optional[Union[str, ExpressRouteCircuitPeeringType]] = None, state: Optional[Union[str, ExpressRouteCircuitPeeringState]] = None, azure_asn: Optional[int] = None, peer_asn: Optional[int] = None, primary_peer_address_prefix: Optional[str] = None, secondary_peer_address_prefix: Optional[str] = None, primary_azure_port: Optional[str] = None, secondary_azure_port: Optional[str] = None, shared_key: Optional[str] = None, vlan_id: Optional[int] = None, microsoft_peering_config: Optional[ExpressRouteCircuitPeeringConfig] = None, stats: Optional[ExpressRouteCircuitStats] = None, provisioning_state: Optional[str] = None, gateway_manager_etag: Optional[str] = None, last_modified_by: Optional[str] = None, route_filter: Optional[RouteFilter] = None, ipv6_peering_config: Optional[Ipv6ExpressRouteCircuitPeeringConfig] = None, **kwargs)[source]

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

Peering in an ExpressRouteCircuit resource.

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

Parameters

  • id (str) – Resource ID.

  • name (str) – Gets name of the resource that is unique within a resource group. This name can be used to access the resource.

  • 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.

  • route_filter (RouteFilter) – The reference of the RouteFilter resource.

  • ipv6_peering_config (Ipv6ExpressRouteCircuitPeeringConfig) – The IPv6 peering configuration.

Variables

etag (str) – A unique read-only string that changes whenever the resource is updated.

class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitPeeringAdvertisedPublicPrefixState(value)[source]

Bases: str, enum.Enum

AdvertisedPublicPrefixState of the Peering resource. Possible values are ‘NotConfigured’, ‘Configuring’, ‘Configured’, and ‘ValidationNeeded’.

configured = 'Configured'
configuring = 'Configuring'
not_configured = 'NotConfigured'
validation_needed = 'ValidationNeeded'
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitPeeringConfig(*, advertised_public_prefixes: Optional[List[str]] = None, advertised_public_prefixes_state: Optional[Union[str, ExpressRouteCircuitPeeringAdvertisedPublicPrefixState]] = None, customer_asn: Optional[int] = None, routing_registry_name: Optional[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.v2017_03_01.models.ExpressRouteCircuitPeeringListResult(*, value: Optional[List[ExpressRouteCircuitPeering]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit.

Parameters
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitPeeringState(value)[source]

Bases: str, enum.Enum

The state of peering. Possible values are: ‘Disabled’ and ‘Enabled’

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitPeeringType(value)[source]

Bases: str, enum.Enum

The PeeringType. Possible values are: ‘AzurePublicPeering’, ‘AzurePrivatePeering’, and ‘MicrosoftPeering’.

azure_private_peering = 'AzurePrivatePeering'
azure_public_peering = 'AzurePublicPeering'
microsoft_peering = 'MicrosoftPeering'
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitRoutesTable(*, network: Optional[str] = None, next_hop: Optional[str] = None, loc_prf: Optional[str] = None, weight: Optional[int] = None, path: Optional[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.v2017_03_01.models.ExpressRouteCircuitRoutesTableSummary(*, neighbor: Optional[str] = None, v: Optional[int] = None, as_property: Optional[int] = None, up_down: Optional[str] = None, state_pfx_rcd: Optional[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.v2017_03_01.models.ExpressRouteCircuitServiceProviderProperties(*, service_provider_name: Optional[str] = None, peering_location: Optional[str] = None, bandwidth_in_mbps: Optional[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.v2017_03_01.models.ExpressRouteCircuitSku(*, name: Optional[str] = None, tier: Optional[Union[str, ExpressRouteCircuitSkuTier]] = None, family: Optional[Union[str, ExpressRouteCircuitSkuFamily]] = 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.v2017_03_01.models.ExpressRouteCircuitSkuFamily(value)[source]

Bases: str, enum.Enum

The family of the SKU. Possible values are: ‘UnlimitedData’ and ‘MeteredData’.

metered_data = 'MeteredData'
unlimited_data = 'UnlimitedData'
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitSkuTier(value)[source]

Bases: str, enum.Enum

The tier of the SKU. Possible values are ‘Standard’ and ‘Premium’.

premium = 'Premium'
standard = 'Standard'
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitStats(*, primarybytes_in: Optional[int] = None, primarybytes_out: Optional[int] = None, secondarybytes_in: Optional[int] = None, secondarybytes_out: Optional[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.v2017_03_01.models.ExpressRouteCircuitsArpTableListResult(*, value: Optional[List[ExpressRouteCircuitArpTable]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListArpTable associated with the Express Route Circuits API.

Parameters
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitsRoutesTableListResult(*, value: Optional[List[ExpressRouteCircuitRoutesTable]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListRoutesTable associated with the Express Route Circuits API.

Parameters
class azure.mgmt.network.v2017_03_01.models.ExpressRouteCircuitsRoutesTableSummaryListResult(*, value: Optional[List[ExpressRouteCircuitRoutesTableSummary]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListRoutesTable associated with the Express Route Circuits API.

Parameters
class azure.mgmt.network.v2017_03_01.models.ExpressRouteServiceProvider(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, peering_locations: Optional[List[str]] = None, bandwidths_offered: Optional[List[ExpressRouteServiceProviderBandwidthsOffered]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

A ExpressRouteResourceProvider object.

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

Parameters
Variables
class azure.mgmt.network.v2017_03_01.models.ExpressRouteServiceProviderBandwidthsOffered(*, offer_name: Optional[str] = None, value_in_mbps: Optional[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.v2017_03_01.models.ExpressRouteServiceProviderListResult(*, value: Optional[List[ExpressRouteServiceProvider]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListExpressRouteServiceProvider API service call.

Parameters
class azure.mgmt.network.v2017_03_01.models.FlowLogInformation(*, target_resource_id: str, storage_id: str, enabled: bool, retention_policy: Optional[RetentionPolicyParameters] = 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) – Parameters that define the retention policy for flow log.

class azure.mgmt.network.v2017_03_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.v2017_03_01.models.FrontendIPConfiguration(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, private_ip_address: Optional[str] = None, private_ip_allocation_method: Optional[Union[str, IPAllocationMethod]] = None, subnet: Optional[Subnet] = None, public_ip_address: Optional[PublicIPAddress] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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.

  • 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.

  • 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’.

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.v2017_03_01.models.GatewayRoute(**kwargs)[source]

Bases: msrest.serialization.Model

Gateway routing details.

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.v2017_03_01.models.GatewayRouteListResult(*, value: Optional[List[GatewayRoute]] = 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.v2017_03_01.models.IPAddressAvailabilityResult(*, available: Optional[bool] = None, available_ip_addresses: Optional[List[str]] = 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.v2017_03_01.models.IPAllocationMethod(value)[source]

Bases: str, enum.Enum

PrivateIP allocation method.

dynamic = 'Dynamic'
static = 'Static'
class azure.mgmt.network.v2017_03_01.models.IPConfiguration(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, private_ip_address: Optional[str] = None, private_ip_allocation_method: Optional[Union[str, IPAllocationMethod]] = None, subnet: Optional[Subnet] = None, public_ip_address: Optional[PublicIPAddress] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

IPConfiguration.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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’.

class azure.mgmt.network.v2017_03_01.models.IPVersion(value)[source]

Bases: str, enum.Enum

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’.

i_pv4 = 'IPv4'
i_pv6 = 'IPv6'
class azure.mgmt.network.v2017_03_01.models.IkeEncryption(value)[source]

Bases: str, enum.Enum

The IKE encryption algorithm (IKE phase 2).

aes128 = 'AES128'
aes192 = 'AES192'
aes256 = 'AES256'
des = 'DES'
des3 = 'DES3'
class azure.mgmt.network.v2017_03_01.models.IkeIntegrity(value)[source]

Bases: str, enum.Enum

The IKE integrity algorithm (IKE phase 2).

md5 = 'MD5'
sha1 = 'SHA1'
sha256 = 'SHA256'
sha384 = 'SHA384'
class azure.mgmt.network.v2017_03_01.models.InboundNatPool(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, frontend_ip_configuration: Optional[SubResource] = None, protocol: Optional[Union[str, TransportProtocol]] = None, frontend_port_range_start: Optional[int] = None, frontend_port_range_end: Optional[int] = None, backend_port: Optional[int] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Inbound NAT pool of the load balancer.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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_range_start (int) – 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) – 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) – 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’.

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

Bases: azure.mgmt.network.v2017_03_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.

  • 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.

  • 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’.

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.v2017_03_01.models.IpsecEncryption(value)[source]

Bases: str, enum.Enum

The IPSec encryption algorithm (IKE phase 1).

aes128 = 'AES128'
aes192 = 'AES192'
aes256 = 'AES256'
des = 'DES'
des3 = 'DES3'
gcmaes128 = 'GCMAES128'
gcmaes192 = 'GCMAES192'
gcmaes256 = 'GCMAES256'
none = 'None'
class azure.mgmt.network.v2017_03_01.models.IpsecIntegrity(value)[source]

Bases: str, enum.Enum

The IPSec integrity algorithm (IKE phase 1).

gcmaes128 = 'GCMAES128'
gcmaes192 = 'GCMAES192'
gcmaes256 = 'GCMAES256'
md5 = 'MD5'
sha1 = 'SHA1'
sha256 = 'SHA256'
class azure.mgmt.network.v2017_03_01.models.IpsecPolicy(*, sa_life_time_seconds: int, sa_data_size_kilobytes: int, ipsec_encryption: Union[str, IpsecEncryption], ipsec_integrity: Union[str, IpsecIntegrity], ike_encryption: Union[str, IkeEncryption], ike_integrity: Union[str, IkeIntegrity], dh_group: Union[str, DhGroup], pfs_group: Union[str, PfsGroup], **kwargs)[source]

Bases: msrest.serialization.Model

An IPSec Policy configuration for a virtual network gateway connection.

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

Parameters

  • sa_life_time_seconds (int) – Required. The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

  • sa_data_size_kilobytes (int) – Required. The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.

  • ipsec_encryption (str or IpsecEncryption) – Required. The IPSec encryption algorithm (IKE phase 1). Possible values include: “None”, “DES”, “DES3”, “AES128”, “AES192”, “AES256”, “GCMAES128”, “GCMAES192”, “GCMAES256”.

  • ipsec_integrity (str or IpsecIntegrity) – Required. The IPSec integrity algorithm (IKE phase 1). Possible values include: “MD5”, “SHA1”, “SHA256”, “GCMAES128”, “GCMAES192”, “GCMAES256”.

  • ike_encryption (str or IkeEncryption) – Required. The IKE encryption algorithm (IKE phase 2). Possible values include: “DES”, “DES3”, “AES128”, “AES192”, “AES256”.

  • ike_integrity (str or IkeIntegrity) – Required. The IKE integrity algorithm (IKE phase 2). Possible values include: “MD5”, “SHA1”, “SHA256”, “SHA384”.

  • dh_group (str or DhGroup) – Required. The DH Groups used in IKE Phase 1 for initial SA. Possible values include: “None”, “DHGroup1”, “DHGroup2”, “DHGroup14”, “DHGroup2048”, “ECP256”, “ECP384”, “DHGroup24”.

  • pfs_group (str or PfsGroup) – Required. The DH Groups used in IKE Phase 2 for new child SA. Possible values include: “None”, “PFS1”, “PFS2”, “PFS2048”, “ECP256”, “ECP384”, “PFS24”.

class azure.mgmt.network.v2017_03_01.models.Ipv6ExpressRouteCircuitPeeringConfig(*, primary_peer_address_prefix: Optional[str] = None, secondary_peer_address_prefix: Optional[str] = None, microsoft_peering_config: Optional[ExpressRouteCircuitPeeringConfig] = None, route_filter: Optional[RouteFilter] = None, state: Optional[Union[str, ExpressRouteCircuitPeeringState]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Contains IPv6 peering config.

Parameters

  • primary_peer_address_prefix (str) – The primary address prefix.

  • secondary_peer_address_prefix (str) – The secondary address prefix.

  • microsoft_peering_config (ExpressRouteCircuitPeeringConfig) – The Microsoft peering configuration.

  • route_filter (RouteFilter) – The reference of the RouteFilter resource.

  • state (str or ExpressRouteCircuitPeeringState) – The state of peering. Possible values are: ‘Disabled’ and ‘Enabled’. Possible values include: “Disabled”, “Enabled”.

class azure.mgmt.network.v2017_03_01.models.IssueType(value)[source]

Bases: str, enum.Enum

The type of issue.

agent_stopped = 'AgentStopped'
dns_resolution = 'DnsResolution'
guest_firewall = 'GuestFirewall'
network_security_rule = 'NetworkSecurityRule'
platform = 'Platform'
port_throttled = 'PortThrottled'
socket_bind = 'SocketBind'
unknown = 'Unknown'
user_defined_route = 'UserDefinedRoute'
class azure.mgmt.network.v2017_03_01.models.LoadBalancer(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, frontend_ip_configurations: Optional[List[FrontendIPConfiguration]] = None, backend_address_pools: Optional[List[BackendAddressPool]] = None, load_balancing_rules: Optional[List[LoadBalancingRule]] = None, probes: Optional[List[Probe]] = None, inbound_nat_rules: Optional[List[InboundNatRule]] = None, inbound_nat_pools: Optional[List[InboundNatPool]] = None, outbound_nat_rules: Optional[List[OutboundNatRule]] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. Resource tags.

  • etag (str) – A unique read-only string that changes whenever the resource is updated.

  • 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’.

Variables
class azure.mgmt.network.v2017_03_01.models.LoadBalancerListResult(*, value: Optional[List[LoadBalancer]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListLoadBalancers API service call.

Parameters

  • value (list[LoadBalancer]) – A list of load balancers in a resource group.

  • next_link (str) – The URL to get the next set of results.

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

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

A load balancing rule for a load balancer.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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) – 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) – 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’.

class azure.mgmt.network.v2017_03_01.models.LoadDistribution(value)[source]

Bases: str, enum.Enum

The load distribution policy for this rule. Possible values are ‘Default’, ‘SourceIP’, and ‘SourceIPProtocol’.

default = 'Default'
source_ip = 'SourceIP'
source_ip_protocol = 'SourceIPProtocol'
class azure.mgmt.network.v2017_03_01.models.LocalNetworkGateway(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, local_network_address_space: Optional[AddressSpace] = None, gateway_ip_address: Optional[str] = None, bgp_settings: Optional[BgpSettings] = None, resource_guid: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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.

Parameters

  • id (str) – Resource ID.

  • location (str) – Resource location.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • etag (str) – A unique read-only string that changes whenever the resource is updated.

  • local_network_address_space (AddressSpace) – 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.

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.v2017_03_01.models.LocalNetworkGatewayListResult(*, value: Optional[List[LocalNetworkGateway]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListLocalNetworkGateways API service call.

Parameters

  • value (list[LocalNetworkGateway]) – A list of local network gateways that exists in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.NetworkInterface(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, virtual_machine: Optional[SubResource] = None, network_security_group: Optional[NetworkSecurityGroup] = None, ip_configurations: Optional[List[NetworkInterfaceIPConfiguration]] = None, dns_settings: Optional[NetworkInterfaceDnsSettings] = None, mac_address: Optional[str] = None, primary: Optional[bool] = None, enable_accelerated_networking: Optional[bool] = None, enable_ip_forwarding: Optional[bool] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. Resource tags.

  • etag (str) – A unique read-only string that changes whenever the resource is updated.

  • 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’.

Variables
class azure.mgmt.network.v2017_03_01.models.NetworkInterfaceAssociation(*, security_rules: Optional[List[SecurityRule]] = 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.v2017_03_01.models.NetworkInterfaceDnsSettings(*, dns_servers: Optional[List[str]] = None, applied_dns_servers: Optional[List[str]] = None, internal_dns_name_label: Optional[str] = None, internal_fqdn: Optional[str] = None, internal_domain_name_suffix: Optional[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.v2017_03_01.models.NetworkInterfaceIPConfiguration(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, application_gateway_backend_address_pools: Optional[List[ApplicationGatewayBackendAddressPool]] = None, load_balancer_backend_address_pools: Optional[List[BackendAddressPool]] = None, load_balancer_inbound_nat_rules: Optional[List[InboundNatRule]] = None, private_ip_address: Optional[str] = None, private_ip_allocation_method: Optional[Union[str, IPAllocationMethod]] = None, private_ip_address_version: Optional[Union[str, IPVersion]] = None, subnet: Optional[Subnet] = None, primary: Optional[bool] = None, public_ip_address: Optional[PublicIPAddress] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

IPConfiguration in a network interface.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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) – Subnet in a virtual network resource.

  • primary (bool) – Gets whether this is a primary customer address on the network interface.

  • public_ip_address (PublicIPAddress) – Public IP address resource.

  • provisioning_state (str) –

class azure.mgmt.network.v2017_03_01.models.NetworkInterfaceListResult(*, value: Optional[List[NetworkInterface]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListNetworkInterface API service call.

Parameters

  • value (list[NetworkInterface]) – A list of network interfaces in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.NetworkOperationStatus(value)[source]

Bases: str, enum.Enum

Status of the Azure async operation. Possible values are: ‘InProgress’, ‘Succeeded’, and ‘Failed’.

failed = 'Failed'
in_progress = 'InProgress'
succeeded = 'Succeeded'
class azure.mgmt.network.v2017_03_01.models.NetworkSecurityGroup(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, security_rules: Optional[List[SecurityRule]] = None, default_security_rules: Optional[List[SecurityRule]] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. Resource tags.

  • etag (str) – A unique read-only string that changes whenever the resource is updated.

  • 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’.

Variables
class azure.mgmt.network.v2017_03_01.models.NetworkSecurityGroupListResult(*, value: Optional[List[NetworkSecurityGroup]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListNetworkSecurityGroups API service call.

Parameters

  • value (list[NetworkSecurityGroup]) – A list of NetworkSecurityGroup resources.

  • next_link (str) – The URL to get the next set of results.

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

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. 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.v2017_03_01.models.NetworkWatcherListResult(*, value: Optional[List[NetworkWatcher]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

List of network watcher resources.

Parameters

value (list[NetworkWatcher]) –

class azure.mgmt.network.v2017_03_01.models.NextHopParameters(*, target_resource_id: str, source_ip_address: str, destination_ip_address: str, target_nic_resource_id: Optional[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.v2017_03_01.models.NextHopResult(*, next_hop_type: Optional[Union[str, NextHopType]] = None, next_hop_ip_address: Optional[str] = None, route_table_id: Optional[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.v2017_03_01.models.NextHopType(value)[source]

Bases: str, enum.Enum

Next hop type.

hyper_net_gateway = 'HyperNetGateway'
internet = 'Internet'
none = 'None'
virtual_appliance = 'VirtualAppliance'
virtual_network_gateway = 'VirtualNetworkGateway'
vnet_local = 'VnetLocal'
class azure.mgmt.network.v2017_03_01.models.Origin(value)[source]

Bases: str, enum.Enum

The origin of the issue.

inbound = 'Inbound'
local = 'Local'
outbound = 'Outbound'
class azure.mgmt.network.v2017_03_01.models.OutboundNatRule(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, allocated_outbound_ports: Optional[int] = None, frontend_ip_configurations: Optional[List[SubResource]] = None, backend_address_pool: Optional[SubResource] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Outbound NAT pool of the load balancer.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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) – 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’.

class azure.mgmt.network.v2017_03_01.models.PacketCapture(*, target: str, storage_location: azure.mgmt.network.v2017_03_01.models._models_py3.PacketCaptureStorageLocation, bytes_to_capture_per_packet: Optional[int] = 0, total_bytes_per_session: Optional[int] = 1073741824, time_limit_in_seconds: Optional[int] = 18000, filters: Optional[List[PacketCaptureFilter]] = 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.

  • total_bytes_per_session (int) – Maximum size of the capture output.

  • time_limit_in_seconds (int) – Maximum duration of the capture session in seconds.

  • storage_location (PacketCaptureStorageLocation) – Required. Describes the storage location for a packet capture session.

  • filters (list[PacketCaptureFilter]) –

class azure.mgmt.network.v2017_03_01.models.PacketCaptureFilter(*, protocol: Optional[Union[str, PcProtocol]] = 'Any', local_ip_address: Optional[str] = None, remote_ip_address: Optional[str] = None, local_port: Optional[str] = None, remote_port: Optional[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.v2017_03_01.models.PacketCaptureListResult(*, value: Optional[List[PacketCaptureResult]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

List of packet capture sessions.

Parameters

value (list[PacketCaptureResult]) – Information about packet capture sessions.

class azure.mgmt.network.v2017_03_01.models.PacketCaptureParameters(*, target: str, storage_location: azure.mgmt.network.v2017_03_01.models._models_py3.PacketCaptureStorageLocation, bytes_to_capture_per_packet: Optional[int] = 0, total_bytes_per_session: Optional[int] = 1073741824, time_limit_in_seconds: Optional[int] = 18000, filters: Optional[List[PacketCaptureFilter]] = 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.

  • total_bytes_per_session (int) – Maximum size of the capture output.

  • time_limit_in_seconds (int) – Maximum duration of the capture session in seconds.

  • storage_location (PacketCaptureStorageLocation) – Required. Describes the storage location for a packet capture session.

  • filters (list[PacketCaptureFilter]) –

class azure.mgmt.network.v2017_03_01.models.PacketCaptureQueryStatusResult(*, name: Optional[str] = None, id: Optional[str] = None, capture_start_time: Optional[datetime.datetime] = None, packet_capture_status: Optional[Union[str, PcStatus]] = None, stop_reason: Optional[str] = None, packet_capture_error: Optional[List[Union[str, PcError]]] = 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.v2017_03_01.models.PacketCaptureResult(*, etag: Optional[str] = 'A unique read-only string that changes whenever the resource is updated.', target: Optional[str] = None, bytes_to_capture_per_packet: Optional[int] = 0, total_bytes_per_session: Optional[int] = 1073741824, time_limit_in_seconds: Optional[int] = 18000, storage_location: Optional[PacketCaptureStorageLocation] = None, filters: Optional[List[PacketCaptureFilter]] = None, provisioning_state: Optional[Union[str, ProvisioningState]] = 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.

Variables

  • name (str) – Name of the packet capture session.

  • id (str) – ID of the packet capture operation.

Parameters

  • etag (str) –

  • target (str) – 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.

  • total_bytes_per_session (int) – Maximum size of the capture output.

  • time_limit_in_seconds (int) – Maximum duration of the capture session in seconds.

  • storage_location (PacketCaptureStorageLocation) – Describes the storage location for a packet capture session.

  • 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.v2017_03_01.models.PacketCaptureResultProperties(*, target: str, storage_location: azure.mgmt.network.v2017_03_01.models._models_py3.PacketCaptureStorageLocation, bytes_to_capture_per_packet: Optional[int] = 0, total_bytes_per_session: Optional[int] = 1073741824, time_limit_in_seconds: Optional[int] = 18000, filters: Optional[List[PacketCaptureFilter]] = None, provisioning_state: Optional[Union[str, ProvisioningState]] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_01.models._models_py3.PacketCaptureParameters

Describes the properties of a packet capture session.

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.

  • total_bytes_per_session (int) – Maximum size of the capture output.

  • time_limit_in_seconds (int) – Maximum duration of the capture session in seconds.

  • storage_location (PacketCaptureStorageLocation) – Required. Describes the storage location for a packet capture session.

  • 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.v2017_03_01.models.PacketCaptureStorageLocation(*, storage_id: Optional[str] = None, storage_path: Optional[str] = None, file_path: Optional[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.v2017_03_01.models.PatchRouteFilter(*, id: Optional[str] = None, tags: Optional[Dict[str, str]] = None, rules: Optional[List[RouteFilterRule]] = None, **kwargs)[source]

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

Route Filter Resource.

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

Parameters

  • id (str) – Resource ID.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • rules (list[RouteFilterRule]) – Collection of RouteFilterRules contained within a route filter.

Variables

  • 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.

  • type (str) – Resource type.

  • peerings (list[ExpressRouteCircuitPeering]) – A collection of references to express route circuit peerings.

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

class azure.mgmt.network.v2017_03_01.models.PatchRouteFilterRule(*, id: Optional[str] = None, tags: Optional[Dict[str, str]] = None, access: Optional[Union[str, Access]] = None, communities: Optional[List[str]] = None, **kwargs)[source]

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

Route Filter Rule Resource.

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

Parameters

  • id (str) – Resource ID.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • access (str or Access) – The access type of the rule. Valid values are: ‘Allow’, ‘Deny’. Possible values include: “Allow”, “Deny”.

  • communities (list[str]) – The collection for bgp community values to filter on. e.g. [‘12076:5010’,’12076:5020’].

Variables

  • 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.

  • route_filter_rule_type (str) – The rule type of the rule. Valid value is: ‘Community’. Default value: “Community”.

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

route_filter_rule_type = 'Community'
class azure.mgmt.network.v2017_03_01.models.PcError(value)[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.v2017_03_01.models.PcProtocol(value)[source]

Bases: str, enum.Enum

Protocol to be filtered on.

any = 'Any'
tcp = 'TCP'
udp = 'UDP'
class azure.mgmt.network.v2017_03_01.models.PcStatus(value)[source]

Bases: str, enum.Enum

The status of the packet capture session.

error = 'Error'
not_started = 'NotStarted'
running = 'Running'
stopped = 'Stopped'
unknown = 'Unknown'
class azure.mgmt.network.v2017_03_01.models.PfsGroup(value)[source]

Bases: str, enum.Enum

The DH Groups used in IKE Phase 2 for new child SA.

ecp256 = 'ECP256'
ecp384 = 'ECP384'
none = 'None'
pfs1 = 'PFS1'
pfs2 = 'PFS2'
pfs2048 = 'PFS2048'
pfs24 = 'PFS24'
class azure.mgmt.network.v2017_03_01.models.Probe(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, protocol: Optional[Union[str, ProbeProtocol]] = None, port: Optional[int] = None, interval_in_seconds: Optional[int] = None, number_of_probes: Optional[int] = None, request_path: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

A load balancer probe.

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

Parameters

  • id (str) – Resource ID.

  • 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.

  • protocol (str or ProbeProtocol) – 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) – 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’.

Variables

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

class azure.mgmt.network.v2017_03_01.models.ProbeProtocol(value)[source]

Bases: str, enum.Enum

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.

http = 'Http'
tcp = 'Tcp'
class azure.mgmt.network.v2017_03_01.models.ProcessorArchitecture(value)[source]

Bases: str, enum.Enum

VPN client Processor Architecture. Possible values are: ‘AMD64’ and ‘X86’.

amd64 = 'Amd64'
x86 = 'X86'
class azure.mgmt.network.v2017_03_01.models.Protocol(value)[source]

Bases: str, enum.Enum

Protocol to be verified on.

tcp = 'TCP'
udp = 'UDP'
class azure.mgmt.network.v2017_03_01.models.ProvisioningState(value)[source]

Bases: str, enum.Enum

The provisioning state of the resource.

deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.network.v2017_03_01.models.PublicIPAddress(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, public_ip_allocation_method: Optional[Union[str, IPAllocationMethod]] = None, public_ip_address_version: Optional[Union[str, IPVersion]] = None, dns_settings: Optional[PublicIPAddressDnsSettings] = None, ip_address: Optional[str] = None, idle_timeout_in_minutes: Optional[int] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. Resource tags.

  • etag (str) – A unique read-only string that changes whenever the resource is updated.

  • 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’.

Variables
class azure.mgmt.network.v2017_03_01.models.PublicIPAddressDnsSettings(*, domain_name_label: Optional[str] = None, fqdn: Optional[str] = None, reverse_fqdn: Optional[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.v2017_03_01.models.PublicIPAddressListResult(*, value: Optional[List[PublicIPAddress]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListPublicIpAddresses API service call.

Parameters

  • value (list[PublicIPAddress]) – A list of public IP addresses that exists in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_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.v2017_03_01.models.Resource(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = 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]) – A set of tags. Resource tags.

Variables

Bases: azure.mgmt.network.v2017_03_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.

  • name (str) – Name of the resource that is unique within a resource group. This name can be used to access the resource.

  • linked_resource_type (str) – Resource type of the linked resource.

  • link (str) – Link to the external resource.

Variables

  • etag (str) – A unique read-only string that changes whenever the resource is updated.

  • provisioning_state (str) – Provisioning state of the ResourceNavigationLink resource.

class azure.mgmt.network.v2017_03_01.models.RetentionPolicyParameters(*, days: Optional[int] = 0, enabled: Optional[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.

  • enabled (bool) – Flag to enable/disable retention.

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

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

Route resource.

Parameters

  • id (str) – Resource ID.

  • 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.

  • address_prefix (str) – The destination CIDR to which the route applies.

  • 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”.

  • 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’.

class azure.mgmt.network.v2017_03_01.models.RouteFilter(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, rules: Optional[List[RouteFilterRule]] = None, **kwargs)[source]

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

Route Filter 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]) – A set of tags. Resource tags.

  • rules (list[RouteFilterRule]) – Collection of RouteFilterRules contained within a route filter.

Variables

  • name (str) – Resource name.

  • type (str) – Resource type.

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

  • peerings (list[ExpressRouteCircuitPeering]) – A collection of references to express route circuit peerings.

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

class azure.mgmt.network.v2017_03_01.models.RouteFilterListResult(*, value: Optional[List[RouteFilter]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListRouteFilters API service call.

Parameters

  • value (list[RouteFilter]) – Gets a list of route filters in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.RouteFilterRule(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, access: Optional[Union[str, Access]] = None, communities: Optional[List[str]] = None, **kwargs)[source]

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

Route Filter Rule 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]) – A set of tags. Resource tags.

  • access (str or Access) – The access type of the rule. Valid values are: ‘Allow’, ‘Deny’. Possible values include: “Allow”, “Deny”.

  • communities (list[str]) – The collection for bgp community values to filter on. e.g. [‘12076:5010’,’12076:5020’].

Variables

  • 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.

  • route_filter_rule_type (str) – The rule type of the rule. Valid value is: ‘Community’. Default value: “Community”.

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

route_filter_rule_type = 'Community'
class azure.mgmt.network.v2017_03_01.models.RouteFilterRuleListResult(*, value: Optional[List[RouteFilterRule]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListRouteFilterRules API service call.

Parameters

  • value (list[RouteFilterRule]) – Gets a list of RouteFilterRules in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.RouteListResult(*, value: Optional[List[Route]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListRoute API service call.

Parameters

  • value (list[Route]) – Gets a list of routes in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.RouteNextHopType(value)[source]

Bases: str, enum.Enum

The type of Azure hop the packet should be sent to. Possible values are: ‘VirtualNetworkGateway’, ‘VnetLocal’, ‘Internet’, ‘VirtualAppliance’, and ‘None’.

internet = 'Internet'
none = 'None'
virtual_appliance = 'VirtualAppliance'
virtual_network_gateway = 'VirtualNetworkGateway'
vnet_local = 'VnetLocal'
class azure.mgmt.network.v2017_03_01.models.RouteTable(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, routes: Optional[List[Route]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. Resource tags.

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

  • 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’.

Variables
class azure.mgmt.network.v2017_03_01.models.RouteTableListResult(*, value: Optional[List[RouteTable]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListRouteTable API service call.

Parameters

  • value (list[RouteTable]) – Gets a list of route tables in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.SecurityGroupNetworkInterface(*, id: Optional[str] = None, security_rule_associations: Optional[SecurityRuleAssociations] = 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) – All security rules associated with the network interface.

class azure.mgmt.network.v2017_03_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.v2017_03_01.models.SecurityGroupViewResult(*, network_interfaces: Optional[List[SecurityGroupNetworkInterface]] = 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.v2017_03_01.models.SecurityRule(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, description: Optional[str] = None, protocol: Optional[Union[str, SecurityRuleProtocol]] = None, source_port_range: Optional[str] = None, destination_port_range: Optional[str] = None, source_address_prefix: Optional[str] = None, destination_address_prefix: Optional[str] = None, access: Optional[Union[str, SecurityRuleAccess]] = None, priority: Optional[int] = None, direction: Optional[Union[str, SecurityRuleDirection]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

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

Network security rule.

Parameters

  • id (str) – Resource ID.

  • 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.

  • description (str) – A description for this rule. Restricted to 140 chars.

  • protocol (str or SecurityRuleProtocol) – 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) – 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) – 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) – 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) – 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’.

class azure.mgmt.network.v2017_03_01.models.SecurityRuleAccess(value)[source]

Bases: str, enum.Enum

Whether network traffic is allowed or denied. Possible values are: ‘Allow’ and ‘Deny’.

allow = 'Allow'
deny = 'Deny'
class azure.mgmt.network.v2017_03_01.models.SecurityRuleAssociations(*, network_interface_association: Optional[NetworkInterfaceAssociation] = None, subnet_association: Optional[SubnetAssociation] = None, default_security_rules: Optional[List[SecurityRule]] = None, effective_security_rules: Optional[List[EffectiveNetworkSecurityRule]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

All security rules associated with the network interface.

Parameters
class azure.mgmt.network.v2017_03_01.models.SecurityRuleDirection(value)[source]

Bases: str, enum.Enum

The direction of the rule. Possible values are: ‘Inbound and Outbound’.

inbound = 'Inbound'
outbound = 'Outbound'
class azure.mgmt.network.v2017_03_01.models.SecurityRuleListResult(*, value: Optional[List[SecurityRule]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group.

Parameters

  • value (list[SecurityRule]) – The security rules in a network security group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.SecurityRuleProtocol(value)[source]

Bases: str, enum.Enum

The network protocol this rule applies to. Possible values are: ‘Tcp’, ‘Udp’, and ‘*’.

asterisk = '*'
tcp = 'Tcp'
udp = 'Udp'
class azure.mgmt.network.v2017_03_01.models.ServiceProviderProvisioningState(value)[source]

Bases: str, enum.Enum

The ServiceProviderProvisioningState state of the resource. Possible values are ‘NotProvisioned’, ‘Provisioning’, ‘Provisioned’, and ‘Deprovisioning’.

deprovisioning = 'Deprovisioning'
not_provisioned = 'NotProvisioned'
provisioned = 'Provisioned'
provisioning = 'Provisioning'
class azure.mgmt.network.v2017_03_01.models.Severity(value)[source]

Bases: str, enum.Enum

The severity of the issue.

error = 'Error'
warning = 'Warning'
class azure.mgmt.network.v2017_03_01.models.SubResource(*, id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

SubResource.

Parameters

id (str) – Resource ID.

class azure.mgmt.network.v2017_03_01.models.Subnet(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, address_prefix: Optional[str] = None, network_security_group: Optional[NetworkSecurityGroup] = None, route_table: Optional[RouteTable] = None, resource_navigation_links: Optional[List[ResourceNavigationLink]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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.

  • 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.

  • 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.

Variables

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

class azure.mgmt.network.v2017_03_01.models.SubnetAssociation(*, security_rules: Optional[List[SecurityRule]] = 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.v2017_03_01.models.SubnetListResult(*, value: Optional[List[Subnet]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network.

Parameters

  • value (list[Subnet]) – The subnets in a virtual network.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.Topology(*, resources: Optional[List[TopologyResource]] = 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.v2017_03_01.models.TopologyAssociation(*, name: Optional[str] = None, resource_id: Optional[str] = None, association_type: Optional[Union[str, AssociationType]] = 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.v2017_03_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.v2017_03_01.models.TopologyResource(*, name: Optional[str] = None, id: Optional[str] = None, location: Optional[str] = None, associations: Optional[List[TopologyAssociation]] = 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.v2017_03_01.models.TransportProtocol(value)[source]

Bases: str, enum.Enum

The transport protocol for the external endpoint. Possible values are ‘Udp’ or ‘Tcp’

tcp = 'Tcp'
udp = 'Udp'
class azure.mgmt.network.v2017_03_01.models.TroubleshootingDetails(*, id: Optional[str] = None, reason_type: Optional[str] = None, summary: Optional[str] = None, detail: Optional[str] = None, recommended_actions: Optional[List[TroubleshootingRecommendedActions]] = 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.v2017_03_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.v2017_03_01.models.TroubleshootingRecommendedActions(*, action_id: Optional[str] = None, action_text: Optional[str] = None, action_uri: Optional[str] = None, action_uri_text: Optional[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.v2017_03_01.models.TroubleshootingResult(*, start_time: Optional[datetime.datetime] = None, end_time: Optional[datetime.datetime] = None, code: Optional[str] = None, results: Optional[List[TroubleshootingDetails]] = 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.v2017_03_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.v2017_03_01.models.Usage(*, current_value: int, limit: int, name: azure.mgmt.network.v2017_03_01.models._models_py3.UsageName, **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.v2017_03_01.models.UsageName(*, value: Optional[str] = None, localized_value: Optional[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.v2017_03_01.models.UsagesListResult(*, value: Optional[List[Usage]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The list usages operation response.

Parameters

  • value (list[Usage]) – The list network resource usages.

  • next_link (str) – URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.VerificationIPFlowParameters(*, target_resource_id: str, direction: Union[str, Direction], protocol: Union[str, Protocol], local_port: str, remote_port: str, local_ip_address: str, remote_ip_address: str, target_nic_resource_id: Optional[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.v2017_03_01.models.VerificationIPFlowResult(*, access: Optional[Union[str, Access]] = None, rule_name: Optional[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.v2017_03_01.models.VirtualNetwork(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, address_space: Optional[AddressSpace] = None, dhcp_options: Optional[DhcpOptions] = None, subnets: Optional[List[Subnet]] = None, virtual_network_peerings: Optional[List[VirtualNetworkPeering]] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. Resource tags.

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

  • 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’.

Variables
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGateway(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, ip_configurations: Optional[List[VirtualNetworkGatewayIPConfiguration]] = None, gateway_type: Optional[Union[str, VirtualNetworkGatewayType]] = None, vpn_type: Optional[Union[str, VpnType]] = None, enable_bgp: Optional[bool] = None, active: Optional[bool] = None, gateway_default_site: Optional[SubResource] = None, sku: Optional[VirtualNetworkGatewaySku] = None, vpn_client_configuration: Optional[VpnClientConfiguration] = None, bgp_settings: Optional[BgpSettings] = None, resource_guid: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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.

Parameters

  • id (str) – Resource ID.

  • location (str) – Resource location.

  • tags (dict[str, str]) – A set of tags. Resource tags.

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

  • ip_configurations (list[VirtualNetworkGatewayIPConfiguration]) – IP configurations for virtual network gateway.

  • gateway_type (str or VirtualNetworkGatewayType) – The type of this virtual network gateway. Possible values are: ‘Vpn’ and ‘ExpressRoute’. Possible values include: “Vpn”, “ExpressRoute”.

  • vpn_type (str or VpnType) – 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 (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.

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.v2017_03_01.models.VirtualNetworkGatewayConnection(*, virtual_network_gateway1: azure.mgmt.network.v2017_03_01.models._models_py3.VirtualNetworkGateway, connection_type: Union[str, VirtualNetworkGatewayConnectionType], id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, authorization_key: Optional[str] = None, virtual_network_gateway2: Optional[VirtualNetworkGateway] = None, local_network_gateway2: Optional[LocalNetworkGateway] = None, routing_weight: Optional[int] = None, shared_key: Optional[str] = None, peer: Optional[SubResource] = None, enable_bgp: Optional[bool] = None, use_policy_based_traffic_selectors: Optional[bool] = None, ipsec_policies: Optional[List[IpsecPolicy]] = None, resource_guid: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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]) – A set of tags. Resource tags.

  • etag (str) – Gets a unique read-only string that changes whenever the resource is updated.

  • authorization_key (str) – The authorizationKey.

  • virtual_network_gateway1 (VirtualNetworkGateway) – Required. A common class for general resource information.

  • virtual_network_gateway2 (VirtualNetworkGateway) – A common class for general resource information.

  • local_network_gateway2 (LocalNetworkGateway) – A common class for general resource information.

  • 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.

  • use_policy_based_traffic_selectors (bool) – Enable policy-based traffic selectors.

  • ipsec_policies (list[IpsecPolicy]) – The IPSec Policies to be considered by this connection.

  • resource_guid (str) – The resource GUID property of the VirtualNetworkGatewayConnection resource.

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.v2017_03_01.models.VirtualNetworkGatewayConnectionListResult(*, value: Optional[List[VirtualNetworkGatewayConnection]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListVirtualNetworkGatewayConnections API service call.

Parameters

  • value (list[VirtualNetworkGatewayConnection]) – Gets a list of VirtualNetworkGatewayConnection resources that exists in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewayConnectionStatus(value)[source]

Bases: str, enum.Enum

Virtual network Gateway connection status

connected = 'Connected'
connecting = 'Connecting'
not_connected = 'NotConnected'
unknown = 'Unknown'
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewayConnectionType(value)[source]

Bases: str, enum.Enum

Gateway connection type. Possible values are: ‘IPsec’,’Vnet2Vnet’,’ExpressRoute’, and ‘VPNClient.

express_route = 'ExpressRoute'
i_psec = 'IPsec'
vnet2_vnet = 'Vnet2Vnet'
vpn_client = 'VPNClient'
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewayIPConfiguration(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, private_ip_allocation_method: Optional[Union[str, IPAllocationMethod]] = None, subnet: Optional[SubResource] = None, public_ip_address: Optional[SubResource] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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) – The reference of the subnet resource.

  • public_ip_address (SubResource) – The reference of the public IP resource.

Variables

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

class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewayListResult(*, value: Optional[List[VirtualNetworkGateway]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListVirtualNetworkGateways API service call.

Parameters

  • value (list[VirtualNetworkGateway]) – Gets a list of VirtualNetworkGateway resources that exists in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewaySku(*, name: Optional[Union[str, VirtualNetworkGatewaySkuName]] = None, tier: Optional[Union[str, VirtualNetworkGatewaySkuTier]] = None, capacity: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

VirtualNetworkGatewaySku details.

Parameters

  • name (str or VirtualNetworkGatewaySkuName) – Gateway SKU name. Possible values include: “Basic”, “HighPerformance”, “Standard”, “UltraPerformance”, “VpnGw1”, “VpnGw2”, “VpnGw3”.

  • tier (str or VirtualNetworkGatewaySkuTier) – Gateway SKU tier. Possible values include: “Basic”, “HighPerformance”, “Standard”, “UltraPerformance”, “VpnGw1”, “VpnGw2”, “VpnGw3”.

  • capacity (int) – The capacity.

class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewaySkuName(value)[source]

Bases: str, enum.Enum

Gateway SKU name.

basic = 'Basic'
high_performance = 'HighPerformance'
standard = 'Standard'
ultra_performance = 'UltraPerformance'
vpn_gw1 = 'VpnGw1'
vpn_gw2 = 'VpnGw2'
vpn_gw3 = 'VpnGw3'
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewaySkuTier(value)[source]

Bases: str, enum.Enum

Gateway SKU tier.

basic = 'Basic'
high_performance = 'HighPerformance'
standard = 'Standard'
ultra_performance = 'UltraPerformance'
vpn_gw1 = 'VpnGw1'
vpn_gw2 = 'VpnGw2'
vpn_gw3 = 'VpnGw3'
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkGatewayType(value)[source]

Bases: str, enum.Enum

The type of this virtual network gateway. Possible values are: ‘Vpn’ and ‘ExpressRoute’.

express_route = 'ExpressRoute'
vpn = 'Vpn'
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkListResult(*, value: Optional[List[VirtualNetwork]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the ListVirtualNetworks API service call.

Parameters

  • value (list[VirtualNetwork]) – Gets a list of VirtualNetwork resources in a resource group.

  • next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2017_03_01.models.VirtualNetworkListUsageResult(*, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the virtual networks GetUsage API service call.

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

Variables

value (list[VirtualNetworkUsage]) – VirtualNetwork usage stats.

Parameters

next_link (str) – The URL to get the next set of results.

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

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

Peerings in a virtual network resource.

Parameters

  • id (str) – Resource ID.

  • 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.

  • 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.

class azure.mgmt.network.v2017_03_01.models.VirtualNetworkPeeringListResult(*, value: Optional[List[VirtualNetworkPeering]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network.

Parameters
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkPeeringState(value)[source]

Bases: str, enum.Enum

The status of the virtual network peering. Possible values are ‘Initiated’, ‘Connected’, and ‘Disconnected’.

connected = 'Connected'
disconnected = 'Disconnected'
initiated = 'Initiated'
class azure.mgmt.network.v2017_03_01.models.VirtualNetworkUsage(**kwargs)[source]

Bases: msrest.serialization.Model

Usage details for subnet.

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

Variables

  • current_value (float) – Indicates number of IPs used from the Subnet.

  • id (str) – Subnet identifier.

  • limit (float) – Indicates the size of the subnet.

  • name (VirtualNetworkUsageName) – The name containing common and localized value for usage.

  • unit (str) – Usage units. Returns ‘Count’.

class azure.mgmt.network.v2017_03_01.models.VirtualNetworkUsageName(**kwargs)[source]

Bases: msrest.serialization.Model

Usage strings container.

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

Variables

  • localized_value (str) – Localized subnet size and usage string.

  • value (str) – Subnet size and usage string.

class azure.mgmt.network.v2017_03_01.models.VpnClientConfiguration(*, vpn_client_address_pool: Optional[AddressSpace] = None, vpn_client_root_certificates: Optional[List[VpnClientRootCertificate]] = None, vpn_client_revoked_certificates: Optional[List[VpnClientRevokedCertificate]] = 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.v2017_03_01.models.VpnClientParameters(*, processor_architecture: Union[str, ProcessorArchitecture], **kwargs)[source]

Bases: msrest.serialization.Model

Vpn Client Parameters for package generation.

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.v2017_03_01.models.VpnClientRevokedCertificate(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, thumbprint: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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.

  • 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.

  • thumbprint (str) – The revoked VPN client certificate thumbprint.

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.v2017_03_01.models.VpnClientRootCertificate(*, public_cert_data: str, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.network.v2017_03_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.

  • 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.

  • public_cert_data (str) – Required. The certificate public data.

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.v2017_03_01.models.VpnType(value)[source]

Bases: str, enum.Enum

The type of this virtual network gateway. Possible values are: ‘PolicyBased’ and ‘RouteBased’.

policy_based = 'PolicyBased'
route_based = 'RouteBased'