azure.mgmt.network.v2015_06_15.models module¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models.ApplicationGateway(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, sku: Optional[ApplicationGatewaySku] = None, gateway_ip_configurations: Optional[List[ApplicationGatewayIPConfiguration]] = 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, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

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

Application gateway resource.

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

Parameters

id (str) – Resource Identifier.
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.
sku (ApplicationGatewaySku) – SKU of the application gateway resource.
gateway_ip_configurations (list[ApplicationGatewayIPConfiguration]) – Gets or sets subnets of application gateway resource.
ssl_certificates (list[ApplicationGatewaySslCertificate]) – SSL certificates of the application gateway resource.
frontend_ip_configurations (list[ApplicationGatewayFrontendIPConfiguration]) – Frontend IP addresses of the application gateway resource.
frontend_ports (list[ApplicationGatewayFrontendPort]) – Frontend ports of the application gateway resource.
probes (list[ApplicationGatewayProbe]) – Probes of the application gateway resource.
backend_address_pools (list[ApplicationGatewayBackendAddressPool]) – Backend address pool of the application gateway resource.
backend_http_settings_collection (list[ApplicationGatewayBackendHttpSettings]) – Backend http settings of the application gateway resource.
http_listeners (list[ApplicationGatewayHttpListener]) – Http listeners of the application gateway resource.
url_path_maps (list[ApplicationGatewayUrlPathMap]) – URL path map of the application gateway resource.
request_routing_rules (list[ApplicationGatewayRequestRoutingRule]) – Request routing rules of the application gateway resource.
resource_guid (str) – Resource GUID property of the application gateway resource.
provisioning_state (str) – Provisioning state of the application gateway resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

Variables

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Backend Address Pool of an application gateway.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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, provisioning_state: Optional[str] = None, **kwargs)[source]¶

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

Backend address pool settings of an application gateway.

Parameters

id (str) – Resource Identifier.
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 are: ‘Http’ and ‘Https’. Possible values include: “Http”, “Https”.
cookie_based_affinity (str or ApplicationGatewayCookieBasedAffinity) – Cookie based affinity. Possible values are: ‘Enabled’ and ‘Disabled’. Possible values include: “Enabled”, “Disabled”.
request_timeout (int) – Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.
probe (SubResource) – Probe resource of an application gateway.
provisioning_state (str) – Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed.

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

Bases: str, enum.Enum

Cookie based affinity. Possible values are: ‘Enabled’ and ‘Disabled’.

disabled = 'Disabled'¶

enabled = 'Enabled'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Frontend IP configuration of an application gateway.

Parameters

id (str) – Resource Identifier.
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 are: ‘Static’ and ‘Dynamic’. Possible values include: “Static”, “Dynamic”.
subnet (SubResource) – Reference of the subnet resource.
public_ip_address (SubResource) – Reference of the PublicIP resource.
provisioning_state (str) – Provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Frontend port of an application gateway.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Http listener of an application gateway.

Parameters

id (str) – Resource Identifier.
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 are: ‘Http’ and ‘Https’. Possible values include: “Http”, “Https”.
host_name (str) – Host name of HTTP listener.
ssl_certificate (SubResource) – SSL certificate resource of an application gateway.
require_server_name_indication (bool) – Applicable only if protocol is https. Enables SNI for multi-hosting.
provisioning_state (str) – Provisioning state of the HTTP listener resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

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

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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.v2015_06_15.models.ApplicationGatewayOperationalState(value)[source]¶

Bases: str, enum.Enum

Operational state of the application gateway resource. Possible values are: ‘Stopped’, ‘Started’, ‘Running’, and ‘Stopping’.

running = 'Running'¶

starting = 'Starting'¶

stopped = 'Stopped'¶

stopping = 'Stopping'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Path rule of URL path map of an application gateway.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Probe of the application gateway.

Parameters

id (str) – Resource Identifier.
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 are: ‘Http’ and ‘Https’. Possible values include: “Http”, “Https”.
host (str) – Host name to send the probe to.
path (str) – Relative path of probe. Valid path starts from ‘/’. Probe is sent to <Protocol>://<host>:<port><path>.
interval (int) – The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.
timeout (int) – the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.
unhealthy_threshold (int) – The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.
provisioning_state (str) – Provisioning state of the backend http settings resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

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

Bases: str, enum.Enum

Protocol. Possible values are: ‘Http’ and ‘Https’.

http = 'Http'¶

https = 'Https'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Request routing rule of an application gateway.

Parameters

id (str) – Resource Identifier.
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 are: ‘Basic’ and ‘PathBasedRouting’. Possible values include: “Basic”, “PathBasedRouting”.
backend_address_pool (SubResource) – Backend address pool resource of the application gateway.
backend_http_settings (SubResource) – Frontend port resource of the application gateway.
http_listener (SubResource) – Http listener resource of the application gateway.
url_path_map (SubResource) – URL path map resource of the application gateway.
provisioning_state (str) – Provisioning state of the request routing rule resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

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

Bases: str, enum.Enum

Rule type. Possible values are: ‘Basic’ and ‘PathBasedRouting’.

basic = 'Basic'¶

path_based_routing = 'PathBasedRouting'¶

class azure.mgmt.network.v2015_06_15.models.ApplicationGatewaySku(*, name: Optional[Union[str, ApplicationGatewaySkuName]] = None, capacity: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SKU of application gateway.

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

Parameters

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

Variables

tier (str) – Tier of an application gateway. Default value: “Standard”.

tier = 'Standard'¶

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

Bases: str, enum.Enum

Name of an application gateway SKU. Possible values are: ‘Standard_Small’, ‘Standard_Medium’, ‘Standard_Large’, ‘WAF_Medium’, and ‘WAF_Large’.

standard_large = 'Standard_Large'¶

standard_medium = 'Standard_Medium'¶

standard_small = 'Standard_Small'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

SSL certificates of an application gateway.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

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

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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

value (list[ExpressRouteCircuitAuthorization]) – The authorizations in an ExpressRoute Circuit.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2015_06_15.models.AuthorizationUseStatus(value)[source]¶

Bases: str, enum.Enum

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

available = 'Available'¶

in_use = 'InUse'¶

class azure.mgmt.network.v2015_06_15.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) – Error object properties.

class azure.mgmt.network.v2015_06_15.models.BackendAddressPool(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, backend_ip_configurations: Optional[List[NetworkInterfaceIPConfiguration]] = None, outbound_nat_rule: Optional[SubResource] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
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.
backend_ip_configurations (list[NetworkInterfaceIPConfiguration]) – Gets collection of references to IP addresses defined in network interfaces.
outbound_nat_rule (SubResource) – Gets outbound rules that use this backend address pool.
provisioning_state (str) – Get provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

Variables

load_balancing_rules (list[SubResource]) – Gets load balancing rules that use this backend address pool.

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

Bases: msrest.serialization.Model

BgpSettings.

Parameters

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

class azure.mgmt.network.v2015_06_15.models.ConnectionResetSharedKey(*, key_length: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ConnectionResetSharedKey.

Parameters: key_length (long) – The virtual network connection reset shared key length.

class azure.mgmt.network.v2015_06_15.models.ConnectionSharedKey(*, value: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for GetConnectionSharedKey API service call.

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

class azure.mgmt.network.v2015_06_15.models.ConnectionSharedKeyResult(*, value: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for CheckConnectionSharedKey API service call.

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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 object properties.

Parameters

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

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

Bases: msrest.serialization.Model

Error details properties.

Parameters

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

class azure.mgmt.network.v2015_06_15.models.ExpressRouteCircuit(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[ExpressRouteCircuitSku] = None, etag: Optional[str] = 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, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
location (str) – Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
sku (ExpressRouteCircuitSku) – The SKU.
etag (str) – Gets a unique read-only string that changes whenever the resource is updated.
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’.

Variables

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

class azure.mgmt.network.v2015_06_15.models.ExpressRouteCircuitArpTable(*, ip_address: Optional[str] = None, mac_address: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The ARP table associated with the ExpressRouteCircuit.

Parameters

ip_address (str) – The IP address.
mac_address (str) – The MAC address.

class azure.mgmt.network.v2015_06_15.models.ExpressRouteCircuitAuthorization(*, id: Optional[str] = None, name: Optional[str] = None, etag: 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.v2015_06_15.models._models_py3.SubResource

Authorization in an ExpressRouteCircuit resource.

Parameters

id (str) – Resource Identifier.
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.
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’.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models.ExpressRouteCircuitPeering(*, id: Optional[str] = None, name: Optional[str] = None, etag: 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, **kwargs)[source]¶

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

Peering in an ExpressRouteCircuit resource.

Parameters

id (str) – Resource Identifier.
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.
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’.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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

value (list[ExpressRouteCircuitPeering]) – The peerings in an express route circuit.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models.ExpressRouteCircuitRoutesTable(*, next_hop_type: Union[str, RouteNextHopType], address_prefix: Optional[str] = None, next_hop_ip: Optional[str] = None, as_path: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The routes table associated with the ExpressRouteCircuit.

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

Parameters

address_prefix (str) – Gets AddressPrefix.
next_hop_type (str or RouteNextHopType) – Required. Gets NextHopType. Possible values include: “VirtualNetworkGateway”, “VnetLocal”, “Internet”, “VirtualAppliance”, “None”.
next_hop_ip (str) – Gets NextHopIP.
as_path (str) – Gets AsPath.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models.ExpressRouteCircuitStats(*, bytes_in: Optional[int] = None, bytes_out: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains stats associated with the peering.

Parameters

bytes_in (int) – Gets BytesIn of the peering.
bytes_out (int) – Gets BytesOut of the peering.

class azure.mgmt.network.v2015_06_15.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

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

class azure.mgmt.network.v2015_06_15.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

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

class azure.mgmt.network.v2015_06_15.models.ExpressRouteCircuitsStatsListResult(*, value: Optional[List[ExpressRouteCircuitStats]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Response for ListStats from Express Route Circuits Api service call.

Parameters

value (list[ExpressRouteCircuitStats]) – Gets List of Stats.
next_link (str) – Gets the URL to get the next set of results.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.Resource

A ExpressRouteResourceProvider object.

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

Parameters

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

Variables

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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

value (list[ExpressRouteServiceProvider]) – A list of ExpressRouteResourceProvider resources.
next_link (str) – The URL to get the next set of results.

class azure.mgmt.network.v2015_06_15.models.FrontendIPConfiguration(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, inbound_nat_rules: Optional[List[SubResource]] = None, inbound_nat_pools: Optional[List[SubResource]] = None, outbound_nat_rules: Optional[List[SubResource]] = None, load_balancing_rules: Optional[List[SubResource]] = 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.v2015_06_15.models._models_py3.SubResource

Frontend IP address of the load balancer.

Parameters

id (str) – Resource Identifier.
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.
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.
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.v2015_06_15.models.IPAllocationMethod(value)[source]¶

Bases: str, enum.Enum

PrivateIP allocation method. Possible values are: ‘Static’ and ‘Dynamic’.

dynamic = 'Dynamic'¶

static = 'Static'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

IPConfiguration.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Inbound NAT pool of the load balancer.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.models.InboundNatRule(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, frontend_ip_configuration: Optional[SubResource] = None, backend_ip_configuration: Optional[NetworkInterfaceIPConfiguration] = 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.v2015_06_15.models._models_py3.SubResource

Inbound NAT rule of the load balancer.

Parameters

id (str) – Resource Identifier.
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.
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.
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’.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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 Identifier.
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

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

A load balancing rule for a load balancer.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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.v2015_06_15.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, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
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.
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.
provisioning_state (str) – Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed.

Variables

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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_ip_forwarding: Optional[bool] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
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_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

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

class azure.mgmt.network.v2015_06_15.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, **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.

class azure.mgmt.network.v2015_06_15.models.NetworkInterfaceIPConfiguration(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = 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, 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.v2015_06_15.models._models_py3.SubResource

IPConfiguration in a network interface.

Parameters

id (str) – Resource Identifier.
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.
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”.
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.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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, network_interfaces: Optional[List[NetworkInterface]] = None, subnets: Optional[List[Subnet]] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
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.
network_interfaces (list[NetworkInterface]) – A collection of references to network interfaces.
subnets (list[Subnet]) – A collection of references to subnets.
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

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Outbound NAT pool of the load balancer.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.models.Probe(*, id: Optional[str] = None, name: Optional[str] = None, etag: Optional[str] = None, load_balancing_rules: Optional[List[SubResource]] = 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.v2015_06_15.models._models_py3.SubResource

A load balancer probe.

Parameters

id (str) – Resource Identifier.
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.
load_balancing_rules (list[SubResource]) – The load balancer rules that use this probe.
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’.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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, ip_configuration: Optional[IPConfiguration] = 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.v2015_06_15.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 Identifier.
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”.
ip_configuration (IPConfiguration) – IPConfiguration.
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

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models.Resource(*, id: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure resource manager resource properties.

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

Parameters

id (str) – Resource Identifier.
location (str) – Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.

Variables

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Route resource.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.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.v2015_06_15.models.RouteNextHopType(value)[source]¶

Bases: str, enum.Enum

Gets NextHopType.

internet = 'Internet'¶

none = 'None'¶

virtual_appliance = 'VirtualAppliance'¶

virtual_network_gateway = 'VirtualNetworkGateway'¶

vnet_local = 'VnetLocal'¶

class azure.mgmt.network.v2015_06_15.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, subnets: Optional[List[Subnet]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
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.
subnets (list[Subnet]) – A collection of references to subnets.
provisioning_state (str) – The provisioning state of the resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

Variables

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models._models_py3.SubResource

Network security rule.

Parameters

id (str) – Resource Identifier.
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.v2015_06_15.models.SecurityRuleAccess(value)[source]¶

Bases: str, enum.Enum

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

allow = 'Allow'¶

deny = 'Deny'¶

class azure.mgmt.network.v2015_06_15.models.SecurityRuleDirection(value)[source]¶

Bases: str, enum.Enum

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: ‘Inbound’ and ‘Outbound’.

inbound = 'Inbound'¶

outbound = 'Outbound'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models.SecurityRuleProtocol(value)[source]¶

Bases: str, enum.Enum

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

asterisk = '*'¶

tcp = 'Tcp'¶

udp = 'Udp'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models.SubResource(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure resource manager sub resource properties.

Parameters: id (str) – Resource Identifier.

class azure.mgmt.network.v2015_06_15.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, ip_configurations: Optional[List[IPConfiguration]] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

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

Subnet in a virtual network resource.

Parameters

id (str) – Resource Identifier.
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.
ip_configurations (list[IPConfiguration]) – Gets an array of references to the network interface IP configurations using subnet.
provisioning_state (str) – The provisioning state of the resource.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.models.Usage(*, current_value: int, limit: int, name: azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

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

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

class azure.mgmt.network.v2015_06_15.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, 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, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
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.
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.
provisioning_state (str) – The provisioning state of the VirtualNetworkGateway resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

Variables

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

class azure.mgmt.network.v2015_06_15.models.VirtualNetworkGatewayConnection(*, 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_gateway1: Optional[VirtualNetworkGateway] = None, virtual_network_gateway2: Optional[VirtualNetworkGateway] = None, local_network_gateway2: Optional[LocalNetworkGateway] = None, connection_type: Optional[Union[str, VirtualNetworkGatewayConnectionType]] = None, routing_weight: Optional[int] = None, shared_key: Optional[str] = None, connection_status: Optional[Union[str, VirtualNetworkGatewayConnectionStatus]] = None, egress_bytes_transferred: Optional[int] = None, ingress_bytes_transferred: Optional[int] = None, peer: Optional[SubResource] = None, enable_bgp: Optional[bool] = None, resource_guid: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.network.v2015_06_15.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 Identifier.
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) – 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) – 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.
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”.
egress_bytes_transferred (long) – The egress bytes transferred in this connection.
ingress_bytes_transferred (long) – The ingress bytes transferred in this connection.
peer (SubResource) – The reference to peerings resource.
enable_bgp (bool) – EnableBgp flag.
resource_guid (str) – The resource GUID property of the VirtualNetworkGatewayConnection resource.
provisioning_state (str) – The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

Variables

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

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models.VirtualNetworkGatewayConnectionStatus(value)[source]¶

Bases: str, enum.Enum

Virtual network Gateway connection status. Possible values are ‘Unknown’, ‘Connecting’, ‘Connected’ and ‘NotConnected’.

connected = 'Connected'¶

connecting = 'Connecting'¶

not_connected = 'NotConnected'¶

unknown = 'Unknown'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.models.VirtualNetworkGatewayIPConfiguration(*, 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.v2015_06_15.models._models_py3.SubResource

IP configuration for virtual network gateway.

Parameters

id (str) – Resource Identifier.
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) – Gets or sets the privateIPAddress 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 (SubResource) – The reference of the subnet resource.
public_ip_address (SubResource) – The reference of the public IP resource.
provisioning_state (str) – The provisioning state of the public IP resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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 -Basic/HighPerformance/Standard. Possible values include: “Basic”, “HighPerformance”, “Standard”.
tier (str or VirtualNetworkGatewaySkuTier) – Gateway sku tier -Basic/HighPerformance/Standard. Possible values include: “Basic”, “HighPerformance”, “Standard”.
capacity (int) – The capacity.

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

Bases: str, enum.Enum

Gateway sku name -Basic/HighPerformance/Standard

basic = 'Basic'¶

high_performance = 'HighPerformance'¶

standard = 'Standard'¶

class azure.mgmt.network.v2015_06_15.models.VirtualNetworkGatewaySkuTier(value)[source]¶

Bases: str, enum.Enum

Gateway sku tier -Basic/HighPerformance/Standard

basic = 'Basic'¶

high_performance = 'HighPerformance'¶

standard = 'Standard'¶

class azure.mgmt.network.v2015_06_15.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.v2015_06_15.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.v2015_06_15.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) – Gets or sets 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.v2015_06_15.models.VpnClientParameters(*, processor_architecture: Optional[Union[str, ProcessorArchitecture]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

VpnClientParameters.

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

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

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

VPN client revoked certificate of virtual network gateway.

Parameters

id (str) – Resource Identifier.
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.
provisioning_state (str) – The provisioning state of the VPN client revoked certificate resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

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

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

VPN client root certificate of virtual network gateway.

Parameters

id (str) – Resource Identifier.
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) – Gets or sets the certificate public data.
provisioning_state (str) – The provisioning state of the VPN client root certificate resource. Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

class azure.mgmt.network.v2015_06_15.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'¶