network

class pulumi_azure.network.ApplicationGateway(resource_name, opts=None, authentication_certificates=None, backend_address_pools=None, backend_http_settings=None, custom_error_configurations=None, disabled_ssl_protocols=None, enable_http2=None, frontend_ip_configurations=None, frontend_ports=None, gateway_ip_configurations=None, http_listeners=None, location=None, name=None, probes=None, request_routing_rules=None, resource_group_name=None, sku=None, ssl_certificates=None, tags=None, url_path_maps=None, waf_configuration=None, __name__=None, __opts__=None)

Manages an Application Gateway.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • authentication_certificates (pulumi.Input[list]) – One or more authentication_certificate blocks as defined below.
  • backend_address_pools (pulumi.Input[list]) – One or more backend_address_pool blocks as defined below.
  • backend_http_settings (pulumi.Input[list]) – One or more backend_http_settings blocks as defined below.
  • custom_error_configurations (pulumi.Input[list]) – One or more custom_error_configuration blocks as defined below.
  • disabled_ssl_protocols (pulumi.Input[list]) – A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.
  • frontend_ip_configurations (pulumi.Input[list]) – One or more frontend_ip_configuration blocks as defined below.
  • frontend_ports (pulumi.Input[list]) – One or more frontend_port blocks as defined below.
  • gateway_ip_configurations (pulumi.Input[list]) – One or more gateway_ip_configuration blocks as defined below.
  • http_listeners (pulumi.Input[list]) – One or more http_listener blocks as defined below.
  • location (pulumi.Input[str]) – The Azure region where the Application Gateway should exist. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the Application Gateway. Changing this forces a new resource to be created.
  • probes (pulumi.Input[list]) – One or more probe blocks as defined below.
  • request_routing_rules (pulumi.Input[list]) – One or more request_routing_rule blocks as defined below.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to the Application Gateway should exist. Changing this forces a new resource to be created.
  • sku (pulumi.Input[dict]) – A sku block as defined below.
  • ssl_certificates (pulumi.Input[list]) – One or more ssl_certificate blocks as defined below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • url_path_maps (pulumi.Input[list]) – One or more url_path_map blocks as defined below.
  • waf_configuration (pulumi.Input[dict]) – A waf_configuration block as defined below.
authentication_certificates = None

One or more authentication_certificate blocks as defined below.

backend_address_pools = None

One or more backend_address_pool blocks as defined below.

backend_http_settings = None

One or more backend_http_settings blocks as defined below.

custom_error_configurations = None

One or more custom_error_configuration blocks as defined below.

disabled_ssl_protocols = None

A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.

frontend_ip_configurations = None

One or more frontend_ip_configuration blocks as defined below.

frontend_ports = None

One or more frontend_port blocks as defined below.

gateway_ip_configurations = None

One or more gateway_ip_configuration blocks as defined below.

http_listeners = None

One or more http_listener blocks as defined below.

location = None

The Azure region where the Application Gateway should exist. Changing this forces a new resource to be created.

name = None

The name of the Application Gateway. Changing this forces a new resource to be created.

probes = None

One or more probe blocks as defined below.

request_routing_rules = None

One or more request_routing_rule blocks as defined below.

resource_group_name = None

The name of the resource group in which to the Application Gateway should exist. Changing this forces a new resource to be created.

sku = None

A sku block as defined below.

ssl_certificates = None

One or more ssl_certificate blocks as defined below.

tags = None

A mapping of tags to assign to the resource.

url_path_maps = None

One or more url_path_map blocks as defined below.

waf_configuration = None

A waf_configuration block as defined below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.ApplicationSecurityGroup(resource_name, opts=None, location=None, name=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

Manage an Application Security Group.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Application Security Group. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Application Security Group.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Application Security Group. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Application Security Group.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.ConnectionMonitor(resource_name, opts=None, auto_start=None, destination=None, interval_in_seconds=None, location=None, name=None, network_watcher_name=None, resource_group_name=None, source=None, tags=None, __name__=None, __opts__=None)

Configures a Connection Monitor to monitor communication between a Virtual Machine and an endpoint using a Network Watcher.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • auto_start (pulumi.Input[bool]) – Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.
  • destination (pulumi.Input[dict]) – A destination block as defined below.
  • interval_in_seconds (pulumi.Input[float]) – Monitoring interval in seconds. Defaults to 60.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the Connection Monitor. Changing this forces a new resource to be created.
  • network_watcher_name (pulumi.Input[str]) – The name of the Network Watcher. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.
  • source (pulumi.Input[dict]) – A source block as defined below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
auto_start = None

Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.

destination = None

A destination block as defined below.

interval_in_seconds = None

Monitoring interval in seconds. Defaults to 60.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

The name of the Connection Monitor. Changing this forces a new resource to be created.

network_watcher_name = None

The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.

source = None

A source block as defined below.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.ExpressRouteCircuit(resource_name, opts=None, allow_classic_operations=None, bandwidth_in_mbps=None, location=None, name=None, peering_location=None, resource_group_name=None, service_provider_name=None, sku=None, tags=None, __name__=None, __opts__=None)

Manages an ExpressRoute circuit.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allow_classic_operations (pulumi.Input[bool]) – Allow the circuit to interact with classic (RDFE) resources. The default value is false.
  • bandwidth_in_mbps (pulumi.Input[float]) – The bandwidth in Mbps of the circuit being created.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
  • peering_location (pulumi.Input[str]) – The name of the peering location and not the Azure resource location.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
  • service_provider_name (pulumi.Input[str]) – The name of the ExpressRoute Service Provider.
  • sku (pulumi.Input[dict]) – A sku block for the ExpressRoute circuit as documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
allow_classic_operations = None

Allow the circuit to interact with classic (RDFE) resources. The default value is false.

bandwidth_in_mbps = None

The bandwidth in Mbps of the circuit being created.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

The name of the ExpressRoute circuit. Changing this forces a new resource to be created.

peering_location = None

The name of the peering location and not the Azure resource location.

resource_group_name = None

The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.

service_key = None

The string needed by the service provider to provision the ExpressRoute circuit.

service_provider_name = None

The name of the ExpressRoute Service Provider.

service_provider_provisioning_state = None

The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are “NotProvisioned”, “Provisioning”, “Provisioned”, and “Deprovisioning”.

sku = None

A sku block for the ExpressRoute circuit as documented below.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.ExpressRouteCircuitAuthorization(resource_name, opts=None, express_route_circuit_name=None, name=None, resource_group_name=None, __name__=None, __opts__=None)

Manages an ExpressRoute Circuit Authorization.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • express_route_circuit_name (pulumi.Input[str]) – The name of the Express Route Circuit in which to create the Authorization.
  • name (pulumi.Input[str]) – The name of the ExpressRoute circuit. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.
authorization_key = None

The Authorization Key.

authorization_use_status = None

The authorization use status.

express_route_circuit_name = None

The name of the Express Route Circuit in which to create the Authorization.

name = None

The name of the ExpressRoute circuit. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.ExpressRouteCircuitPeering(resource_name, opts=None, express_route_circuit_name=None, microsoft_peering_config=None, peer_asn=None, peering_type=None, primary_peer_address_prefix=None, resource_group_name=None, secondary_peer_address_prefix=None, shared_key=None, vlan_id=None, __name__=None, __opts__=None)

Manages an ExpressRoute Circuit Peering.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • express_route_circuit_name (pulumi.Input[str]) – The name of the ExpressRoute Circuit in which to create the Peering.
  • microsoft_peering_config (pulumi.Input[dict]) – A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.
  • peer_asn (pulumi.Input[float]) – The Either a 16-bit or a 32-bit ASN. Can either be public or private..
  • peering_type (pulumi.Input[str]) – The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.
  • primary_peer_address_prefix (pulumi.Input[str]) – A /30 subnet for the primary link.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.
  • secondary_peer_address_prefix (pulumi.Input[str]) – A /30 subnet for the secondary link.
  • shared_key (pulumi.Input[str]) – The shared key. Can be a maximum of 25 characters.
  • vlan_id (pulumi.Input[float]) – A valid VLAN ID to establish this peering on.
azure_asn = None

The ASN used by Azure.

express_route_circuit_name = None

The name of the ExpressRoute Circuit in which to create the Peering.

microsoft_peering_config = None

A microsoft_peering_config block as defined below. Required when peering_type is set to MicrosoftPeering.

peer_asn = None

The Either a 16-bit or a 32-bit ASN. Can either be public or private..

peering_type = None

The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.

primary_azure_port = None

The Primary Port used by Azure for this Peering.

primary_peer_address_prefix = None

A /30 subnet for the primary link.

resource_group_name = None

The name of the resource group in which to create the Express Route Circuit Peering. Changing this forces a new resource to be created.

secondary_azure_port = None

The Secondary Port used by Azure for this Peering.

secondary_peer_address_prefix = None

A /30 subnet for the secondary link.

shared_key = None

The shared key. Can be a maximum of 25 characters.

vlan_id = None

A valid VLAN ID to establish this peering on.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.Firewall(resource_name, opts=None, ip_configuration=None, location=None, name=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

Manages an Azure Firewall.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • ip_configuration (pulumi.Input[dict]) – A ip_configuration block as documented below.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Firewall. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the resource. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
ip_configuration = None

A ip_configuration block as documented below.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Firewall. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.FirewallApplicationRuleCollection(resource_name, opts=None, action=None, azure_firewall_name=None, name=None, priority=None, resource_group_name=None, rules=None, __name__=None, __opts__=None)

Manages an Application Rule Collection within an Azure Firewall.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • action (pulumi.Input[str]) – Specifies the action the rule will apply to matching traffic. Possible values are Allow and Deny.
  • azure_firewall_name (pulumi.Input[str]) – Specifies the name of the Firewall in which the Application Rule Collection should be created. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Application Rule Collection which must be unique within the Firewall. Changing this forces a new resource to be created.
  • priority (pulumi.Input[float]) – Specifies the priority of the rule collection. Possible values are between 100 - 65000.
  • resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.
  • rules (pulumi.Input[list]) – One or more rule blocks as defined below.
action = None

Specifies the action the rule will apply to matching traffic. Possible values are Allow and Deny.

azure_firewall_name = None

Specifies the name of the Firewall in which the Application Rule Collection should be created. Changing this forces a new resource to be created.

name = None

Specifies the name of the Application Rule Collection which must be unique within the Firewall. Changing this forces a new resource to be created.

priority = None

Specifies the priority of the rule collection. Possible values are between 100 - 65000.

resource_group_name = None

Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.

rules = None

One or more rule blocks as defined below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.FirewallNetworkRuleCollection(resource_name, opts=None, action=None, azure_firewall_name=None, name=None, priority=None, resource_group_name=None, rules=None, __name__=None, __opts__=None)

Manages a Network Rule Collection within an Azure Firewall.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • action (pulumi.Input[str]) – Specifies the action the rule will apply to matching traffic. Possible values are Allow and Deny.
  • azure_firewall_name (pulumi.Input[str]) – Specifies the name of the Firewall in which the Network Rule Collection should be created. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Network Rule Collection which must be unique within the Firewall. Changing this forces a new resource to be created.
  • priority (pulumi.Input[float]) – Specifies the priority of the rule collection. Possible values are between 100 - 65000.
  • resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.
  • rules (pulumi.Input[list]) – One or more rule blocks as defined below.
action = None

Specifies the action the rule will apply to matching traffic. Possible values are Allow and Deny.

azure_firewall_name = None

Specifies the name of the Firewall in which the Network Rule Collection should be created. Changing this forces a new resource to be created.

name = None

Specifies the name of the Network Rule Collection which must be unique within the Firewall. Changing this forces a new resource to be created.

priority = None

Specifies the priority of the rule collection. Possible values are between 100 - 65000.

resource_group_name = None

Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.

rules = None

One or more rule blocks as defined below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.GetApplicationSecurityGroupResult(location=None, tags=None, id=None)

A collection of values returned by getApplicationSecurityGroup.

location = None

The supported Azure location where the Application Security Group exists.

tags = None

A mapping of tags assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetNetworkInterfaceResult(applied_dns_servers=None, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, internal_dns_name_label=None, internal_fqdn=None, ip_configurations=None, location=None, mac_address=None, network_security_group_id=None, private_ip_address=None, private_ip_addresses=None, tags=None, virtual_machine_id=None, id=None)

A collection of values returned by getNetworkInterface.

applied_dns_servers = None

List of DNS servers applied to the specified Network Interface.

dns_servers = None

The list of DNS servers used by the specified Network Interface.

enable_accelerated_networking = None

Indicates if accelerated networking is set on the specified Network Interface.

enable_ip_forwarding = None

Indicate if IP forwarding is set on the specified Network Interface.

internal_dns_name_label = None

The internal dns name label of the specified Network Interface.

ip_configurations = None

One or more ip_configuration blocks as defined below.

location = None

The location of the specified Network Interface.

mac_address = None

The MAC address used by the specified Network Interface.

network_security_group_id = None

The ID of the network security group associated to the specified Network Interface.

private_ip_address = None

The Private IP Address assigned to this Network Interface.

private_ip_addresses = None

The list of private ip addresses associates to the specified Network Interface.

tags = None

List the tags associated to the specified Network Interface.

virtual_machine_id = None

The ID of the virtual machine that the specified Network Interface is attached to.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetNetworkSecurityGroupResult(location=None, security_rules=None, tags=None, id=None)

A collection of values returned by getNetworkSecurityGroup.

location = None

The supported Azure location where the resource exists.

security_rules = None

One or more security_rule blocks as defined below.

tags = None

A mapping of tags assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetNetworkWatcherResult(location=None, tags=None, id=None)

A collection of values returned by getNetworkWatcher.

location = None

The supported Azure location where the resource exists.

tags = None

A mapping of tags assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetPublicIPResult(allocation_method=None, domain_name_label=None, fqdn=None, idle_timeout_in_minutes=None, ip_address=None, ip_version=None, location=None, reverse_fqdn=None, sku=None, tags=None, zones=None, id=None)

A collection of values returned by getPublicIP.

domain_name_label = None

The label for the Domain Name.

fqdn = None

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.

idle_timeout_in_minutes = None

Specifies the timeout for the TCP idle connection.

ip_address = None

The IP address value that was allocated.

ip_version = None

The IP version being used, for example IPv4 or IPv6.

tags = None

A mapping of tags to assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetPublicIPsResult(public_ips=None, id=None)

A collection of values returned by getPublicIPs.

public_ips = None

A List of public_ips blocks as defined below filtered by the criteria above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetRouteTableResult(location=None, routes=None, subnets=None, tags=None, id=None)

A collection of values returned by getRouteTable.

location = None

The Azure Region in which the Route Table exists.

routes = None

One or more route blocks as documented below.

subnets = None

The collection of Subnets associated with this route table.

tags = None

A mapping of tags assigned to the Route Table.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetSubnetResult(address_prefix=None, ip_configurations=None, network_security_group_id=None, route_table_id=None, id=None)

A collection of values returned by getSubnet.

address_prefix = None

The address prefix used for the subnet.

ip_configurations = None

The collection of IP Configurations with IPs within this subnet.

network_security_group_id = None

The ID of the Network Security Group associated with the subnet.

route_table_id = None

The ID of the Route Table associated with this subnet.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetVirtualNetworkGatewayResult(active_active=None, bgp_settings=None, default_local_network_gateway_id=None, enable_bgp=None, ip_configurations=None, location=None, sku=None, tags=None, type=None, vpn_client_configurations=None, vpn_type=None, id=None)

A collection of values returned by getVirtualNetworkGateway.

active_active = None

(Optional) Is this an Active-Active Gateway?

default_local_network_gateway_id = None

The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling.

enable_bgp = None

Will BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway.

ip_configurations = None

One or two ip_configuration blocks documented below.

location = None

The location/region where the Virtual Network Gateway is located.

sku = None

Configuration of the size and capacity of the Virtual Network Gateway.

tags = None

A mapping of tags assigned to the resource.

type = None

The type of the Virtual Network Gateway.

vpn_client_configurations = None

A vpn_client_configuration block which is documented below.

vpn_type = None

The routing type of the Virtual Network Gateway.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetVirtualNetworkResult(address_spaces=None, dns_servers=None, subnets=None, vnet_peerings=None, id=None)

A collection of values returned by getVirtualNetwork.

address_spaces = None

The list of address spaces used by the virtual network.

dns_servers = None

The list of DNS servers used by the virtual network.

subnets = None

The list of name of the subnets that are attached to this virtual network.

vnet_peerings = None

A mapping of name - virtual network id of the virtual network peerings.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.network.LocalNetworkGateway(resource_name, opts=None, address_spaces=None, bgp_settings=None, gateway_address=None, location=None, name=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

Manages a local network gateway connection over which specific connections can be configured.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address_spaces (pulumi.Input[list]) – The list of string CIDRs representing the address spaces the gateway exposes.
  • bgp_settings (pulumi.Input[dict]) – A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.
  • gateway_address (pulumi.Input[str]) – The IP address of the gateway to which to connect.
  • location (pulumi.Input[str]) – The location/region where the local network gateway is created. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the local network gateway. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the local network gateway.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
address_spaces = None

The list of string CIDRs representing the address spaces the gateway exposes.

bgp_settings = None

A bgp_settings block as defined below containing the Local Network Gateway’s BGP speaker settings.

gateway_address = None

The IP address of the gateway to which to connect.

location = None

The location/region where the local network gateway is created. Changing this forces a new resource to be created.

name = None

The name of the local network gateway. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the local network gateway.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkInterface(resource_name, opts=None, applied_dns_servers=None, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, internal_dns_name_label=None, internal_fqdn=None, ip_configurations=None, location=None, mac_address=None, name=None, network_security_group_id=None, resource_group_name=None, tags=None, virtual_machine_id=None, __name__=None, __opts__=None)

Manages a Network Interface located in a Virtual Network, usually attached to a Virtual Machine.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • applied_dns_servers (pulumi.Input[list]) – 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
  • dns_servers (pulumi.Input[list]) – List of DNS servers IP addresses to use for this NIC, overrides the VNet-level server list
  • enable_accelerated_networking (pulumi.Input[bool]) – Enables Azure Accelerated Networking using SR-IOV. Only certain VM instance sizes are supported. Refer to Create a Virtual Machine with Accelerated Networking. Defaults to false.
  • enable_ip_forwarding (pulumi.Input[bool]) – Enables IP Forwarding on the NIC. Defaults to false.
  • internal_dns_name_label (pulumi.Input[str]) – Relative DNS name for this NIC used for internal communications between VMs in the same VNet
  • ip_configurations (pulumi.Input[list]) – One or more ip_configuration associated with this NIC as documented below.
  • location (pulumi.Input[str]) – The location/region where the network interface is created. Changing this forces a new resource to be created.
  • mac_address (pulumi.Input[str]) – The media access control (MAC) address of the network interface.
  • name (pulumi.Input[str]) – The name of the network interface. Changing this forces a new resource to be created.
  • network_security_group_id (pulumi.Input[str]) – The ID of the Network Security Group to associate with the network interface.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the network interface. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • virtual_machine_id (pulumi.Input[str]) – Reference to a VM with which this NIC has been associated.
applied_dns_servers = None

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

dns_servers = None

List of DNS servers IP addresses to use for this NIC, overrides the VNet-level server list

enable_accelerated_networking = None

Enables Azure Accelerated Networking using SR-IOV. Only certain VM instance sizes are supported. Refer to Create a Virtual Machine with Accelerated Networking. Defaults to false.

enable_ip_forwarding = None

Enables IP Forwarding on the NIC. Defaults to false.

internal_dns_name_label = None

Relative DNS name for this NIC used for internal communications between VMs in the same VNet

ip_configurations = None

One or more ip_configuration associated with this NIC as documented below.

location = None

The location/region where the network interface is created. Changing this forces a new resource to be created.

mac_address = None

The media access control (MAC) address of the network interface.

name = None

The name of the network interface. Changing this forces a new resource to be created.

network_security_group_id = None

The ID of the Network Security Group to associate with the network interface.

private_ip_address = None

The first private IP address of the network interface.

private_ip_addresses = None

The private IP addresses of the network interface.

resource_group_name = None

The name of the resource group in which to create the network interface. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource.

virtual_machine_id = None

Reference to a VM with which this NIC has been associated.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation(resource_name, opts=None, backend_address_pool_id=None, ip_configuration_name=None, network_interface_id=None, __name__=None, __opts__=None)

Manages the association between a Network Interface and a Application Gateway’s Backend Address Pool.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • backend_address_pool_id (pulumi.Input[str]) – The ID of the Application Gateway’s Backend Address Pool which this Network Interface which should be connected to. Changing this forces a new resource to be created.
  • ip_configuration_name (pulumi.Input[str]) – The Name of the IP Configuration within the Network Interface which should be connected to the Backend Address Pool. Changing this forces a new resource to be created.
  • network_interface_id (pulumi.Input[str]) – The ID of the Network Interface. Changing this forces a new resource to be created.
backend_address_pool_id = None

The ID of the Application Gateway’s Backend Address Pool which this Network Interface which should be connected to. Changing this forces a new resource to be created.

ip_configuration_name = None

The Name of the IP Configuration within the Network Interface which should be connected to the Backend Address Pool. Changing this forces a new resource to be created.

network_interface_id = None

The ID of the Network Interface. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkInterfaceApplicationSecurityGroupAssociation(resource_name, opts=None, application_security_group_id=None, ip_configuration_name=None, network_interface_id=None, __name__=None, __opts__=None)

Manages the association between a Network Interface and a Application Security Group.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • application_security_group_id (pulumi.Input[str]) – The ID of the Application Security Group which this Network Interface which should be connected to. Changing this forces a new resource to be created.
  • ip_configuration_name (pulumi.Input[str]) – The Name of the IP Configuration within the Network Interface which should be connected to the Application Security Group. Changing this forces a new resource to be created.
  • network_interface_id (pulumi.Input[str]) – The ID of the Network Interface. Changing this forces a new resource to be created.
application_security_group_id = None

The ID of the Application Security Group which this Network Interface which should be connected to. Changing this forces a new resource to be created.

ip_configuration_name = None

The Name of the IP Configuration within the Network Interface which should be connected to the Application Security Group. Changing this forces a new resource to be created.

network_interface_id = None

The ID of the Network Interface. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkInterfaceBackendAddressPoolAssociation(resource_name, opts=None, backend_address_pool_id=None, ip_configuration_name=None, network_interface_id=None, __name__=None, __opts__=None)

Manages the association between a Network Interface and a Load Balancer’s Backend Address Pool.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • backend_address_pool_id (pulumi.Input[str]) – The ID of the Load Balancer Backend Address Pool which this Network Interface which should be connected to. Changing this forces a new resource to be created.
  • ip_configuration_name (pulumi.Input[str]) – The Name of the IP Configuration within the Network Interface which should be connected to the Backend Address Pool. Changing this forces a new resource to be created.
  • network_interface_id (pulumi.Input[str]) – The ID of the Network Interface. Changing this forces a new resource to be created.
backend_address_pool_id = None

The ID of the Load Balancer Backend Address Pool which this Network Interface which should be connected to. Changing this forces a new resource to be created.

ip_configuration_name = None

The Name of the IP Configuration within the Network Interface which should be connected to the Backend Address Pool. Changing this forces a new resource to be created.

network_interface_id = None

The ID of the Network Interface. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkInterfaceNatRuleAssociation(resource_name, opts=None, ip_configuration_name=None, nat_rule_id=None, network_interface_id=None, __name__=None, __opts__=None)

Manages the association between a Network Interface and a Load Balancer’s NAT Rule.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • ip_configuration_name (pulumi.Input[str]) – The Name of the IP Configuration within the Network Interface which should be connected to the NAT Rule. Changing this forces a new resource to be created.
  • nat_rule_id (pulumi.Input[str]) – The ID of the Load Balancer NAT Rule which this Network Interface which should be connected to. Changing this forces a new resource to be created.
  • network_interface_id (pulumi.Input[str]) – The ID of the Network Interface. Changing this forces a new resource to be created.
ip_configuration_name = None

The Name of the IP Configuration within the Network Interface which should be connected to the NAT Rule. Changing this forces a new resource to be created.

nat_rule_id = None

The ID of the Load Balancer NAT Rule which this Network Interface which should be connected to. Changing this forces a new resource to be created.

network_interface_id = None

The ID of the Network Interface. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkSecurityGroup(resource_name, opts=None, location=None, name=None, resource_group_name=None, security_rules=None, tags=None, __name__=None, __opts__=None)

Manages a network security group that contains a list of network security rules. Network security groups enable inbound or outbound traffic to be enabled or denied.

NOTE on Network Security Groups and Network Security Rules: Terraform currently provides both a standalone Network Security Rule resource, and allows for Network Security Rules to be defined in-line within the Network Security Group resource. At this time you cannot use a Network Security Group with in-line Network Security Rules in conjunction with any Network Security Rule resources. Doing so will cause a conflict of rule settings and will overwrite rules.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the network security group. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the network security group. Changing this forces a new resource to be created.
  • security_rules (pulumi.Input[list]) – One or more security_rule blocks as defined below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the network security group. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the network security group. Changing this forces a new resource to be created.

security_rules = None

One or more security_rule blocks as defined below.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkSecurityRule(resource_name, opts=None, access=None, description=None, destination_address_prefix=None, destination_address_prefixes=None, destination_application_security_group_ids=None, destination_port_range=None, destination_port_ranges=None, direction=None, name=None, network_security_group_name=None, priority=None, protocol=None, resource_group_name=None, source_address_prefix=None, source_address_prefixes=None, source_application_security_group_ids=None, source_port_range=None, source_port_ranges=None, __name__=None, __opts__=None)

Manages a Network Security Rule.

NOTE on Network Security Groups and Network Security Rules: Terraform currently provides both a standalone Network Security Rule resource, and allows for Network Security Rules to be defined in-line within the Network Security Group resource. At this time you cannot use a Network Security Group with in-line Network Security Rules in conjunction with any Network Security Rule resources. Doing so will cause a conflict of rule settings and will overwrite rules.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • access (pulumi.Input[str]) – Specifies whether network traffic is allowed or denied. Possible values are Allow and Deny.
  • description (pulumi.Input[str]) – A description for this rule. Restricted to 140 characters.
  • destination_address_prefix (pulumi.Input[str]) – CIDR or destination IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if destination_address_prefixes is not specified.
  • destination_address_prefixes (pulumi.Input[list]) – List of destination address prefixes. Tags may not be used. This is required if destination_address_prefix is not specified.
  • destination_application_security_group_ids (pulumi.Input[str]) – A List of destination Application Security Group ID’s
  • destination_port_range (pulumi.Input[str]) – Destination Port or Range. Integer or range between 0 and 65535 or *``to match any. This is required if`destination_port_ranges``is not specified.
  • destination_port_ranges (pulumi.Input[list]) – List of destination ports or port ranges. This is required if``destination_port_range``is not specified.
  • direction (pulumi.Input[str]) – The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are``InboundandOutbound``.
  • name (pulumi.Input[str]) – The name of the security rule. This needs to be unique across all Rules in the Network Security Group. Changing this forces a new resource to be created.
  • network_security_group_name (pulumi.Input[str]) – The name of the Network Security Group that we want to attach the rule to. Changing this forces a new resource to be created.
  • priority (pulumi.Input[float]) – Specifies 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.
  • protocol (pulumi.Input[str]) – Network protocol this rule applies to. Possible values include``Tcp,Udpor*` (which matches both).
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Network Security Rule. Changing this forces a new resource to be created.
  • source_address_prefix (pulumi.Input[str]) – CIDR or source IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if source_address_prefixes is not specified.
  • source_address_prefixes (pulumi.Input[list]) – List of source address prefixes. Tags may not be used. This is required if source_address_prefix is not specified.
  • source_application_security_group_ids (pulumi.Input[str]) – A List of source Application Security Group ID’s
  • source_port_range (pulumi.Input[str]) – Source Port or Range. Integer or range between 0 and 65535 or * to match any. This is required if source_port_ranges is not specified.
  • source_port_ranges (pulumi.Input[list]) – List of source ports or port ranges. This is required if source_port_range is not specified.
access = None

Specifies whether network traffic is allowed or denied. Possible values are Allow and Deny.

description = None

A description for this rule. Restricted to 140 characters.

destination_address_prefix = None

CIDR or destination IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if destination_address_prefixes is not specified.

destination_address_prefixes = None

List of destination address prefixes. Tags may not be used. This is required if destination_address_prefix is not specified.

destination_application_security_group_ids = None

A List of destination Application Security Group ID’s

destination_port_range = None

Destination Port or Range. Integer or range between 0 and 65535 or * to match any. This is required if destination_port_ranges is not specified.

destination_port_ranges = None

List of destination ports or port ranges. This is required if destination_port_range is not specified.

direction = None

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

name = None

The name of the security rule. This needs to be unique across all Rules in the Network Security Group. Changing this forces a new resource to be created.

network_security_group_name = None

The name of the Network Security Group that we want to attach the rule to. Changing this forces a new resource to be created.

priority = None

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

protocol = None

Network protocol this rule applies to. Possible values include Tcp, Udp or * (which matches both).

resource_group_name = None

The name of the resource group in which to create the Network Security Rule. Changing this forces a new resource to be created.

source_address_prefix = None

CIDR or source IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if source_address_prefixes is not specified.

source_address_prefixes = None

List of source address prefixes. Tags may not be used. This is required if source_address_prefix is not specified.

source_application_security_group_ids = None

A List of source Application Security Group ID’s

source_port_range = None

Source Port or Range. Integer or range between 0 and 65535 or * to match any. This is required if source_port_ranges is not specified.

source_port_ranges = None

List of source ports or port ranges. This is required if source_port_range is not specified.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.NetworkWatcher(resource_name, opts=None, location=None, name=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

Manages a Network Watcher.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the Network Watcher. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.PacketCapture(resource_name, opts=None, filters=None, maximum_bytes_per_packet=None, maximum_bytes_per_session=None, maximum_capture_duration=None, name=None, network_watcher_name=None, resource_group_name=None, storage_location=None, target_resource_id=None, __name__=None, __opts__=None)

Configures Packet Capturing against a Virtual Machine using a Network Watcher.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • filters (pulumi.Input[list]) – One or more filter blocks as defined below. Changing this forces a new resource to be created.
  • maximum_bytes_per_packet (pulumi.Input[float]) – The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.
  • maximum_bytes_per_session (pulumi.Input[float]) – Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.
  • maximum_capture_duration (pulumi.Input[float]) – The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name to use for this Packet Capture. Changing this forces a new resource to be created.
  • network_watcher_name (pulumi.Input[str]) – The name of the Network Watcher. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.
  • storage_location (pulumi.Input[dict]) – A storage_location block as defined below. Changing this forces a new resource to be created.
  • target_resource_id (pulumi.Input[str]) – The ID of the Resource to capture packets from. Changing this forces a new resource to be created.
filters = None

One or more filter blocks as defined below. Changing this forces a new resource to be created.

maximum_bytes_per_packet = None

The number of bytes captured per packet. The remaining bytes are truncated. Defaults to 0 (Entire Packet Captured). Changing this forces a new resource to be created.

maximum_bytes_per_session = None

Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.

maximum_capture_duration = None

The maximum duration of the capture session in seconds. Defaults to 18000 (5 hours). Changing this forces a new resource to be created.

name = None

The name to use for this Packet Capture. Changing this forces a new resource to be created.

network_watcher_name = None

The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.

storage_location = None

A storage_location block as defined below. Changing this forces a new resource to be created.

target_resource_id = None

The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.PublicIp(resource_name, opts=None, allocation_method=None, domain_name_label=None, idle_timeout_in_minutes=None, ip_version=None, location=None, name=None, public_ip_address_allocation=None, resource_group_name=None, reverse_fqdn=None, sku=None, tags=None, zones=None, __name__=None, __opts__=None)

Manage a Public IP Address.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allocation_method (pulumi.Input[str]) – Defines the allocation method for this IP address. Possible values are Static or Dynamic.
  • domain_name_label (pulumi.Input[str]) – Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
  • idle_timeout_in_minutes (pulumi.Input[float]) – Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.
  • ip_version (pulumi.Input[str]) – The IP Version to use, IPv6 or IPv4.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Public IP resource . Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the public ip.
  • reverse_fqdn (pulumi.Input[str]) – A 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.
  • sku (pulumi.Input[str]) – The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • zones (pulumi.Input[str]) – A collection containing the availability zone to allocate the Public IP in.
allocation_method = None

Defines the allocation method for this IP address. Possible values are Static or Dynamic.

domain_name_label = None

Label for the Domain Name. Will be used to make up the FQDN. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

fqdn = None

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

idle_timeout_in_minutes = None

Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

ip_address = None

The IP address value that was allocated.

ip_version = None

The IP Version to use, IPv6 or IPv4.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Public IP resource . Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the public ip.

reverse_fqdn = None

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

sku = None

The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic.

tags = None

A mapping of tags to assign to the resource.

zones = None

A collection containing the availability zone to allocate the Public IP in.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.Route(resource_name, opts=None, address_prefix=None, name=None, next_hop_in_ip_address=None, next_hop_type=None, resource_group_name=None, route_table_name=None, __name__=None, __opts__=None)

Manages a Route within a Route Table.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address_prefix (pulumi.Input[str]) – The destination CIDR to which the route applies, such as 10.1.0.0/16
  • name (pulumi.Input[str]) – The name of the route. Changing this forces a new resource to be created.
  • next_hop_in_ip_address (pulumi.Input[str]) – Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
  • next_hop_type (pulumi.Input[str]) – The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the route. Changing this forces a new resource to be created.
  • route_table_name (pulumi.Input[str]) – The name of the route table within which create the route. Changing this forces a new resource to be created.
address_prefix = None

The destination CIDR to which the route applies, such as 10.1.0.0/16

name = None

The name of the route. Changing this forces a new resource to be created.

next_hop_in_ip_address = None

Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

next_hop_type = None

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

resource_group_name = None

The name of the resource group in which to create the route. Changing this forces a new resource to be created.

route_table_name = None

The name of the route table within which create the route. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.RouteTable(resource_name, opts=None, disable_bgp_route_propagation=None, location=None, name=None, resource_group_name=None, routes=None, tags=None, __name__=None, __opts__=None)

Manages a Route Table

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • disable_bgp_route_propagation (pulumi.Input[bool]) – Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the route table. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the route table. Changing this forces a new resource to be created.
  • routes (pulumi.Input[list]) – Can be specified multiple times to define multiple routes. Each route block supports fields documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
disable_bgp_route_propagation = None

Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

The name of the route table. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the route table. Changing this forces a new resource to be created.

routes = None

Can be specified multiple times to define multiple routes. Each route block supports fields documented below.

subnets = None

The collection of Subnets associated with this route table.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.Subnet(resource_name, opts=None, address_prefix=None, delegations=None, ip_configurations=None, name=None, network_security_group_id=None, resource_group_name=None, route_table_id=None, service_endpoints=None, virtual_network_name=None, __name__=None, __opts__=None)

Manages a subnet. Subnets represent network segments within the IP space defined by the virtual network.

NOTE on Virtual Networks and Subnet’s: Terraform currently provides both a standalone Subnet resource, and allows for Subnets to be defined in-line within the Virtual Network resource. At this time you cannot use a Virtual Network with in-line Subnets in conjunction with any Subnet resources. Doing so will cause a conflict of Subnet configurations and will overwrite Subnet’s.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address_prefix (pulumi.Input[str]) – The address prefix to use for the subnet.
  • delegations (pulumi.Input[list]) – One or more delegation blocks as defined below.
  • ip_configurations (pulumi.Input[list]) – The collection of IP Configurations with IPs within this subnet.
  • name (pulumi.Input[str]) – The name of the subnet. Changing this forces a new resource to be created.
  • network_security_group_id (pulumi.Input[str]) – The ID of the Network Security Group to associate with the subnet.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the subnet. Changing this forces a new resource to be created.
  • route_table_id (pulumi.Input[str]) – The ID of the Route Table to associate with the subnet.
  • service_endpoints (pulumi.Input[list]) – The list of Service endpoints to associate with the subnet. Possible values include: Microsoft.AzureActiveDirectory, Microsoft.AzureCosmosDB, Microsoft.EventHub, Microsoft.KeyVault, Microsoft.ServiceBus, Microsoft.Sql and Microsoft.Storage.
  • virtual_network_name (pulumi.Input[str]) – The name of the virtual network to which to attach the subnet. Changing this forces a new resource to be created.
address_prefix = None

The address prefix to use for the subnet.

delegations = None

One or more delegation blocks as defined below.

ip_configurations = None

The collection of IP Configurations with IPs within this subnet.

name = None

The name of the subnet. Changing this forces a new resource to be created.

network_security_group_id = None

The ID of the Network Security Group to associate with the subnet.

resource_group_name = None

The name of the resource group in which to create the subnet. Changing this forces a new resource to be created.

route_table_id = None

The ID of the Route Table to associate with the subnet.

service_endpoints = None

The list of Service endpoints to associate with the subnet. Possible values include: Microsoft.AzureActiveDirectory, Microsoft.AzureCosmosDB, Microsoft.EventHub, Microsoft.KeyVault, Microsoft.ServiceBus, Microsoft.Sql and Microsoft.Storage.

virtual_network_name = None

The name of the virtual network to which to attach the subnet. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.SubnetNetworkSecurityGroupAssociation(resource_name, opts=None, network_security_group_id=None, subnet_id=None, __name__=None, __opts__=None)

Associates a Network Security Group with a Subnet within a Virtual Network.

NOTE: Subnet <-> Network Security Group associations currently need to be configured on both this resource and using the network_security_group_id field on the azurerm_subnet resource. The next major version of the AzureRM Provider (2.0) will remove the network_security_group_id field from the azurerm_subnet resource such that this resource is used to link resources in future.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • network_security_group_id (pulumi.Input[str]) – The ID of the Network Security Group which should be associated with the Subnet. Changing this forces a new resource to be created.
  • subnet_id (pulumi.Input[str]) – The ID of the Subnet. Changing this forces a new resource to be created.
network_security_group_id = None

The ID of the Network Security Group which should be associated with the Subnet. Changing this forces a new resource to be created.

subnet_id = None

The ID of the Subnet. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.SubnetRouteTableAssociation(resource_name, opts=None, route_table_id=None, subnet_id=None, __name__=None, __opts__=None)

Associates a Route Table with a Subnet within a Virtual Network.

NOTE: Subnet <-> Route Table associations currently need to be configured on both this resource and using the route_table_id field on the azurerm_subnet resource. The next major version of the AzureRM Provider (2.0) will remove the route_table_id field from the azurerm_subnet resource such that this resource is used to link resources in future.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • route_table_id (pulumi.Input[str]) – The ID of the Route Table which should be associated with the Subnet. Changing this forces a new resource to be created.
  • subnet_id (pulumi.Input[str]) – The ID of the Subnet. Changing this forces a new resource to be created.
route_table_id = None

The ID of the Route Table which should be associated with the Subnet. Changing this forces a new resource to be created.

subnet_id = None

The ID of the Subnet. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.VirtualNetwork(resource_name, opts=None, address_spaces=None, ddos_protection_plan=None, dns_servers=None, location=None, name=None, resource_group_name=None, subnets=None, tags=None, __name__=None, __opts__=None)

Manages a virtual network including any configured subnets. Each subnet can optionally be configured with a security group to be associated with the subnet.

NOTE on Virtual Networks and Subnet’s: Terraform currently provides both a standalone Subnet resource, and allows for Subnets to be defined in-line within the Virtual Network resource. At this time you cannot use a Virtual Network with in-line Subnets in conjunction with any Subnet resources. Doing so will cause a conflict of Subnet configurations and will overwrite Subnet’s.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • address_spaces (pulumi.Input[list]) – The address space that is used the virtual network. You can supply more than one address space. Changing this forces a new resource to be created.
  • ddos_protection_plan (pulumi.Input[dict]) – A ddos_protection_plan block as documented below.
  • dns_servers (pulumi.Input[list]) – List of IP addresses of DNS servers
  • location (pulumi.Input[str]) – The location/region where the virtual network is created. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the virtual network. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the virtual network.
  • subnets (pulumi.Input[list]) – Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
address_spaces = None

The address space that is used the virtual network. You can supply more than one address space. Changing this forces a new resource to be created.

ddos_protection_plan = None

A ddos_protection_plan block as documented below.

dns_servers = None

List of IP addresses of DNS servers

location = None

The location/region where the virtual network is created. Changing this forces a new resource to be created.

name = None

The name of the virtual network. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the virtual network.

subnets = None

Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.VirtualNetworkGateway(resource_name, opts=None, active_active=None, bgp_settings=None, default_local_network_gateway_id=None, enable_bgp=None, ip_configurations=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, type=None, vpn_client_configuration=None, vpn_type=None, __name__=None, __opts__=None)

Manages a Virtual Network Gateway to establish secure, cross-premises connectivity.

Note: Please be aware that provisioning a Virtual Network Gateway takes a long time (between 30 minutes and 1 hour)
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • active_active (pulumi.Input[bool]) – If true, an active-active Virtual Network Gateway will be created. An active-active gateway requires a HighPerformance or an UltraPerformance sku. If false, an active-standby gateway will be created. Defaults to false.
  • default_local_network_gateway_id (pulumi.Input[str]) –

    The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling. If not specified, forced tunneling is disabled.

  • enable_bgp (pulumi.Input[bool]) – If true, BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway. Defaults to false.
  • ip_configurations (pulumi.Input[list]) – One or two ip_configuration blocks documented below. An active-standby gateway requires exactly one ip_configuration block whereas an active-active gateway requires exactly two ip_configuration blocks.
  • location (pulumi.Input[str]) – The location/region where the Virtual Network Gateway is located. Changing the location/region forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the Virtual Network Gateway. Changing the name forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Virtual Network Gateway. Changing the resource group name forces a new resource to be created.
  • sku (pulumi.Input[str]) – Configuration of the size and capacity of the virtual network gateway. Valid options are Basic, Standard, HighPerformance, UltraPerformance, ErGw1AZ, ErGw2AZ, ErGw3AZ, VpnGw1, VpnGw2 and VpnGw3 and depend on the type and vpn_type arguments. A PolicyBased gateway only supports the Basic sku. Further, the UltraPerformance sku is only supported by an ExpressRoute gateway.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • type (pulumi.Input[str]) – The type of the Virtual Network Gateway. Valid options are Vpn or ExpressRoute. Changing the type forces a new resource to be created.
  • vpn_client_configuration (pulumi.Input[dict]) – A vpn_client_configuration block which is documented below. In this block the Virtual Network Gateway can be configured to accept IPSec point-to-site connections.
  • vpn_type (pulumi.Input[str]) – The routing type of the Virtual Network Gateway. Valid options are RouteBased or PolicyBased. Defaults to RouteBased.
active_active = None

If true, an active-active Virtual Network Gateway will be created. An active-active gateway requires a HighPerformance or an UltraPerformance sku. If false, an active-standby gateway will be created. Defaults to false.

default_local_network_gateway_id = None

The ID of the local network gateway through which outbound Internet traffic from the virtual network in which the gateway is created will be routed (forced tunneling). Refer to the Azure documentation on forced tunneling. If not specified, forced tunneling is disabled.

enable_bgp = None

If true, BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway. Defaults to false.

ip_configurations = None

One or two ip_configuration blocks documented below. An active-standby gateway requires exactly one ip_configuration block whereas an active-active gateway requires exactly two ip_configuration blocks.

location = None

The location/region where the Virtual Network Gateway is located. Changing the location/region forces a new resource to be created.

name = None

The name of the Virtual Network Gateway. Changing the name forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Virtual Network Gateway. Changing the resource group name forces a new resource to be created.

sku = None

Configuration of the size and capacity of the virtual network gateway. Valid options are Basic, Standard, HighPerformance, UltraPerformance, ErGw1AZ, ErGw2AZ, ErGw3AZ, VpnGw1, VpnGw2 and VpnGw3 and depend on the type and vpn_type arguments. A PolicyBased gateway only supports the Basic sku. Further, the UltraPerformance sku is only supported by an ExpressRoute gateway.

tags = None

A mapping of tags to assign to the resource.

type = None

The type of the Virtual Network Gateway. Valid options are Vpn or ExpressRoute. Changing the type forces a new resource to be created.

vpn_client_configuration = None

A vpn_client_configuration block which is documented below. In this block the Virtual Network Gateway can be configured to accept IPSec point-to-site connections.

vpn_type = None

The routing type of the Virtual Network Gateway. Valid options are RouteBased or PolicyBased. Defaults to RouteBased.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.VirtualNetworkGatewayConnection(resource_name, opts=None, authorization_key=None, enable_bgp=None, express_route_circuit_id=None, ipsec_policy=None, local_network_gateway_id=None, location=None, name=None, peer_virtual_network_gateway_id=None, resource_group_name=None, routing_weight=None, shared_key=None, tags=None, type=None, use_policy_based_traffic_selectors=None, virtual_network_gateway_id=None, __name__=None, __opts__=None)

Manages a connection in an existing Virtual Network Gateway.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • authorization_key (pulumi.Input[str]) – The authorization key associated with the Express Route Circuit. This field is required only if the type is an ExpressRoute connection.
  • enable_bgp (pulumi.Input[bool]) – If true, BGP (Border Gateway Protocol) is enabled for this connection. Defaults to false.
  • express_route_circuit_id (pulumi.Input[str]) – The ID of the Express Route Circuit when creating an ExpressRoute connection (i.e. when type is ExpressRoute). The Express Route Circuit can be in the same or in a different subscription.
  • ipsec_policy (pulumi.Input[dict]) – A ipsec_policy block which is documented below. Only a single policy can be defined for a connection. For details on custom policies refer to the relevant section in the Azure documentation.
  • local_network_gateway_id (pulumi.Input[str]) – The ID of the local network gateway when creating Site-to-Site connection (i.e. when type is IPsec).
  • location (pulumi.Input[str]) – The location/region where the connection is located. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the connection. Changing the name forces a new resource to be created.
  • peer_virtual_network_gateway_id (pulumi.Input[str]) – The ID of the peer virtual network gateway when creating a VNet-to-VNet connection (i.e. when type is Vnet2Vnet). The peer Virtual Network Gateway can be in the same or in a different subscription.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the connection Changing the name forces a new resource to be created.
  • routing_weight (pulumi.Input[float]) – The routing weight. Defaults to 10.
  • shared_key (pulumi.Input[str]) – The shared IPSec key. A key must be provided if a Site-to-Site or VNet-to-VNet connection is created whereas ExpressRoute connections do not need a shared key.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • type (pulumi.Input[str]) – The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet). Each connection type requires different mandatory arguments (refer to the examples above). Changing the connection type will force a new connection to be created.
  • use_policy_based_traffic_selectors (pulumi.Input[bool]) – If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsec_policy block. Defaults to false.
  • virtual_network_gateway_id (pulumi.Input[str]) – The ID of the Virtual Network Gateway in which the connection will be created. Changing the gateway forces a new resource to be created.
authorization_key = None

The authorization key associated with the Express Route Circuit. This field is required only if the type is an ExpressRoute connection.

enable_bgp = None

If true, BGP (Border Gateway Protocol) is enabled for this connection. Defaults to false.

express_route_circuit_id = None

The ID of the Express Route Circuit when creating an ExpressRoute connection (i.e. when type is ExpressRoute). The Express Route Circuit can be in the same or in a different subscription.

ipsec_policy = None

A ipsec_policy block which is documented below. Only a single policy can be defined for a connection. For details on custom policies refer to the relevant section in the Azure documentation.

local_network_gateway_id = None

The ID of the local network gateway when creating Site-to-Site connection (i.e. when type is IPsec).

location = None

The location/region where the connection is located. Changing this forces a new resource to be created.

name = None

The name of the connection. Changing the name forces a new resource to be created.

peer_virtual_network_gateway_id = None

The ID of the peer virtual network gateway when creating a VNet-to-VNet connection (i.e. when type is Vnet2Vnet). The peer Virtual Network Gateway can be in the same or in a different subscription.

resource_group_name = None

The name of the resource group in which to create the connection Changing the name forces a new resource to be created.

routing_weight = None

The routing weight. Defaults to 10.

shared_key = None

The shared IPSec key. A key must be provided if a Site-to-Site or VNet-to-VNet connection is created whereas ExpressRoute connections do not need a shared key.

tags = None

A mapping of tags to assign to the resource.

type = None

The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet). Each connection type requires different mandatory arguments (refer to the examples above). Changing the connection type will force a new connection to be created.

use_policy_based_traffic_selectors = None

If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsec_policy block. Defaults to false.

virtual_network_gateway_id = None

The ID of the Virtual Network Gateway in which the connection will be created. Changing the gateway forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.network.VirtualNetworkPeering(resource_name, opts=None, allow_forwarded_traffic=None, allow_gateway_transit=None, allow_virtual_network_access=None, name=None, remote_virtual_network_id=None, resource_group_name=None, use_remote_gateways=None, virtual_network_name=None, __name__=None, __opts__=None)

Manages a virtual network peering which allows resources to access other resources in the linked virtual network.

Virtual Network peerings cannot be created, updated or deleted concurrently.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allow_forwarded_traffic (pulumi.Input[bool]) – Controls if forwarded traffic from VMs in the remote virtual network is allowed. Defaults to false.
  • allow_gateway_transit (pulumi.Input[bool]) – Controls gatewayLinks can be used in the remote virtual network’s link to the local virtual network.
  • allow_virtual_network_access (pulumi.Input[bool]) – Controls if the VMs in the remote virtual network can access VMs in the local virtual network. Defaults to false.
  • name (pulumi.Input[str]) – The name of the virtual network peering. Changing this forces a new resource to be created.
  • remote_virtual_network_id (pulumi.Input[str]) – The full Azure resource ID of the remote virtual network. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created.
  • use_remote_gateways (pulumi.Input[bool]) – Controls if remote gateways can be used on the local virtual network. If the flag is set to true, and allow_gateway_transit on the remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. Defaults to false.
  • virtual_network_name (pulumi.Input[str]) – The name of the virtual network. Changing this forces a new resource to be created.
allow_forwarded_traffic = None

Controls if forwarded traffic from VMs in the remote virtual network is allowed. Defaults to false.

allow_gateway_transit = None

Controls gatewayLinks can be used in the remote virtual network’s link to the local virtual network.

allow_virtual_network_access = None

Controls if the VMs in the remote virtual network can access VMs in the local virtual network. Defaults to false.

name = None

The name of the virtual network peering. Changing this forces a new resource to be created.

remote_virtual_network_id = None

The full Azure resource ID of the remote virtual network. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created.

use_remote_gateways = None

Controls if remote gateways can be used on the local virtual network. If the flag is set to true, and allow_gateway_transit on the remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. Defaults to false.

virtual_network_name = None

The name of the virtual network. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_azure.network.get_application_security_group(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Application Security Group.

pulumi_azure.network.get_network_interface(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Network Interface.

pulumi_azure.network.get_network_security_group(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Network Security Group.

pulumi_azure.network.get_network_watcher(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Network Watcher.

pulumi_azure.network.get_public_i_ps(allocation_type=None, attached=None, name_prefix=None, resource_group_name=None, opts=None)

Use this data source to access information about a set of existing Public IP Addresses.

pulumi_azure.network.get_public_ip(name=None, resource_group_name=None, tags=None, zones=None, opts=None)

Use this data source to access information about an existing Public IP Address.

pulumi_azure.network.get_route_table(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Route Table.

pulumi_azure.network.get_subnet(name=None, resource_group_name=None, virtual_network_name=None, opts=None)

Use this data source to access information about an existing Subnet within a Virtual Network.

pulumi_azure.network.get_virtual_network(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Virtual Network.

pulumi_azure.network.get_virtual_network_gateway(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Virtual Network Gateway.