This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

network¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.network.ApplicationGateway(resource_name, opts=None, authentication_certificates=None, autoscale_configuration=None, backend_address_pools=None, backend_http_settings=None, custom_error_configurations=None, enable_http2=None, firewall_policy_id=None, frontend_ip_configurations=None, frontend_ports=None, gateway_ip_configurations=None, http_listeners=None, identity=None, location=None, name=None, probes=None, redirect_configurations=None, request_routing_rules=None, resource_group_name=None, rewrite_rule_sets=None, sku=None, ssl_certificates=None, ssl_policies=None, tags=None, trusted_root_certificates=None, url_path_maps=None, waf_configuration=None, zones=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Application Gateway.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    address_spaces=["10.254.0.0/16"])
frontend = azure.network.Subnet("frontend",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.254.0.0/24"])
backend = azure.network.Subnet("backend",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.254.2.0/24"])
example_public_ip = azure.network.PublicIp("examplePublicIp",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    allocation_method="Dynamic")
backend_address_pool_name = example_virtual_network.name.apply(lambda name: f"{name}-beap")
frontend_port_name = example_virtual_network.name.apply(lambda name: f"{name}-feport")
frontend_ip_configuration_name = example_virtual_network.name.apply(lambda name: f"{name}-feip")
http_setting_name = example_virtual_network.name.apply(lambda name: f"{name}-be-htst")
listener_name = example_virtual_network.name.apply(lambda name: f"{name}-httplstn")
request_routing_rule_name = example_virtual_network.name.apply(lambda name: f"{name}-rqrt")
redirect_configuration_name = example_virtual_network.name.apply(lambda name: f"{name}-rdrcfg")
network = azure.network.ApplicationGateway("network",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "Standard_Small",
        "tier": "Standard",
        "capacity": 2,
    },
    gateway_ip_configuration=[{
        "name": "my-gateway-ip-configuration",
        "subnet_id": frontend.id,
    }],
    frontend_port=[{
        "name": frontend_port_name,
        "port": 80,
    }],
    frontend_ip_configuration=[{
        "name": frontend_ip_configuration_name,
        "public_ip_address_id": example_public_ip.id,
    }],
    backend_address_pool=[{
        "name": backend_address_pool_name,
    }],
    backend_http_settings=[{
        "name": http_setting_name,
        "cookieBasedAffinity": "Disabled",
        "path": "/path1/",
        "port": 80,
        "protocol": "Http",
        "requestTimeout": 1,
    }],
    http_listener=[{
        "name": listener_name,
        "frontend_ip_configuration_name": frontend_ip_configuration_name,
        "frontendPortName": frontend_port_name,
        "protocol": "Http",
    }],
    request_routing_rule=[{
        "name": request_routing_rule_name,
        "ruleType": "Basic",
        "httpListenerName": listener_name,
        "backendAddressPoolName": backend_address_pool_name,
        "backendHttpSettingsName": http_setting_name,
    }])

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.
autoscale_configuration (pulumi.Input[dict]) – A autoscale_configuration block 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.
enable_http2 (pulumi.Input[bool]) – Is HTTP2 enabled on the application gateway resource? Defaults to false.
firewall_policy_id (pulumi.Input[str]) – The resource ID of a firewall policy.
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.
identity (pulumi.Input[dict]) – A identity block.
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.
redirect_configurations (pulumi.Input[list]) – A redirect_configuration block 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.
rewrite_rule_sets (pulumi.Input[list]) – One or more rewrite_rule_set blocks as defined below. Only valid for v2 SKUs.
sku (pulumi.Input[dict]) – A sku block as defined below.
ssl_certificates (pulumi.Input[list]) – One or more ssl_certificate blocks as defined below.
ssl_policies (pulumi.Input[list]) – a ssl policy block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
trusted_root_certificates (pulumi.Input[list]) – One or more trusted_root_certificate blocks as defined below.
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.
zones (pulumi.Input[list]) – A collection of availability zones to spread the Application Gateway over.

The authentication_certificates object supports the following:

data (pulumi.Input[str]) - The contents of the Authentication Certificate which should be used.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Authentication Certificate.

The autoscale_configuration object supports the following:

maxCapacity (pulumi.Input[float]) - Maximum capacity for autoscaling. Accepted values are in the range 2 to 125.
min_capacity (pulumi.Input[float]) - Minimum capacity for autoscaling. Accepted values are in the range 0 to 100.

The backend_address_pools object supports the following:

fqdns (pulumi.Input[list]) - A list of FQDN’s which should be part of the Backend Address Pool.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
ipAddresses (pulumi.Input[list]) - A list of IP Addresses which should be part of the Backend Address Pool.
name (pulumi.Input[str]) - The name of the Backend Address Pool.

The backend_http_settings object supports the following:

affinityCookieName (pulumi.Input[str]) - The name of the affinity cookie.
authentication_certificates (pulumi.Input[list]) - One or more authentication_certificate blocks.
- id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
- name (pulumi.Input[str]) - The name of the Authentication Certificate.
connectionDraining (pulumi.Input[dict]) - A connection_draining block as defined below.
- drainTimeoutSec (pulumi.Input[float]) - The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.
- enabled (pulumi.Input[bool]) - If connection draining is enabled or not.
cookieBasedAffinity (pulumi.Input[str]) - Is Cookie-Based Affinity enabled? Possible values are Enabled and Disabled.
host_name (pulumi.Input[str]) - Host header to be sent to the backend servers. Cannot be set if pick_host_name_from_backend_address is set to true.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Backend HTTP Settings Collection.
path (pulumi.Input[str]) - The Path which should be used as a prefix for all HTTP requests.
pickHostNameFromBackendAddress (pulumi.Input[bool]) - Whether host header should be picked from the host name of the backend server. Defaults to false.
port (pulumi.Input[float]) - The port which should be used for this Backend HTTP Settings Collection.
probe_id (pulumi.Input[str]) - The ID of the associated Probe.
probeName (pulumi.Input[str]) - The name of an associated HTTP Probe.
protocol (pulumi.Input[str]) - The Protocol which should be used. Possible values are Http and Https.
requestTimeout (pulumi.Input[float]) - The request timeout in seconds, which must be between 1 and 86400 seconds.
trustedRootCertificateNames (pulumi.Input[list]) - A list of trusted_root_certificate names.

The custom_error_configurations object supports the following:

customErrorPageUrl (pulumi.Input[str]) - Error page URL of the application gateway customer error.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
statusCode (pulumi.Input[str]) - Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502

The frontend_ip_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Frontend IP Configuration.
private_ip_address (pulumi.Input[str]) - The Private IP Address to use for the Application Gateway.
privateIpAddressAllocation (pulumi.Input[str]) - The Allocation Method for the Private IP Address. Possible values are Dynamic and Static.
public_ip_address_id (pulumi.Input[str]) - The ID of a Public IP Address which the Application Gateway should use.
subnet_id (pulumi.Input[str]) - The ID of the Subnet.

The frontend_ports object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Frontend Port.
port (pulumi.Input[float]) - The port used for this Frontend Port.

The gateway_ip_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of this Gateway IP Configuration.
subnet_id (pulumi.Input[str]) - The ID of the Subnet which the Application Gateway should be connected to.

The http_listeners object supports the following:

custom_error_configurations (pulumi.Input[list]) - One or more custom_error_configuration blocks as defined below.
- customErrorPageUrl (pulumi.Input[str]) - Error page URL of the application gateway customer error.
- id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
- statusCode (pulumi.Input[str]) - Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502
frontend_ip_configuration_id (pulumi.Input[str]) - The ID of the associated Frontend Configuration.
frontend_ip_configuration_name (pulumi.Input[str]) - The Name of the Frontend IP Configuration used for this HTTP Listener.
frontendPortId (pulumi.Input[str]) - The ID of the associated Frontend Port.
frontendPortName (pulumi.Input[str]) - The Name of the Frontend Port use for this HTTP Listener.
host_name (pulumi.Input[str]) - The Hostname which should be used for this HTTP Listener.
host_names (pulumi.Input[list]) - A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of the HTTP Listener.
protocol (pulumi.Input[str]) - The Protocol to use for this HTTP Listener. Possible values are Http and Https.
requireSni (pulumi.Input[bool]) - Should Server Name Indication be Required? Defaults to false.
sslCertificateId (pulumi.Input[str]) - The ID of the associated SSL Certificate.
sslCertificateName (pulumi.Input[str]) - The name of the associated SSL Certificate which should be used for this HTTP Listener.

The identity object supports the following:

identityIds (pulumi.Input[str]) - Specifies a list with a single user managed identity id to be assigned to the Application Gateway.
type (pulumi.Input[str]) - The Managed Service Identity Type of this Application Gateway. The only possible value is UserAssigned. Defaults to UserAssigned.

The probes object supports the following:

host (pulumi.Input[str]) - The Hostname used for this Probe. If the Application Gateway is configured for a single site, by default the Host name should be specified as ‘127.0.0.1’, unless otherwise configured in custom probe. Cannot be set if pick_host_name_from_backend_http_settings is set to true.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
interval (pulumi.Input[float]) - The Interval between two consecutive probes in seconds. Possible values range from 1 second to a maximum of 86,400 seconds.
match (pulumi.Input[dict]) - A match block as defined above.
- body (pulumi.Input[str]) - A snippet from the Response Body which must be present in the Response..
- statusCodes (pulumi.Input[list]) - A list of allowed status codes for this Health Probe.
minimumServers (pulumi.Input[float]) - The minimum number of servers that are always marked as healthy. Defaults to 0.
name (pulumi.Input[str]) - The Name of the Probe.
path (pulumi.Input[str]) - The Path used for this Probe.
pickHostNameFromBackendHttpSettings (pulumi.Input[bool]) - Whether the host header should be picked from the backend http settings. Defaults to false.
protocol (pulumi.Input[str]) - The Protocol used for this Probe. Possible values are Http and Https.
timeout (pulumi.Input[float]) - The Timeout used for this Probe, which indicates when a probe becomes unhealthy. Possible values range from 1 second to a maximum of 86,400 seconds.
unhealthyThreshold (pulumi.Input[float]) - The Unhealthy Threshold for this Probe, which indicates the amount of retries which should be attempted before a node is deemed unhealthy. Possible values are from 1 - 20 seconds.

The redirect_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
includePath (pulumi.Input[bool]) - Whether or not to include the path in the redirected Url. Defaults to false
includeQueryString (pulumi.Input[bool]) - Whether or not to include the query string in the redirected Url. Default to false
name (pulumi.Input[str]) - Unique name of the redirect configuration block
redirectType (pulumi.Input[str]) - The type of redirect. Possible values are Permanent, Temporary, Found and SeeOther
targetListenerId (pulumi.Input[str])
targetListenerName (pulumi.Input[str]) - The name of the listener to redirect to. Cannot be set if target_url is set.
targetUrl (pulumi.Input[str]) - The Url to redirect the request to. Cannot be set if target_listener_name is set.

The request_routing_rules object supports the following:

backend_address_pool_id (pulumi.Input[str]) - The ID of the associated Backend Address Pool.
backendAddressPoolName (pulumi.Input[str]) - The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set.
backendHttpSettingsId (pulumi.Input[str]) - The ID of the associated Backend HTTP Settings Configuration.
backendHttpSettingsName (pulumi.Input[str]) - The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set.
httpListenerId (pulumi.Input[str]) - The ID of the associated HTTP Listener.
httpListenerName (pulumi.Input[str]) - The Name of the HTTP Listener which should be used for this Routing Rule.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of this Request Routing Rule.
redirectConfigurationId (pulumi.Input[str]) - The ID of the associated Redirect Configuration.
redirectConfigurationName (pulumi.Input[str]) - The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either backend_address_pool_name or backend_http_settings_name is set.
rewriteRuleSetId (pulumi.Input[str]) - The ID of the associated Rewrite Rule Set.
rewriteRuleSetName (pulumi.Input[str]) - The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs.
ruleType (pulumi.Input[str]) - The Type of Routing that should be used for this Rule. Possible values are Basic and PathBasedRouting.
urlPathMapId (pulumi.Input[str]) - The ID of the associated URL Path Map.
urlPathMapName (pulumi.Input[str]) - The Name of the URL Path Map which should be associated with this Routing Rule.

The rewrite_rule_sets object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - Unique name of the rewrite rule set block
rewriteRules (pulumi.Input[list]) - One or more rewrite_rule blocks as defined above.
- conditions (pulumi.Input[list]) - One or more condition blocks as defined above.
  - ignoreCase (pulumi.Input[bool]) - Perform a case in-sensitive comparison. Defaults to false
  - negate (pulumi.Input[bool]) - Negate the result of the condition evaluation. Defaults to false
  - pattern (pulumi.Input[str]) - The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.
  - variable (pulumi.Input[str]) - The variable of the condition.
- name (pulumi.Input[str]) - Unique name of the rewrite rule block
- requestHeaderConfigurations (pulumi.Input[list]) - One or more request_header_configuration blocks as defined above.
  - headerName (pulumi.Input[str]) - Header name of the header configuration.
  - headerValue (pulumi.Input[str]) - Header value of the header configuration. To delete a request header set this property to an empty string.
- responseHeaderConfigurations (pulumi.Input[list]) - One or more response_header_configuration blocks as defined above.
  - headerName (pulumi.Input[str]) - Header name of the header configuration.
  - headerValue (pulumi.Input[str]) - Header value of the header configuration. To delete a response header set this property to an empty string.
- ruleSequence (pulumi.Input[float]) - Rule sequence of the rewrite rule that determines the order of execution in a set.

The sku object supports the following:

capacity (pulumi.Input[float]) - The Capacity of the SKU to use for this Application Gateway. When using a V1 SKU this value must be between 1 and 32, and 1 to 125 for a V2 SKU. This property is optional if autoscale_configuration is set.
name (pulumi.Input[str]) - The Name of the SKU to use for this Application Gateway. Possible values are Standard_Small, Standard_Medium, Standard_Large, Standard_v2, WAF_Medium, WAF_Large, and WAF_v2.
tier (pulumi.Input[str]) - The Tier of the SKU to use for this Application Gateway. Possible values are Standard, Standard_v2, WAF and WAF_v2.

The ssl_certificates object supports the following:

data (pulumi.Input[str]) - PFX certificate. Required if key_vault_secret_id is not set.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
key_vault_secret_id (pulumi.Input[str]) - Secret Id of (base-64 encoded unencrypted pfx) Secret or Certificate object stored in Azure KeyVault. You need to enable soft delete for keyvault to use this feature. Required if data is not set.
name (pulumi.Input[str]) - The Name of the SSL certificate that is unique within this Application Gateway
password (pulumi.Input[str]) - Password for the pfx file specified in data. Required if data is set.
publicCertData (pulumi.Input[str]) - The Public Certificate Data associated with the SSL Certificate.

The ssl_policies object supports the following:

cipherSuites (pulumi.Input[list]) - A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384.
disabledProtocols (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.
minProtocolVersion (pulumi.Input[str]) - The minimal TLS version. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.
policyName (pulumi.Input[str]) - The Name of the Policy e.g AppGwSslPolicy20170401S. Required if policy_type is set to Predefined. Possible values can change over time and are published here https://docs.microsoft.com/en-us/azure/application-gateway/application-gateway-ssl-policy-overview. Not compatible with disabled_protocols.
policy_type (pulumi.Input[str]) - The Type of the Policy. Possible values are Predefined and Custom.

The trusted_root_certificates object supports the following:

data (pulumi.Input[str]) - The contents of the Trusted Root Certificate which should be used.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of the Trusted Root Certificate to use.

The url_path_maps object supports the following:

defaultBackendAddressPoolId (pulumi.Input[str]) - The ID of the Default Backend Address Pool.
defaultBackendAddressPoolName (pulumi.Input[str]) - The Name of the Default Backend Address Pool which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set.
defaultBackendHttpSettingsId (pulumi.Input[str]) - The ID of the Default Backend HTTP Settings Collection.
defaultBackendHttpSettingsName (pulumi.Input[str]) - The Name of the Default Backend HTTP Settings Collection which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set.
defaultRedirectConfigurationId (pulumi.Input[str]) - The ID of the Default Redirect Configuration.
defaultRedirectConfigurationName (pulumi.Input[str]) - The Name of the Default Redirect Configuration which should be used for this URL Path Map. Cannot be set if either default_backend_address_pool_name or default_backend_http_settings_name is set.
defaultRewriteRuleSetId (pulumi.Input[str])
defaultRewriteRuleSetName (pulumi.Input[str]) - The Name of the Default Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of the URL Path Map.
pathRules (pulumi.Input[list]) - One or more path_rule blocks as defined above.
- backend_address_pool_id (pulumi.Input[str]) - The ID of the associated Backend Address Pool.
- backendAddressPoolName (pulumi.Input[str]) - The Name of the Backend Address Pool to use for this Path Rule. Cannot be set if redirect_configuration_name is set.
- backendHttpSettingsId (pulumi.Input[str]) - The ID of the associated Backend HTTP Settings Configuration.
- backendHttpSettingsName (pulumi.Input[str]) - The Name of the Backend HTTP Settings Collection to use for this Path Rule. Cannot be set if redirect_configuration_name is set.
- id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
- name (pulumi.Input[str]) - The Name of the Path Rule.
- paths (pulumi.Input[list]) - A list of Paths used in this Path Rule.
- redirectConfigurationId (pulumi.Input[str]) - The ID of the associated Redirect Configuration.
- redirectConfigurationName (pulumi.Input[str]) - The Name of a Redirect Configuration to use for this Path Rule. Cannot be set if backend_address_pool_name or backend_http_settings_name is set.
- rewriteRuleSetId (pulumi.Input[str]) - The ID of the associated Rewrite Rule Set.
- rewriteRuleSetName (pulumi.Input[str]) - The Name of the Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.

The waf_configuration object supports the following:

disabledRuleGroups (pulumi.Input[list]) - one or more disabled_rule_group blocks as defined below.
- ruleGroupName (pulumi.Input[str]) - The rule group where specific rules should be disabled. Accepted values are: crs_20_protocol_violations, crs_21_protocol_anomalies, crs_23_request_limits, crs_30_http_policy, crs_35_bad_robots, crs_40_generic_attacks, crs_41_sql_injection_attacks, crs_41_xss_attacks, crs_42_tight_security, crs_45_trojans, General, REQUEST-911-METHOD-ENFORCEMENT, REQUEST-913-SCANNER-DETECTION, REQUEST-920-PROTOCOL-ENFORCEMENT, REQUEST-921-PROTOCOL-ATTACK, REQUEST-930-APPLICATION-ATTACK-LFI, REQUEST-931-APPLICATION-ATTACK-RFI, REQUEST-932-APPLICATION-ATTACK-RCE, REQUEST-933-APPLICATION-ATTACK-PHP, REQUEST-941-APPLICATION-ATTACK-XSS, REQUEST-942-APPLICATION-ATTACK-SQLI, REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION
- rules (pulumi.Input[list]) - A list of rules which should be disabled in that group. Disables all rules in the specified group if rules is not specified.
enabled (pulumi.Input[bool]) - Is the Web Application Firewall be enabled?
exclusions (pulumi.Input[list]) - one or more exclusion blocks as defined below.
- matchVariable (pulumi.Input[str]) - Match variable of the exclusion rule to exclude header, cookie or GET arguments. Possible values are RequestHeaderNames, RequestArgNames and RequestCookieNames
- selector (pulumi.Input[str]) - String value which will be used for the filter operation. If empty will exclude all traffic on this match_variable
- selectorMatchOperator (pulumi.Input[str]) - Operator which will be used to search in the variable content. Possible values are Equals, StartsWith, EndsWith, Contains. If empty will exclude all traffic on this match_variable
fileUploadLimitMb (pulumi.Input[float]) - The File Upload Limit in MB. Accepted values are in the range 1MB to 500MB. Defaults to 100MB.
firewallMode (pulumi.Input[str]) - The Web Application Firewall Mode. Possible values are Detection and Prevention.
maxRequestBodySizeKb (pulumi.Input[float]) - The Maximum Request Body Size in KB. Accepted values are in the range 1KB to 128KB. Defaults to 128KB.
requestBodyCheck (pulumi.Input[bool]) - Is Request Body Inspection enabled? Defaults to true.
ruleSetType (pulumi.Input[str]) - The Type of the Rule Set used for this Web Application Firewall. Currently, only OWASP is supported.
ruleSetVersion (pulumi.Input[str]) - The Version of the Rule Set used for this Web Application Firewall. Possible values are 2.2.9, 3.0, and 3.1.

authentication_certificates: pulumi.Output[list] = None¶

One or more authentication_certificate blocks as defined below.

data (str) - The contents of the Authentication Certificate which should be used.
id (str) - The ID of the Rewrite Rule Set
name (str) - The name of the Authentication Certificate.

autoscale_configuration: pulumi.Output[dict] = None¶

A autoscale_configuration block as defined below.

maxCapacity (float) - Maximum capacity for autoscaling. Accepted values are in the range 2 to 125.
min_capacity (float) - Minimum capacity for autoscaling. Accepted values are in the range 0 to 100.

backend_address_pools: pulumi.Output[list] = None¶

One or more backend_address_pool blocks as defined below.

fqdns (list) - A list of FQDN’s which should be part of the Backend Address Pool.
id (str) - The ID of the Rewrite Rule Set
ipAddresses (list) - A list of IP Addresses which should be part of the Backend Address Pool.
name (str) - The name of the Backend Address Pool.

backend_http_settings: pulumi.Output[list] = None¶

One or more backend_http_settings blocks as defined below.

affinityCookieName (str) - The name of the affinity cookie.
authentication_certificates (list) - One or more authentication_certificate blocks.
- id (str) - The ID of the Rewrite Rule Set
- name (str) - The name of the Authentication Certificate.
connectionDraining (dict) - A connection_draining block as defined below.
- drainTimeoutSec (float) - The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.
- enabled (bool) - If connection draining is enabled or not.
cookieBasedAffinity (str) - Is Cookie-Based Affinity enabled? Possible values are Enabled and Disabled.
host_name (str) - Host header to be sent to the backend servers. Cannot be set if pick_host_name_from_backend_address is set to true.
id (str) - The ID of the Rewrite Rule Set
name (str) - The name of the Backend HTTP Settings Collection.
path (str) - The Path which should be used as a prefix for all HTTP requests.
pickHostNameFromBackendAddress (bool) - Whether host header should be picked from the host name of the backend server. Defaults to false.
port (float) - The port which should be used for this Backend HTTP Settings Collection.
probe_id (str) - The ID of the associated Probe.
probeName (str) - The name of an associated HTTP Probe.
protocol (str) - The Protocol which should be used. Possible values are Http and Https.
requestTimeout (float) - The request timeout in seconds, which must be between 1 and 86400 seconds.
trustedRootCertificateNames (list) - A list of trusted_root_certificate names.

custom_error_configurations: pulumi.Output[list] = None¶

One or more custom_error_configuration blocks as defined below.

customErrorPageUrl (str) - Error page URL of the application gateway customer error.
id (str) - The ID of the Rewrite Rule Set
statusCode (str) - Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502

enable_http2: pulumi.Output[bool] = None¶: Is HTTP2 enabled on the application gateway resource? Defaults to false.

firewall_policy_id: pulumi.Output[str] = None¶: The resource ID of a firewall policy.

frontend_ip_configurations: pulumi.Output[list] = None¶

One or more frontend_ip_configuration blocks as defined below.

id (str) - The ID of the Rewrite Rule Set
name (str) - The name of the Frontend IP Configuration.
private_ip_address (str) - The Private IP Address to use for the Application Gateway.
privateIpAddressAllocation (str) - The Allocation Method for the Private IP Address. Possible values are Dynamic and Static.
public_ip_address_id (str) - The ID of a Public IP Address which the Application Gateway should use.
subnet_id (str) - The ID of the Subnet.

frontend_ports: pulumi.Output[list] = None¶

One or more frontend_port blocks as defined below.

id (str) - The ID of the Rewrite Rule Set
name (str) - The name of the Frontend Port.
port (float) - The port used for this Frontend Port.

gateway_ip_configurations: pulumi.Output[list] = None¶

One or more gateway_ip_configuration blocks as defined below.

id (str) - The ID of the Rewrite Rule Set
name (str) - The Name of this Gateway IP Configuration.
subnet_id (str) - The ID of the Subnet which the Application Gateway should be connected to.

http_listeners: pulumi.Output[list] = None¶

One or more http_listener blocks as defined below.

custom_error_configurations (list) - One or more custom_error_configuration blocks as defined below.
- customErrorPageUrl (str) - Error page URL of the application gateway customer error.
- id (str) - The ID of the Rewrite Rule Set
- statusCode (str) - Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502
frontend_ip_configuration_id (str) - The ID of the associated Frontend Configuration.
frontend_ip_configuration_name (str) - The Name of the Frontend IP Configuration used for this HTTP Listener.
frontendPortId (str) - The ID of the associated Frontend Port.
frontendPortName (str) - The Name of the Frontend Port use for this HTTP Listener.
host_name (str) - The Hostname which should be used for this HTTP Listener.
host_names (list) - A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters.
id (str) - The ID of the Rewrite Rule Set
name (str) - The Name of the HTTP Listener.
protocol (str) - The Protocol to use for this HTTP Listener. Possible values are Http and Https.
requireSni (bool) - Should Server Name Indication be Required? Defaults to false.
sslCertificateId (str) - The ID of the associated SSL Certificate.
sslCertificateName (str) - The name of the associated SSL Certificate which should be used for this HTTP Listener.

identity: pulumi.Output[dict] = None¶

A identity block.

identityIds (str) - Specifies a list with a single user managed identity id to be assigned to the Application Gateway.
type (str) - The Managed Service Identity Type of this Application Gateway. The only possible value is UserAssigned. Defaults to UserAssigned.

location: pulumi.Output[str] = None¶: The Azure region where the Application Gateway should exist. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the Application Gateway. Changing this forces a new resource to be created.

probes: pulumi.Output[list] = None¶

One or more probe blocks as defined below.

host (str) - The Hostname used for this Probe. If the Application Gateway is configured for a single site, by default the Host name should be specified as ‘127.0.0.1’, unless otherwise configured in custom probe. Cannot be set if pick_host_name_from_backend_http_settings is set to true.
id (str) - The ID of the Rewrite Rule Set
interval (float) - The Interval between two consecutive probes in seconds. Possible values range from 1 second to a maximum of 86,400 seconds.
match (dict) - A match block as defined above.
- body (str) - A snippet from the Response Body which must be present in the Response..
- statusCodes (list) - A list of allowed status codes for this Health Probe.
minimumServers (float) - The minimum number of servers that are always marked as healthy. Defaults to 0.
name (str) - The Name of the Probe.
path (str) - The Path used for this Probe.
pickHostNameFromBackendHttpSettings (bool) - Whether the host header should be picked from the backend http settings. Defaults to false.
protocol (str) - The Protocol used for this Probe. Possible values are Http and Https.
timeout (float) - The Timeout used for this Probe, which indicates when a probe becomes unhealthy. Possible values range from 1 second to a maximum of 86,400 seconds.
unhealthyThreshold (float) - The Unhealthy Threshold for this Probe, which indicates the amount of retries which should be attempted before a node is deemed unhealthy. Possible values are from 1 - 20 seconds.

redirect_configurations: pulumi.Output[list] = None¶

A redirect_configuration block as defined below.

id (str) - The ID of the Rewrite Rule Set
includePath (bool) - Whether or not to include the path in the redirected Url. Defaults to false
includeQueryString (bool) - Whether or not to include the query string in the redirected Url. Default to false
name (str) - Unique name of the redirect configuration block
redirectType (str) - The type of redirect. Possible values are Permanent, Temporary, Found and SeeOther
targetListenerId (str)
targetListenerName (str) - The name of the listener to redirect to. Cannot be set if target_url is set.
targetUrl (str) - The Url to redirect the request to. Cannot be set if target_listener_name is set.

request_routing_rules: pulumi.Output[list] = None¶

One or more request_routing_rule blocks as defined below.

backend_address_pool_id (str) - The ID of the associated Backend Address Pool.
backendAddressPoolName (str) - The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set.
backendHttpSettingsId (str) - The ID of the associated Backend HTTP Settings Configuration.
backendHttpSettingsName (str) - The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set.
httpListenerId (str) - The ID of the associated HTTP Listener.
httpListenerName (str) - The Name of the HTTP Listener which should be used for this Routing Rule.
id (str) - The ID of the Rewrite Rule Set
name (str) - The Name of this Request Routing Rule.
redirectConfigurationId (str) - The ID of the associated Redirect Configuration.
redirectConfigurationName (str) - The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either backend_address_pool_name or backend_http_settings_name is set.
rewriteRuleSetId (str) - The ID of the associated Rewrite Rule Set.
rewriteRuleSetName (str) - The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs.
ruleType (str) - The Type of Routing that should be used for this Rule. Possible values are Basic and PathBasedRouting.
urlPathMapId (str) - The ID of the associated URL Path Map.
urlPathMapName (str) - The Name of the URL Path Map which should be associated with this Routing Rule.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to the Application Gateway should exist. Changing this forces a new resource to be created.

rewrite_rule_sets: pulumi.Output[list] = None¶

One or more rewrite_rule_set blocks as defined below. Only valid for v2 SKUs.

id (str) - The ID of the Rewrite Rule Set
name (str) - Unique name of the rewrite rule set block
rewriteRules (list) - One or more rewrite_rule blocks as defined above.
- conditions (list) - One or more condition blocks as defined above.
  - ignoreCase (bool) - Perform a case in-sensitive comparison. Defaults to false
  - negate (bool) - Negate the result of the condition evaluation. Defaults to false
  - pattern (str) - The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.
  - variable (str) - The variable of the condition.
- name (str) - Unique name of the rewrite rule block
- requestHeaderConfigurations (list) - One or more request_header_configuration blocks as defined above.
  - headerName (str) - Header name of the header configuration.
  - headerValue (str) - Header value of the header configuration. To delete a request header set this property to an empty string.
- responseHeaderConfigurations (list) - One or more response_header_configuration blocks as defined above.
  - headerName (str) - Header name of the header configuration.
  - headerValue (str) - Header value of the header configuration. To delete a response header set this property to an empty string.
- ruleSequence (float) - Rule sequence of the rewrite rule that determines the order of execution in a set.

sku: pulumi.Output[dict] = None¶

A sku block as defined below.

capacity (float) - The Capacity of the SKU to use for this Application Gateway. When using a V1 SKU this value must be between 1 and 32, and 1 to 125 for a V2 SKU. This property is optional if autoscale_configuration is set.
name (str) - The Name of the SKU to use for this Application Gateway. Possible values are Standard_Small, Standard_Medium, Standard_Large, Standard_v2, WAF_Medium, WAF_Large, and WAF_v2.
tier (str) - The Tier of the SKU to use for this Application Gateway. Possible values are Standard, Standard_v2, WAF and WAF_v2.

ssl_certificates: pulumi.Output[list] = None¶

One or more ssl_certificate blocks as defined below.

data (str) - PFX certificate. Required if key_vault_secret_id is not set.
id (str) - The ID of the Rewrite Rule Set
key_vault_secret_id (str) - Secret Id of (base-64 encoded unencrypted pfx) Secret or Certificate object stored in Azure KeyVault. You need to enable soft delete for keyvault to use this feature. Required if data is not set.
name (str) - The Name of the SSL certificate that is unique within this Application Gateway
password (str) - Password for the pfx file specified in data. Required if data is set.
publicCertData (str) - The Public Certificate Data associated with the SSL Certificate.

ssl_policies: pulumi.Output[list] = None¶

a ssl policy block as defined below.

cipherSuites (list) - A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384.
disabledProtocols (list) - A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.
minProtocolVersion (str) - The minimal TLS version. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.
policyName (str) - The Name of the Policy e.g AppGwSslPolicy20170401S. Required if policy_type is set to Predefined. Possible values can change over time and are published here https://docs.microsoft.com/en-us/azure/application-gateway/application-gateway-ssl-policy-overview. Not compatible with disabled_protocols.
policy_type (str) - The Type of the Policy. Possible values are Predefined and Custom.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

trusted_root_certificates: pulumi.Output[list] = None¶

One or more trusted_root_certificate blocks as defined below.

data (str) - The contents of the Trusted Root Certificate which should be used.
id (str) - The ID of the Rewrite Rule Set
name (str) - The Name of the Trusted Root Certificate to use.

url_path_maps: pulumi.Output[list] = None¶

One or more url_path_map blocks as defined below.

defaultBackendAddressPoolId (str) - The ID of the Default Backend Address Pool.
defaultBackendAddressPoolName (str) - The Name of the Default Backend Address Pool which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set.
defaultBackendHttpSettingsId (str) - The ID of the Default Backend HTTP Settings Collection.
defaultBackendHttpSettingsName (str) - The Name of the Default Backend HTTP Settings Collection which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set.
defaultRedirectConfigurationId (str) - The ID of the Default Redirect Configuration.
defaultRedirectConfigurationName (str) - The Name of the Default Redirect Configuration which should be used for this URL Path Map. Cannot be set if either default_backend_address_pool_name or default_backend_http_settings_name is set.
defaultRewriteRuleSetId (str)
defaultRewriteRuleSetName (str) - The Name of the Default Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.
id (str) - The ID of the Rewrite Rule Set
name (str) - The Name of the URL Path Map.
pathRules (list) - One or more path_rule blocks as defined above.
- backend_address_pool_id (str) - The ID of the associated Backend Address Pool.
- backendAddressPoolName (str) - The Name of the Backend Address Pool to use for this Path Rule. Cannot be set if redirect_configuration_name is set.
- backendHttpSettingsId (str) - The ID of the associated Backend HTTP Settings Configuration.
- backendHttpSettingsName (str) - The Name of the Backend HTTP Settings Collection to use for this Path Rule. Cannot be set if redirect_configuration_name is set.
- id (str) - The ID of the Rewrite Rule Set
- name (str) - The Name of the Path Rule.
- paths (list) - A list of Paths used in this Path Rule.
- redirectConfigurationId (str) - The ID of the associated Redirect Configuration.
- redirectConfigurationName (str) - The Name of a Redirect Configuration to use for this Path Rule. Cannot be set if backend_address_pool_name or backend_http_settings_name is set.
- rewriteRuleSetId (str) - The ID of the associated Rewrite Rule Set.
- rewriteRuleSetName (str) - The Name of the Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.

waf_configuration: pulumi.Output[dict] = None¶

A waf_configuration block as defined below.

disabledRuleGroups (list) - one or more disabled_rule_group blocks as defined below.
- ruleGroupName (str) - The rule group where specific rules should be disabled. Accepted values are: crs_20_protocol_violations, crs_21_protocol_anomalies, crs_23_request_limits, crs_30_http_policy, crs_35_bad_robots, crs_40_generic_attacks, crs_41_sql_injection_attacks, crs_41_xss_attacks, crs_42_tight_security, crs_45_trojans, General, REQUEST-911-METHOD-ENFORCEMENT, REQUEST-913-SCANNER-DETECTION, REQUEST-920-PROTOCOL-ENFORCEMENT, REQUEST-921-PROTOCOL-ATTACK, REQUEST-930-APPLICATION-ATTACK-LFI, REQUEST-931-APPLICATION-ATTACK-RFI, REQUEST-932-APPLICATION-ATTACK-RCE, REQUEST-933-APPLICATION-ATTACK-PHP, REQUEST-941-APPLICATION-ATTACK-XSS, REQUEST-942-APPLICATION-ATTACK-SQLI, REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION
- rules (list) - A list of rules which should be disabled in that group. Disables all rules in the specified group if rules is not specified.
enabled (bool) - Is the Web Application Firewall be enabled?
exclusions (list) - one or more exclusion blocks as defined below.
- matchVariable (str) - Match variable of the exclusion rule to exclude header, cookie or GET arguments. Possible values are RequestHeaderNames, RequestArgNames and RequestCookieNames
- selector (str) - String value which will be used for the filter operation. If empty will exclude all traffic on this match_variable
- selectorMatchOperator (str) - Operator which will be used to search in the variable content. Possible values are Equals, StartsWith, EndsWith, Contains. If empty will exclude all traffic on this match_variable
fileUploadLimitMb (float) - The File Upload Limit in MB. Accepted values are in the range 1MB to 500MB. Defaults to 100MB.
firewallMode (str) - The Web Application Firewall Mode. Possible values are Detection and Prevention.
maxRequestBodySizeKb (float) - The Maximum Request Body Size in KB. Accepted values are in the range 1KB to 128KB. Defaults to 128KB.
requestBodyCheck (bool) - Is Request Body Inspection enabled? Defaults to true.
ruleSetType (str) - The Type of the Rule Set used for this Web Application Firewall. Currently, only OWASP is supported.
ruleSetVersion (str) - The Version of the Rule Set used for this Web Application Firewall. Possible values are 2.2.9, 3.0, and 3.1.

zones: pulumi.Output[list] = None¶: A collection of availability zones to spread the Application Gateway over.

static get(resource_name, id, opts=None, authentication_certificates=None, autoscale_configuration=None, backend_address_pools=None, backend_http_settings=None, custom_error_configurations=None, enable_http2=None, firewall_policy_id=None, frontend_ip_configurations=None, frontend_ports=None, gateway_ip_configurations=None, http_listeners=None, identity=None, location=None, name=None, probes=None, redirect_configurations=None, request_routing_rules=None, resource_group_name=None, rewrite_rule_sets=None, sku=None, ssl_certificates=None, ssl_policies=None, tags=None, trusted_root_certificates=None, url_path_maps=None, waf_configuration=None, zones=None)¶

Get an existing ApplicationGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
authentication_certificates (pulumi.Input[list]) – One or more authentication_certificate blocks as defined below.
autoscale_configuration (pulumi.Input[dict]) – A autoscale_configuration block 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.
enable_http2 (pulumi.Input[bool]) – Is HTTP2 enabled on the application gateway resource? Defaults to false.
firewall_policy_id (pulumi.Input[str]) – The resource ID of a firewall policy.
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.
identity (pulumi.Input[dict]) – A identity block.
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.
redirect_configurations (pulumi.Input[list]) – A redirect_configuration block 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.
rewrite_rule_sets (pulumi.Input[list]) – One or more rewrite_rule_set blocks as defined below. Only valid for v2 SKUs.
sku (pulumi.Input[dict]) – A sku block as defined below.
ssl_certificates (pulumi.Input[list]) – One or more ssl_certificate blocks as defined below.
ssl_policies (pulumi.Input[list]) – a ssl policy block as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
trusted_root_certificates (pulumi.Input[list]) – One or more trusted_root_certificate blocks as defined below.
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.
zones (pulumi.Input[list]) – A collection of availability zones to spread the Application Gateway over.

The authentication_certificates object supports the following:

data (pulumi.Input[str]) - The contents of the Authentication Certificate which should be used.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Authentication Certificate.

The autoscale_configuration object supports the following:

maxCapacity (pulumi.Input[float]) - Maximum capacity for autoscaling. Accepted values are in the range 2 to 125.
min_capacity (pulumi.Input[float]) - Minimum capacity for autoscaling. Accepted values are in the range 0 to 100.

The backend_address_pools object supports the following:

fqdns (pulumi.Input[list]) - A list of FQDN’s which should be part of the Backend Address Pool.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
ipAddresses (pulumi.Input[list]) - A list of IP Addresses which should be part of the Backend Address Pool.
name (pulumi.Input[str]) - The name of the Backend Address Pool.

The backend_http_settings object supports the following:

affinityCookieName (pulumi.Input[str]) - The name of the affinity cookie.
authentication_certificates (pulumi.Input[list]) - One or more authentication_certificate blocks.
- id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
- name (pulumi.Input[str]) - The name of the Authentication Certificate.
connectionDraining (pulumi.Input[dict]) - A connection_draining block as defined below.
- drainTimeoutSec (pulumi.Input[float]) - The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.
- enabled (pulumi.Input[bool]) - If connection draining is enabled or not.
cookieBasedAffinity (pulumi.Input[str]) - Is Cookie-Based Affinity enabled? Possible values are Enabled and Disabled.
host_name (pulumi.Input[str]) - Host header to be sent to the backend servers. Cannot be set if pick_host_name_from_backend_address is set to true.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Backend HTTP Settings Collection.
path (pulumi.Input[str]) - The Path which should be used as a prefix for all HTTP requests.
pickHostNameFromBackendAddress (pulumi.Input[bool]) - Whether host header should be picked from the host name of the backend server. Defaults to false.
port (pulumi.Input[float]) - The port which should be used for this Backend HTTP Settings Collection.
probe_id (pulumi.Input[str]) - The ID of the associated Probe.
probeName (pulumi.Input[str]) - The name of an associated HTTP Probe.
protocol (pulumi.Input[str]) - The Protocol which should be used. Possible values are Http and Https.
requestTimeout (pulumi.Input[float]) - The request timeout in seconds, which must be between 1 and 86400 seconds.
trustedRootCertificateNames (pulumi.Input[list]) - A list of trusted_root_certificate names.

The custom_error_configurations object supports the following:

customErrorPageUrl (pulumi.Input[str]) - Error page URL of the application gateway customer error.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
statusCode (pulumi.Input[str]) - Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502

The frontend_ip_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Frontend IP Configuration.
private_ip_address (pulumi.Input[str]) - The Private IP Address to use for the Application Gateway.
privateIpAddressAllocation (pulumi.Input[str]) - The Allocation Method for the Private IP Address. Possible values are Dynamic and Static.
public_ip_address_id (pulumi.Input[str]) - The ID of a Public IP Address which the Application Gateway should use.
subnet_id (pulumi.Input[str]) - The ID of the Subnet.

The frontend_ports object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The name of the Frontend Port.
port (pulumi.Input[float]) - The port used for this Frontend Port.

The gateway_ip_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of this Gateway IP Configuration.
subnet_id (pulumi.Input[str]) - The ID of the Subnet which the Application Gateway should be connected to.

The http_listeners object supports the following:

custom_error_configurations (pulumi.Input[list]) - One or more custom_error_configuration blocks as defined below.
- customErrorPageUrl (pulumi.Input[str]) - Error page URL of the application gateway customer error.
- id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
- statusCode (pulumi.Input[str]) - Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502
frontend_ip_configuration_id (pulumi.Input[str]) - The ID of the associated Frontend Configuration.
frontend_ip_configuration_name (pulumi.Input[str]) - The Name of the Frontend IP Configuration used for this HTTP Listener.
frontendPortId (pulumi.Input[str]) - The ID of the associated Frontend Port.
frontendPortName (pulumi.Input[str]) - The Name of the Frontend Port use for this HTTP Listener.
host_name (pulumi.Input[str]) - The Hostname which should be used for this HTTP Listener.
host_names (pulumi.Input[list]) - A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of the HTTP Listener.
protocol (pulumi.Input[str]) - The Protocol to use for this HTTP Listener. Possible values are Http and Https.
requireSni (pulumi.Input[bool]) - Should Server Name Indication be Required? Defaults to false.
sslCertificateId (pulumi.Input[str]) - The ID of the associated SSL Certificate.
sslCertificateName (pulumi.Input[str]) - The name of the associated SSL Certificate which should be used for this HTTP Listener.

The identity object supports the following:

identityIds (pulumi.Input[str]) - Specifies a list with a single user managed identity id to be assigned to the Application Gateway.
type (pulumi.Input[str]) - The Managed Service Identity Type of this Application Gateway. The only possible value is UserAssigned. Defaults to UserAssigned.

The probes object supports the following:

host (pulumi.Input[str]) - The Hostname used for this Probe. If the Application Gateway is configured for a single site, by default the Host name should be specified as ‘127.0.0.1’, unless otherwise configured in custom probe. Cannot be set if pick_host_name_from_backend_http_settings is set to true.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
interval (pulumi.Input[float]) - The Interval between two consecutive probes in seconds. Possible values range from 1 second to a maximum of 86,400 seconds.
match (pulumi.Input[dict]) - A match block as defined above.
- body (pulumi.Input[str]) - A snippet from the Response Body which must be present in the Response..
- statusCodes (pulumi.Input[list]) - A list of allowed status codes for this Health Probe.
minimumServers (pulumi.Input[float]) - The minimum number of servers that are always marked as healthy. Defaults to 0.
name (pulumi.Input[str]) - The Name of the Probe.
path (pulumi.Input[str]) - The Path used for this Probe.
pickHostNameFromBackendHttpSettings (pulumi.Input[bool]) - Whether the host header should be picked from the backend http settings. Defaults to false.
protocol (pulumi.Input[str]) - The Protocol used for this Probe. Possible values are Http and Https.
timeout (pulumi.Input[float]) - The Timeout used for this Probe, which indicates when a probe becomes unhealthy. Possible values range from 1 second to a maximum of 86,400 seconds.
unhealthyThreshold (pulumi.Input[float]) - The Unhealthy Threshold for this Probe, which indicates the amount of retries which should be attempted before a node is deemed unhealthy. Possible values are from 1 - 20 seconds.

The redirect_configurations object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
includePath (pulumi.Input[bool]) - Whether or not to include the path in the redirected Url. Defaults to false
includeQueryString (pulumi.Input[bool]) - Whether or not to include the query string in the redirected Url. Default to false
name (pulumi.Input[str]) - Unique name of the redirect configuration block
redirectType (pulumi.Input[str]) - The type of redirect. Possible values are Permanent, Temporary, Found and SeeOther
targetListenerId (pulumi.Input[str])
targetListenerName (pulumi.Input[str]) - The name of the listener to redirect to. Cannot be set if target_url is set.
targetUrl (pulumi.Input[str]) - The Url to redirect the request to. Cannot be set if target_listener_name is set.

The request_routing_rules object supports the following:

backend_address_pool_id (pulumi.Input[str]) - The ID of the associated Backend Address Pool.
backendAddressPoolName (pulumi.Input[str]) - The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set.
backendHttpSettingsId (pulumi.Input[str]) - The ID of the associated Backend HTTP Settings Configuration.
backendHttpSettingsName (pulumi.Input[str]) - The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if redirect_configuration_name is set.
httpListenerId (pulumi.Input[str]) - The ID of the associated HTTP Listener.
httpListenerName (pulumi.Input[str]) - The Name of the HTTP Listener which should be used for this Routing Rule.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of this Request Routing Rule.
redirectConfigurationId (pulumi.Input[str]) - The ID of the associated Redirect Configuration.
redirectConfigurationName (pulumi.Input[str]) - The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either backend_address_pool_name or backend_http_settings_name is set.
rewriteRuleSetId (pulumi.Input[str]) - The ID of the associated Rewrite Rule Set.
rewriteRuleSetName (pulumi.Input[str]) - The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs.
ruleType (pulumi.Input[str]) - The Type of Routing that should be used for this Rule. Possible values are Basic and PathBasedRouting.
urlPathMapId (pulumi.Input[str]) - The ID of the associated URL Path Map.
urlPathMapName (pulumi.Input[str]) - The Name of the URL Path Map which should be associated with this Routing Rule.

The rewrite_rule_sets object supports the following:

id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - Unique name of the rewrite rule set block
rewriteRules (pulumi.Input[list]) - One or more rewrite_rule blocks as defined above.
- conditions (pulumi.Input[list]) - One or more condition blocks as defined above.
  - ignoreCase (pulumi.Input[bool]) - Perform a case in-sensitive comparison. Defaults to false
  - negate (pulumi.Input[bool]) - Negate the result of the condition evaluation. Defaults to false
  - pattern (pulumi.Input[str]) - The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.
  - variable (pulumi.Input[str]) - The variable of the condition.
- name (pulumi.Input[str]) - Unique name of the rewrite rule block
- requestHeaderConfigurations (pulumi.Input[list]) - One or more request_header_configuration blocks as defined above.
  - headerName (pulumi.Input[str]) - Header name of the header configuration.
  - headerValue (pulumi.Input[str]) - Header value of the header configuration. To delete a request header set this property to an empty string.
- responseHeaderConfigurations (pulumi.Input[list]) - One or more response_header_configuration blocks as defined above.
  - headerName (pulumi.Input[str]) - Header name of the header configuration.
  - headerValue (pulumi.Input[str]) - Header value of the header configuration. To delete a response header set this property to an empty string.
- ruleSequence (pulumi.Input[float]) - Rule sequence of the rewrite rule that determines the order of execution in a set.

The sku object supports the following:

capacity (pulumi.Input[float]) - The Capacity of the SKU to use for this Application Gateway. When using a V1 SKU this value must be between 1 and 32, and 1 to 125 for a V2 SKU. This property is optional if autoscale_configuration is set.
name (pulumi.Input[str]) - The Name of the SKU to use for this Application Gateway. Possible values are Standard_Small, Standard_Medium, Standard_Large, Standard_v2, WAF_Medium, WAF_Large, and WAF_v2.
tier (pulumi.Input[str]) - The Tier of the SKU to use for this Application Gateway. Possible values are Standard, Standard_v2, WAF and WAF_v2.

The ssl_certificates object supports the following:

data (pulumi.Input[str]) - PFX certificate. Required if key_vault_secret_id is not set.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
key_vault_secret_id (pulumi.Input[str]) - Secret Id of (base-64 encoded unencrypted pfx) Secret or Certificate object stored in Azure KeyVault. You need to enable soft delete for keyvault to use this feature. Required if data is not set.
name (pulumi.Input[str]) - The Name of the SSL certificate that is unique within this Application Gateway
password (pulumi.Input[str]) - Password for the pfx file specified in data. Required if data is set.
publicCertData (pulumi.Input[str]) - The Public Certificate Data associated with the SSL Certificate.

The ssl_policies object supports the following:

cipherSuites (pulumi.Input[list]) - A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384.
disabledProtocols (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.
minProtocolVersion (pulumi.Input[str]) - The minimal TLS version. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.
policyName (pulumi.Input[str]) - The Name of the Policy e.g AppGwSslPolicy20170401S. Required if policy_type is set to Predefined. Possible values can change over time and are published here https://docs.microsoft.com/en-us/azure/application-gateway/application-gateway-ssl-policy-overview. Not compatible with disabled_protocols.
policy_type (pulumi.Input[str]) - The Type of the Policy. Possible values are Predefined and Custom.

The trusted_root_certificates object supports the following:

data (pulumi.Input[str]) - The contents of the Trusted Root Certificate which should be used.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of the Trusted Root Certificate to use.

The url_path_maps object supports the following:

defaultBackendAddressPoolId (pulumi.Input[str]) - The ID of the Default Backend Address Pool.
defaultBackendAddressPoolName (pulumi.Input[str]) - The Name of the Default Backend Address Pool which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set.
defaultBackendHttpSettingsId (pulumi.Input[str]) - The ID of the Default Backend HTTP Settings Collection.
defaultBackendHttpSettingsName (pulumi.Input[str]) - The Name of the Default Backend HTTP Settings Collection which should be used for this URL Path Map. Cannot be set if default_redirect_configuration_name is set.
defaultRedirectConfigurationId (pulumi.Input[str]) - The ID of the Default Redirect Configuration.
defaultRedirectConfigurationName (pulumi.Input[str]) - The Name of the Default Redirect Configuration which should be used for this URL Path Map. Cannot be set if either default_backend_address_pool_name or default_backend_http_settings_name is set.
defaultRewriteRuleSetId (pulumi.Input[str])
defaultRewriteRuleSetName (pulumi.Input[str]) - The Name of the Default Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.
id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
name (pulumi.Input[str]) - The Name of the URL Path Map.
pathRules (pulumi.Input[list]) - One or more path_rule blocks as defined above.
- backend_address_pool_id (pulumi.Input[str]) - The ID of the associated Backend Address Pool.
- backendAddressPoolName (pulumi.Input[str]) - The Name of the Backend Address Pool to use for this Path Rule. Cannot be set if redirect_configuration_name is set.
- backendHttpSettingsId (pulumi.Input[str]) - The ID of the associated Backend HTTP Settings Configuration.
- backendHttpSettingsName (pulumi.Input[str]) - The Name of the Backend HTTP Settings Collection to use for this Path Rule. Cannot be set if redirect_configuration_name is set.
- id (pulumi.Input[str]) - The ID of the Rewrite Rule Set
- name (pulumi.Input[str]) - The Name of the Path Rule.
- paths (pulumi.Input[list]) - A list of Paths used in this Path Rule.
- redirectConfigurationId (pulumi.Input[str]) - The ID of the associated Redirect Configuration.
- redirectConfigurationName (pulumi.Input[str]) - The Name of a Redirect Configuration to use for this Path Rule. Cannot be set if backend_address_pool_name or backend_http_settings_name is set.
- rewriteRuleSetId (pulumi.Input[str]) - The ID of the associated Rewrite Rule Set.
- rewriteRuleSetName (pulumi.Input[str]) - The Name of the Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.

The waf_configuration object supports the following:

disabledRuleGroups (pulumi.Input[list]) - one or more disabled_rule_group blocks as defined below.
- ruleGroupName (pulumi.Input[str]) - The rule group where specific rules should be disabled. Accepted values are: crs_20_protocol_violations, crs_21_protocol_anomalies, crs_23_request_limits, crs_30_http_policy, crs_35_bad_robots, crs_40_generic_attacks, crs_41_sql_injection_attacks, crs_41_xss_attacks, crs_42_tight_security, crs_45_trojans, General, REQUEST-911-METHOD-ENFORCEMENT, REQUEST-913-SCANNER-DETECTION, REQUEST-920-PROTOCOL-ENFORCEMENT, REQUEST-921-PROTOCOL-ATTACK, REQUEST-930-APPLICATION-ATTACK-LFI, REQUEST-931-APPLICATION-ATTACK-RFI, REQUEST-932-APPLICATION-ATTACK-RCE, REQUEST-933-APPLICATION-ATTACK-PHP, REQUEST-941-APPLICATION-ATTACK-XSS, REQUEST-942-APPLICATION-ATTACK-SQLI, REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION
- rules (pulumi.Input[list]) - A list of rules which should be disabled in that group. Disables all rules in the specified group if rules is not specified.
enabled (pulumi.Input[bool]) - Is the Web Application Firewall be enabled?
exclusions (pulumi.Input[list]) - one or more exclusion blocks as defined below.
- matchVariable (pulumi.Input[str]) - Match variable of the exclusion rule to exclude header, cookie or GET arguments. Possible values are RequestHeaderNames, RequestArgNames and RequestCookieNames
- selector (pulumi.Input[str]) - String value which will be used for the filter operation. If empty will exclude all traffic on this match_variable
- selectorMatchOperator (pulumi.Input[str]) - Operator which will be used to search in the variable content. Possible values are Equals, StartsWith, EndsWith, Contains. If empty will exclude all traffic on this match_variable
fileUploadLimitMb (pulumi.Input[float]) - The File Upload Limit in MB. Accepted values are in the range 1MB to 500MB. Defaults to 100MB.
firewallMode (pulumi.Input[str]) - The Web Application Firewall Mode. Possible values are Detection and Prevention.
maxRequestBodySizeKb (pulumi.Input[float]) - The Maximum Request Body Size in KB. Accepted values are in the range 1KB to 128KB. Defaults to 128KB.
requestBodyCheck (pulumi.Input[bool]) - Is Request Body Inspection enabled? Defaults to true.
ruleSetType (pulumi.Input[str]) - The Type of the Rule Set used for this Web Application Firewall. Currently, only OWASP is supported.
ruleSetVersion (pulumi.Input[str]) - The Version of the Rule Set used for this Web Application Firewall. Possible values are 2.2.9, 3.0, and 3.1.

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, __props__=None, __name__=None, __opts__=None)¶

Manages an Application Security Group.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_application_security_group = azure.network.ApplicationSecurityGroup("exampleApplicationSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tags={
        "Hello": "World",
    })

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: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Application Security Group. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Application Security Group.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, tags=None)¶

Get an existing ApplicationSecurityGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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.AwaitableGetApplicationSecurityGroupResult(id=None, location=None, name=None, resource_group_name=None, tags=None)¶

class pulumi_azure.network.AwaitableGetExpressRouteCircuitResult(id=None, location=None, name=None, peerings=None, resource_group_name=None, service_key=None, service_provider_properties=None, service_provider_provisioning_state=None, sku=None)¶

class pulumi_azure.network.AwaitableGetFirewallResult(id=None, ip_configurations=None, location=None, name=None, resource_group_name=None, tags=None)¶

class pulumi_azure.network.AwaitableGetGatewayConnectionResult(authorization_key=None, connection_protocol=None, egress_bytes_transferred=None, enable_bgp=None, express_route_circuit_id=None, express_route_gateway_bypass=None, id=None, ingress_bytes_transferred=None, ipsec_policies=None, local_network_gateway_id=None, location=None, name=None, peer_virtual_network_gateway_id=None, resource_group_name=None, resource_guid=None, routing_weight=None, shared_key=None, tags=None, type=None, use_policy_based_traffic_selectors=None, virtual_network_gateway_id=None)¶

class pulumi_azure.network.AwaitableGetNatGatewayResult(id=None, idle_timeout_in_minutes=None, location=None, name=None, public_ip_address_ids=None, public_ip_prefix_ids=None, resource_group_name=None, resource_guid=None, sku_name=None, tags=None, zones=None)¶

class pulumi_azure.network.AwaitableGetNetworkDdosProtectionPlanResult(id=None, location=None, name=None, resource_group_name=None, tags=None, virtual_network_ids=None)¶

class pulumi_azure.network.AwaitableGetNetworkInterfaceResult(applied_dns_servers=None, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, id=None, internal_dns_name_label=None, ip_configurations=None, location=None, mac_address=None, name=None, network_security_group_id=None, private_ip_address=None, private_ip_addresses=None, resource_group_name=None, tags=None, virtual_machine_id=None)¶

class pulumi_azure.network.AwaitableGetNetworkSecurityGroupResult(id=None, location=None, name=None, resource_group_name=None, security_rules=None, tags=None)¶

class pulumi_azure.network.AwaitableGetNetworkWatcherResult(id=None, location=None, name=None, resource_group_name=None, tags=None)¶

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

class pulumi_azure.network.AwaitableGetPublicIPsResult(allocation_type=None, attached=None, id=None, name_prefix=None, public_ips=None, resource_group_name=None)¶

class pulumi_azure.network.AwaitableGetPublicIpPrefixResult(id=None, ip_prefix=None, location=None, name=None, prefix_length=None, resource_group_name=None, sku=None, tags=None, zones=None)¶

class pulumi_azure.network.AwaitableGetRouteTableResult(id=None, location=None, name=None, resource_group_name=None, routes=None, subnets=None, tags=None)¶

class pulumi_azure.network.AwaitableGetServiceTagsResult(address_prefixes=None, id=None, location=None, location_filter=None, service=None)¶

class pulumi_azure.network.AwaitableGetSubnetResult(address_prefix=None, address_prefixes=None, enforce_private_link_endpoint_network_policies=None, enforce_private_link_service_network_policies=None, id=None, name=None, network_security_group_id=None, resource_group_name=None, route_table_id=None, service_endpoints=None, virtual_network_name=None)¶

class pulumi_azure.network.AwaitableGetTrafficManagerResult(id=None, name=None)¶

class pulumi_azure.network.AwaitableGetVirtualHubResult(address_prefix=None, id=None, location=None, name=None, resource_group_name=None, tags=None, virtual_wan_id=None)¶

class pulumi_azure.network.AwaitableGetVirtualNetworkGatewayResult(active_active=None, bgp_settings=None, default_local_network_gateway_id=None, enable_bgp=None, generation=None, id=None, ip_configurations=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, type=None, vpn_client_configurations=None, vpn_type=None)¶

class pulumi_azure.network.AwaitableGetVirtualNetworkResult(address_spaces=None, dns_servers=None, guid=None, id=None, location=None, name=None, resource_group_name=None, subnets=None, vnet_peerings=None)¶

class pulumi_azure.network.DdosProtectionPlan(resource_name, opts=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an AzureNetwork DDoS Protection Plan.

NOTE Azure only allows one DDoS Protection Plan per region.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_ddos_protection_plan = azure.network.DdosProtectionPlan("exampleDdosProtectionPlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)

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 DDoS Protection Plan. 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.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Network DDoS Protection Plan. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

virtual_network_ids: pulumi.Output[list] = None¶: A list of Virtual Network ID’s associated with the DDoS Protection Plan.

static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, tags=None, virtual_network_ids=None)¶

Get an existing DdosProtectionPlan resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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 DDoS Protection Plan. 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.
virtual_network_ids (pulumi.Input[list]) – A list of Virtual Network ID’s associated with the DDoS Protection Plan.

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, __props__=None, __name__=None, __opts__=None)¶

Manages an ExpressRoute circuit.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_express_route_circuit = azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    },
    tags={
        "environment": "Production",
    })

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.

The sku object supports the following:

family (pulumi.Input[str]) - The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.
tier (pulumi.Input[str]) - The service tier. Possible values are Basic, Local, Standard or Premium.

allow_classic_operations: pulumi.Output[bool] = None¶: Allow the circuit to interact with classic (RDFE) resources. The default value is false.

bandwidth_in_mbps: pulumi.Output[float] = None¶: The bandwidth in Mbps of the circuit being created.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.

peering_location: pulumi.Output[str] = None¶: The name of the peering location and not the Azure resource location.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The string needed by the service provider to provision the ExpressRoute circuit.

service_provider_name: pulumi.Output[str] = None¶: The name of the ExpressRoute Service Provider.

service_provider_provisioning_state: pulumi.Output[str] = None¶: The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are “NotProvisioned”, “Provisioning”, “Provisioned”, and “Deprovisioning”.

sku: pulumi.Output[dict] = None¶

A sku block for the ExpressRoute circuit as documented below.

family (str) - The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.
tier (str) - The service tier. Possible values are Basic, Local, Standard or Premium.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, allow_classic_operations=None, bandwidth_in_mbps=None, location=None, name=None, peering_location=None, resource_group_name=None, service_key=None, service_provider_name=None, service_provider_provisioning_state=None, sku=None, tags=None)¶

Get an existing ExpressRouteCircuit resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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_key (pulumi.Input[str]) – The string needed by the service provider to provision the ExpressRoute circuit.
service_provider_name (pulumi.Input[str]) – The name of the ExpressRoute Service Provider.
service_provider_provisioning_state (pulumi.Input[str]) – The ExpressRoute circuit provisioning state from your chosen service provider. Possible values are “NotProvisioned”, “Provisioning”, “Provisioned”, and “Deprovisioning”.
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.

The sku object supports the following:

family (pulumi.Input[str]) - The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.
tier (pulumi.Input[str]) - The service tier. Possible values are Basic, Local, Standard or Premium.

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, __props__=None, __name__=None, __opts__=None)¶

Manages an ExpressRoute Circuit Authorization.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_express_route_circuit = azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    },
    allow_classic_operations=False,
    tags={
        "environment": "Production",
    })
example_express_route_circuit_authorization = azure.network.ExpressRouteCircuitAuthorization("exampleExpressRouteCircuitAuthorization",
    express_route_circuit_name=example_express_route_circuit.name,
    resource_group_name=example_resource_group.name)

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: pulumi.Output[str] = None¶: The Authorization Key.

authorization_use_status: pulumi.Output[str] = None¶: The authorization use status.

express_route_circuit_name: pulumi.Output[str] = None¶: The name of the Express Route Circuit in which to create the Authorization.

name: pulumi.Output[str] = None¶: The name of the ExpressRoute circuit. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, authorization_key=None, authorization_use_status=None, express_route_circuit_name=None, name=None, resource_group_name=None)¶

Get an existing ExpressRouteCircuitAuthorization resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
authorization_key (pulumi.Input[str]) – The Authorization Key.
authorization_use_status (pulumi.Input[str]) – The authorization use status.
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.

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, __props__=None, __name__=None, __opts__=None)¶

Manages an ExpressRoute Circuit Peering.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_express_route_circuit = azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    service_provider_name="Equinix",
    peering_location="Silicon Valley",
    bandwidth_in_mbps=50,
    sku={
        "tier": "Standard",
        "family": "MeteredData",
    },
    allow_classic_operations=False,
    tags={
        "environment": "Production",
    })
example_express_route_circuit_peering = azure.network.ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering",
    peering_type="MicrosoftPeering",
    express_route_circuit_name=example_express_route_circuit.name,
    resource_group_name=example_resource_group.name,
    peer_asn=100,
    primary_peer_address_prefix="123.0.0.0/30",
    secondary_peer_address_prefix="123.0.0.4/30",
    vlan_id=300,
    microsoft_peering_config={
        "advertisedPublicPrefixes": ["123.1.0.0/24"],
    })

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.

The microsoft_peering_config object supports the following:

advertisedPublicPrefixes (pulumi.Input[list]) - A list of Advertised Public Prefixes
customerAsn (pulumi.Input[float]) - The CustomerASN of the peering
routingRegistryName (pulumi.Input[str]) - The RoutingRegistryName of the configuration

azure_asn: pulumi.Output[float] = None¶: The ASN used by Azure.

express_route_circuit_name: pulumi.Output[str] = None¶: The name of the ExpressRoute Circuit in which to create the Peering.

microsoft_peering_config: pulumi.Output[dict] = None¶

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

advertisedPublicPrefixes (list) - A list of Advertised Public Prefixes
customerAsn (float) - The CustomerASN of the peering
routingRegistryName (str) - The RoutingRegistryName of the configuration

peer_asn: pulumi.Output[float] = None¶: The Either a 16-bit or a 32-bit ASN. Can either be public or private..

peering_type: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The Primary Port used by Azure for this Peering.

primary_peer_address_prefix: pulumi.Output[str] = None¶: A /30 subnet for the primary link.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The Secondary Port used by Azure for this Peering.

secondary_peer_address_prefix: pulumi.Output[str] = None¶: A /30 subnet for the secondary link.

shared_key: pulumi.Output[str] = None¶: The shared key. Can be a maximum of 25 characters.

vlan_id: pulumi.Output[float] = None¶: A valid VLAN ID to establish this peering on.

static get(resource_name, id, opts=None, azure_asn=None, express_route_circuit_name=None, microsoft_peering_config=None, peer_asn=None, peering_type=None, primary_azure_port=None, primary_peer_address_prefix=None, resource_group_name=None, secondary_azure_port=None, secondary_peer_address_prefix=None, shared_key=None, vlan_id=None)¶

Get an existing ExpressRouteCircuitPeering resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
azure_asn (pulumi.Input[float]) – The ASN used by Azure.
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_azure_port (pulumi.Input[str]) – The Primary Port used by Azure for this Peering.
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_azure_port (pulumi.Input[str]) – The Secondary Port used by Azure for this Peering.
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.

The microsoft_peering_config object supports the following:

advertisedPublicPrefixes (pulumi.Input[list]) - A list of Advertised Public Prefixes
customerAsn (pulumi.Input[float]) - The CustomerASN of the peering
routingRegistryName (pulumi.Input[str]) - The RoutingRegistryName of the configuration

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.ExpressRouteGateway(resource_name, opts=None, location=None, name=None, resource_group_name=None, scale_units=None, tags=None, virtual_hub_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages an ExpressRoute gateway.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_wan = azure.network.VirtualWan("exampleVirtualWan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_virtual_hub = azure.network.VirtualHub("exampleVirtualHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.1.0/24")
example_express_route_gateway = azure.network.ExpressRouteGateway("exampleExpressRouteGateway",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_hub_id=example_virtual_hub.id,
    scale_units=1,
    tags={
        "environment": "Production",
    })

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 ExpressRoute 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 ExpressRoute gateway. Changing this forces a new resource to be created.
scale_units (pulumi.Input[float]) – The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
virtual_hub_id (pulumi.Input[str]) – The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the ExpressRoute gateway. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the ExpressRoute gateway. Changing this forces a new resource to be created.

scale_units: pulumi.Output[float] = None¶: The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

virtual_hub_id: pulumi.Output[str] = None¶: The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, scale_units=None, tags=None, virtual_hub_id=None)¶

Get an existing ExpressRouteGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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 ExpressRoute 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 ExpressRoute gateway. Changing this forces a new resource to be created.
scale_units (pulumi.Input[float]) – The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps).
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
virtual_hub_id (pulumi.Input[str]) – The ID of a Virtual HUB within which the ExpressRoute gateway should 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.Firewall(resource_name, opts=None, ip_configurations=None, location=None, name=None, resource_group_name=None, tags=None, zones=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Firewall.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="North Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static",
    sku="Standard")
example_firewall = azure.network.Firewall("exampleFirewall",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "configuration",
        "subnet_id": example_subnet.id,
        "public_ip_address_id": example_public_ip.id,
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
ip_configurations (pulumi.Input[list]) – 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.
zones (pulumi.Input[list]) – Specifies the availability zones in which the Azure Firewall should be created.

The ip_configurations object supports the following:

name (pulumi.Input[str]) - Specifies the name of the IP Configuration.
private_ip_address (pulumi.Input[str]) - The private IP address of the Azure Firewall.
public_ip_address_id (pulumi.Input[str]) - The Resource ID of the Public IP Address associated with the firewall.
subnet_id (pulumi.Input[str]) - Reference to the subnet associated with the IP Configuration.

ip_configurations: pulumi.Output[list] = None¶

A ip_configuration block as documented below.

name (str) - Specifies the name of the IP Configuration.
private_ip_address (str) - The private IP address of the Azure Firewall.
public_ip_address_id (str) - The Resource ID of the Public IP Address associated with the firewall.
subnet_id (str) - Reference to the subnet associated with the IP Configuration.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Firewall. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zones: pulumi.Output[list] = None¶: Specifies the availability zones in which the Azure Firewall should be created.

static get(resource_name, id, opts=None, ip_configurations=None, location=None, name=None, resource_group_name=None, tags=None, zones=None)¶

Get an existing Firewall resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
ip_configurations (pulumi.Input[list]) – 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.
zones (pulumi.Input[list]) – Specifies the availability zones in which the Azure Firewall should be created.

The ip_configurations object supports the following:

name (pulumi.Input[str]) - Specifies the name of the IP Configuration.
private_ip_address (pulumi.Input[str]) - The private IP address of the Azure Firewall.
public_ip_address_id (pulumi.Input[str]) - The Resource ID of the Public IP Address associated with the firewall.
subnet_id (pulumi.Input[str]) - Reference to the subnet associated with the IP Configuration.

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, __props__=None, __name__=None, __opts__=None)¶

Manages an Application Rule Collection within an Azure Firewall.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="North Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static",
    sku="Standard")
example_firewall = azure.network.Firewall("exampleFirewall",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "configuration",
        "subnet_id": example_subnet.id,
        "public_ip_address_id": example_public_ip.id,
    }])
example_firewall_application_rule_collection = azure.network.FirewallApplicationRuleCollection("exampleFirewallApplicationRuleCollection",
    azure_firewall_name=example_firewall.name,
    resource_group_name=example_resource_group.name,
    priority=100,
    action="Allow",
    rule=[{
        "name": "testrule",
        "sourceAddresses": ["10.0.0.0/16"],
        "targetFqdns": ["*.google.com"],
        "protocol": [{
            "port": "443",
            "type": "Https",
        }],
    }])

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.

The rules object supports the following:

description (pulumi.Input[str]) - Specifies a description for the rule.
fqdnTags (pulumi.Input[list]) - A list of FQDN tags. Possible values are AppServiceEnvironment, AzureBackup, MicrosoftActiveProtectionService, WindowsDiagnostics and WindowsUpdate
name (pulumi.Input[str]) - Specifies the name of the rule.
protocols (pulumi.Input[list]) - One or more protocol blocks as defined below.
- port (pulumi.Input[float]) - Specify a port for the connection.
- type (pulumi.Input[str]) - Specifies the type of connection. Possible values are Http, Https and Mssql.
sourceAddresses (pulumi.Input[list]) - A list of source IP addresses and/or IP ranges.
targetFqdns (pulumi.Input[list]) - A list of FQDNs.

action: pulumi.Output[str] = None¶: Specifies the action the rule will apply to matching traffic. Possible values are Allow and Deny.

azure_firewall_name: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[float] = None¶: Specifies the priority of the rule collection. Possible values are between 100 - 65000.

resource_group_name: pulumi.Output[str] = None¶: Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.

rules: pulumi.Output[list] = None¶

One or more rule blocks as defined below.

description (str) - Specifies a description for the rule.
fqdnTags (list) - A list of FQDN tags. Possible values are AppServiceEnvironment, AzureBackup, MicrosoftActiveProtectionService, WindowsDiagnostics and WindowsUpdate
name (str) - Specifies the name of the rule.
protocols (list) - One or more protocol blocks as defined below.
- port (float) - Specify a port for the connection.
- type (str) - Specifies the type of connection. Possible values are Http, Https and Mssql.
sourceAddresses (list) - A list of source IP addresses and/or IP ranges.
targetFqdns (list) - A list of FQDNs.

static get(resource_name, id, opts=None, action=None, azure_firewall_name=None, name=None, priority=None, resource_group_name=None, rules=None)¶

Get an existing FirewallApplicationRuleCollection resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

The rules object supports the following:

description (pulumi.Input[str]) - Specifies a description for the rule.
fqdnTags (pulumi.Input[list]) - A list of FQDN tags. Possible values are AppServiceEnvironment, AzureBackup, MicrosoftActiveProtectionService, WindowsDiagnostics and WindowsUpdate
name (pulumi.Input[str]) - Specifies the name of the rule.
protocols (pulumi.Input[list]) - One or more protocol blocks as defined below.
- port (pulumi.Input[float]) - Specify a port for the connection.
- type (pulumi.Input[str]) - Specifies the type of connection. Possible values are Http, Https and Mssql.
sourceAddresses (pulumi.Input[list]) - A list of source IP addresses and/or IP ranges.
targetFqdns (pulumi.Input[list]) - A list of FQDNs.

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.FirewallNatRuleCollection(resource_name, opts=None, action=None, azure_firewall_name=None, name=None, priority=None, resource_group_name=None, rules=None, __props__=None, __name__=None, __opts__=None)¶

Manages a NAT Rule Collection within an Azure Firewall.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="North Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static",
    sku="Standard")
example_firewall = azure.network.Firewall("exampleFirewall",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "configuration",
        "subnet_id": example_subnet.id,
        "public_ip_address_id": example_public_ip.id,
    }])
example_firewall_nat_rule_collection = azure.network.FirewallNatRuleCollection("exampleFirewallNatRuleCollection",
    azure_firewall_name=example_firewall.name,
    resource_group_name=example_resource_group.name,
    priority=100,
    action="Dnat",
    rule=[{
        "name": "testrule",
        "sourceAddresses": ["10.0.0.0/16"],
        "destinationPorts": ["53"],
        "destinationAddresses": [example_public_ip.ip_address],
        "translatedPort": 53,
        "translatedAddress": "8.8.8.8",
        "protocols": [
            "TCP",
            "UDP",
        ],
    }])

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 Dnat and Snat.
azure_firewall_name (pulumi.Input[str]) – Specifies the name of the Firewall in which the NAT Rule Collection should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the NAT 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.

The rules object supports the following:

description (pulumi.Input[str]) - Specifies a description for the rule.
destinationAddresses (pulumi.Input[list]) - A list of destination IP addresses and/or IP ranges.
destinationPorts (pulumi.Input[list]) - A list of destination ports.
name (pulumi.Input[str]) - Specifies the name of the rule.
protocols (pulumi.Input[list]) - A list of protocols. Possible values are Any, ICMP, TCP and UDP. If action is Dnat, protocols can only be TCP and UDP.
sourceAddresses (pulumi.Input[list]) - A list of source IP addresses and/or IP ranges.
translatedAddress (pulumi.Input[str]) - The address of the service behind the Firewall.
translatedPort (pulumi.Input[str]) - The port of the service behind the Firewall.

action: pulumi.Output[str] = None¶: Specifies the action the rule will apply to matching traffic. Possible values are Dnat and Snat.

azure_firewall_name: pulumi.Output[str] = None¶: Specifies the name of the Firewall in which the NAT Rule Collection should be created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the NAT Rule Collection which must be unique within the Firewall. Changing this forces a new resource to be created.

priority: pulumi.Output[float] = None¶: Specifies the priority of the rule collection. Possible values are between 100 - 65000.

resource_group_name: pulumi.Output[str] = None¶: Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.

rules: pulumi.Output[list] = None¶

One or more rule blocks as defined below.

description (str) - Specifies a description for the rule.
destinationAddresses (list) - A list of destination IP addresses and/or IP ranges.
destinationPorts (list) - A list of destination ports.
name (str) - Specifies the name of the rule.
protocols (list) - A list of protocols. Possible values are Any, ICMP, TCP and UDP. If action is Dnat, protocols can only be TCP and UDP.
sourceAddresses (list) - A list of source IP addresses and/or IP ranges.
translatedAddress (str) - The address of the service behind the Firewall.
translatedPort (str) - The port of the service behind the Firewall.

static get(resource_name, id, opts=None, action=None, azure_firewall_name=None, name=None, priority=None, resource_group_name=None, rules=None)¶

Get an existing FirewallNatRuleCollection resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
action (pulumi.Input[str]) – Specifies the action the rule will apply to matching traffic. Possible values are Dnat and Snat.
azure_firewall_name (pulumi.Input[str]) – Specifies the name of the Firewall in which the NAT Rule Collection should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the NAT 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.

The rules object supports the following:

description (pulumi.Input[str]) - Specifies a description for the rule.
destinationAddresses (pulumi.Input[list]) - A list of destination IP addresses and/or IP ranges.
destinationPorts (pulumi.Input[list]) - A list of destination ports.
name (pulumi.Input[str]) - Specifies the name of the rule.
protocols (pulumi.Input[list]) - A list of protocols. Possible values are Any, ICMP, TCP and UDP. If action is Dnat, protocols can only be TCP and UDP.
sourceAddresses (pulumi.Input[list]) - A list of source IP addresses and/or IP ranges.
translatedAddress (pulumi.Input[str]) - The address of the service behind the Firewall.
translatedPort (pulumi.Input[str]) - The port of the service behind the Firewall.

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, __props__=None, __name__=None, __opts__=None)¶

Manages a Network Rule Collection within an Azure Firewall.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="North Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static",
    sku="Standard")
example_firewall = azure.network.Firewall("exampleFirewall",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "configuration",
        "subnet_id": example_subnet.id,
        "public_ip_address_id": example_public_ip.id,
    }])
example_firewall_network_rule_collection = azure.network.FirewallNetworkRuleCollection("exampleFirewallNetworkRuleCollection",
    azure_firewall_name=example_firewall.name,
    resource_group_name=example_resource_group.name,
    priority=100,
    action="Allow",
    rule=[{
        "name": "testrule",
        "sourceAddresses": ["10.0.0.0/16"],
        "destinationPorts": ["53"],
        "destinationAddresses": [
            "8.8.8.8",
            "8.8.4.4",
        ],
        "protocols": [
            "TCP",
            "UDP",
        ],
    }])

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.

The rules object supports the following:

description (pulumi.Input[str]) - Specifies a description for the rule.
destinationAddresses (pulumi.Input[list]) - A list of destination IP addresses and/or IP ranges.
destinationPorts (pulumi.Input[list]) - A list of destination ports.
name (pulumi.Input[str]) - Specifies the name of the rule.
protocols (pulumi.Input[list]) - A list of protocols. Possible values are Any, ICMP, TCP and UDP.
sourceAddresses (pulumi.Input[list]) - A list of source IP addresses and/or IP ranges.

action: pulumi.Output[str] = None¶: Specifies the action the rule will apply to matching traffic. Possible values are Allow and Deny.

azure_firewall_name: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[float] = None¶: Specifies the priority of the rule collection. Possible values are between 100 - 65000.

resource_group_name: pulumi.Output[str] = None¶: Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.

rules: pulumi.Output[list] = None¶

One or more rule blocks as defined below.

description (str) - Specifies a description for the rule.
destinationAddresses (list) - A list of destination IP addresses and/or IP ranges.
destinationPorts (list) - A list of destination ports.
name (str) - Specifies the name of the rule.
protocols (list) - A list of protocols. Possible values are Any, ICMP, TCP and UDP.
sourceAddresses (list) - A list of source IP addresses and/or IP ranges.

static get(resource_name, id, opts=None, action=None, azure_firewall_name=None, name=None, priority=None, resource_group_name=None, rules=None)¶

Get an existing FirewallNetworkRuleCollection resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

The rules object supports the following:

description (pulumi.Input[str]) - Specifies a description for the rule.
destinationAddresses (pulumi.Input[list]) - A list of destination IP addresses and/or IP ranges.
destinationPorts (pulumi.Input[list]) - A list of destination ports.
name (pulumi.Input[str]) - Specifies the name of the rule.
protocols (pulumi.Input[list]) - A list of protocols. Possible values are Any, ICMP, TCP and UDP.
sourceAddresses (pulumi.Input[list]) - A list of source IP addresses and/or IP ranges.

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(id=None, location=None, name=None, resource_group_name=None, tags=None)¶

A collection of values returned by getApplicationSecurityGroup.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The supported Azure location where the Application Security Group exists.

tags = None¶: A mapping of tags assigned to the resource.

class pulumi_azure.network.GetExpressRouteCircuitResult(id=None, location=None, name=None, peerings=None, resource_group_name=None, service_key=None, service_provider_properties=None, service_provider_provisioning_state=None, sku=None)¶

A collection of values returned by getExpressRouteCircuit.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The Azure location where the ExpressRoute circuit exists

peerings = None¶: A peerings block for the ExpressRoute circuit as documented below

service_key = None¶: The string needed by the service provider to provision the ExpressRoute circuit.

service_provider_properties = None¶: A service_provider_properties block for the ExpressRoute circuit as documented below

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.

class pulumi_azure.network.GetFirewallResult(id=None, ip_configurations=None, location=None, name=None, resource_group_name=None, tags=None)¶

A collection of values returned by getFirewall.

id = None¶: The provider-assigned unique ID for this managed resource.

ip_configurations = None¶: A ip_configuration block as defined below.

class pulumi_azure.network.GetGatewayConnectionResult(authorization_key=None, connection_protocol=None, egress_bytes_transferred=None, enable_bgp=None, express_route_circuit_id=None, express_route_gateway_bypass=None, id=None, ingress_bytes_transferred=None, ipsec_policies=None, local_network_gateway_id=None, location=None, name=None, peer_virtual_network_gateway_id=None, resource_group_name=None, resource_guid=None, routing_weight=None, shared_key=None, tags=None, type=None, use_policy_based_traffic_selectors=None, virtual_network_gateway_id=None)¶

A collection of values returned by getGatewayConnection.

authorization_key = None¶: The authorization key associated with the Express Route Circuit. This field is present only if the type is an ExpressRoute connection.

enable_bgp = None¶: If true, BGP (Border Gateway Protocol) is enabled for this connection.

express_route_circuit_id = None¶: The ID of the Express Route Circuit (i.e. when type is ExpressRoute).

express_route_gateway_bypass = None¶: If true, data packets will bypass ExpressRoute Gateway for data forwarding. This is only valid for ExpressRoute connections.

id = None¶: The provider-assigned unique ID for this managed resource.

local_network_gateway_id = None¶: The ID of the local network gateway when a Site-to-Site connection (i.e. when type is IPsec).

location = None¶: The location/region where the connection is located.

peer_virtual_network_gateway_id = None¶: The ID of the peer virtual network gateway when a VNet-to-VNet connection (i.e. when type is Vnet2Vnet).

routing_weight = None¶: The routing weight.

shared_key = None¶: The shared IPSec 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).

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.

virtual_network_gateway_id = None¶: The ID of the Virtual Network Gateway in which the connection is created.

class pulumi_azure.network.GetNatGatewayResult(id=None, idle_timeout_in_minutes=None, location=None, name=None, public_ip_address_ids=None, public_ip_prefix_ids=None, resource_group_name=None, resource_guid=None, sku_name=None, tags=None, zones=None)¶

A collection of values returned by getNatGateway.

id = None¶: The provider-assigned unique ID for this managed resource.

idle_timeout_in_minutes = None¶: The idle timeout in minutes which is used for the NAT Gateway.

location = None¶: The location where the NAT Gateway exists.

public_ip_address_ids = None¶: A list of existing Public IP Address resource IDs which the NAT Gateway is using.

public_ip_prefix_ids = None¶: A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

resource_guid = None¶: The Resource GUID of the NAT Gateway.

sku_name = None¶: The SKU used by the NAT Gateway.

tags = None¶: A mapping of tags assigned to the resource.

zones = None¶: A list of Availability Zones which the NAT Gateway exists in.

class pulumi_azure.network.GetNetworkDdosProtectionPlanResult(id=None, location=None, name=None, resource_group_name=None, tags=None, virtual_network_ids=None)¶

A collection of values returned by getNetworkDdosProtectionPlan.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: Specifies the supported Azure location where the resource exists.

tags = None¶: A mapping of tags assigned to the resource.

virtual_network_ids = None¶: The Resource ID list of the Virtual Networks associated with DDoS Protection Plan.

class pulumi_azure.network.GetNetworkInterfaceResult(applied_dns_servers=None, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, id=None, internal_dns_name_label=None, ip_configurations=None, location=None, mac_address=None, name=None, network_security_group_id=None, private_ip_address=None, private_ip_addresses=None, resource_group_name=None, tags=None, virtual_machine_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.

id = None¶: The provider-assigned unique ID for this managed resource.

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.

name = None¶: The name of the IP Configuration.

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.

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

A collection of values returned by getNetworkSecurityGroup.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The supported Azure location where the resource exists.

name = None¶: The name of the security rule.

security_rules = None¶: One or more security_rule blocks as defined below.

tags = None¶: A mapping of tags assigned to the resource.

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

A collection of values returned by getNetworkWatcher.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The supported Azure location where the resource exists.

tags = None¶: A mapping of tags assigned to the resource.

class pulumi_azure.network.GetPublicIPResult(allocation_method=None, domain_name_label=None, fqdn=None, id=None, idle_timeout_in_minutes=None, ip_address=None, ip_version=None, location=None, name=None, resource_group_name=None, reverse_fqdn=None, sku=None, tags=None, zones=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.

id = None¶: The provider-assigned unique ID for this managed resource.

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.

class pulumi_azure.network.GetPublicIPsResult(allocation_type=None, attached=None, id=None, name_prefix=None, public_ips=None, resource_group_name=None)¶

A collection of values returned by getPublicIPs.

id = None¶: The provider-assigned unique ID for this managed resource.

public_ips = None¶: A List of public_ips blocks as defined below filtered by the criteria above.

class pulumi_azure.network.GetPublicIpPrefixResult(id=None, ip_prefix=None, location=None, name=None, prefix_length=None, resource_group_name=None, sku=None, tags=None, zones=None)¶

A collection of values returned by getPublicIpPrefix.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The supported Azure location where the resource exists.

name = None¶: The name of the Public IP prefix resource.

prefix_length = None¶: The number of bits of the prefix.

resource_group_name = None¶: The name of the resource group in which to create the public IP.

sku = None¶: The SKU of the Public IP Prefix.

tags = None¶: A mapping of tags to assigned to the resource.

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

A collection of values returned by getRouteTable.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The Azure Region in which the Route Table exists.

name = None¶: The name of the Route.

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.

class pulumi_azure.network.GetServiceTagsResult(address_prefixes=None, id=None, location=None, location_filter=None, service=None)¶

A collection of values returned by getServiceTags.

address_prefixes = None¶: List of address prefixes for the service type (and optionally a specific region).

id = None¶: The provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetSubnetResult(address_prefix=None, address_prefixes=None, enforce_private_link_endpoint_network_policies=None, enforce_private_link_service_network_policies=None, id=None, name=None, network_security_group_id=None, resource_group_name=None, route_table_id=None, service_endpoints=None, virtual_network_name=None)¶

A collection of values returned by getSubnet.

address_prefix = None¶: (Deprecated) The address prefix used for the subnet.

address_prefixes = None¶: The address prefixes for the subnet.

enforce_private_link_endpoint_network_policies = None¶: Enable or Disable network policies for the private link endpoint on the subnet.

enforce_private_link_service_network_policies = None¶: Enable or Disable network policies for the private link service on the subnet.

id = None¶: The provider-assigned unique ID for this managed resource.

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.

service_endpoints = None¶: A list of Service Endpoints within this subnet.

class pulumi_azure.network.GetTrafficManagerResult(id=None, name=None)¶

A collection of values returned by getTrafficManager.

id = None¶: The provider-assigned unique ID for this managed resource.

class pulumi_azure.network.GetVirtualHubResult(address_prefix=None, id=None, location=None, name=None, resource_group_name=None, tags=None, virtual_wan_id=None)¶

A collection of values returned by getVirtualHub.

address_prefix = None¶: The Address Prefix used for this Virtual Hub.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: The Azure Region where the Virtual Hub exists.

tags = None¶: A mapping of tags assigned to the Virtual Hub.

virtual_wan_id = None¶: The ID of the Virtual WAN within which the Virtual Hub exists.

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

A collection of values returned by getVirtualNetworkGateway.

active_active = None¶: 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.

generation = None¶: The Generation of the Virtual Network Gateway.

id = None¶: The provider-assigned unique ID for this managed resource.

ip_configurations = None¶: One or two ip_configuration blocks documented below.

location = None¶: The location/region where the Virtual Network Gateway is located.

name = None¶: The user-defined name of the revoked certificate.

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.

class pulumi_azure.network.GetVirtualNetworkResult(address_spaces=None, dns_servers=None, guid=None, id=None, location=None, name=None, resource_group_name=None, subnets=None, vnet_peerings=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.

guid = None¶: The GUID of the virtual network.

id = None¶: The provider-assigned unique ID for this managed resource.

location = None¶: Location of 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.

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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West US")
home = azure.network.LocalNetworkGateway("home",
    resource_group_name=example.name,
    location=example.location,
    gateway_address="12.13.14.15",
    address_spaces=["10.0.0.0/16"])

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.

The bgp_settings object supports the following:

asn (pulumi.Input[float]) - The BGP speaker’s ASN.
bgpPeeringAddress (pulumi.Input[str]) - The BGP peering address and BGP identifier of this BGP speaker.
peerWeight (pulumi.Input[float]) - The weight added to routes learned from this BGP speaker.

address_spaces: pulumi.Output[list] = None¶: The list of string CIDRs representing the address spaces the gateway exposes.

bgp_settings: pulumi.Output[dict] = None¶

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

asn (float) - The BGP speaker’s ASN.
bgpPeeringAddress (str) - The BGP peering address and BGP identifier of this BGP speaker.
peerWeight (float) - The weight added to routes learned from this BGP speaker.

gateway_address: pulumi.Output[str] = None¶: The IP address of the gateway to which to connect.

location: pulumi.Output[str] = None¶: The location/region where the local network gateway is created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the local network gateway. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the local network gateway.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, address_spaces=None, bgp_settings=None, gateway_address=None, location=None, name=None, resource_group_name=None, tags=None)¶

Get an existing LocalNetworkGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

The bgp_settings object supports the following:

asn (pulumi.Input[float]) - The BGP speaker’s ASN.
bgpPeeringAddress (pulumi.Input[str]) - The BGP peering address and BGP identifier of this BGP speaker.
peerWeight (pulumi.Input[float]) - The weight added to routes learned from this BGP speaker.

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.NatGateway(resource_name, opts=None, idle_timeout_in_minutes=None, location=None, name=None, public_ip_address_ids=None, public_ip_prefix_ids=None, resource_group_name=None, sku_name=None, tags=None, zones=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Azure NAT Gateway.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus2")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static",
    sku="Standard",
    zones=["1"])
example_public_ip_prefix = azure.network.PublicIpPrefix("examplePublicIpPrefix",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    prefix_length=30,
    zones=["1"])
example_nat_gateway = azure.network.NatGateway("exampleNatGateway",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    public_ip_address_ids=[example_public_ip.id],
    public_ip_prefix_ids=[example_public_ip_prefix.id],
    sku_name="Standard",
    idle_timeout_in_minutes=10,
    zones=["1"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
idle_timeout_in_minutes (pulumi.Input[float]) – The idle timeout which should be used in minutes. Defaults to 4.
location (pulumi.Input[str]) – Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the NAT Gateway. Changing this forces a new resource to be created.
public_ip_address_ids (pulumi.Input[list]) – A list of Public IP Address ID’s which should be associated with the NAT Gateway resource.
public_ip_prefix_ids (pulumi.Input[list]) – A list of Public IP Prefix ID’s which should be associated with the NAT Gateway resource.
resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.
sku_name (pulumi.Input[str]) – The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
zones (pulumi.Input[list]) – A list of availability zones where the NAT Gateway should be provisioned. Changing this forces a new resource to be created.

idle_timeout_in_minutes: pulumi.Output[float] = None¶: The idle timeout which should be used in minutes. Defaults to 4.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the NAT Gateway. Changing this forces a new resource to be created.

public_ip_address_ids: pulumi.Output[list] = None¶: A list of Public IP Address ID’s which should be associated with the NAT Gateway resource.

public_ip_prefix_ids: pulumi.Output[list] = None¶: A list of Public IP Prefix ID’s which should be associated with the NAT Gateway resource.

resource_group_name: pulumi.Output[str] = None¶: Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.

resource_guid: pulumi.Output[str] = None¶: The resource GUID property of the NAT Gateway.

sku_name: pulumi.Output[str] = None¶: The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

zones: pulumi.Output[list] = None¶: A list of availability zones where the NAT Gateway should be provisioned. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, idle_timeout_in_minutes=None, location=None, name=None, public_ip_address_ids=None, public_ip_prefix_ids=None, resource_group_name=None, resource_guid=None, sku_name=None, tags=None, zones=None)¶

Get an existing NatGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
idle_timeout_in_minutes (pulumi.Input[float]) – The idle timeout which should be used in minutes. Defaults to 4.
location (pulumi.Input[str]) – Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – Specifies the name of the NAT Gateway. Changing this forces a new resource to be created.
public_ip_address_ids (pulumi.Input[list]) – A list of Public IP Address ID’s which should be associated with the NAT Gateway resource.
public_ip_prefix_ids (pulumi.Input[list]) – A list of Public IP Prefix ID’s which should be associated with the NAT Gateway resource.
resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.
resource_guid (pulumi.Input[str]) – The resource GUID property of the NAT Gateway.
sku_name (pulumi.Input[str]) – The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
zones (pulumi.Input[list]) – A list of availability zones where the NAT Gateway should be provisioned. 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.NatGatewayPublicIpAssociation(resource_name, opts=None, nat_gateway_id=None, public_ip_address_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages the association between a Nat Gateway and a Public IP.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static",
    sku="Standard")
example_nat_gateway = azure.network.NatGateway("exampleNatGateway",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku_name="Standard")
example_nat_gateway_public_ip_association = azure.network.NatGatewayPublicIpAssociation("exampleNatGatewayPublicIpAssociation",
    nat_gateway_id=example_nat_gateway.id,
    public_ip_address_id=example_public_ip.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
nat_gateway_id (pulumi.Input[str]) – The ID of the Nat Gateway. Changing this forces a new resource to be created.
public_ip_address_id (pulumi.Input[str]) – The ID of the Public IP which this Nat Gateway which should be connected to. Changing this forces a new resource to be created.

nat_gateway_id: pulumi.Output[str] = None¶: The ID of the Nat Gateway. Changing this forces a new resource to be created.

public_ip_address_id: pulumi.Output[str] = None¶: The ID of the Public IP which this Nat Gateway which should be connected to. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, nat_gateway_id=None, public_ip_address_id=None)¶

Get an existing NatGatewayPublicIpAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
nat_gateway_id (pulumi.Input[str]) – The ID of the Nat Gateway. Changing this forces a new resource to be created.
public_ip_address_id (pulumi.Input[str]) – The ID of the Public IP which this Nat Gateway which should be connected to. 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.NetworkConnectionMonitor(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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_network_watcher = azure.network.NetworkWatcher("exampleNetworkWatcher",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_virtual_machine = azure.compute.VirtualMachine("exampleVirtualMachine",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    network_interface_ids=[example_network_interface.id],
    vm_size="Standard_F2",
    storage_image_reference={
        "publisher": "Canonical",
        "offer": "UbuntuServer",
        "sku": "16.04-LTS",
        "version": "latest",
    },
    storage_os_disk={
        "name": "osdisk",
        "caching": "ReadWrite",
        "create_option": "FromImage",
        "managedDiskType": "Standard_LRS",
    },
    os_profile={
        "computer_name": "cmtest-vm",
        "admin_username": "testadmin",
        "admin_password": "Password1234!",
    },
    os_profile_linux_config={
        "disable_password_authentication": False,
    })
example_extension = azure.compute.Extension("exampleExtension",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    virtual_machine_name=example_virtual_machine.name,
    publisher="Microsoft.Azure.NetworkWatcher",
    type="NetworkWatcherAgentLinux",
    type_handler_version="1.4",
    auto_upgrade_minor_version=True)
example_network_connection_monitor = azure.network.NetworkConnectionMonitor("exampleNetworkConnectionMonitor",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    network_watcher_name=example_network_watcher.name,
    source={
        "virtual_machine_id": example_virtual_machine.id,
    },
    destination={
        "address": "exmaple.com",
        "port": 80,
    })

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

The destination object supports the following:

address (pulumi.Input[str]) - IP address or domain name to monitor connectivity to.
port (pulumi.Input[float]) - The port on the destination to monitor connectivity to.
virtual_machine_id (pulumi.Input[str]) - The ID of the Virtual Machine to monitor connectivity to.

The source object supports the following:

port (pulumi.Input[float]) - The port on the destination to monitor connectivity to.
virtual_machine_id (pulumi.Input[str]) - The ID of the Virtual Machine to monitor connectivity to.

auto_start: pulumi.Output[bool] = None¶: Specifies whether the connection monitor will start automatically once created. Defaults to true. Changing this forces a new resource to be created.

destination: pulumi.Output[dict] = None¶

A destination block as defined below.

address (str) - IP address or domain name to monitor connectivity to.
port (float) - The port on the destination to monitor connectivity to.
virtual_machine_id (str) - The ID of the Virtual Machine to monitor connectivity to.

interval_in_seconds: pulumi.Output[float] = None¶: Monitoring interval in seconds. Defaults to 60.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the Network Connection Monitor. Changing this forces a new resource to be created.

network_watcher_name: pulumi.Output[str] = None¶: The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Connection Monitor. Changing this forces a new resource to be created.

source: pulumi.Output[dict] = None¶

A source block as defined below.

port (float) - The port on the destination to monitor connectivity to.
virtual_machine_id (str) - The ID of the Virtual Machine to monitor connectivity to.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, 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)¶

Get an existing NetworkConnectionMonitor resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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 Network 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.

The destination object supports the following:

address (pulumi.Input[str]) - IP address or domain name to monitor connectivity to.
port (pulumi.Input[float]) - The port on the destination to monitor connectivity to.
virtual_machine_id (pulumi.Input[str]) - The ID of the Virtual Machine to monitor connectivity to.

The source object supports the following:

port (pulumi.Input[float]) - The port on the destination to monitor connectivity to.
virtual_machine_id (pulumi.Input[str]) - The ID of the Virtual Machine to monitor connectivity to.

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, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, internal_dns_name_label=None, ip_configurations=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Network Interface.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "internal",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
dns_servers (pulumi.Input[list]) – A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
enable_accelerated_networking (pulumi.Input[bool]) – Should Accelerated Networking be enabled? Defaults to false.
enable_ip_forwarding (pulumi.Input[bool]) – Should IP Forwarding be enabled? Defaults to false.
internal_dns_name_label (pulumi.Input[str]) – The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
ip_configurations (pulumi.Input[list]) – One or more ip_configuration blocks as defined below.
location (pulumi.Input[str]) – The location where the Network Interface should exist. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the Network Interface. 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 Interface. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The ip_configurations object supports the following:

name (pulumi.Input[str]) - A name used for this IP Configuration.
primary (pulumi.Input[bool]) - Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
private_ip_address (pulumi.Input[str]) - The Static IP Address which should be used.
privateIpAddressAllocation (pulumi.Input[str]) - The allocation method used for the Private IP Address. Possible values are Dynamic and Static.
privateIpAddressVersion (pulumi.Input[str]) - The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
public_ip_address_id (pulumi.Input[str]) - Reference to a Public IP Address to associate with this NIC
subnet_id (pulumi.Input[str]) - The ID of the Subnet where this Network Interface should be located in.

applied_dns_servers: pulumi.Output[list] = None¶: If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.

dns_servers: pulumi.Output[list] = None¶: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

enable_accelerated_networking: pulumi.Output[bool] = None¶: Should Accelerated Networking be enabled? Defaults to false.

enable_ip_forwarding: pulumi.Output[bool] = None¶: Should IP Forwarding be enabled? Defaults to false.

internal_dns_name_label: pulumi.Output[str] = None¶: The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.

internal_domain_name_suffix: pulumi.Output[str] = None¶: Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.

ip_configurations: pulumi.Output[list] = None¶

One or more ip_configuration blocks as defined below.

name (str) - A name used for this IP Configuration.
primary (bool) - Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
private_ip_address (str) - The Static IP Address which should be used.
privateIpAddressAllocation (str) - The allocation method used for the Private IP Address. Possible values are Dynamic and Static.
privateIpAddressVersion (str) - The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
public_ip_address_id (str) - Reference to a Public IP Address to associate with this NIC
subnet_id (str) - The ID of the Subnet where this Network Interface should be located in.

location: pulumi.Output[str] = None¶: The location where the Network Interface should exist. Changing this forces a new resource to be created.

mac_address: pulumi.Output[str] = None¶: The Media Access Control (MAC) Address of the Network Interface.

name: pulumi.Output[str] = None¶: The name of the Network Interface. Changing this forces a new resource to be created.

private_ip_address: pulumi.Output[str] = None¶: The Static IP Address which should be used.

private_ip_addresses: pulumi.Output[list] = None¶: The private IP addresses of the network interface.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

virtual_machine_id: pulumi.Output[str] = None¶: The ID of the Virtual Machine which this Network Interface is connected to.

static get(resource_name, id, opts=None, applied_dns_servers=None, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, internal_dns_name_label=None, internal_domain_name_suffix=None, ip_configurations=None, location=None, mac_address=None, name=None, private_ip_address=None, private_ip_addresses=None, resource_group_name=None, tags=None, virtual_machine_id=None)¶

Get an existing NetworkInterface resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
applied_dns_servers (pulumi.Input[list]) – If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
dns_servers (pulumi.Input[list]) – A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
enable_accelerated_networking (pulumi.Input[bool]) – Should Accelerated Networking be enabled? Defaults to false.
enable_ip_forwarding (pulumi.Input[bool]) – Should IP Forwarding be enabled? Defaults to false.
internal_dns_name_label (pulumi.Input[str]) – The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
internal_domain_name_suffix (pulumi.Input[str]) – Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
ip_configurations (pulumi.Input[list]) – One or more ip_configuration blocks as defined below.
location (pulumi.Input[str]) – The location where the Network Interface should exist. 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.
private_ip_address (pulumi.Input[str]) – The Static IP Address which should be used.
private_ip_addresses (pulumi.Input[list]) – The private IP addresses of 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]) – The ID of the Virtual Machine which this Network Interface is connected to.

The ip_configurations object supports the following:

name (pulumi.Input[str]) - A name used for this IP Configuration.
primary (pulumi.Input[bool]) - Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
private_ip_address (pulumi.Input[str]) - The Static IP Address which should be used.
privateIpAddressAllocation (pulumi.Input[str]) - The allocation method used for the Private IP Address. Possible values are Dynamic and Static.
privateIpAddressVersion (pulumi.Input[str]) - The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
public_ip_address_id (pulumi.Input[str]) - Reference to a Public IP Address to associate with this NIC
subnet_id (pulumi.Input[str]) - The ID of the Subnet where this Network Interface should be located 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.NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation(resource_name, opts=None, backend_address_pool_id=None, ip_configuration_name=None, network_interface_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
frontend = azure.network.Subnet("frontend",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
backend = azure.network.Subnet("backend",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Dynamic")
backend_address_pool_name = example_virtual_network.name.apply(lambda name: f"{name}-beap")
frontend_port_name = example_virtual_network.name.apply(lambda name: f"{name}-feport")
frontend_ip_configuration_name = example_virtual_network.name.apply(lambda name: f"{name}-feip")
http_setting_name = example_virtual_network.name.apply(lambda name: f"{name}-be-htst")
listener_name = example_virtual_network.name.apply(lambda name: f"{name}-httplstn")
request_routing_rule_name = example_virtual_network.name.apply(lambda name: f"{name}-rqrt")
network = azure.network.ApplicationGateway("network",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku={
        "name": "Standard_Small",
        "tier": "Standard",
        "capacity": 2,
    },
    gateway_ip_configuration=[{
        "name": "my-gateway-ip-configuration",
        "subnet_id": frontend.id,
    }],
    frontend_port=[{
        "name": frontend_port_name,
        "port": 80,
    }],
    frontend_ip_configuration=[{
        "name": frontend_ip_configuration_name,
        "public_ip_address_id": example_public_ip.id,
    }],
    backend_address_pool=[{
        "name": backend_address_pool_name,
    }],
    backend_http_settings=[{
        "name": http_setting_name,
        "cookieBasedAffinity": "Disabled",
        "port": 80,
        "protocol": "Http",
        "requestTimeout": 1,
    }],
    http_listener=[{
        "name": listener_name,
        "frontend_ip_configuration_name": frontend_ip_configuration_name,
        "frontendPortName": frontend_port_name,
        "protocol": "Http",
    }],
    request_routing_rule=[{
        "name": request_routing_rule_name,
        "ruleType": "Basic",
        "httpListenerName": listener_name,
        "backendAddressPoolName": backend_address_pool_name,
        "backendHttpSettingsName": http_setting_name,
    }])
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": frontend.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_network_interface_application_gateway_backend_address_pool_association = azure.network.NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation("exampleNetworkInterfaceApplicationGatewayBackendAddressPoolAssociation",
    network_interface_id=example_network_interface.id,
    ip_configuration_name="testconfiguration1",
    backend_address_pool_id=network.backend_address_pools[0]["id"])

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: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ID of the Network Interface. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, backend_address_pool_id=None, ip_configuration_name=None, network_interface_id=None)¶

Get an existing NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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, network_interface_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_application_security_group = azure.network.ApplicationSecurityGroup("exampleApplicationSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
        "applicationSecurityGroupIds": [example_application_security_group.id],
    }])
example_network_interface_application_security_group_association = azure.network.NetworkInterfaceApplicationSecurityGroupAssociation("exampleNetworkInterfaceApplicationSecurityGroupAssociation",
    network_interface_id=example_network_interface.id,
    application_security_group_id=example_application_security_group.id)

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.
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: pulumi.Output[str] = 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.

network_interface_id: pulumi.Output[str] = None¶: The ID of the Network Interface. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, application_security_group_id=None, network_interface_id=None)¶

Get an existing NetworkInterfaceApplicationSecurityGroupAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
network_interface_id (pulumi.Input[str]) – 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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "primary",
        "public_ip_address_id": example_public_ip.id,
    }])
example_backend_address_pool = azure.lb.BackendAddressPool("exampleBackendAddressPool",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id)
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_network_interface_backend_address_pool_association = azure.network.NetworkInterfaceBackendAddressPoolAssociation("exampleNetworkInterfaceBackendAddressPoolAssociation",
    network_interface_id=example_network_interface.id,
    ip_configuration_name="testconfiguration1",
    backend_address_pool_id=example_backend_address_pool.id)

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: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ID of the Network Interface. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, backend_address_pool_id=None, ip_configuration_name=None, network_interface_id=None)¶

Get an existing NetworkInterfaceBackendAddressPoolAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static")
example_load_balancer = azure.lb.LoadBalancer("exampleLoadBalancer",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    frontend_ip_configuration=[{
        "name": "primary",
        "public_ip_address_id": example_public_ip.id,
    }])
example_nat_rule = azure.lb.NatRule("exampleNatRule",
    resource_group_name=example_resource_group.name,
    loadbalancer_id=example_load_balancer.id,
    protocol="Tcp",
    frontend_port=3389,
    backend_port=3389,
    frontend_ip_configuration_name="primary")
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_network_interface_nat_rule_association = azure.network.NetworkInterfaceNatRuleAssociation("exampleNetworkInterfaceNatRuleAssociation",
    network_interface_id=example_network_interface.id,
    ip_configuration_name="testconfiguration1",
    nat_rule_id=example_nat_rule.id)

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: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ID of the Network Interface. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, ip_configuration_name=None, nat_rule_id=None, network_interface_id=None)¶

Get an existing NetworkInterfaceNatRuleAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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.NetworkInterfaceSecurityGroupAssociation(resource_name, opts=None, network_interface_id=None, network_security_group_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_network_security_group = azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_network_interface_security_group_association = azure.network.NetworkInterfaceSecurityGroupAssociation("exampleNetworkInterfaceSecurityGroupAssociation",
    network_interface_id=example_network_interface.id,
    network_security_group_id=example_network_security_group.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
network_interface_id (pulumi.Input[str]) – The ID 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 which should be attached to the Network Interface. Changing this forces a new resource to be created.

network_interface_id: pulumi.Output[str] = None¶: The ID of the Network Interface. Changing this forces a new resource to be created.

network_security_group_id: pulumi.Output[str] = None¶: The ID of the Network Security Group which should be attached to the Network Interface. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, network_interface_id=None, network_security_group_id=None)¶

Get an existing NetworkInterfaceSecurityGroupAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
network_interface_id (pulumi.Input[str]) – The ID 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 which should be attached to 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.NetworkPacketCapture(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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_network_watcher = azure.network.NetworkWatcher("exampleNetworkWatcher",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_virtual_machine = azure.compute.VirtualMachine("exampleVirtualMachine",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    network_interface_ids=[example_network_interface.id],
    vm_size="Standard_F2",
    storage_image_reference={
        "publisher": "Canonical",
        "offer": "UbuntuServer",
        "sku": "16.04-LTS",
        "version": "latest",
    },
    storage_os_disk={
        "name": "osdisk",
        "caching": "ReadWrite",
        "create_option": "FromImage",
        "managedDiskType": "Standard_LRS",
    },
    os_profile={
        "computer_name": "pctest-vm",
        "admin_username": "testadmin",
        "admin_password": "Password1234!",
    },
    os_profile_linux_config={
        "disable_password_authentication": False,
    })
example_extension = azure.compute.Extension("exampleExtension",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    virtual_machine_name=example_virtual_machine.name,
    publisher="Microsoft.Azure.NetworkWatcher",
    type="NetworkWatcherAgentLinux",
    type_handler_version="1.4",
    auto_upgrade_minor_version=True)
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_network_packet_capture = azure.network.NetworkPacketCapture("exampleNetworkPacketCapture",
    network_watcher_name=example_network_watcher.name,
    resource_group_name=example_resource_group.name,
    target_resource_id=example_virtual_machine.id,
    storage_location={
        "storage_account_id": example_account.id,
    })

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

The filters object supports the following:

localIpAddress (pulumi.Input[str]) - The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
localPort (pulumi.Input[str]) - The local port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
protocol (pulumi.Input[str]) - The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
remoteIpAddress (pulumi.Input[str]) - The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.
remotePort (pulumi.Input[str]) - The remote port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

The storage_location object supports the following:

file_path (pulumi.Input[str]) - A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storage_account_id (pulumi.Input[str]) - The ID of the storage account to save the packet capture session
storagePath (pulumi.Input[str]) - The URI of the storage path to save the packet capture.

filters: pulumi.Output[list] = None¶

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

localIpAddress (str) - The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
localPort (str) - The local port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
protocol (str) - The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
remoteIpAddress (str) - The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.
remotePort (str) - The remote port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

maximum_bytes_per_packet: pulumi.Output[float] = 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: pulumi.Output[float] = None¶: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.

maximum_capture_duration: pulumi.Output[float] = 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: pulumi.Output[str] = None¶: The name to use for this Network Packet Capture. Changing this forces a new resource to be created.

network_watcher_name: pulumi.Output[str] = None¶: The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.

storage_location: pulumi.Output[dict] = None¶

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

file_path (str) - A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storage_account_id (str) - The ID of the storage account to save the packet capture session
storagePath (str) - The URI of the storage path to save the packet capture.

target_resource_id: pulumi.Output[str] = None¶: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

static get(resource_name, id, 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)¶

Get an existing NetworkPacketCapture resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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 Network 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.

The filters object supports the following:

localIpAddress (pulumi.Input[str]) - The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
localPort (pulumi.Input[str]) - The local port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
protocol (pulumi.Input[str]) - The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
remoteIpAddress (pulumi.Input[str]) - The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.
remotePort (pulumi.Input[str]) - The remote port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

The storage_location object supports the following:

file_path (pulumi.Input[str]) - A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storage_account_id (pulumi.Input[str]) - The ID of the storage account to save the packet capture session
storagePath (pulumi.Input[str]) - The URI of the storage path to save the packet capture.

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, __props__=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: This provider 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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_network_security_group = azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    security_rule=[{
        "name": "test123",
        "priority": 100,
        "direction": "Inbound",
        "access": "Allow",
        "protocol": "Tcp",
        "source_port_range": "*",
        "destination_port_range": "*",
        "source_address_prefix": "*",
        "destination_address_prefix": "*",
    }],
    tags={
        "environment": "Production",
    })

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 security rule.
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]) – A list of objects representing security rules, as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The security_rules object supports the following:

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[list]) - 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 Inbound and Outbound.
name (pulumi.Input[str]) - The name of the security rule.
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. Can be Tcp, Udp, Icmp, or * to match all.
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[list]) - 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.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the security rule.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[list] = None¶

A list of objects representing security rules, as defined below.

access (str) - Specifies whether network traffic is allowed or denied. Possible values are Allow and Deny.
description (str) - A description for this rule. Restricted to 140 characters.
destination_address_prefix (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 (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 (list) - A List of destination Application Security Group ID’s
destination_port_range (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 (list) - List of destination ports or port ranges. This is required if destination_port_range is not specified.
direction (str) - The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are Inbound and Outbound.
name (str) - The name of the security rule.
priority (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 (str) - Network protocol this rule applies to. Can be Tcp, Udp, Icmp, or * to match all.
source_address_prefix (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 (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 (list) - A List of source Application Security Group ID’s
source_port_range (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 (list) - List of source ports or port ranges. This is required if source_port_range is not specified.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, security_rules=None, tags=None)¶

Get an existing NetworkSecurityGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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 security rule.
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]) – A list of objects representing security rules, as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The security_rules object supports the following:

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[list]) - 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 Inbound and Outbound.
name (pulumi.Input[str]) - The name of the security rule.
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. Can be Tcp, Udp, Icmp, or * to match all.
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[list]) - 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.

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, __props__=None, __name__=None, __opts__=None)¶

Manages a Network Security Rule.

NOTE on Network Security Groups and Network Security Rules: This provider 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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_network_security_group = azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_network_security_rule = azure.network.NetworkSecurityRule("exampleNetworkSecurityRule",
    priority=100,
    direction="Outbound",
    access="Allow",
    protocol="Tcp",
    source_port_range="*",
    destination_port_range="*",
    source_address_prefix="*",
    destination_address_prefix="*",
    resource_group_name=example_resource_group.name,
    network_security_group_name=example_network_security_group.name)

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,Udp,Icmp, or*` (which matches all).
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: pulumi.Output[str] = None¶: Specifies whether network traffic is allowed or denied. Possible values are Allow and Deny.

description: pulumi.Output[str] = None¶: A description for this rule. Restricted to 140 characters.

destination_address_prefix: pulumi.Output[str] = 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: pulumi.Output[list] = 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: pulumi.Output[str] = None¶: A List of destination Application Security Group ID’s

destination_port_range: pulumi.Output[str] = 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: pulumi.Output[list] = None¶: List of destination ports or port ranges. This is required if destination_port_range is not specified.

direction: pulumi.Output[str] = None¶: The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are Inbound and Outbound.

name: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[float] = 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: pulumi.Output[str] = None¶: Network protocol this rule applies to. Possible values include Tcp, Udp, Icmp, or * (which matches all).

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[list] = 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: pulumi.Output[str] = None¶: A List of source Application Security Group ID’s

source_port_range: pulumi.Output[str] = 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: pulumi.Output[list] = None¶: List of source ports or port ranges. This is required if source_port_range is not specified.

static get(resource_name, id, 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)¶

Get an existing NetworkSecurityRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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,Udp,Icmp, or*` (which matches all).
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.

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, __props__=None, __name__=None, __opts__=None)¶

Manages a Network Watcher.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_network_watcher = azure.network.NetworkWatcher("exampleNetworkWatcher",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)

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: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, tags=None)¶

Get an existing NetworkWatcher resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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.NetworkWatcherFlowLog(resource_name, opts=None, enabled=None, network_security_group_id=None, network_watcher_name=None, resource_group_name=None, retention_policy=None, storage_account_id=None, traffic_analytics=None, version=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Network Watcher Flow Log.

import pulumi
import pulumi_azure as azure

test_resource_group = azure.core.ResourceGroup("testResourceGroup", location="eastus")
test_network_security_group = azure.network.NetworkSecurityGroup("testNetworkSecurityGroup",
    location=test_resource_group.location,
    resource_group_name=test_resource_group.name)
test_network_watcher = azure.network.NetworkWatcher("testNetworkWatcher",
    location=test_resource_group.location,
    resource_group_name=test_resource_group.name)
test_account = azure.storage.Account("testAccount",
    resource_group_name=test_resource_group.name,
    location=test_resource_group.location,
    account_tier="Standard",
    account_kind="StorageV2",
    account_replication_type="LRS",
    enable_https_traffic_only=True)
test_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("testAnalyticsWorkspace",
    location=test_resource_group.location,
    resource_group_name=test_resource_group.name,
    sku="PerGB2018")
test_network_watcher_flow_log = azure.network.NetworkWatcherFlowLog("testNetworkWatcherFlowLog",
    network_watcher_name=test_network_watcher.name,
    resource_group_name=test_resource_group.name,
    network_security_group_id=test_network_security_group.id,
    storage_account_id=test_account.id,
    enabled=True,
    retention_policy={
        "enabled": True,
        "days": 7,
    },
    traffic_analytics={
        "enabled": True,
        "workspace_id": test_analytics_workspace.workspace_id,
        "workspaceRegion": test_analytics_workspace.location,
        "workspace_resource_id": test_analytics_workspace.id,
        "intervalInMinutes": 10,
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
enabled (pulumi.Input[bool]) – Boolean flag to enable/disable traffic analytics.
network_security_group_id (pulumi.Input[str]) – The ID of the Network Security Group for which to enable flow logs for. 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 was deployed. Changing this forces a new resource to be created.
retention_policy (pulumi.Input[dict]) – A retention_policy block as documented below.
storage_account_id (pulumi.Input[str]) – The ID of the Storage Account where flow logs are stored.
traffic_analytics (pulumi.Input[dict]) – A traffic_analytics block as documented below.
version (pulumi.Input[float]) – The version (revision) of the flow log. Possible values are 1 and 2.

The retention_policy object supports the following:

days (pulumi.Input[float]) - The number of days to retain flow log records.
enabled (pulumi.Input[bool]) - Boolean flag to enable/disable traffic analytics.

The traffic_analytics object supports the following:

enabled (pulumi.Input[bool]) - Boolean flag to enable/disable traffic analytics.
intervalInMinutes (pulumi.Input[float]) - How frequently service should do flow analytics in minutes.
workspace_id (pulumi.Input[str]) - The resource guid of the attached workspace.
workspaceRegion (pulumi.Input[str]) - The location of the attached workspace.
workspace_resource_id (pulumi.Input[str]) - The resource ID of the attached workspace.

enabled: pulumi.Output[bool] = None¶: Boolean flag to enable/disable traffic analytics.

network_security_group_id: pulumi.Output[str] = None¶: The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.

network_watcher_name: pulumi.Output[str] = None¶: The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Network Watcher was deployed. Changing this forces a new resource to be created.

retention_policy: pulumi.Output[dict] = None¶

A retention_policy block as documented below.

days (float) - The number of days to retain flow log records.
enabled (bool) - Boolean flag to enable/disable traffic analytics.

storage_account_id: pulumi.Output[str] = None¶: The ID of the Storage Account where flow logs are stored.

traffic_analytics: pulumi.Output[dict] = None¶

A traffic_analytics block as documented below.

enabled (bool) - Boolean flag to enable/disable traffic analytics.
intervalInMinutes (float) - How frequently service should do flow analytics in minutes.
workspace_id (str) - The resource guid of the attached workspace.
workspaceRegion (str) - The location of the attached workspace.
workspace_resource_id (str) - The resource ID of the attached workspace.

version: pulumi.Output[float] = None¶: The version (revision) of the flow log. Possible values are 1 and 2.

static get(resource_name, id, opts=None, enabled=None, network_security_group_id=None, network_watcher_name=None, resource_group_name=None, retention_policy=None, storage_account_id=None, traffic_analytics=None, version=None)¶

Get an existing NetworkWatcherFlowLog resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
enabled (pulumi.Input[bool]) – Boolean flag to enable/disable traffic analytics.
network_security_group_id (pulumi.Input[str]) – The ID of the Network Security Group for which to enable flow logs for. 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 was deployed. Changing this forces a new resource to be created.
retention_policy (pulumi.Input[dict]) – A retention_policy block as documented below.
storage_account_id (pulumi.Input[str]) – The ID of the Storage Account where flow logs are stored.
traffic_analytics (pulumi.Input[dict]) – A traffic_analytics block as documented below.
version (pulumi.Input[float]) – The version (revision) of the flow log. Possible values are 1 and 2.

The retention_policy object supports the following:

days (pulumi.Input[float]) - The number of days to retain flow log records.
enabled (pulumi.Input[bool]) - Boolean flag to enable/disable traffic analytics.

The traffic_analytics object supports the following:

enabled (pulumi.Input[bool]) - Boolean flag to enable/disable traffic analytics.
intervalInMinutes (pulumi.Input[float]) - How frequently service should do flow analytics in minutes.
workspace_id (pulumi.Input[str]) - The resource guid of the attached workspace.
workspaceRegion (pulumi.Input[str]) - The location of the attached workspace.
workspace_resource_id (pulumi.Input[str]) - The resource ID of the attached workspace.

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, __props__=None, __name__=None, __opts__=None)¶

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

NOTE: This resource has been deprecated in favour of the network.NetworkConnectionMonitor resource and will be removed in the next major version of the AzureRM Provider. The new resource shares the same fields as this one, and information on migrating across can be found in this guide.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_network_watcher = azure.network.NetworkWatcher("exampleNetworkWatcher",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Dynamic",
    }])
example_virtual_machine = azure.compute.VirtualMachine("exampleVirtualMachine",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    network_interface_ids=[example_network_interface.id],
    vm_size="Standard_F2",
    storage_image_reference={
        "publisher": "Canonical",
        "offer": "UbuntuServer",
        "sku": "16.04-LTS",
        "version": "latest",
    },
    storage_os_disk={
        "name": "osdisk",
        "caching": "ReadWrite",
        "create_option": "FromImage",
        "managedDiskType": "Standard_LRS",
    },
    os_profile={
        "computer_name": "pctest-vm",
        "admin_username": "testadmin",
        "admin_password": "Password1234!",
    },
    os_profile_linux_config={
        "disable_password_authentication": False,
    })
example_extension = azure.compute.Extension("exampleExtension",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    virtual_machine_name=example_virtual_machine.name,
    publisher="Microsoft.Azure.NetworkWatcher",
    type="NetworkWatcherAgentLinux",
    type_handler_version="1.4",
    auto_upgrade_minor_version=True)
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_packet_capture = azure.network.PacketCapture("examplePacketCapture",
    network_watcher_name=example_network_watcher.name,
    resource_group_name=example_resource_group.name,
    target_resource_id=example_virtual_machine.id,
    storage_location={
        "storage_account_id": example_account.id,
    })

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.

The filters object supports the following:

localIpAddress (pulumi.Input[str]) - The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
localPort (pulumi.Input[str]) - The local port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
protocol (pulumi.Input[str]) - The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
remoteIpAddress (pulumi.Input[str]) - The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.
remotePort (pulumi.Input[str]) - The remote port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

The storage_location object supports the following:

file_path (pulumi.Input[str]) - A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storage_account_id (pulumi.Input[str]) - The ID of the storage account to save the packet capture session
storagePath (pulumi.Input[str]) - The URI of the storage path to save the packet capture.

filters: pulumi.Output[list] = None¶

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

localIpAddress (str) - The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
localPort (str) - The local port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
protocol (str) - The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
remoteIpAddress (str) - The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.
remotePort (str) - The remote port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

maximum_bytes_per_packet: pulumi.Output[float] = 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: pulumi.Output[float] = None¶: Maximum size of the capture in Bytes. Defaults to 1073741824 (1GB). Changing this forces a new resource to be created.

maximum_capture_duration: pulumi.Output[float] = 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: pulumi.Output[str] = None¶: The name to use for this Packet Capture. Changing this forces a new resource to be created.

network_watcher_name: pulumi.Output[str] = None¶: The name of the Network Watcher. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.

storage_location: pulumi.Output[dict] = None¶

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

file_path (str) - A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storage_account_id (str) - The ID of the storage account to save the packet capture session
storagePath (str) - The URI of the storage path to save the packet capture.

target_resource_id: pulumi.Output[str] = None¶: The ID of the Resource to capture packets from. Changing this forces a new resource to be created.

Get an existing PacketCapture resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

The filters object supports the following:

localIpAddress (pulumi.Input[str]) - The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
localPort (pulumi.Input[str]) - The local port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.
protocol (pulumi.Input[str]) - The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.
remoteIpAddress (pulumi.Input[str]) - The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.
remotePort (pulumi.Input[str]) - The remote port to be filtered on. Notation: “80” for single port entry.”80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

The storage_location object supports the following:

file_path (pulumi.Input[str]) - A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.
storage_account_id (pulumi.Input[str]) - The ID of the storage account to save the packet capture session
storagePath (pulumi.Input[str]) - The URI of the storage path to save the packet capture.

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.PointToPointVpnGateway(resource_name, opts=None, connection_configuration=None, location=None, name=None, resource_group_name=None, scale_unit=None, tags=None, virtual_hub_id=None, vpn_server_configuration_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Point-to-Site VPN Gateway.

import pulumi
import pulumi_azure as azure

example = azure.network.PointToPointVpnGateway("example",
    location=azurerm_resource_group["example"]["location"],
    resource_group_name=azurerm_resource_group["example"]["resource_group_name"],
    virtual_hub_id=azurerm_virtual_hub["example"]["id"],
    vpn_server_configuration_id=azurerm_vpn_server_configuration["example"]["id"],
    scale_unit=1)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_configuration (pulumi.Input[dict]) – A connection_configuration block as defined 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 Point-to-Site VPN 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 Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
scale_unit (pulumi.Input[float]) – The Scale Unit for this Point-to-Site VPN Gateway.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the Point-to-Site VPN Gateway.
virtual_hub_id (pulumi.Input[str]) – The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpn_server_configuration_id (pulumi.Input[str]) – The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.

The connection_configuration object supports the following:

name (pulumi.Input[str]) - The Name which should be used for this Connection Configuration.
vpnClientAddressPool (pulumi.Input[dict]) - A vpn_client_address_pool block as defined below.
- address_prefixes (pulumi.Input[list]) - A list of CIDR Ranges which should be used as Address Prefixes.

connection_configuration: pulumi.Output[dict] = None¶

A connection_configuration block as defined below.

name (str) - The Name which should be used for this Connection Configuration.
vpnClientAddressPool (dict) - A vpn_client_address_pool block as defined below.
- address_prefixes (list) - A list of CIDR Ranges which should be used as Address Prefixes.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.

scale_unit: pulumi.Output[float] = None¶: The Scale Unit for this Point-to-Site VPN Gateway.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the Point-to-Site VPN Gateway.

virtual_hub_id: pulumi.Output[str] = None¶: The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.

vpn_server_configuration_id: pulumi.Output[str] = None¶: The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, connection_configuration=None, location=None, name=None, resource_group_name=None, scale_unit=None, tags=None, virtual_hub_id=None, vpn_server_configuration_id=None)¶

Get an existing PointToPointVpnGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_configuration (pulumi.Input[dict]) – A connection_configuration block as defined 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 Point-to-Site VPN 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 Point-to-Site VPN Gateway. Changing this forces a new resource to be created.
scale_unit (pulumi.Input[float]) – The Scale Unit for this Point-to-Site VPN Gateway.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the Point-to-Site VPN Gateway.
virtual_hub_id (pulumi.Input[str]) – The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.
vpn_server_configuration_id (pulumi.Input[str]) – The ID of the VPN Server Configuration which this Point-to-Site VPN Gateway should use. Changing this forces a new resource to be created.

The connection_configuration object supports the following:

name (pulumi.Input[str]) - The Name which should be used for this Connection Configuration.
vpnClientAddressPool (pulumi.Input[dict]) - A vpn_client_address_pool block as defined below.
- address_prefixes (pulumi.Input[list]) - A list of CIDR Ranges which should be used as Address Prefixes.

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.Profile(resource_name, opts=None, container_network_interface=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Network Profile.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.1.0.0/16"])
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.1.0.0/24",
    delegation=[{
        "name": "delegation",
        "service_delegation": {
            "name": "Microsoft.ContainerInstance/containerGroups",
            "actions": ["Microsoft.Network/virtualNetworks/subnets/action"],
        },
    }])
example_profile = azure.network.Profile("exampleProfile",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    container_network_interface={
        "name": "examplecnic",
        "ip_configuration": [{
            "name": "exampleipconfig",
            "subnet_id": example_subnet.id,
        }],
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
container_network_interface (pulumi.Input[dict]) – A container_network_interface 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 Network Profile. 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.

The container_network_interface object supports the following:

ip_configurations (pulumi.Input[list]) - One or more ip_configuration blocks as documented below.
- name (pulumi.Input[str]) - Specifies the name of the IP Configuration.
- subnet_id (pulumi.Input[str]) - Reference to the subnet associated with the IP Configuration.
name (pulumi.Input[str]) - Specifies the name of the IP Configuration.

container_network_interface: pulumi.Output[dict] = None¶

A container_network_interface block as documented below.

ip_configurations (list) - One or more ip_configuration blocks as documented below.
- name (str) - Specifies the name of the IP Configuration.
- subnet_id (str) - Reference to the subnet associated with the IP Configuration.
name (str) - Specifies the name of the IP Configuration.

container_network_interface_ids: pulumi.Output[list] = None¶: A list of Container Network Interface ID’s.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Network Profile. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the resource. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, container_network_interface=None, container_network_interface_ids=None, location=None, name=None, resource_group_name=None, tags=None)¶

Get an existing Profile resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
container_network_interface (pulumi.Input[dict]) – A container_network_interface block as documented below.
container_network_interface_ids (pulumi.Input[list]) – A list of Container Network Interface ID’s.
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 Profile. 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.

The container_network_interface object supports the following:

ip_configurations (pulumi.Input[list]) - One or more ip_configuration blocks as documented below.
- name (pulumi.Input[str]) - Specifies the name of the IP Configuration.
- subnet_id (pulumi.Input[str]) - Reference to the subnet associated with the IP Configuration.
name (pulumi.Input[str]) - Specifies the name of the IP Configuration.

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_prefix_id=None, resource_group_name=None, reverse_fqdn=None, sku=None, tags=None, zones=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Public IP Address.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    allocation_method="Static",
    tags={
        "environment": "Production",
    })

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.
public_ip_prefix_id (pulumi.Input[str]) – If specified then public IP address allocated will be provided from the public IP prefix resource.
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: pulumi.Output[str] = None¶: Defines the allocation method for this IP address. Possible values are Static or Dynamic.

domain_name_label: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone

idle_timeout_in_minutes: pulumi.Output[float] = None¶: Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes.

ip_address: pulumi.Output[str] = None¶: The IP address value that was allocated.

ip_version: pulumi.Output[str] = None¶: The IP Version to use, IPv6 or IPv4.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Public IP resource . Changing this forces a new resource to be created.

public_ip_prefix_id: pulumi.Output[str] = None¶: If specified then public IP address allocated will be provided from the public IP prefix resource.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the public ip.

reverse_fqdn: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zones: pulumi.Output[str] = None¶: A collection containing the availability zone to allocate the Public IP in.

static get(resource_name, id, opts=None, allocation_method=None, domain_name_label=None, fqdn=None, idle_timeout_in_minutes=None, ip_address=None, ip_version=None, location=None, name=None, public_ip_prefix_id=None, resource_group_name=None, reverse_fqdn=None, sku=None, tags=None, zones=None)¶

Get an existing PublicIp resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
fqdn (pulumi.Input[str]) – Fully qualified domain name of the A DNS record associated with the public IP. domain_name_label must be specified to get the fqdn. This is the concatenation of the domain_name_label and the regionalized DNS zone
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_address (pulumi.Input[str]) – The IP address value that was allocated.
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.
public_ip_prefix_id (pulumi.Input[str]) – If specified then public IP address allocated will be provided from the public IP prefix resource.
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.

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.PublicIpPrefix(resource_name, opts=None, location=None, name=None, prefix_length=None, resource_group_name=None, sku=None, tags=None, zones=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Public IP Prefix.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_public_ip_prefix = azure.network.PublicIpPrefix("examplePublicIpPrefix",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    prefix_length=31,
    tags={
        "environment": "Production",
    })

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 Public IP Prefix resource . Changing this forces a new resource to be created.
prefix_length (pulumi.Input[float]) – Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). 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 Prefix.
sku (pulumi.Input[str]) – The SKU of the Public IP Prefix. Accepted values are Standard. Defaults to Standard. Changing this forces a new resource to be created.
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 Prefix in.

ip_prefix: pulumi.Output[str] = None¶: The IP address prefix value that was allocated.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Public IP Prefix resource . Changing this forces a new resource to be created.

prefix_length: pulumi.Output[float] = None¶: Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Public IP Prefix.

sku: pulumi.Output[str] = None¶: The SKU of the Public IP Prefix. Accepted values are Standard. Defaults to Standard. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zones: pulumi.Output[str] = None¶: A collection containing the availability zone to allocate the Public IP Prefix in.

static get(resource_name, id, opts=None, ip_prefix=None, location=None, name=None, prefix_length=None, resource_group_name=None, sku=None, tags=None, zones=None)¶

Get an existing PublicIpPrefix resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
ip_prefix (pulumi.Input[str]) – The IP address prefix value that was allocated.
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 Prefix resource . Changing this forces a new resource to be created.
prefix_length (pulumi.Input[float]) – Specifies the number of bits of the prefix. The value can be set between 0 (4,294,967,296 addresses) and 31 (2 addresses). Defaults to 28(16 addresses). 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 Prefix.
sku (pulumi.Input[str]) – The SKU of the Public IP Prefix. Accepted values are Standard. Defaults to Standard. Changing this forces a new resource to be created.
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 Prefix 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, __props__=None, __name__=None, __opts__=None)¶

Manages a Route within a Route Table.

NOTE on Route Tables and Routes: This provider currently provides both a standalone Route resource, and allows for Routes to be defined in-line within the Route Table resource. At this time you cannot use a Route Table with in-line Routes in conjunction with any Route resources. Doing so will cause a conflict of Route configurations and will overwrite Routes.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_route_table = azure.network.RouteTable("exampleRouteTable",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_route = azure.network.Route("exampleRoute",
    resource_group_name=example_resource_group.name,
    route_table_name=example_route_table.name,
    address_prefix="10.1.0.0/16",
    next_hop_type="vnetlocal")

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: pulumi.Output[str] = None¶: The destination CIDR to which the route applies, such as 10.1.0.0/16

name: pulumi.Output[str] = None¶: The name of the route. Changing this forces a new resource to be created.

next_hop_in_ip_address: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The name of the route table within which create the route. Changing this forces a new resource to be created.

static get(resource_name, id, 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)¶

Get an existing Route resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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, __props__=None, __name__=None, __opts__=None)¶

Manages a Route Table

NOTE on Route Tables and Routes: There is both a standalone route resource, and allows for Routes to be defined in-line within the route_table resource. At this time you cannot use a Route Table with in-line Routes in conjunction with any Route resources. Doing so will cause a conflict of Route configurations and will overwrite Routes.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_route_table = azure.network.RouteTable("exampleRouteTable",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    disable_bgp_route_propagation=False,
    route=[{
        "name": "route1",
        "address_prefix": "10.1.0.0/16",
        "next_hop_type": "vnetlocal",
    }],
    tags={
        "environment": "Production",
    })

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.
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]) – A list of objects representing routes. Each object accepts the arguments documented below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The routes object supports the following:

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

disable_bgp_route_propagation: pulumi.Output[bool] = None¶: Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the route.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the route table. Changing this forces a new resource to be created.

routes: pulumi.Output[list] = None¶

A list of objects representing routes. Each object accepts the arguments documented below.

address_prefix (str) - The destination CIDR to which the route applies, such as 10.1.0.0/16
name (str) - The name of the route.
next_hop_in_ip_address (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 (str) - The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None.

subnets: pulumi.Output[list] = None¶: The collection of Subnets associated with this route table.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, disable_bgp_route_propagation=None, location=None, name=None, resource_group_name=None, routes=None, subnets=None, tags=None)¶

Get an existing RouteTable resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
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]) – A list of objects representing routes. Each object accepts the arguments documented below.
subnets (pulumi.Input[list]) – The collection of Subnets associated with this route table.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The routes object supports the following:

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

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, address_prefixes=None, delegations=None, enforce_private_link_endpoint_network_policies=None, enforce_private_link_service_network_policies=None, name=None, resource_group_name=None, service_endpoints=None, virtual_network_name=None, __props__=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: This provider 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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.1.0/24"],
    delegation=[{
        "name": "acctestdelegation",
        "service_delegation": {
            "name": "Microsoft.ContainerInstance/containerGroups",
            "actions": [
                "Microsoft.Network/virtualNetworks/subnets/join/action",
                "Microsoft.Network/virtualNetworks/subnets/prepareNetworkPolicies/action",
            ],
        },
    }])

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.
address_prefixes (pulumi.Input[list]) – The address prefixes to use for the subnet.
delegations (pulumi.Input[list]) – One or more delegation blocks as defined below.
enforce_private_link_endpoint_network_policies (pulumi.Input[bool]) – Enable or Disable network policies for the private link endpoint on the subnet. Default value is false. Conflicts with enforce_private_link_service_network_policies.
enforce_private_link_service_network_policies (pulumi.Input[bool]) – Enable or Disable network policies for the private link service on the subnet. Default valule is false. Conflicts with enforce_private_link_endpoint_network_policies.
name (pulumi.Input[str]) – The name of the subnet. 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 subnet. Changing this forces a new resource to be created.
service_endpoints (pulumi.Input[list]) – The list of Service endpoints to associate with the subnet. Possible values include: Microsoft.AzureActiveDirectory, Microsoft.AzureCosmosDB, Microsoft.ContainerRegistry, Microsoft.EventHub, Microsoft.KeyVault, Microsoft.ServiceBus, Microsoft.Sql, Microsoft.Storage and Microsoft.Web.
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.

The delegations object supports the following:

name (pulumi.Input[str]) - A name for this delegation.
serviceDelegation (pulumi.Input[dict]) - A service_delegation block as defined below.
- actions (pulumi.Input[list]) - A list of Actions which should be delegated. This list is specific to the service to delegate to. Possible values include Microsoft.Network/networkinterfaces/*, Microsoft.Network/virtualNetworks/subnets/action, Microsoft.Network/virtualNetworks/subnets/join/action, Microsoft.Network/virtualNetworks/subnets/prepareNetworkPolicies/action and Microsoft.Network/virtualNetworks/subnets/unprepareNetworkPolicies/action.
- name (pulumi.Input[str]) - The name of service to delegate to. Possible values include Microsoft.BareMetal/AzureVMware, Microsoft.BareMetal/CrayServers, Microsoft.Batch/batchAccounts, Microsoft.ContainerInstance/containerGroups, Microsoft.Databricks/workspaces, Microsoft.DBforPostgreSQL/serversv2, Microsoft.HardwareSecurityModules/dedicatedHSMs, Microsoft.Logic/integrationServiceEnvironments, Microsoft.Netapp/volumes, Microsoft.ServiceFabricMesh/networks, Microsoft.Sql/managedInstances, Microsoft.Sql/servers, Microsoft.StreamAnalytics/streamingJobs, Microsoft.Web/hostingEnvironments and Microsoft.Web/serverFarms.

address_prefix: pulumi.Output[str] = None¶: The address prefix to use for the subnet.

address_prefixes: pulumi.Output[list] = None¶: The address prefixes to use for the subnet.

delegations: pulumi.Output[list] = None¶

One or more delegation blocks as defined below.

name (str) - A name for this delegation.
serviceDelegation (dict) - A service_delegation block as defined below.
- actions (list) - A list of Actions which should be delegated. This list is specific to the service to delegate to. Possible values include Microsoft.Network/networkinterfaces/*, Microsoft.Network/virtualNetworks/subnets/action, Microsoft.Network/virtualNetworks/subnets/join/action, Microsoft.Network/virtualNetworks/subnets/prepareNetworkPolicies/action and Microsoft.Network/virtualNetworks/subnets/unprepareNetworkPolicies/action.
- name (str) - The name of service to delegate to. Possible values include Microsoft.BareMetal/AzureVMware, Microsoft.BareMetal/CrayServers, Microsoft.Batch/batchAccounts, Microsoft.ContainerInstance/containerGroups, Microsoft.Databricks/workspaces, Microsoft.DBforPostgreSQL/serversv2, Microsoft.HardwareSecurityModules/dedicatedHSMs, Microsoft.Logic/integrationServiceEnvironments, Microsoft.Netapp/volumes, Microsoft.ServiceFabricMesh/networks, Microsoft.Sql/managedInstances, Microsoft.Sql/servers, Microsoft.StreamAnalytics/streamingJobs, Microsoft.Web/hostingEnvironments and Microsoft.Web/serverFarms.

enforce_private_link_endpoint_network_policies: pulumi.Output[bool] = None¶: Enable or Disable network policies for the private link endpoint on the subnet. Default value is false. Conflicts with enforce_private_link_service_network_policies.

enforce_private_link_service_network_policies: pulumi.Output[bool] = None¶: Enable or Disable network policies for the private link service on the subnet. Default valule is false. Conflicts with enforce_private_link_endpoint_network_policies.

name: pulumi.Output[str] = None¶: The name of the subnet. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the subnet. Changing this forces a new resource to be created.

service_endpoints: pulumi.Output[list] = None¶: The list of Service endpoints to associate with the subnet. Possible values include: Microsoft.AzureActiveDirectory, Microsoft.AzureCosmosDB, Microsoft.ContainerRegistry, Microsoft.EventHub, Microsoft.KeyVault, Microsoft.ServiceBus, Microsoft.Sql, Microsoft.Storage and Microsoft.Web.

virtual_network_name: pulumi.Output[str] = None¶: The name of the virtual network to which to attach the subnet. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, address_prefix=None, address_prefixes=None, delegations=None, enforce_private_link_endpoint_network_policies=None, enforce_private_link_service_network_policies=None, name=None, resource_group_name=None, service_endpoints=None, virtual_network_name=None)¶

Get an existing Subnet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_prefix (pulumi.Input[str]) – The address prefix to use for the subnet.
address_prefixes (pulumi.Input[list]) – The address prefixes to use for the subnet.
delegations (pulumi.Input[list]) – One or more delegation blocks as defined below.
enforce_private_link_endpoint_network_policies (pulumi.Input[bool]) – Enable or Disable network policies for the private link endpoint on the subnet. Default value is false. Conflicts with enforce_private_link_service_network_policies.
enforce_private_link_service_network_policies (pulumi.Input[bool]) – Enable or Disable network policies for the private link service on the subnet. Default valule is false. Conflicts with enforce_private_link_endpoint_network_policies.
name (pulumi.Input[str]) – The name of the subnet. 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 subnet. Changing this forces a new resource to be created.
service_endpoints (pulumi.Input[list]) – The list of Service endpoints to associate with the subnet. Possible values include: Microsoft.AzureActiveDirectory, Microsoft.AzureCosmosDB, Microsoft.ContainerRegistry, Microsoft.EventHub, Microsoft.KeyVault, Microsoft.ServiceBus, Microsoft.Sql, Microsoft.Storage and Microsoft.Web.
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.

The delegations object supports the following:

name (pulumi.Input[str]) - A name for this delegation.
serviceDelegation (pulumi.Input[dict]) - A service_delegation block as defined below.
- actions (pulumi.Input[list]) - A list of Actions which should be delegated. This list is specific to the service to delegate to. Possible values include Microsoft.Network/networkinterfaces/*, Microsoft.Network/virtualNetworks/subnets/action, Microsoft.Network/virtualNetworks/subnets/join/action, Microsoft.Network/virtualNetworks/subnets/prepareNetworkPolicies/action and Microsoft.Network/virtualNetworks/subnets/unprepareNetworkPolicies/action.
- name (pulumi.Input[str]) - The name of service to delegate to. Possible values include Microsoft.BareMetal/AzureVMware, Microsoft.BareMetal/CrayServers, Microsoft.Batch/batchAccounts, Microsoft.ContainerInstance/containerGroups, Microsoft.Databricks/workspaces, Microsoft.DBforPostgreSQL/serversv2, Microsoft.HardwareSecurityModules/dedicatedHSMs, Microsoft.Logic/integrationServiceEnvironments, Microsoft.Netapp/volumes, Microsoft.ServiceFabricMesh/networks, Microsoft.Sql/managedInstances, Microsoft.Sql/servers, Microsoft.StreamAnalytics/streamingJobs, Microsoft.Web/hostingEnvironments and Microsoft.Web/serverFarms.

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.SubnetNatGatewayAssociation(resource_name, opts=None, nat_gateway_id=None, subnet_id=None, __props__=None, __name__=None, __opts__=None)¶

Associates a NAT Gateway with a Subnet within a Virtual Network.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="East US 2")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"])
example_nat_gateway = azure.network.NatGateway("exampleNatGateway",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet_nat_gateway_association = azure.network.SubnetNatGatewayAssociation("exampleSubnetNatGatewayAssociation",
    subnet_id=example_subnet.id,
    nat_gateway_id=example_nat_gateway.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
nat_gateway_id (pulumi.Input[str]) – The ID of the NAT Gateway 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.

nat_gateway_id: pulumi.Output[str] = None¶: The ID of the NAT Gateway which should be associated with the Subnet. Changing this forces a new resource to be created.

subnet_id: pulumi.Output[str] = None¶: The ID of the Subnet. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, nat_gateway_id=None, subnet_id=None)¶

Get an existing SubnetNatGatewayAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
nat_gateway_id (pulumi.Input[str]) – The ID of the NAT Gateway 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.

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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_network_security_group = azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    security_rule=[{
        "name": "test123",
        "priority": 100,
        "direction": "Inbound",
        "access": "Allow",
        "protocol": "Tcp",
        "source_port_range": "*",
        "destination_port_range": "*",
        "source_address_prefix": "*",
        "destination_address_prefix": "*",
    }])
example_subnet_network_security_group_association = azure.network.SubnetNetworkSecurityGroupAssociation("exampleSubnetNetworkSecurityGroupAssociation",
    subnet_id=example_subnet.id,
    network_security_group_id=example_network_security_group.id)

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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ID of the Subnet. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, network_security_group_id=None, subnet_id=None)¶

Get an existing SubnetNetworkSecurityGroupAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_route_table = azure.network.RouteTable("exampleRouteTable",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    route=[{
        "name": "example",
        "address_prefix": "10.100.0.0/14",
        "next_hop_type": "VirtualAppliance",
        "next_hop_in_ip_address": "10.10.1.1",
    }])
example_subnet_route_table_association = azure.network.SubnetRouteTableAssociation("exampleSubnetRouteTableAssociation",
    subnet_id=example_subnet.id,
    route_table_id=example_route_table.id)

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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ID of the Subnet. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, route_table_id=None, subnet_id=None)¶

Get an existing SubnetRouteTableAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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.TrafficManagerEndpoint(resource_name, opts=None, custom_headers=None, endpoint_location=None, endpoint_status=None, geo_mappings=None, min_child_endpoints=None, name=None, priority=None, profile_name=None, resource_group_name=None, subnets=None, target=None, target_resource_id=None, type=None, weight=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Traffic Manager Endpoint.

import pulumi
import pulumi_azure as azure
import pulumi_random as random

server = random.RandomId("server",
    keepers={
        "azi_id": 1,
    },
    byte_length=8)
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_traffic_manager_profile = azure.network.TrafficManagerProfile("exampleTrafficManagerProfile",
    resource_group_name=example_resource_group.name,
    traffic_routing_method="Weighted",
    dns_config={
        "relativeName": server.hex,
        "ttl": 100,
    },
    monitor_config={
        "protocol": "http",
        "port": 80,
        "path": "/",
        "interval_in_seconds": 30,
        "timeoutInSeconds": 9,
        "toleratedNumberOfFailures": 3,
    },
    tags={
        "environment": "Production",
    })
example_traffic_manager_endpoint = azure.network.TrafficManagerEndpoint("exampleTrafficManagerEndpoint",
    resource_group_name=example_resource_group.name,
    profile_name=example_traffic_manager_profile.name,
    type="externalEndpoints",
    weight=100)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
custom_headers (pulumi.Input[list]) – One or more custom_header blocks as defined below
endpoint_location (pulumi.Input[str]) – Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method if the Endpoint is of either type nestedEndpoints or externalEndpoints. For Endpoints of type azureEndpoints the value will be taken from the location of the Azure target resource.
endpoint_status (pulumi.Input[str]) – The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
geo_mappings (pulumi.Input[list]) – A list of Geographic Regions used to distribute traffic, such as WORLD, UK or DE. The same location can’t be specified in two endpoints. See the Geographic Hierarchies documentation for more information.
min_child_endpoints (pulumi.Input[float]) – This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
name (pulumi.Input[str]) – The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.
priority (pulumi.Input[float]) – Specifies the priority of this Endpoint, this must be specified for Profiles using the Priority traffic routing method. Supports values between 1 and 1000, with no Endpoints sharing the same value. If omitted the value will be computed in order of creation.
profile_name (pulumi.Input[str]) – The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
resource_group_name (pulumi.Input[str]) – The name of the resource group where the Traffic Manager Profile exists.
subnets (pulumi.Input[list]) – One or more subnet blocks as defined below
target (pulumi.Input[str]) – The FQDN DNS name of the target. This argument must be provided for an endpoint of type externalEndpoints, for other types it will be computed.
target_resource_id (pulumi.Input[str]) – The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
type (pulumi.Input[str]) – The Endpoint type, must be one of:

- `azureEndpoints`
- `externalEndpoints`
- `nestedEndpoints`

Parameters: weight (pulumi.Input[float]) – Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Supports values between 1 and 1000.

The custom_headers object supports the following:

name (pulumi.Input[str]) - The name of the custom header.
value (pulumi.Input[str]) - The value of custom header. Applicable for Http and Https protocol.

The subnets object supports the following:

first (pulumi.Input[str]) - The First IP….
last (pulumi.Input[str]) - The Last IP…
scope (pulumi.Input[float]) - The Scope…

custom_headers: pulumi.Output[list] = None¶

One or more custom_header blocks as defined below

name (str) - The name of the custom header.
value (str) - The value of custom header. Applicable for Http and Https protocol.

endpoint_location: pulumi.Output[str] = None¶: Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method if the Endpoint is of either type nestedEndpoints or externalEndpoints. For Endpoints of type azureEndpoints the value will be taken from the location of the Azure target resource.

endpoint_status: pulumi.Output[str] = None¶: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.

geo_mappings: pulumi.Output[list] = None¶: A list of Geographic Regions used to distribute traffic, such as WORLD, UK or DE. The same location can’t be specified in two endpoints. See the Geographic Hierarchies documentation for more information.

min_child_endpoints: pulumi.Output[float] = None¶: This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and defaults to 1.

name: pulumi.Output[str] = None¶: The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.

priority: pulumi.Output[float] = None¶: Specifies the priority of this Endpoint, this must be specified for Profiles using the Priority traffic routing method. Supports values between 1 and 1000, with no Endpoints sharing the same value. If omitted the value will be computed in order of creation.

profile_name: pulumi.Output[str] = None¶: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group where the Traffic Manager Profile exists.

subnets: pulumi.Output[list] = None¶

One or more subnet blocks as defined below

first (str) - The First IP….
last (str) - The Last IP…
scope (float) - The Scope…

target: pulumi.Output[str] = None¶: The FQDN DNS name of the target. This argument must be provided for an endpoint of type externalEndpoints, for other types it will be computed.

target_resource_id: pulumi.Output[str] = None¶: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.

type: pulumi.Output[str] = None¶

The Endpoint type, must be one of:

azureEndpoints
externalEndpoints
nestedEndpoints

weight: pulumi.Output[float] = None¶: Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Supports values between 1 and 1000.

static get(resource_name, id, opts=None, custom_headers=None, endpoint_location=None, endpoint_monitor_status=None, endpoint_status=None, geo_mappings=None, min_child_endpoints=None, name=None, priority=None, profile_name=None, resource_group_name=None, subnets=None, target=None, target_resource_id=None, type=None, weight=None)¶

Get an existing TrafficManagerEndpoint resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
custom_headers (pulumi.Input[list]) – One or more custom_header blocks as defined below
endpoint_location (pulumi.Input[str]) – Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method if the Endpoint is of either type nestedEndpoints or externalEndpoints. For Endpoints of type azureEndpoints the value will be taken from the location of the Azure target resource.
endpoint_status (pulumi.Input[str]) – The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
geo_mappings (pulumi.Input[list]) –
A list of Geographic Regions used to distribute traffic, such as WORLD, UK or DE. The same location can’t be specified in two endpoints. See the Geographic Hierarchies documentation for more information.
min_child_endpoints (pulumi.Input[float]) – This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
name (pulumi.Input[str]) – The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.
priority (pulumi.Input[float]) – Specifies the priority of this Endpoint, this must be specified for Profiles using the Priority traffic routing method. Supports values between 1 and 1000, with no Endpoints sharing the same value. If omitted the value will be computed in order of creation.
profile_name (pulumi.Input[str]) – The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
resource_group_name (pulumi.Input[str]) – The name of the resource group where the Traffic Manager Profile exists.
subnets (pulumi.Input[list]) – One or more subnet blocks as defined below
target (pulumi.Input[str]) – The FQDN DNS name of the target. This argument must be provided for an endpoint of type externalEndpoints, for other types it will be computed.
target_resource_id (pulumi.Input[str]) – The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
type (pulumi.Input[str]) – The Endpoint type, must be one of:

- `azureEndpoints`
- `externalEndpoints`
- `nestedEndpoints`

Parameters: weight (pulumi.Input[float]) – Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Supports values between 1 and 1000.

The custom_headers object supports the following:

name (pulumi.Input[str]) - The name of the custom header.
value (pulumi.Input[str]) - The value of custom header. Applicable for Http and Https protocol.

The subnets object supports the following:

first (pulumi.Input[str]) - The First IP….
last (pulumi.Input[str]) - The Last IP…
scope (pulumi.Input[float]) - The Scope…

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.TrafficManagerProfile(resource_name, opts=None, dns_config=None, monitor_config=None, name=None, profile_status=None, resource_group_name=None, tags=None, traffic_routing_method=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Traffic Manager Profile to which multiple endpoints can be attached.

import pulumi
import pulumi_azure as azure
import pulumi_random as random

server = random.RandomId("server",
    keepers={
        "azi_id": 1,
    },
    byte_length=8)
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_traffic_manager_profile = azure.network.TrafficManagerProfile("exampleTrafficManagerProfile",
    resource_group_name=example_resource_group.name,
    traffic_routing_method="Weighted",
    dns_config={
        "relativeName": server.hex,
        "ttl": 100,
    },
    monitor_config={
        "protocol": "http",
        "port": 80,
        "path": "/",
        "interval_in_seconds": 30,
        "timeoutInSeconds": 9,
        "toleratedNumberOfFailures": 3,
    },
    tags={
        "environment": "Production",
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
dns_config (pulumi.Input[dict]) – This block specifies the DNS configuration of the Profile, it supports the fields documented below.
monitor_config (pulumi.Input[dict]) – This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
name (pulumi.Input[str]) – The name of the Traffic Manager profile. Changing this forces a new resource to be created.
profile_status (pulumi.Input[str]) – The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Traffic Manager profile.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
traffic_routing_method (pulumi.Input[str]) – Specifies the algorithm used to route traffic, possible values are:

The dns_config object supports the following:

relativeName (pulumi.Input[str]) - The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.
ttl (pulumi.Input[float]) - The TTL value of the Profile used by Local DNS resolvers and clients.

The monitor_config object supports the following:

custom_headers (pulumi.Input[list]) - One or more custom_header blocks as defined below.
- name (pulumi.Input[str]) - The name of the custom header.
- value (pulumi.Input[str]) - The value of custom header. Applicable for Http and Https protocol.
expectedStatusCodeRanges (pulumi.Input[list]) - A list of status code ranges in the format of 100-101.
interval_in_seconds (pulumi.Input[float]) - The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.
path (pulumi.Input[str]) - The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.
port (pulumi.Input[float]) - The port number used by the monitoring checks.
protocol (pulumi.Input[str]) - The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.
timeoutInSeconds (pulumi.Input[float]) - The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If interval_in_seconds is set to 30, then timeout_in_seconds can be between 5 and 10. The default value is 10. If interval_in_seconds is set to 10, then valid values are between 5 and 9 and timeout_in_seconds is required.
toleratedNumberOfFailures (pulumi.Input[float]) - The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

dns_config: pulumi.Output[dict] = None¶

This block specifies the DNS configuration of the Profile, it supports the fields documented below.

relativeName (str) - The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.
ttl (float) - The TTL value of the Profile used by Local DNS resolvers and clients.

fqdn: pulumi.Output[str] = None¶: The FQDN of the created Profile.

monitor_config: pulumi.Output[dict] = None¶

This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.

custom_headers (list) - One or more custom_header blocks as defined below.
- name (str) - The name of the custom header.
- value (str) - The value of custom header. Applicable for Http and Https protocol.
expectedStatusCodeRanges (list) - A list of status code ranges in the format of 100-101.
interval_in_seconds (float) - The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.
path (str) - The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.
port (float) - The port number used by the monitoring checks.
protocol (str) - The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.
timeoutInSeconds (float) - The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If interval_in_seconds is set to 30, then timeout_in_seconds can be between 5 and 10. The default value is 10. If interval_in_seconds is set to 10, then valid values are between 5 and 9 and timeout_in_seconds is required.
toleratedNumberOfFailures (float) - The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

name: pulumi.Output[str] = None¶: The name of the Traffic Manager profile. Changing this forces a new resource to be created.

profile_status: pulumi.Output[str] = None¶: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Traffic Manager profile.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

traffic_routing_method: pulumi.Output[str] = None¶: Specifies the algorithm used to route traffic, possible values are:

static get(resource_name, id, opts=None, dns_config=None, fqdn=None, monitor_config=None, name=None, profile_status=None, resource_group_name=None, tags=None, traffic_routing_method=None)¶

Get an existing TrafficManagerProfile resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
dns_config (pulumi.Input[dict]) – This block specifies the DNS configuration of the Profile, it supports the fields documented below.
fqdn (pulumi.Input[str]) – The FQDN of the created Profile.
monitor_config (pulumi.Input[dict]) – This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
name (pulumi.Input[str]) – The name of the Traffic Manager profile. Changing this forces a new resource to be created.
profile_status (pulumi.Input[str]) – The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Traffic Manager profile.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
traffic_routing_method (pulumi.Input[str]) – Specifies the algorithm used to route traffic, possible values are:

The dns_config object supports the following:

relativeName (pulumi.Input[str]) - The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.
ttl (pulumi.Input[float]) - The TTL value of the Profile used by Local DNS resolvers and clients.

The monitor_config object supports the following:

custom_headers (pulumi.Input[list]) - One or more custom_header blocks as defined below.
- name (pulumi.Input[str]) - The name of the custom header.
- value (pulumi.Input[str]) - The value of custom header. Applicable for Http and Https protocol.
expectedStatusCodeRanges (pulumi.Input[list]) - A list of status code ranges in the format of 100-101.
interval_in_seconds (pulumi.Input[float]) - The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.
path (pulumi.Input[str]) - The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.
port (pulumi.Input[float]) - The port number used by the monitoring checks.
protocol (pulumi.Input[str]) - The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.
timeoutInSeconds (pulumi.Input[float]) - The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If interval_in_seconds is set to 30, then timeout_in_seconds can be between 5 and 10. The default value is 10. If interval_in_seconds is set to 10, then valid values are between 5 and 9 and timeout_in_seconds is required.
toleratedNumberOfFailures (pulumi.Input[float]) - The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

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.VirtualHub(resource_name, opts=None, address_prefix=None, location=None, name=None, resource_group_name=None, routes=None, tags=None, virtual_wan_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Virtual Hub within a Virtual WAN.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_wan = azure.network.VirtualWan("exampleVirtualWan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_virtual_hub = azure.network.VirtualHub("exampleVirtualHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.1.0/24")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_prefix (pulumi.Input[str]) – The Address Prefix which should be used for this Virtual Hub.
location (pulumi.Input[str]) – Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the Virtual Hub. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
routes (pulumi.Input[list]) – One or more route blocks as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the Virtual Hub.
virtual_wan_id (pulumi.Input[str]) – The ID of a Virtual WAN within which the Virtual Hub should be created.

The routes object supports the following:

address_prefixes (pulumi.Input[list]) - A list of Address Prefixes.
nextHopIpAddress (pulumi.Input[str]) - The IP Address that Packets should be forwarded to as the Next Hop.

address_prefix: pulumi.Output[str] = None¶: The Address Prefix which should be used for this Virtual Hub.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the Virtual Hub. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.

routes: pulumi.Output[list] = None¶

One or more route blocks as defined below.

address_prefixes (list) - A list of Address Prefixes.
nextHopIpAddress (str) - The IP Address that Packets should be forwarded to as the Next Hop.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the Virtual Hub.

virtual_wan_id: pulumi.Output[str] = None¶: The ID of a Virtual WAN within which the Virtual Hub should be created.

static get(resource_name, id, opts=None, address_prefix=None, location=None, name=None, resource_group_name=None, routes=None, tags=None, virtual_wan_id=None)¶

Get an existing VirtualHub resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_prefix (pulumi.Input[str]) – The Address Prefix which should be used for this Virtual Hub.
location (pulumi.Input[str]) – Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the Virtual Hub. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
routes (pulumi.Input[list]) – One or more route blocks as defined below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the Virtual Hub.
virtual_wan_id (pulumi.Input[str]) – The ID of a Virtual WAN within which the Virtual Hub should be created.

The routes object supports the following:

address_prefixes (pulumi.Input[list]) - A list of Address Prefixes.
nextHopIpAddress (pulumi.Input[str]) - The IP Address that Packets should be forwarded to as the Next Hop.

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.VirtualHubConnection(resource_name, opts=None, hub_to_vitual_network_traffic_allowed=None, internet_security_enabled=None, name=None, remote_virtual_network_id=None, virtual_hub_id=None, vitual_network_to_hub_gateways_traffic_allowed=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Connection for a Virtual Hub.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["172.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
test = azure.network.VirtualWan("test",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_virtual_hub = azure.network.VirtualHub("exampleVirtualHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_wan_id=azurerm_virtual_wan["example"]["id"],
    address_prefix="10.0.1.0/24")
example_virtual_hub_connection = azure.network.VirtualHubConnection("exampleVirtualHubConnection",
    virtual_hub_id=example_virtual_hub.id,
    remote_virtual_network_id=example_virtual_network.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
hub_to_vitual_network_traffic_allowed (pulumi.Input[bool]) – Is the Virtual Hub traffic allowed to transit via the Remote Virtual Network? Changing this forces a new resource to be created.
internet_security_enabled (pulumi.Input[bool]) – Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The Name which should be used for this Connection, which must be unique within the Virtual Hub. Changing this forces a new resource to be created.
remote_virtual_network_id (pulumi.Input[str]) – The ID of the Virtual Network which the Virtual Hub should be connected to. Changing this forces a new resource to be created.
virtual_hub_id (pulumi.Input[str]) – The ID of the Virtual Hub within which this connection should be created. Changing this forces a new resource to be created.
vitual_network_to_hub_gateways_traffic_allowed (pulumi.Input[bool]) – Is Remote Virtual Network traffic allowed to transit the Hub’s Virtual Network Gateway’s? Changing this forces a new resource to be created.

hub_to_vitual_network_traffic_allowed: pulumi.Output[bool] = None¶: Is the Virtual Hub traffic allowed to transit via the Remote Virtual Network? Changing this forces a new resource to be created.

internet_security_enabled: pulumi.Output[bool] = None¶: Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The Name which should be used for this Connection, which must be unique within the Virtual Hub. Changing this forces a new resource to be created.

remote_virtual_network_id: pulumi.Output[str] = None¶: The ID of the Virtual Network which the Virtual Hub should be connected to. Changing this forces a new resource to be created.

virtual_hub_id: pulumi.Output[str] = None¶: The ID of the Virtual Hub within which this connection should be created. Changing this forces a new resource to be created.

vitual_network_to_hub_gateways_traffic_allowed: pulumi.Output[bool] = None¶: Is Remote Virtual Network traffic allowed to transit the Hub’s Virtual Network Gateway’s? Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, hub_to_vitual_network_traffic_allowed=None, internet_security_enabled=None, name=None, remote_virtual_network_id=None, virtual_hub_id=None, vitual_network_to_hub_gateways_traffic_allowed=None)¶

Get an existing VirtualHubConnection resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
hub_to_vitual_network_traffic_allowed (pulumi.Input[bool]) – Is the Virtual Hub traffic allowed to transit via the Remote Virtual Network? Changing this forces a new resource to be created.
internet_security_enabled (pulumi.Input[bool]) – Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The Name which should be used for this Connection, which must be unique within the Virtual Hub. Changing this forces a new resource to be created.
remote_virtual_network_id (pulumi.Input[str]) – The ID of the Virtual Network which the Virtual Hub should be connected to. Changing this forces a new resource to be created.
virtual_hub_id (pulumi.Input[str]) – The ID of the Virtual Hub within which this connection should be created. Changing this forces a new resource to be created.
vitual_network_to_hub_gateways_traffic_allowed (pulumi.Input[bool]) – Is Remote Virtual Network traffic allowed to transit the Hub’s Virtual Network Gateway’s? 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, __props__=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: This provider 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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_network_security_group = azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_ddos_protection_plan = azure.network.DdosProtectionPlan("exampleDdosProtectionPlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.0.0.0/16"],
    dns_servers=[
        "10.0.0.4",
        "10.0.0.5",
    ],
    ddos_protection_plan={
        "id": example_ddos_protection_plan.id,
        "enable": True,
    },
    subnet=[
        {
            "name": "subnet1",
            "address_prefix": "10.0.1.0/24",
        },
        {
            "name": "subnet2",
            "address_prefix": "10.0.2.0/24",
        },
        {
            "name": "subnet3",
            "address_prefix": "10.0.3.0/24",
            "securityGroup": example_network_security_group.id,
        },
    ],
    tags={
        "environment": "Production",
    })

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.

The ddos_protection_plan object supports the following:

enable (pulumi.Input[bool]) - Enable/disable DDoS Protection Plan on Virtual Network.
id (pulumi.Input[str]) - The Resource ID of DDoS Protection Plan.

The subnets object supports the following:

address_prefix (pulumi.Input[str]) - The address prefix to use for the subnet.
id (pulumi.Input[str]) - The Resource ID of DDoS Protection Plan.
name (pulumi.Input[str]) - The name of the virtual network. Changing this forces a new resource to be created.
securityGroup (pulumi.Input[str]) - The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)

address_spaces: pulumi.Output[list] = 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: pulumi.Output[dict] = None¶

A ddos_protection_plan block as documented below.

enable (bool) - Enable/disable DDoS Protection Plan on Virtual Network.
id (str) - The Resource ID of DDoS Protection Plan.

dns_servers: pulumi.Output[list] = None¶: List of IP addresses of DNS servers

guid: pulumi.Output[str] = None¶: The GUID of the virtual network.

location: pulumi.Output[str] = None¶: The location/region where the virtual network is created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the virtual network. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the virtual network.

subnets: pulumi.Output[list] = None¶

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

address_prefix (str) - The address prefix to use for the subnet.
id (str) - The Resource ID of DDoS Protection Plan.
name (str) - The name of the virtual network. Changing this forces a new resource to be created.
securityGroup (str) - The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, address_spaces=None, ddos_protection_plan=None, dns_servers=None, guid=None, location=None, name=None, resource_group_name=None, subnets=None, tags=None)¶

Get an existing VirtualNetwork resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
guid (pulumi.Input[str]) – The GUID of the virtual network.
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.

The ddos_protection_plan object supports the following:

enable (pulumi.Input[bool]) - Enable/disable DDoS Protection Plan on Virtual Network.
id (pulumi.Input[str]) - The Resource ID of DDoS Protection Plan.

The subnets object supports the following:

address_prefix (pulumi.Input[str]) - The address prefix to use for the subnet.
id (pulumi.Input[str]) - The Resource ID of DDoS Protection Plan.
name (pulumi.Input[str]) - The name of the virtual network. Changing this forces a new resource to be created.
securityGroup (pulumi.Input[str]) - The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)

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, generation=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, __props__=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)

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Dynamic")
example_virtual_network_gateway = azure.network.VirtualNetworkGateway("exampleVirtualNetworkGateway",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    type="Vpn",
    vpn_type="RouteBased",
    active_active=False,
    enable_bgp=False,
    sku="Basic",
    ip_configuration=[{
        "name": "vnetGatewayConfig",
        "public_ip_address_id": example_public_ip.id,
        "privateIpAddressAllocation": "Dynamic",
        "subnet_id": example_subnet.id,
    }],
    vpn_client_configuration={
        "address_spaces": ["10.2.0.0/24"],
        "root_certificate": [{
            "name": "DigiCert-Federated-ID-Root-CA",
            "publicCertData": """MIIDuzCCAqOgAwIBAgIQCHTZWCM+IlfFIRXIvyKSrjANBgkqhkiG9w0BAQsFADBn
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
d3cuZGlnaWNlcnQuY29tMSYwJAYDVQQDEx1EaWdpQ2VydCBGZWRlcmF0ZWQgSUQg
Um9vdCBDQTAeFw0xMzAxMTUxMjAwMDBaFw0zMzAxMTUxMjAwMDBaMGcxCzAJBgNV
BAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdp
Y2VydC5jb20xJjAkBgNVBAMTHURpZ2lDZXJ0IEZlZGVyYXRlZCBJRCBSb290IENB
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvAEB4pcCqnNNOWE6Ur5j
QPUH+1y1F9KdHTRSza6k5iDlXq1kGS1qAkuKtw9JsiNRrjltmFnzMZRBbX8Tlfl8
zAhBmb6dDduDGED01kBsTkgywYPxXVTKec0WxYEEF0oMn4wSYNl0lt2eJAKHXjNf
GTwiibdP8CUR2ghSM2sUTI8Nt1Omfc4SMHhGhYD64uJMbX98THQ/4LMGuYegou+d
GTiahfHtjn7AboSEknwAMJHCh5RlYZZ6B1O4QbKJ+34Q0eKgnI3X6Vc9u0zf6DH8
Dk+4zQDYRRTqTnVO3VT8jzqDlCRuNtq6YvryOWN74/dq8LQhUnXHvFyrsdMaE1X2
DwIDAQABo2MwYTAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBhjAdBgNV
HQ4EFgQUGRdkFnbGt1EWjKwbUne+5OaZvRYwHwYDVR0jBBgwFoAUGRdkFnbGt1EW
jKwbUne+5OaZvRYwDQYJKoZIhvcNAQELBQADggEBAHcqsHkrjpESqfuVTRiptJfP
9JbdtWqRTmOf6uJi2c8YVqI6XlKXsD8C1dUUaaHKLUJzvKiazibVuBwMIT84AyqR
QELn3e0BtgEymEygMU569b01ZPxoFSnNXc7qDZBDef8WfqAV/sxkTi8L9BkmFYfL
uGLOhRJOFprPdoDIUBB+tmCl3oDcBy3vnUeOEioz8zAkprcb3GHwHAK+vHmmfgcn
WsfMLH4JCLa/tRYL+Rw/N3ybCkDp00s0WUZ+AoDywSl0Q/ZEnNY0MsFiw6LyIdbq
M/s/1JRtO3bDSzD9TazRVzn2oBqzSa8VgIo5C1nOnoAKJTlsClJKvIhnRlaLQqk=
""",
        }],
        "revoked_certificate": [{
            "name": "Verizon-Global-Root-CA",
            "thumbprint": "912198EEF23DCAC40939312FEE97DD560BAE49B1",
        }],
    })

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 tunnelling). Refer to the Azure documentation on forced tunnelling. If not specified, forced tunnelling is disabled.
enable_bgp (pulumi.Input[bool]) – If true, BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway. Defaults to false.
generation (pulumi.Input[str]) – The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None.
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]) – A user-defined name of the revoked certificate.
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, VpnGw3, VpnGw4,VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ,VpnGw4AZ and VpnGw5AZ and depend on the type, vpn_type and generation 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.

The bgp_settings object supports the following:

asn (pulumi.Input[float]) - The Autonomous System Number (ASN) to use as part of the BGP.
peerWeight (pulumi.Input[float]) - The weight added to routes which have been learned through BGP peering. Valid values can be between 0 and 100.
peeringAddress (pulumi.Input[str]) - The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices. The IP address must be part of the subnet of the Virtual Network Gateway. Changing this forces a new resource to be created.

The ip_configurations object supports the following:

name (pulumi.Input[str]) - A user-defined name of the revoked certificate.
privateIpAddressAllocation (pulumi.Input[str]) - Defines how the private IP address of the gateways virtual interface is assigned. Valid options are Static or Dynamic. Defaults to Dynamic.
public_ip_address_id (pulumi.Input[str]) - The ID of the public ip address to associate with the Virtual Network Gateway.
subnet_id (pulumi.Input[str]) - The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

The vpn_client_configuration object supports the following:

address_spaces (pulumi.Input[list]) - The address space out of which ip addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
radiusServerAddress (pulumi.Input[str]) - The address of the Radius server. This setting is incompatible with the use of root_certificate and revoked_certificate.
radiusServerSecret (pulumi.Input[str]) - The secret used by the Radius server. This setting is incompatible with the use of root_certificate and revoked_certificate.
revokedCertificates (pulumi.Input[list]) - One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of radius_server_address and radius_server_secret.
- name (pulumi.Input[str]) - A user-defined name of the revoked certificate.
- thumbprint (pulumi.Input[str])
rootCertificates (pulumi.Input[list]) - One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of radius_server_address and radius_server_secret.
- name (pulumi.Input[str]) - A user-defined name of the revoked certificate.
- publicCertData (pulumi.Input[str]) - The SHA1 thumbprint of the certificate to be revoked.
vpnClientProtocols (pulumi.Input[list]) - List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

active_active: pulumi.Output[bool] = 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: pulumi.Output[str] = 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 tunnelling). Refer to the Azure documentation on forced tunnelling. If not specified, forced tunnelling is disabled.

enable_bgp: pulumi.Output[bool] = None¶: If true, BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway. Defaults to false.

generation: pulumi.Output[str] = None¶: The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None.

ip_configurations: pulumi.Output[list] = 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.

name (str) - A user-defined name of the revoked certificate.
privateIpAddressAllocation (str) - Defines how the private IP address of the gateways virtual interface is assigned. Valid options are Static or Dynamic. Defaults to Dynamic.
public_ip_address_id (str) - The ID of the public ip address to associate with the Virtual Network Gateway.
subnet_id (str) - The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

location: pulumi.Output[str] = None¶: The location/region where the Virtual Network Gateway is located. Changing the location/region forces a new resource to be created.

name: pulumi.Output[str] = None¶: A user-defined name of the revoked certificate.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: Configuration of the size and capacity of the virtual network gateway. Valid options are Basic, Standard, HighPerformance, UltraPerformance, ErGw1AZ, ErGw2AZ, ErGw3AZ, VpnGw1, VpnGw2, VpnGw3, VpnGw4,VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ,VpnGw4AZ and VpnGw5AZ and depend on the type, vpn_type and generation arguments. A PolicyBased gateway only supports the Basic sku. Further, the UltraPerformance sku is only supported by an ExpressRoute gateway.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

type: pulumi.Output[str] = 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: pulumi.Output[dict] = 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.

address_spaces (list) - The address space out of which ip addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
radiusServerAddress (str) - The address of the Radius server. This setting is incompatible with the use of root_certificate and revoked_certificate.
radiusServerSecret (str) - The secret used by the Radius server. This setting is incompatible with the use of root_certificate and revoked_certificate.
revokedCertificates (list) - One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of radius_server_address and radius_server_secret.
- name (str) - A user-defined name of the revoked certificate.
- thumbprint (str)
rootCertificates (list) - One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of radius_server_address and radius_server_secret.
- name (str) - A user-defined name of the revoked certificate.
- publicCertData (str) - The SHA1 thumbprint of the certificate to be revoked.
vpnClientProtocols (list) - List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

vpn_type: pulumi.Output[str] = None¶: The routing type of the Virtual Network Gateway. Valid options are RouteBased or PolicyBased. Defaults to RouteBased.

static get(resource_name, id, opts=None, active_active=None, bgp_settings=None, default_local_network_gateway_id=None, enable_bgp=None, generation=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)¶

Get an existing VirtualNetworkGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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 tunnelling). Refer to the Azure documentation on forced tunnelling. If not specified, forced tunnelling is disabled.
enable_bgp (pulumi.Input[bool]) – If true, BGP (Border Gateway Protocol) will be enabled for this Virtual Network Gateway. Defaults to false.
generation (pulumi.Input[str]) – The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None.
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]) – A user-defined name of the revoked certificate.
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, VpnGw3, VpnGw4,VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ,VpnGw4AZ and VpnGw5AZ and depend on the type, vpn_type and generation 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.

The bgp_settings object supports the following:

asn (pulumi.Input[float]) - The Autonomous System Number (ASN) to use as part of the BGP.
peerWeight (pulumi.Input[float]) - The weight added to routes which have been learned through BGP peering. Valid values can be between 0 and 100.
peeringAddress (pulumi.Input[str]) - The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices. The IP address must be part of the subnet of the Virtual Network Gateway. Changing this forces a new resource to be created.

The ip_configurations object supports the following:

name (pulumi.Input[str]) - A user-defined name of the revoked certificate.
privateIpAddressAllocation (pulumi.Input[str]) - Defines how the private IP address of the gateways virtual interface is assigned. Valid options are Static or Dynamic. Defaults to Dynamic.
public_ip_address_id (pulumi.Input[str]) - The ID of the public ip address to associate with the Virtual Network Gateway.
subnet_id (pulumi.Input[str]) - The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

The vpn_client_configuration object supports the following:

address_spaces (pulumi.Input[list]) - The address space out of which ip addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.
radiusServerAddress (pulumi.Input[str]) - The address of the Radius server. This setting is incompatible with the use of root_certificate and revoked_certificate.
radiusServerSecret (pulumi.Input[str]) - The secret used by the Radius server. This setting is incompatible with the use of root_certificate and revoked_certificate.
revokedCertificates (pulumi.Input[list]) - One or more revoked_certificate blocks which are defined below. This setting is incompatible with the use of radius_server_address and radius_server_secret.
- name (pulumi.Input[str]) - A user-defined name of the revoked certificate.
- thumbprint (pulumi.Input[str])
rootCertificates (pulumi.Input[list]) - One or more root_certificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of radius_server_address and radius_server_secret.
- name (pulumi.Input[str]) - A user-defined name of the revoked certificate.
- publicCertData (pulumi.Input[str]) - The SHA1 thumbprint of the certificate to be revoked.
vpnClientProtocols (pulumi.Input[list]) - List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

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, connection_protocol=None, enable_bgp=None, express_route_circuit_id=None, express_route_gateway_bypass=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, __props__=None, __name__=None, __opts__=None)¶

Manages a connection in an existing Virtual Network Gateway.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.0.0.0/16"])
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
onpremise_local_network_gateway = azure.network.LocalNetworkGateway("onpremiseLocalNetworkGateway",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    gateway_address="168.62.225.23",
    address_spaces=["10.1.1.0/24"])
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Dynamic")
example_virtual_network_gateway = azure.network.VirtualNetworkGateway("exampleVirtualNetworkGateway",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    type="Vpn",
    vpn_type="RouteBased",
    active_active=False,
    enable_bgp=False,
    sku="Basic",
    ip_configuration=[{
        "public_ip_address_id": example_public_ip.id,
        "privateIpAddressAllocation": "Dynamic",
        "subnet_id": example_subnet.id,
    }])
onpremise_virtual_network_gateway_connection = azure.network.VirtualNetworkGatewayConnection("onpremiseVirtualNetworkGatewayConnection",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    type="IPsec",
    virtual_network_gateway_id=example_virtual_network_gateway.id,
    local_network_gateway_id=onpremise_local_network_gateway.id,
    shared_key="4-v3ry-53cr37-1p53c-5h4r3d-k3y")

import pulumi
import pulumi_azure as azure

us_resource_group = azure.core.ResourceGroup("usResourceGroup", location="East US")
us_virtual_network = azure.network.VirtualNetwork("usVirtualNetwork",
    location=us_resource_group.location,
    resource_group_name=us_resource_group.name,
    address_spaces=["10.0.0.0/16"])
us_gateway = azure.network.Subnet("usGateway",
    resource_group_name=us_resource_group.name,
    virtual_network_name=us_virtual_network.name,
    address_prefix="10.0.1.0/24")
us_public_ip = azure.network.PublicIp("usPublicIp",
    location=us_resource_group.location,
    resource_group_name=us_resource_group.name,
    allocation_method="Dynamic")
us_virtual_network_gateway = azure.network.VirtualNetworkGateway("usVirtualNetworkGateway",
    location=us_resource_group.location,
    resource_group_name=us_resource_group.name,
    type="Vpn",
    vpn_type="RouteBased",
    sku="Basic",
    ip_configuration=[{
        "public_ip_address_id": us_public_ip.id,
        "privateIpAddressAllocation": "Dynamic",
        "subnet_id": us_gateway.id,
    }])
europe_resource_group = azure.core.ResourceGroup("europeResourceGroup", location="West Europe")
europe_virtual_network = azure.network.VirtualNetwork("europeVirtualNetwork",
    location=europe_resource_group.location,
    resource_group_name=europe_resource_group.name,
    address_spaces=["10.1.0.0/16"])
europe_gateway = azure.network.Subnet("europeGateway",
    resource_group_name=europe_resource_group.name,
    virtual_network_name=europe_virtual_network.name,
    address_prefix="10.1.1.0/24")
europe_public_ip = azure.network.PublicIp("europePublicIp",
    location=europe_resource_group.location,
    resource_group_name=europe_resource_group.name,
    allocation_method="Dynamic")
europe_virtual_network_gateway = azure.network.VirtualNetworkGateway("europeVirtualNetworkGateway",
    location=europe_resource_group.location,
    resource_group_name=europe_resource_group.name,
    type="Vpn",
    vpn_type="RouteBased",
    sku="Basic",
    ip_configuration=[{
        "public_ip_address_id": europe_public_ip.id,
        "privateIpAddressAllocation": "Dynamic",
        "subnet_id": europe_gateway.id,
    }])
us_to_europe = azure.network.VirtualNetworkGatewayConnection("usToEurope",
    location=us_resource_group.location,
    resource_group_name=us_resource_group.name,
    type="Vnet2Vnet",
    virtual_network_gateway_id=us_virtual_network_gateway.id,
    peer_virtual_network_gateway_id=europe_virtual_network_gateway.id,
    shared_key="4-v3ry-53cr37-1p53c-5h4r3d-k3y")
europe_to_us = azure.network.VirtualNetworkGatewayConnection("europeToUs",
    location=europe_resource_group.location,
    resource_group_name=europe_resource_group.name,
    type="Vnet2Vnet",
    virtual_network_gateway_id=europe_virtual_network_gateway.id,
    peer_virtual_network_gateway_id=us_virtual_network_gateway.id,
    shared_key="4-v3ry-53cr37-1p53c-5h4r3d-k3y")

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.
connection_protocol (pulumi.Input[str]) – The IKE protocol version to use. Possible values are IKEv1 and IKEv2. Defaults to IKEv2. Changing this value will force a resource to be created.

> **Note**: Only valid for `IPSec` connections on virtual network gateways with SKU `VpnGw1`, `VpnGw2`, `VpnGw3`, `VpnGw1AZ`, `VpnGw2AZ` or `VpnGw3AZ`.

Parameters

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.
express_route_gateway_bypass (pulumi.Input[bool]) – If true, data packets will bypass ExpressRoute Gateway for data forwarding This is only valid for ExpressRoute connections.
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 could be provided if a Site-to-Site, VNet-to-VNet or ExpressRoute connection is created.
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.

The ipsec_policy object supports the following:

dhGroup (pulumi.Input[str]) - The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.
ikeEncryption (pulumi.Input[str]) - The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.
ikeIntegrity (pulumi.Input[str]) - The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.
ipsecEncryption (pulumi.Input[str]) - The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.
ipsecIntegrity (pulumi.Input[str]) - The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.
pfsGroup (pulumi.Input[str]) - The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.
saDatasize (pulumi.Input[float]) - The IPSec SA payload size in KB. Must be at least 1024 KB. Defaults to 102400000 KB.
saLifetime (pulumi.Input[float]) - The IPSec SA lifetime in seconds. Must be at least 300 seconds. Defaults to 27000 seconds.

authorization_key: pulumi.Output[str] = None¶: The authorization key associated with the Express Route Circuit. This field is required only if the type is an ExpressRoute connection.

connection_protocol: pulumi.Output[str] = None¶: The IKE protocol version to use. Possible values are IKEv1 and IKEv2. Defaults to IKEv2. Changing this value will force a resource to be created.
Note: Only valid for IPSec connections on virtual network gateways with SKU VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ or VpnGw3AZ.

enable_bgp: pulumi.Output[bool] = None¶: If true, BGP (Border Gateway Protocol) is enabled for this connection. Defaults to false.

express_route_circuit_id: pulumi.Output[str] = 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.

express_route_gateway_bypass: pulumi.Output[bool] = None¶: If true, data packets will bypass ExpressRoute Gateway for data forwarding This is only valid for ExpressRoute connections.

ipsec_policy: pulumi.Output[dict] = 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.

dhGroup (str) - The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.
ikeEncryption (str) - The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.
ikeIntegrity (str) - The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.
ipsecEncryption (str) - The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.
ipsecIntegrity (str) - The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.
pfsGroup (str) - The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.
saDatasize (float) - The IPSec SA payload size in KB. Must be at least 1024 KB. Defaults to 102400000 KB.
saLifetime (float) - The IPSec SA lifetime in seconds. Must be at least 300 seconds. Defaults to 27000 seconds.

local_network_gateway_id: pulumi.Output[str] = None¶: The ID of the local network gateway when creating Site-to-Site connection (i.e. when type is IPsec).

location: pulumi.Output[str] = None¶: The location/region where the connection is located. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the connection. Changing the name forces a new resource to be created.

peer_virtual_network_gateway_id: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[float] = None¶: The routing weight. Defaults to 10.

shared_key: pulumi.Output[str] = None¶: The shared IPSec key. A key could be provided if a Site-to-Site, VNet-to-VNet or ExpressRoute connection is created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

type: pulumi.Output[str] = 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: pulumi.Output[bool] = 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: pulumi.Output[str] = 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.

static get(resource_name, id, opts=None, authorization_key=None, connection_protocol=None, enable_bgp=None, express_route_circuit_id=None, express_route_gateway_bypass=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)¶

Get an existing VirtualNetworkGatewayConnection resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
connection_protocol (pulumi.Input[str]) – The IKE protocol version to use. Possible values are IKEv1 and IKEv2. Defaults to IKEv2. Changing this value will force a resource to be created.

> **Note**: Only valid for `IPSec` connections on virtual network gateways with SKU `VpnGw1`, `VpnGw2`, `VpnGw3`, `VpnGw1AZ`, `VpnGw2AZ` or `VpnGw3AZ`.

Parameters

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.
express_route_gateway_bypass (pulumi.Input[bool]) – If true, data packets will bypass ExpressRoute Gateway for data forwarding This is only valid for ExpressRoute connections.
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 could be provided if a Site-to-Site, VNet-to-VNet or ExpressRoute connection is created.
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.

The ipsec_policy object supports the following:

dhGroup (pulumi.Input[str]) - The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.
ikeEncryption (pulumi.Input[str]) - The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.
ikeIntegrity (pulumi.Input[str]) - The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.
ipsecEncryption (pulumi.Input[str]) - The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.
ipsecIntegrity (pulumi.Input[str]) - The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.
pfsGroup (pulumi.Input[str]) - The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.
saDatasize (pulumi.Input[float]) - The IPSec SA payload size in KB. Must be at least 1024 KB. Defaults to 102400000 KB.
saLifetime (pulumi.Input[float]) - The IPSec SA lifetime in seconds. Must be at least 300 seconds. Defaults to 27000 seconds.

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, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West US")
example_1_virtual_network = azure.network.VirtualNetwork("example-1VirtualNetwork",
    resource_group_name=example.name,
    address_spaces=["10.0.1.0/24"],
    location="West US")
example_2_virtual_network = azure.network.VirtualNetwork("example-2VirtualNetwork",
    resource_group_name=example.name,
    address_spaces=["10.0.2.0/24"],
    location="West US")
example_1_virtual_network_peering = azure.network.VirtualNetworkPeering("example-1VirtualNetworkPeering",
    resource_group_name=example.name,
    virtual_network_name=example_1_virtual_network.name,
    remote_virtual_network_id=example_2_virtual_network.id)
example_2_virtual_network_peering = azure.network.VirtualNetworkPeering("example-2VirtualNetworkPeering",
    resource_group_name=example.name,
    virtual_network_name=example_2_virtual_network.name,
    remote_virtual_network_id=example_1_virtual_network.id)

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 true.
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 peering. 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: pulumi.Output[bool] = None¶: Controls if forwarded traffic from VMs in the remote virtual network is allowed. Defaults to false.

allow_gateway_transit: pulumi.Output[bool] = None¶: Controls gatewayLinks can be used in the remote virtual network’s link to the local virtual network.

allow_virtual_network_access: pulumi.Output[bool] = None¶: Controls if the VMs in the remote virtual network can access VMs in the local virtual network. Defaults to true.

name: pulumi.Output[str] = None¶: The name of the virtual network peering. Changing this forces a new resource to be created.

remote_virtual_network_id: pulumi.Output[str] = None¶: The full Azure resource ID of the remote virtual network. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the virtual network peering. Changing this forces a new resource to be created.

use_remote_gateways: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: The name of the virtual network. Changing this forces a new resource to be created.

static get(resource_name, id, 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)¶

Get an existing VirtualNetworkPeering resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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 true.
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 peering. 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.

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.VirtualWan(resource_name, opts=None, allow_branch_to_branch_traffic=None, allow_vnet_to_vnet_traffic=None, disable_vpn_encryption=None, location=None, name=None, office365_local_breakout_category=None, resource_group_name=None, tags=None, type=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Virtual WAN.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_wan = azure.network.VirtualWan("exampleVirtualWan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
allow_branch_to_branch_traffic (pulumi.Input[bool]) – Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
allow_vnet_to_vnet_traffic (pulumi.Input[bool]) – Boolean flag to specify whether VNet to VNet traffic is allowed. Defaults to false.
disable_vpn_encryption (pulumi.Input[bool]) – Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
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 Virtual WAN. Changing this forces a new resource to be created.
office365_local_breakout_category (pulumi.Input[str]) – Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the Virtual WAN.
type (pulumi.Input[str]) – Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

allow_branch_to_branch_traffic: pulumi.Output[bool] = None¶: Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.

allow_vnet_to_vnet_traffic: pulumi.Output[bool] = None¶: Boolean flag to specify whether VNet to VNet traffic is allowed. Defaults to false.

disable_vpn_encryption: pulumi.Output[bool] = None¶: Boolean flag to specify whether VPN encryption is disabled. Defaults to false.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Virtual WAN. Changing this forces a new resource to be created.

office365_local_breakout_category: pulumi.Output[str] = None¶: Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the Virtual WAN.

type: pulumi.Output[str] = None¶: Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

static get(resource_name, id, opts=None, allow_branch_to_branch_traffic=None, allow_vnet_to_vnet_traffic=None, disable_vpn_encryption=None, location=None, name=None, office365_local_breakout_category=None, resource_group_name=None, tags=None, type=None)¶

Get an existing VirtualWan resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
allow_branch_to_branch_traffic (pulumi.Input[bool]) – Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.
allow_vnet_to_vnet_traffic (pulumi.Input[bool]) – Boolean flag to specify whether VNet to VNet traffic is allowed. Defaults to false.
disable_vpn_encryption (pulumi.Input[bool]) – Boolean flag to specify whether VPN encryption is disabled. Defaults to false.
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 Virtual WAN. Changing this forces a new resource to be created.
office365_local_breakout_category (pulumi.Input[str]) – Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Virtual WAN. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the Virtual WAN.
type (pulumi.Input[str]) – Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

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.VpnGateway(resource_name, opts=None, bgp_settings=None, location=None, name=None, resource_group_name=None, scale_unit=None, tags=None, virtual_hub_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages a VPN Gateway within a Virtual Hub, which enables Site-to-Site communication.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["10.0.0.0/16"])
example_virtual_wan = azure.network.VirtualWan("exampleVirtualWan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_virtual_hub = azure.network.VirtualHub("exampleVirtualHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.1.0/24")
example_vpn_gateway = azure.network.VpnGateway("exampleVpnGateway",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    virtual_hub_id=example_virtual_hub.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
bgp_settings (pulumi.Input[list]) – A bgp_settings block as defined below.
location (pulumi.Input[str]) – The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.
scale_unit (pulumi.Input[float]) – The Scale Unit for this VPN Gateway. Defaults to 1.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the VPN Gateway.
virtual_hub_id (pulumi.Input[str]) – The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.

The bgp_settings object supports the following:

asn (pulumi.Input[float]) - The ASN of the BGP Speaker. Changing this forces a new resource to be created.
bgpPeeringAddress (pulumi.Input[str]) - The Address which should be used for the BGP Peering.
peerWeight (pulumi.Input[float]) - The weight added to Routes learned from this BGP Speaker. Changing this forces a new resource to be created.

bgp_settings: pulumi.Output[list] = None¶

A bgp_settings block as defined below.

asn (float) - The ASN of the BGP Speaker. Changing this forces a new resource to be created.
bgpPeeringAddress (str) - The Address which should be used for the BGP Peering.
peerWeight (float) - The weight added to Routes learned from this BGP Speaker. Changing this forces a new resource to be created.

location: pulumi.Output[str] = None¶: The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.

scale_unit: pulumi.Output[float] = None¶: The Scale Unit for this VPN Gateway. Defaults to 1.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the VPN Gateway.

virtual_hub_id: pulumi.Output[str] = None¶: The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, bgp_settings=None, location=None, name=None, resource_group_name=None, scale_unit=None, tags=None, virtual_hub_id=None)¶

Get an existing VpnGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
bgp_settings (pulumi.Input[list]) – A bgp_settings block as defined below.
location (pulumi.Input[str]) – The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.
scale_unit (pulumi.Input[float]) – The Scale Unit for this VPN Gateway. Defaults to 1.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the VPN Gateway.
virtual_hub_id (pulumi.Input[str]) – The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.

The bgp_settings object supports the following:

asn (pulumi.Input[float]) - The ASN of the BGP Speaker. Changing this forces a new resource to be created.
bgpPeeringAddress (pulumi.Input[str]) - The Address which should be used for the BGP Peering.
peerWeight (pulumi.Input[float]) - The weight added to Routes learned from this BGP Speaker. 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.VpnServerConfiguration(resource_name, opts=None, azure_active_directory_authentications=None, client_revoked_certificates=None, client_root_certificates=None, ipsec_policy=None, location=None, name=None, radius_server=None, resource_group_name=None, tags=None, vpn_authentication_types=None, vpn_protocols=None, __props__=None, __name__=None, __opts__=None)¶

Manages a VPN Server Configuration.

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West Europe")
test = azure.network.VpnServerConfiguration("test",
    resource_group_name=example.name,
    location=example.location,
    vpn_authentication_types=["Certificate"],
    client_root_certificate=[{
        "name": "DigiCert-Federated-ID-Root-CA",
        "publicCertData": """MIIDuzCCAqOgAwIBAgIQCHTZWCM+IlfFIRXIvyKSrjANBgkqhkiG9w0BAQsFADBn
MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3
d3cuZGlnaWNlcnQuY29tMSYwJAYDVQQDEx1EaWdpQ2VydCBGZWRlcmF0ZWQgSUQg
Um9vdCBDQTAeFw0xMzAxMTUxMjAwMDBaFw0zMzAxMTUxMjAwMDBaMGcxCzAJBgNV
BAYTAlVTMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdp
Y2VydC5jb20xJjAkBgNVBAMTHURpZ2lDZXJ0IEZlZGVyYXRlZCBJRCBSb290IENB
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvAEB4pcCqnNNOWE6Ur5j
QPUH+1y1F9KdHTRSza6k5iDlXq1kGS1qAkuKtw9JsiNRrjltmFnzMZRBbX8Tlfl8
zAhBmb6dDduDGED01kBsTkgywYPxXVTKec0WxYEEF0oMn4wSYNl0lt2eJAKHXjNf
GTwiibdP8CUR2ghSM2sUTI8Nt1Omfc4SMHhGhYD64uJMbX98THQ/4LMGuYegou+d
GTiahfHtjn7AboSEknwAMJHCh5RlYZZ6B1O4QbKJ+34Q0eKgnI3X6Vc9u0zf6DH8
Dk+4zQDYRRTqTnVO3VT8jzqDlCRuNtq6YvryOWN74/dq8LQhUnXHvFyrsdMaE1X2
DwIDAQABo2MwYTAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBhjAdBgNV
HQ4EFgQUGRdkFnbGt1EWjKwbUne+5OaZvRYwHwYDVR0jBBgwFoAUGRdkFnbGt1EW
jKwbUne+5OaZvRYwDQYJKoZIhvcNAQELBQADggEBAHcqsHkrjpESqfuVTRiptJfP
9JbdtWqRTmOf6uJi2c8YVqI6XlKXsD8C1dUUaaHKLUJzvKiazibVuBwMIT84AyqR
QELn3e0BtgEymEygMU569b01ZPxoFSnNXc7qDZBDef8WfqAV/sxkTi8L9BkmFYfL
uGLOhRJOFprPdoDIUBB+tmCl3oDcBy3vnUeOEioz8zAkprcb3GHwHAK+vHmmfgcn
WsfMLH4JCLa/tRYL+Rw/N3ybCkDp00s0WUZ+AoDywSl0Q/ZEnNY0MsFiw6LyIdbq
M/s/1JRtO3bDSzD9TazRVzn2oBqzSa8VgIo5C1nOnoAKJTlsClJKvIhnRlaLQqk=
""",
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
azure_active_directory_authentications (pulumi.Input[list]) – A azure_active_directory_authentication block as defined below.
client_revoked_certificates (pulumi.Input[list]) – One or more client_revoked_certificate blocks as defined below.
client_root_certificates (pulumi.Input[list]) – One or more client_root_certificate blocks as defined below.
ipsec_policy (pulumi.Input[dict]) – A ipsec_policy block as defined below.
location (pulumi.Input[str]) – The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.
radius_server (pulumi.Input[dict]) – A radius_server block as defined below.
resource_group_name (pulumi.Input[str]) – The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vpn_authentication_types (pulumi.Input[str]) – A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.
vpn_protocols (pulumi.Input[list]) – A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

The azure_active_directory_authentications object supports the following:

audience (pulumi.Input[str]) - The Audience which should be used for authentication.
issuer (pulumi.Input[str]) - The Issuer which should be used for authentication.
tenant (pulumi.Input[str]) - The Tenant which should be used for authentication.

The client_revoked_certificates object supports the following:

name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.

The client_root_certificates object supports the following:

name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
publicCertData (pulumi.Input[str]) - The Public Key Data associated with the Certificate.

The ipsec_policy object supports the following:

dhGroup (pulumi.Input[str]) - The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.
ikeEncryption (pulumi.Input[str]) - The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.
ikeIntegrity (pulumi.Input[str]) - The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.
ipsecEncryption (pulumi.Input[str]) - The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.
ipsecIntegrity (pulumi.Input[str]) - The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.
pfsGroup (pulumi.Input[str]) - The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.
saDataSizeKilobytes (pulumi.Input[float]) - The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
saLifetimeSeconds (pulumi.Input[float]) - The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

The radius_server object supports the following:

address (pulumi.Input[str]) - The Address of the Radius Server.
client_root_certificates (pulumi.Input[list]) - One or more client_root_certificate blocks as defined above.
- name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
- thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.
secret (pulumi.Input[str]) - The Secret used to communicate with the Radius Server.
serverRootCertificates (pulumi.Input[list]) - One or more server_root_certificate blocks as defined below.
- name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
- publicCertData (pulumi.Input[str]) - The Public Key Data associated with the Certificate.

azure_active_directory_authentications: pulumi.Output[list] = None¶

A azure_active_directory_authentication block as defined below.

audience (str) - The Audience which should be used for authentication.
issuer (str) - The Issuer which should be used for authentication.
tenant (str) - The Tenant which should be used for authentication.

client_revoked_certificates: pulumi.Output[list] = None¶

One or more client_revoked_certificate blocks as defined below.

name (str) - A name used to uniquely identify this certificate.
thumbprint (str) - The Thumbprint of the Certificate.

client_root_certificates: pulumi.Output[list] = None¶

One or more client_root_certificate blocks as defined below.

name (str) - A name used to uniquely identify this certificate.
publicCertData (str) - The Public Key Data associated with the Certificate.

ipsec_policy: pulumi.Output[dict] = None¶

A ipsec_policy block as defined below.

dhGroup (str) - The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.
ikeEncryption (str) - The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.
ikeIntegrity (str) - The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.
ipsecEncryption (str) - The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.
ipsecIntegrity (str) - The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.
pfsGroup (str) - The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.
saDataSizeKilobytes (float) - The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
saLifetimeSeconds (float) - The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

location: pulumi.Output[str] = None¶: The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

radius_server: pulumi.Output[dict] = None¶

A radius_server block as defined below.

address (str) - The Address of the Radius Server.
client_root_certificates (list) - One or more client_root_certificate blocks as defined above.
- name (str) - A name used to uniquely identify this certificate.
- thumbprint (str) - The Thumbprint of the Certificate.
secret (str) - The Secret used to communicate with the Radius Server.
serverRootCertificates (list) - One or more server_root_certificate blocks as defined below.
- name (str) - A name used to uniquely identify this certificate.
- publicCertData (str) - The Public Key Data associated with the Certificate.

resource_group_name: pulumi.Output[str] = None¶: The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

vpn_authentication_types: pulumi.Output[str] = None¶: A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

vpn_protocols: pulumi.Output[list] = None¶: A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

static get(resource_name, id, opts=None, azure_active_directory_authentications=None, client_revoked_certificates=None, client_root_certificates=None, ipsec_policy=None, location=None, name=None, radius_server=None, resource_group_name=None, tags=None, vpn_authentication_types=None, vpn_protocols=None)¶

Get an existing VpnServerConfiguration resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
azure_active_directory_authentications (pulumi.Input[list]) – A azure_active_directory_authentication block as defined below.
client_revoked_certificates (pulumi.Input[list]) – One or more client_revoked_certificate blocks as defined below.
client_root_certificates (pulumi.Input[list]) – One or more client_root_certificate blocks as defined below.
ipsec_policy (pulumi.Input[dict]) – A ipsec_policy block as defined below.
location (pulumi.Input[str]) – The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.
radius_server (pulumi.Input[dict]) – A radius_server block as defined below.
resource_group_name (pulumi.Input[str]) – The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vpn_authentication_types (pulumi.Input[str]) – A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.
vpn_protocols (pulumi.Input[list]) – A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

The azure_active_directory_authentications object supports the following:

audience (pulumi.Input[str]) - The Audience which should be used for authentication.
issuer (pulumi.Input[str]) - The Issuer which should be used for authentication.
tenant (pulumi.Input[str]) - The Tenant which should be used for authentication.

The client_revoked_certificates object supports the following:

name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.

The client_root_certificates object supports the following:

name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
publicCertData (pulumi.Input[str]) - The Public Key Data associated with the Certificate.

The ipsec_policy object supports the following:

dhGroup (pulumi.Input[str]) - The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.
ikeEncryption (pulumi.Input[str]) - The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.
ikeIntegrity (pulumi.Input[str]) - The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.
ipsecEncryption (pulumi.Input[str]) - The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.
ipsecIntegrity (pulumi.Input[str]) - The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.
pfsGroup (pulumi.Input[str]) - The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.
saDataSizeKilobytes (pulumi.Input[float]) - The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
saLifetimeSeconds (pulumi.Input[float]) - The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

The radius_server object supports the following:

address (pulumi.Input[str]) - The Address of the Radius Server.
client_root_certificates (pulumi.Input[list]) - One or more client_root_certificate blocks as defined above.
- name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
- thumbprint (pulumi.Input[str]) - The Thumbprint of the Certificate.
secret (pulumi.Input[str]) - The Secret used to communicate with the Radius Server.
serverRootCertificates (pulumi.Input[list]) - One or more server_root_certificate blocks as defined below.
- name (pulumi.Input[str]) - A name used to uniquely identify this certificate.
- publicCertData (pulumi.Input[str]) - The Public Key Data associated with the Certificate.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_application_security_group(name="tf-appsecuritygroup",
    resource_group_name="my-resource-group")
pulumi.export("applicationSecurityGroupId", example.id)

Parameters

name (str) – The name of the Application Security Group.
resource_group_name (str) – The name of the resource group in which the Application Security Group exists.

pulumi_azure.network.get_express_route_circuit(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing ExpressRoute circuit.

import pulumi
import pulumi_azure as azure

example = azure.network.get_express_route_circuit(resource_group_name=azurerm_resource_group["example"]["name"],
    name=azurerm_express_route_circuit["example"]["name"])
pulumi.export("expressRouteCircuitId", example.id)
pulumi.export("serviceKey", example.service_key)

Parameters

name (str) – The name of the ExpressRoute circuit.
resource_group_name (str) – The Name of the Resource Group where the ExpressRoute circuit exists.

pulumi_azure.network.get_firewall(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Azure Firewall.

import pulumi
import pulumi_azure as azure

example = azure.network.get_firewall(name="firewall1",
    resource_group_name="firewall-RG")
pulumi.export("firewallPrivateIp", example.ip_configurations[0]["private_ip_address"])

Parameters

name (str) – The name of the Azure Firewall.
resource_group_name (str) – The name of the Resource Group in which the Azure Firewall exists.

pulumi_azure.network.get_gateway_connection(name=None, resource_group_name=None, opts=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.network.get_gateway_connection(name="production",
    resource_group_name="networking")
pulumi.export("virtualNetworkGatewayConnectionId", example.id)

Parameters

name (str) – Specifies the name of the Virtual Network Gateway Connection.
resource_group_name (str) – Specifies the name of the resource group the Virtual Network Gateway Connection is located in.

pulumi_azure.network.get_nat_gateway(name=None, public_ip_address_ids=None, public_ip_prefix_ids=None, resource_group_name=None, opts=None)¶

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

Parameters

name (str) – Specifies the Name of the NAT Gateway.
public_ip_address_ids (list) – A list of existing Public IP Address resource IDs which the NAT Gateway is using.
public_ip_prefix_ids (list) – A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.
resource_group_name (str) – Specifies the name of the Resource Group where the NAT Gateway exists.

pulumi_azure.network.get_network_ddos_protection_plan(name=None, resource_group_name=None, tags=None, opts=None)¶

Use this data source to access information about an existing Azure Network DDoS Protection Plan.

import pulumi
import pulumi_azure as azure

example = azure.network.get_network_ddos_protection_plan(name=azurerm_network_ddos_protection_plan["example"]["name"],
    resource_group_name=azurerm_network_ddos_protection_plan["example"]["resource_group_name"])
pulumi.export("ddosProtectionPlanId", example.id)

Parameters

name (str) – The name of the Network DDoS Protection Plan.
resource_group_name (str) – The name of the resource group where the Network DDoS Protection Plan exists.
tags (dict) – A mapping of tags assigned to the resource.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_network_interface(name="acctest-nic",
    resource_group_name="networking")
pulumi.export("networkInterfaceId", example.id)

Parameters

name (str) – Specifies the name of the Network Interface.
resource_group_name (str) – Specifies the name of the resource group the Network Interface is located in.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_network_security_group(name=azurerm_network_security_group["example"]["name"],
    resource_group_name=azurerm_resource_group["example"]["name"])
pulumi.export("location", example.location)

Parameters

name (str) – Specifies the Name of the Network Security Group.
resource_group_name (str) – Specifies the Name of the Resource Group within which the Network Security Group exists

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_network_watcher(name=azurerm_network_watcher["example"]["name"],
    resource_group_name=azurerm_resource_group["example"]["name"])
pulumi.export("networkWatcherId", example.id)

Parameters

name (str) – Specifies the Name of the Network Watcher.
resource_group_name (str) – Specifies the Name of the Resource Group within which the Network Watcher exists.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_public_i_ps(attached=False,
    resource_group_name="pip-test")

Parameters

allocation_type (str) – The Allocation Type for the Public IP Address. Possible values include Static or Dynamic.
attached (bool) – Filter to include IP Addresses which are attached to a device, such as a VM/LB (true) or unattached (false).
name_prefix (str) – A prefix match used for the IP Addresses name field, case sensitive.
resource_group_name (str) – Specifies the name of the resource group.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_public_ip(name="name_of_public_ip",
    resource_group_name="name_of_resource_group")
pulumi.export("domainNameLabel", example.domain_name_label)
pulumi.export("publicIpAddress", example.ip_address)

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US 2")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Dynamic",
    idle_timeout_in_minutes=30,
    tags={
        "environment": "test",
    })
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    ip_configuration=[{
        "name": "testconfiguration1",
        "subnet_id": example_subnet.id,
        "privateIpAddressAllocation": "Static",
        "private_ip_address": "10.0.2.5",
        "public_ip_address_id": example_public_ip.id,
    }])
example_virtual_machine = azure.compute.VirtualMachine("exampleVirtualMachine",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    network_interface_ids=[example_network_interface.id])
# ...
example_public_ip = pulumi.Output.all(example_public_ip.name, example_virtual_machine.resource_group_name).apply(lambda name, resource_group_name: azure.network.get_public_ip(name=name,
    resource_group_name=resource_group_name))
pulumi.export("publicIpAddress", example_public_ip.ip_address)

Parameters

name (str) – Specifies the name of the public IP address.
resource_group_name (str) – Specifies the name of the resource group.
tags (dict) – A mapping of tags to assigned to the resource.

pulumi_azure.network.get_public_ip_prefix(name=None, resource_group_name=None, zones=None, opts=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.network.get_public_ip_prefix(name="name_of_public_ip",
    resource_group_name="name_of_resource_group")
pulumi.export("publicIpPrefix", example.ip_prefix)

Parameters

name (str) – Specifies the name of the public IP prefix.
resource_group_name (str) – Specifies the name of the resource group.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_route_table(name="myroutetable",
    resource_group_name="some-resource-group")

Parameters

name (str) – The name of the Route Table.
resource_group_name (str) – The name of the Resource Group in which the Route Table exists.

pulumi_azure.network.get_service_tags(location=None, location_filter=None, service=None, opts=None)¶

Use this data source to access information about Service Tags.

import pulumi
import pulumi_azure as azure

example = azure.network.get_service_tags(location="West Europe",
    service="AzureKeyVault",
    location_filter="northeurope")
pulumi.export("addressPrefixes", data["azurerm_service_tags"]["example"]["address_prefixes"])

Parameters

location (str) – The Azure Region where the Service Tags exists. This value is not used to filter the results but for specifying the region to request. For filtering by region use location_filter instead. More information can be found here: Service Tags URL parameters.
location_filter (str) – Changes the scope of the service tags. Can be any value that is also valid for location. If this field is empty then all address prefixes are considered instead of only location specific ones.
service (str) – The type of the service for which address prefixes will be fetched. Available service tags can be found here: Available service tags.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_subnet(name="backend",
    virtual_network_name="production",
    resource_group_name="networking")
pulumi.export("subnetId", example.id)

Parameters

name (str) – Specifies the name of the Subnet.
resource_group_name (str) – Specifies the name of the resource group the Virtual Network is located in.
virtual_network_name (str) – Specifies the name of the Virtual Network this Subnet is located within.

pulumi_azure.network.get_traffic_manager(name=None, opts=None)¶

Use this data source to access the ID of a specified Traffic Manager Geographical Location within the Geographical Hierarchy.

import pulumi
import pulumi_azure as azure

example = azure.network.get_traffic_manager(name="World")
pulumi.export("locationCode", example.id)

Parameters: name (str) – Specifies the name of the Location, for example World, Europe or Germany.

pulumi_azure.network.get_virtual_hub(name=None, resource_group_name=None, opts=None)¶

Uses this data source to access information about an existing Virtual Hub.

import pulumi
import pulumi_azure as azure

example = azure.network.get_virtual_hub(name="example-hub",
    resource_group_name="example-resources")
pulumi.export("virtualHubId", example.id)

Parameters

name (str) – The name of the Virtual Hub.
resource_group_name (str) – The Name of the Resource Group where the Virtual Hub exists.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_virtual_network(name="production",
    resource_group_name="networking")
pulumi.export("virtualNetworkId", example.id)

Parameters

name (str) – Specifies the name of the Virtual Network.
resource_group_name (str) – Specifies the name of the resource group the Virtual Network is located in.

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.

import pulumi
import pulumi_azure as azure

example = azure.network.get_virtual_network_gateway(name="production",
    resource_group_name="networking")
pulumi.export("virtualNetworkGatewayId", example.id)

Parameters

name (str) – Specifies the name of the Virtual Network Gateway.
resource_group_name (str) – Specifies the name of the resource group the Virtual Network Gateway is located in.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

network¶

On This Page