Module network

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.

Resources

Functions

Others

Resources

Resource ApplicationGateway

class ApplicationGateway extends CustomResource

Manages an Application Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    addressSpaces: ["10.254.0.0/16"],
});
const frontend = new azure.network.Subnet("frontend", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.254.0.0/24"],
});
const backend = new azure.network.Subnet("backend", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.254.2.0/24"],
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    allocationMethod: "Dynamic",
});
const backendAddressPoolName = pulumi.interpolate`${exampleVirtualNetwork.name}-beap`;
const frontendPortName = pulumi.interpolate`${exampleVirtualNetwork.name}-feport`;
const frontendIpConfigurationName = pulumi.interpolate`${exampleVirtualNetwork.name}-feip`;
const httpSettingName = pulumi.interpolate`${exampleVirtualNetwork.name}-be-htst`;
const listenerName = pulumi.interpolate`${exampleVirtualNetwork.name}-httplstn`;
const requestRoutingRuleName = pulumi.interpolate`${exampleVirtualNetwork.name}-rqrt`;
const redirectConfigurationName = pulumi.interpolate`${exampleVirtualNetwork.name}-rdrcfg`;
const network = new azure.network.ApplicationGateway("network", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "Standard_Small",
        tier: "Standard",
        capacity: 2,
    },
    gateway_ip_configuration: [{
        name: "my-gateway-ip-configuration",
        subnetId: frontend.id,
    }],
    frontend_port: [{
        name: frontendPortName,
        port: 80,
    }],
    frontend_ip_configuration: [{
        name: frontendIpConfigurationName,
        publicIpAddressId: examplePublicIp.id,
    }],
    backend_address_pool: [{
        name: backendAddressPoolName,
    }],
    backend_http_settings: [{
        name: httpSettingName,
        cookieBasedAffinity: "Disabled",
        path: "/path1/",
        port: 80,
        protocol: "Http",
        requestTimeout: 1,
    }],
    http_listener: [{
        name: listenerName,
        frontendIpConfigurationName: frontendIpConfigurationName,
        frontendPortName: frontendPortName,
        protocol: "Http",
    }],
    request_routing_rule: [{
        name: requestRoutingRuleName,
        ruleType: "Basic",
        httpListenerName: listenerName,
        backendAddressPoolName: backendAddressPoolName,
        backendHttpSettingsName: httpSettingName,
    }],
});

constructor

new ApplicationGateway(name: string, args: ApplicationGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a ApplicationGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationGatewayState, opts?: pulumi.CustomResourceOptions): ApplicationGateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApplicationGateway

Returns true if the given object is an instance of ApplicationGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authenticationCertificates

public authenticationCertificates: pulumi.Output<ApplicationGatewayAuthenticationCertificate[] | undefined>;

One or more authenticationCertificate blocks as defined below.

property autoscaleConfiguration

public autoscaleConfiguration: pulumi.Output<ApplicationGatewayAutoscaleConfiguration | undefined>;

A autoscaleConfiguration block as defined below.

property backendAddressPools

public backendAddressPools: pulumi.Output<ApplicationGatewayBackendAddressPool[]>;

One or more backendAddressPool blocks as defined below.

property backendHttpSettings

public backendHttpSettings: pulumi.Output<ApplicationGatewayBackendHttpSetting[]>;

One or more backendHttpSettings blocks as defined below.

property customErrorConfigurations

public customErrorConfigurations: pulumi.Output<ApplicationGatewayCustomErrorConfiguration[] | undefined>;

One or more customErrorConfiguration blocks as defined below.

property enableHttp2

public enableHttp2: pulumi.Output<boolean | undefined>;

Is HTTP2 enabled on the application gateway resource? Defaults to false.

property firewallPolicyId

public firewallPolicyId: pulumi.Output<string | undefined>;

The resource ID of a firewall policy.

property frontendIpConfigurations

public frontendIpConfigurations: pulumi.Output<ApplicationGatewayFrontendIpConfiguration[]>;

One or more frontendIpConfiguration blocks as defined below.

property frontendPorts

public frontendPorts: pulumi.Output<ApplicationGatewayFrontendPort[]>;

One or more frontendPort blocks as defined below.

property gatewayIpConfigurations

public gatewayIpConfigurations: pulumi.Output<ApplicationGatewayGatewayIpConfiguration[]>;

One or more gatewayIpConfiguration blocks as defined below.

property httpListeners

public httpListeners: pulumi.Output<ApplicationGatewayHttpListener[]>;

One or more httpListener blocks as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<ApplicationGatewayIdentity>;

A identity block.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property probes

public probes: pulumi.Output<ApplicationGatewayProbe[] | undefined>;

One or more probe blocks as defined below.

property redirectConfigurations

public redirectConfigurations: pulumi.Output<ApplicationGatewayRedirectConfiguration[] | undefined>;

A redirectConfiguration block as defined below.

property requestRoutingRules

public requestRoutingRules: pulumi.Output<ApplicationGatewayRequestRoutingRule[]>;

One or more requestRoutingRule blocks as defined below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property rewriteRuleSets

public rewriteRuleSets: pulumi.Output<ApplicationGatewayRewriteRuleSet[] | undefined>;

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

property sku

public sku: pulumi.Output<ApplicationGatewaySku>;

A sku block as defined below.

property sslCertificates

public sslCertificates: pulumi.Output<ApplicationGatewaySslCertificate[] | undefined>;

One or more sslCertificate blocks as defined below.

property sslPolicies

public sslPolicies: pulumi.Output<ApplicationGatewaySslPolicy[]>;

a ssl policy block as defined below.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property trustedRootCertificates

public trustedRootCertificates: pulumi.Output<ApplicationGatewayTrustedRootCertificate[] | undefined>;

One or more trustedRootCertificate blocks as defined below.

property urlPathMaps

public urlPathMaps: pulumi.Output<ApplicationGatewayUrlPathMap[] | undefined>;

One or more urlPathMap blocks as defined below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property wafConfiguration

public wafConfiguration: pulumi.Output<ApplicationGatewayWafConfiguration | undefined>;

A wafConfiguration block as defined below.

property zones

public zones: pulumi.Output<string[] | undefined>;

A collection of availability zones to spread the Application Gateway over.

Resource ApplicationSecurityGroup

class ApplicationSecurityGroup extends CustomResource

Manages an Application Security Group.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleApplicationSecurityGroup = new azure.network.ApplicationSecurityGroup("exampleApplicationSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tags: {
        Hello: "World",
    },
});

constructor

new ApplicationSecurityGroup(name: string, args: ApplicationSecurityGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ApplicationSecurityGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationSecurityGroupState, opts?: pulumi.CustomResourceOptions): ApplicationSecurityGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApplicationSecurityGroup

Returns true if the given object is an instance of ApplicationSecurityGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DdosProtectionPlan

class DdosProtectionPlan extends CustomResource

Manages an AzureNetwork DDoS Protection Plan.

NOTE Azure only allows one DDoS Protection Plan per region.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleDdosProtectionPlan = new azure.network.DdosProtectionPlan("exampleDdosProtectionPlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});

constructor

new DdosProtectionPlan(name: string, args: DdosProtectionPlanArgs, opts?: pulumi.CustomResourceOptions)

Create a DdosProtectionPlan resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DdosProtectionPlanState, opts?: pulumi.CustomResourceOptions): DdosProtectionPlan

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DdosProtectionPlan

Returns true if the given object is an instance of DdosProtectionPlan. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

Specifies the name of the Network DDoS Protection Plan. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualNetworkIds

public virtualNetworkIds: pulumi.Output<string[]>;

A list of Virtual Network ID’s associated with the DDoS Protection Plan.

Resource ExpressRouteCircuit

class ExpressRouteCircuit extends CustomResource

Manages an ExpressRoute circuit.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    tags: {
        environment: "Production",
    },
});

constructor

new ExpressRouteCircuit(name: string, args: ExpressRouteCircuitArgs, opts?: pulumi.CustomResourceOptions)

Create a ExpressRouteCircuit resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ExpressRouteCircuitState, opts?: pulumi.CustomResourceOptions): ExpressRouteCircuit

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ExpressRouteCircuit

Returns true if the given object is an instance of ExpressRouteCircuit. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowClassicOperations

public allowClassicOperations: pulumi.Output<boolean | undefined>;

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

property bandwidthInMbps

public bandwidthInMbps: pulumi.Output<number>;

The bandwidth in Mbps of the circuit being created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property peeringLocation

public peeringLocation: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property serviceKey

public serviceKey: pulumi.Output<string>;

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

property serviceProviderName

public serviceProviderName: pulumi.Output<string>;

The name of the ExpressRoute Service Provider.

property serviceProviderProvisioningState

public serviceProviderProvisioningState: pulumi.Output<string>;

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

property sku

public sku: pulumi.Output<ExpressRouteCircuitSku>;

A sku block for the ExpressRoute circuit as documented below.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ExpressRouteCircuitAuthorization

class ExpressRouteCircuitAuthorization extends CustomResource

Manages an ExpressRoute Circuit Authorization.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    allowClassicOperations: false,
    tags: {
        environment: "Production",
    },
});
const exampleExpressRouteCircuitAuthorization = new azure.network.ExpressRouteCircuitAuthorization("exampleExpressRouteCircuitAuthorization", {
    expressRouteCircuitName: exampleExpressRouteCircuit.name,
    resourceGroupName: exampleResourceGroup.name,
});

constructor

new ExpressRouteCircuitAuthorization(name: string, args: ExpressRouteCircuitAuthorizationArgs, opts?: pulumi.CustomResourceOptions)

Create a ExpressRouteCircuitAuthorization resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ExpressRouteCircuitAuthorizationState, opts?: pulumi.CustomResourceOptions): ExpressRouteCircuitAuthorization

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ExpressRouteCircuitAuthorization

Returns true if the given object is an instance of ExpressRouteCircuitAuthorization. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorizationKey

public authorizationKey: pulumi.Output<string>;

The Authorization Key.

property authorizationUseStatus

public authorizationUseStatus: pulumi.Output<string>;

The authorization use status.

property expressRouteCircuitName

public expressRouteCircuitName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ExpressRouteCircuitPeering

class ExpressRouteCircuitPeering extends CustomResource

Manages an ExpressRoute Circuit Peering.

Example Usage

Creating A Microsoft Peering)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleExpressRouteCircuit = new azure.network.ExpressRouteCircuit("exampleExpressRouteCircuit", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    serviceProviderName: "Equinix",
    peeringLocation: "Silicon Valley",
    bandwidthInMbps: 50,
    sku: {
        tier: "Standard",
        family: "MeteredData",
    },
    allowClassicOperations: false,
    tags: {
        environment: "Production",
    },
});
const exampleExpressRouteCircuitPeering = new azure.network.ExpressRouteCircuitPeering("exampleExpressRouteCircuitPeering", {
    peeringType: "MicrosoftPeering",
    expressRouteCircuitName: exampleExpressRouteCircuit.name,
    resourceGroupName: exampleResourceGroup.name,
    peerAsn: 100,
    primaryPeerAddressPrefix: "123.0.0.0/30",
    secondaryPeerAddressPrefix: "123.0.0.4/30",
    vlanId: 300,
    microsoft_peering_config: {
        advertisedPublicPrefixes: ["123.1.0.0/24"],
    },
});

constructor

new ExpressRouteCircuitPeering(name: string, args: ExpressRouteCircuitPeeringArgs, opts?: pulumi.CustomResourceOptions)

Create a ExpressRouteCircuitPeering resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ExpressRouteCircuitPeeringState, opts?: pulumi.CustomResourceOptions): ExpressRouteCircuitPeering

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ExpressRouteCircuitPeering

Returns true if the given object is an instance of ExpressRouteCircuitPeering. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property azureAsn

public azureAsn: pulumi.Output<number>;

The ASN used by Azure.

property expressRouteCircuitName

public expressRouteCircuitName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property microsoftPeeringConfig

public microsoftPeeringConfig: pulumi.Output<ExpressRouteCircuitPeeringMicrosoftPeeringConfig | undefined>;

A microsoftPeeringConfig block as defined below. Required when peeringType is set to MicrosoftPeering.

property peerAsn

public peerAsn: pulumi.Output<number>;

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

property peeringType

public peeringType: pulumi.Output<string>;

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

property primaryAzurePort

public primaryAzurePort: pulumi.Output<string>;

The Primary Port used by Azure for this Peering.

property primaryPeerAddressPrefix

public primaryPeerAddressPrefix: pulumi.Output<string>;

A /30 subnet for the primary link.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryAzurePort

public secondaryAzurePort: pulumi.Output<string>;

The Secondary Port used by Azure for this Peering.

property secondaryPeerAddressPrefix

public secondaryPeerAddressPrefix: pulumi.Output<string>;

A /30 subnet for the secondary link.

property sharedKey

public sharedKey: pulumi.Output<string | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vlanId

public vlanId: pulumi.Output<number>;

A valid VLAN ID to establish this peering on.

Resource ExpressRouteGateway

class ExpressRouteGateway extends CustomResource

Manages an ExpressRoute gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualWan = new azure.network.VirtualWan("exampleVirtualWan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("exampleVirtualHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.1.0/24",
});
const exampleExpressRouteGateway = new azure.network.ExpressRouteGateway("exampleExpressRouteGateway", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualHubId: exampleVirtualHub.id,
    scaleUnits: 1,
    tags: {
        environment: "Production",
    },
});

constructor

new ExpressRouteGateway(name: string, args: ExpressRouteGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a ExpressRouteGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ExpressRouteGatewayState, opts?: pulumi.CustomResourceOptions): ExpressRouteGateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ExpressRouteGateway

Returns true if the given object is an instance of ExpressRouteGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property scaleUnits

public scaleUnits: pulumi.Output<number>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualHubId

public virtualHubId: pulumi.Output<string>;

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

Resource Firewall

class Firewall extends CustomResource

Manages an Azure Firewall.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "North Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
    sku: "Standard",
});
const exampleFirewall = new azure.network.Firewall("exampleFirewall", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "configuration",
        subnetId: exampleSubnet.id,
        publicIpAddressId: examplePublicIp.id,
    }],
});

constructor

new Firewall(name: string, args: FirewallArgs, opts?: pulumi.CustomResourceOptions)

Create a Firewall resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallState, opts?: pulumi.CustomResourceOptions): Firewall

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Firewall

Returns true if the given object is an instance of Firewall. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipConfigurations

public ipConfigurations: pulumi.Output<FirewallIpConfiguration[]>;

A ipConfiguration block as documented below.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zones

public zones: pulumi.Output<string[] | undefined>;

Specifies the availability zones in which the Azure Firewall should be created.

Resource FirewallApplicationRuleCollection

class FirewallApplicationRuleCollection extends CustomResource

Manages an Application Rule Collection within an Azure Firewall.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "North Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
    sku: "Standard",
});
const exampleFirewall = new azure.network.Firewall("exampleFirewall", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "configuration",
        subnetId: exampleSubnet.id,
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleFirewallApplicationRuleCollection = new azure.network.FirewallApplicationRuleCollection("exampleFirewallApplicationRuleCollection", {
    azureFirewallName: exampleFirewall.name,
    resourceGroupName: exampleResourceGroup.name,
    priority: 100,
    action: "Allow",
    rule: [{
        name: "testrule",
        sourceAddresses: ["10.0.0.0/16"],
        targetFqdns: ["*.google.com"],
        protocol: [{
            port: "443",
            type: "Https",
        }],
    }],
});

constructor

new FirewallApplicationRuleCollection(name: string, args: FirewallApplicationRuleCollectionArgs, opts?: pulumi.CustomResourceOptions)

Create a FirewallApplicationRuleCollection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallApplicationRuleCollectionState, opts?: pulumi.CustomResourceOptions): FirewallApplicationRuleCollection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FirewallApplicationRuleCollection

Returns true if the given object is an instance of FirewallApplicationRuleCollection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property action

public action: pulumi.Output<string>;

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

property azureFirewallName

public azureFirewallName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property priority

public priority: pulumi.Output<number>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property rules

public rules: pulumi.Output<FirewallApplicationRuleCollectionRule[]>;

One or more rule blocks as defined below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FirewallNatRuleCollection

class FirewallNatRuleCollection extends CustomResource

Manages a NAT Rule Collection within an Azure Firewall.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "North Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
    sku: "Standard",
});
const exampleFirewall = new azure.network.Firewall("exampleFirewall", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "configuration",
        subnetId: exampleSubnet.id,
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleFirewallNatRuleCollection = new azure.network.FirewallNatRuleCollection("exampleFirewallNatRuleCollection", {
    azureFirewallName: exampleFirewall.name,
    resourceGroupName: exampleResourceGroup.name,
    priority: 100,
    action: "Dnat",
    rule: [{
        name: "testrule",
        sourceAddresses: ["10.0.0.0/16"],
        destinationPorts: ["53"],
        destinationAddresses: [examplePublicIp.ipAddress],
        translatedPort: 53,
        translatedAddress: "8.8.8.8",
        protocols: [
            "TCP",
            "UDP",
        ],
    }],
});

constructor

new FirewallNatRuleCollection(name: string, args: FirewallNatRuleCollectionArgs, opts?: pulumi.CustomResourceOptions)

Create a FirewallNatRuleCollection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallNatRuleCollectionState, opts?: pulumi.CustomResourceOptions): FirewallNatRuleCollection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FirewallNatRuleCollection

Returns true if the given object is an instance of FirewallNatRuleCollection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property action

public action: pulumi.Output<string>;

Specifies the action the rule will apply to matching traffic. Possible values are Dnat and Snat.

property azureFirewallName

public azureFirewallName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property priority

public priority: pulumi.Output<number>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property rules

public rules: pulumi.Output<FirewallNatRuleCollectionRule[]>;

One or more rule blocks as defined below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FirewallNetworkRuleCollection

class FirewallNetworkRuleCollection extends CustomResource

Manages a Network Rule Collection within an Azure Firewall.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "North Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
    sku: "Standard",
});
const exampleFirewall = new azure.network.Firewall("exampleFirewall", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "configuration",
        subnetId: exampleSubnet.id,
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleFirewallNetworkRuleCollection = new azure.network.FirewallNetworkRuleCollection("exampleFirewallNetworkRuleCollection", {
    azureFirewallName: exampleFirewall.name,
    resourceGroupName: exampleResourceGroup.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",
        ],
    }],
});

constructor

new FirewallNetworkRuleCollection(name: string, args: FirewallNetworkRuleCollectionArgs, opts?: pulumi.CustomResourceOptions)

Create a FirewallNetworkRuleCollection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallNetworkRuleCollectionState, opts?: pulumi.CustomResourceOptions): FirewallNetworkRuleCollection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FirewallNetworkRuleCollection

Returns true if the given object is an instance of FirewallNetworkRuleCollection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property action

public action: pulumi.Output<string>;

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

property azureFirewallName

public azureFirewallName: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property priority

public priority: pulumi.Output<number>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property rules

public rules: pulumi.Output<FirewallNetworkRuleCollectionRule[]>;

One or more rule blocks as defined below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource LocalNetworkGateway

class LocalNetworkGateway extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West US"});
const home = new azure.network.LocalNetworkGateway("home", {
    resourceGroupName: example.name,
    location: example.location,
    gatewayAddress: "12.13.14.15",
    addressSpaces: ["10.0.0.0/16"],
});

constructor

new LocalNetworkGateway(name: string, args: LocalNetworkGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a LocalNetworkGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LocalNetworkGatewayState, opts?: pulumi.CustomResourceOptions): LocalNetworkGateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is LocalNetworkGateway

Returns true if the given object is an instance of LocalNetworkGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressSpaces

public addressSpaces: pulumi.Output<string[]>;

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

property bgpSettings

public bgpSettings: pulumi.Output<LocalNetworkGatewayBgpSettings | undefined>;

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

property gatewayAddress

public gatewayAddress: pulumi.Output<string>;

The IP address of the gateway to which to connect.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NatGateway

class NatGateway extends CustomResource

Manages a Azure NAT Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "eastus2"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
    sku: "Standard",
    zones: ["1"],
});
const examplePublicIpPrefix = new azure.network.PublicIpPrefix("examplePublicIpPrefix", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    prefixLength: 30,
    zones: ["1"],
});
const exampleNatGateway = new azure.network.NatGateway("exampleNatGateway", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publicIpAddressIds: [examplePublicIp.id],
    publicIpPrefixIds: [examplePublicIpPrefix.id],
    skuName: "Standard",
    idleTimeoutInMinutes: 10,
    zones: ["1"],
});

constructor

new NatGateway(name: string, args: NatGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a NatGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NatGatewayState, opts?: pulumi.CustomResourceOptions): NatGateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NatGateway

Returns true if the given object is an instance of NatGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idleTimeoutInMinutes

public idleTimeoutInMinutes: pulumi.Output<number | undefined>;

The idle timeout which should be used in minutes. Defaults to 4.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

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

property publicIpAddressIds

DEPRECATED Inline Public IP Address ID Deprecations have been deprecated in favour of the azurerm_nat_gateway_public_ip_association resource. This field will be removed in the next major version of the Azure Provider.
public publicIpAddressIds: pulumi.Output<string[]>;

A list of Public IP Address ID’s which should be associated with the NAT Gateway resource.

property publicIpPrefixIds

public publicIpPrefixIds: pulumi.Output<string[] | undefined>;

A list of Public IP Prefix ID’s which should be associated with the NAT Gateway resource.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.

property resourceGuid

public resourceGuid: pulumi.Output<string>;

The resource GUID property of the NAT Gateway.

property skuName

public skuName: pulumi.Output<string | undefined>;

The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zones

public zones: pulumi.Output<string[] | undefined>;

A list of availability zones where the NAT Gateway should be provisioned. Changing this forces a new resource to be created.

Resource NatGatewayPublicIpAssociation

class NatGatewayPublicIpAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
    sku: "Standard",
});
const exampleNatGateway = new azure.network.NatGateway("exampleNatGateway", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    skuName: "Standard",
});
const exampleNatGatewayPublicIpAssociation = new azure.network.NatGatewayPublicIpAssociation("exampleNatGatewayPublicIpAssociation", {
    natGatewayId: exampleNatGateway.id,
    publicIpAddressId: examplePublicIp.id,
});

constructor

new NatGatewayPublicIpAssociation(name: string, args: NatGatewayPublicIpAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a NatGatewayPublicIpAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NatGatewayPublicIpAssociationState, opts?: pulumi.CustomResourceOptions): NatGatewayPublicIpAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NatGatewayPublicIpAssociation

Returns true if the given object is an instance of NatGatewayPublicIpAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property natGatewayId

public natGatewayId: pulumi.Output<string>;

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

property publicIpAddressId

public publicIpAddressId: pulumi.Output<string>;

The ID of the Public IP which this Nat Gateway which should be connected to. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkConnectionMonitor

class NetworkConnectionMonitor extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleNetworkWatcher = new azure.network.NetworkWatcher("exampleNetworkWatcher", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleVirtualMachine = new azure.compute.VirtualMachine("exampleVirtualMachine", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    networkInterfaceIds: [exampleNetworkInterface.id],
    vmSize: "Standard_F2",
    storage_image_reference: {
        publisher: "Canonical",
        offer: "UbuntuServer",
        sku: "16.04-LTS",
        version: "latest",
    },
    storage_os_disk: {
        name: "osdisk",
        caching: "ReadWrite",
        createOption: "FromImage",
        managedDiskType: "Standard_LRS",
    },
    os_profile: {
        computerName: "cmtest-vm",
        adminUsername: "testadmin",
        adminPassword: "Password1234!",
    },
    os_profile_linux_config: {
        disablePasswordAuthentication: false,
    },
});
const exampleExtension = new azure.compute.Extension("exampleExtension", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    virtualMachineName: exampleVirtualMachine.name,
    publisher: "Microsoft.Azure.NetworkWatcher",
    type: "NetworkWatcherAgentLinux",
    typeHandlerVersion: "1.4",
    autoUpgradeMinorVersion: true,
});
const exampleNetworkConnectionMonitor = new azure.network.NetworkConnectionMonitor("exampleNetworkConnectionMonitor", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    networkWatcherName: exampleNetworkWatcher.name,
    source: {
        virtualMachineId: exampleVirtualMachine.id,
    },
    destination: {
        address: "exmaple.com",
        port: 80,
    },
});

constructor

new NetworkConnectionMonitor(name: string, args: NetworkConnectionMonitorArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkConnectionMonitor resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkConnectionMonitorState, opts?: pulumi.CustomResourceOptions): NetworkConnectionMonitor

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkConnectionMonitor

Returns true if the given object is an instance of NetworkConnectionMonitor. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property autoStart

public autoStart: pulumi.Output<boolean | undefined>;

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

property destination

public destination: pulumi.Output<NetworkConnectionMonitorDestination>;

A destination block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property intervalInSeconds

public intervalInSeconds: pulumi.Output<number | undefined>;

Monitoring interval in seconds. Defaults to 60.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property networkWatcherName

public networkWatcherName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property source

public source: pulumi.Output<NetworkConnectionMonitorSource>;

A source block as defined below.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkInterface

class NetworkInterface extends CustomResource

Manages a Network Interface.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "internal",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});

constructor

new NetworkInterface(name: string, args: NetworkInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceState, opts?: pulumi.CustomResourceOptions): NetworkInterface

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterface

Returns true if the given object is an instance of NetworkInterface. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property appliedDnsServers

public appliedDnsServers: pulumi.Output<string[]>;

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.

property dnsServers

public dnsServers: pulumi.Output<string[]>;

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

property enableAcceleratedNetworking

public enableAcceleratedNetworking: pulumi.Output<boolean | undefined>;

Should Accelerated Networking be enabled? Defaults to false.

property enableIpForwarding

public enableIpForwarding: pulumi.Output<boolean | undefined>;

Should IP Forwarding be enabled? Defaults to false.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property internalDnsNameLabel

public internalDnsNameLabel: pulumi.Output<string>;

The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.

property internalDomainNameSuffix

public internalDomainNameSuffix: pulumi.Output<string>;

Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.

property ipConfigurations

public ipConfigurations: pulumi.Output<NetworkInterfaceIpConfiguration[]>;

One or more ipConfiguration blocks as defined below.

property location

public location: pulumi.Output<string>;

The location where the Network Interface should exist. Changing this forces a new resource to be created.

property macAddress

public macAddress: pulumi.Output<string>;

The Media Access Control (MAC) Address of the Network Interface.

property name

public name: pulumi.Output<string>;

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

property privateIpAddress

public privateIpAddress: pulumi.Output<string>;

The Static IP Address which should be used.

property privateIpAddresses

public privateIpAddresses: pulumi.Output<string[]>;

The private IP addresses of the network interface.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualMachineId

public virtualMachineId: pulumi.Output<string>;

The ID of the Virtual Machine which this Network Interface is connected to.

Resource NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation

class NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const frontend = new azure.network.Subnet("frontend", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const backend = new azure.network.Subnet("backend", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Dynamic",
});
const backendAddressPoolName = pulumi.interpolate`${exampleVirtualNetwork.name}-beap`;
const frontendPortName = pulumi.interpolate`${exampleVirtualNetwork.name}-feport`;
const frontendIpConfigurationName = pulumi.interpolate`${exampleVirtualNetwork.name}-feip`;
const httpSettingName = pulumi.interpolate`${exampleVirtualNetwork.name}-be-htst`;
const listenerName = pulumi.interpolate`${exampleVirtualNetwork.name}-httplstn`;
const requestRoutingRuleName = pulumi.interpolate`${exampleVirtualNetwork.name}-rqrt`;
const network = new azure.network.ApplicationGateway("network", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "Standard_Small",
        tier: "Standard",
        capacity: 2,
    },
    gateway_ip_configuration: [{
        name: "my-gateway-ip-configuration",
        subnetId: frontend.id,
    }],
    frontend_port: [{
        name: frontendPortName,
        port: 80,
    }],
    frontend_ip_configuration: [{
        name: frontendIpConfigurationName,
        publicIpAddressId: examplePublicIp.id,
    }],
    backend_address_pool: [{
        name: backendAddressPoolName,
    }],
    backend_http_settings: [{
        name: httpSettingName,
        cookieBasedAffinity: "Disabled",
        port: 80,
        protocol: "Http",
        requestTimeout: 1,
    }],
    http_listener: [{
        name: listenerName,
        frontendIpConfigurationName: frontendIpConfigurationName,
        frontendPortName: frontendPortName,
        protocol: "Http",
    }],
    request_routing_rule: [{
        name: requestRoutingRuleName,
        ruleType: "Basic",
        httpListenerName: listenerName,
        backendAddressPoolName: backendAddressPoolName,
        backendHttpSettingsName: httpSettingName,
    }],
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: frontend.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleNetworkInterfaceApplicationGatewayBackendAddressPoolAssociation = new azure.network.NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation("exampleNetworkInterfaceApplicationGatewayBackendAddressPoolAssociation", {
    networkInterfaceId: exampleNetworkInterface.id,
    ipConfigurationName: "testconfiguration1",
    backendAddressPoolId: network.backendAddressPools.apply(backendAddressPools => backendAddressPools[0].id),
});

constructor

new NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation(name: string, args: NetworkInterfaceApplicationGatewayBackendAddressPoolAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceApplicationGatewayBackendAddressPoolAssociationState, opts?: pulumi.CustomResourceOptions): NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation

Returns true if the given object is an instance of NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backendAddressPoolId

public backendAddressPoolId: pulumi.Output<string>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipConfigurationName

public ipConfigurationName: pulumi.Output<string>;

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.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkInterfaceApplicationSecurityGroupAssociation

class NetworkInterfaceApplicationSecurityGroupAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const exampleApplicationSecurityGroup = new azure.network.ApplicationSecurityGroup("exampleApplicationSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
        applicationSecurityGroupIds: [exampleApplicationSecurityGroup.id],
    }],
});
const exampleNetworkInterfaceApplicationSecurityGroupAssociation = new azure.network.NetworkInterfaceApplicationSecurityGroupAssociation("exampleNetworkInterfaceApplicationSecurityGroupAssociation", {
    networkInterfaceId: exampleNetworkInterface.id,
    applicationSecurityGroupId: exampleApplicationSecurityGroup.id,
});

constructor

new NetworkInterfaceApplicationSecurityGroupAssociation(name: string, args: NetworkInterfaceApplicationSecurityGroupAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterfaceApplicationSecurityGroupAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceApplicationSecurityGroupAssociationState, opts?: pulumi.CustomResourceOptions): NetworkInterfaceApplicationSecurityGroupAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterfaceApplicationSecurityGroupAssociation

Returns true if the given object is an instance of NetworkInterfaceApplicationSecurityGroupAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationSecurityGroupId

public applicationSecurityGroupId: pulumi.Output<string>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkInterfaceBackendAddressPoolAssociation

class NetworkInterfaceBackendAddressPoolAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "primary",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleBackendAddressPool = new azure.lb.BackendAddressPool("exampleBackendAddressPool", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleNetworkInterfaceBackendAddressPoolAssociation = new azure.network.NetworkInterfaceBackendAddressPoolAssociation("exampleNetworkInterfaceBackendAddressPoolAssociation", {
    networkInterfaceId: exampleNetworkInterface.id,
    ipConfigurationName: "testconfiguration1",
    backendAddressPoolId: exampleBackendAddressPool.id,
});

constructor

new NetworkInterfaceBackendAddressPoolAssociation(name: string, args: NetworkInterfaceBackendAddressPoolAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterfaceBackendAddressPoolAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceBackendAddressPoolAssociationState, opts?: pulumi.CustomResourceOptions): NetworkInterfaceBackendAddressPoolAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterfaceBackendAddressPoolAssociation

Returns true if the given object is an instance of NetworkInterfaceBackendAddressPoolAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backendAddressPoolId

public backendAddressPoolId: pulumi.Output<string>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipConfigurationName

public ipConfigurationName: pulumi.Output<string>;

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.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkInterfaceNatRuleAssociation

class NetworkInterfaceNatRuleAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
});
const exampleLoadBalancer = new azure.lb.LoadBalancer("exampleLoadBalancer", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    frontend_ip_configuration: [{
        name: "primary",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleNatRule = new azure.lb.NatRule("exampleNatRule", {
    resourceGroupName: exampleResourceGroup.name,
    loadbalancerId: exampleLoadBalancer.id,
    protocol: "Tcp",
    frontendPort: 3389,
    backendPort: 3389,
    frontendIpConfigurationName: "primary",
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleNetworkInterfaceNatRuleAssociation = new azure.network.NetworkInterfaceNatRuleAssociation("exampleNetworkInterfaceNatRuleAssociation", {
    networkInterfaceId: exampleNetworkInterface.id,
    ipConfigurationName: "testconfiguration1",
    natRuleId: exampleNatRule.id,
});

constructor

new NetworkInterfaceNatRuleAssociation(name: string, args: NetworkInterfaceNatRuleAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterfaceNatRuleAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceNatRuleAssociationState, opts?: pulumi.CustomResourceOptions): NetworkInterfaceNatRuleAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterfaceNatRuleAssociation

Returns true if the given object is an instance of NetworkInterfaceNatRuleAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipConfigurationName

public ipConfigurationName: pulumi.Output<string>;

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.

property natRuleId

public natRuleId: pulumi.Output<string>;

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.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkInterfaceSecurityGroupAssociation

class NetworkInterfaceSecurityGroupAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const exampleNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleNetworkInterfaceSecurityGroupAssociation = new azure.network.NetworkInterfaceSecurityGroupAssociation("exampleNetworkInterfaceSecurityGroupAssociation", {
    networkInterfaceId: exampleNetworkInterface.id,
    networkSecurityGroupId: exampleNetworkSecurityGroup.id,
});

constructor

new NetworkInterfaceSecurityGroupAssociation(name: string, args: NetworkInterfaceSecurityGroupAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterfaceSecurityGroupAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceSecurityGroupAssociationState, opts?: pulumi.CustomResourceOptions): NetworkInterfaceSecurityGroupAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterfaceSecurityGroupAssociation

Returns true if the given object is an instance of NetworkInterfaceSecurityGroupAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

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

property networkSecurityGroupId

public networkSecurityGroupId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkPacketCapture

class NetworkPacketCapture extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleNetworkWatcher = new azure.network.NetworkWatcher("exampleNetworkWatcher", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleVirtualMachine = new azure.compute.VirtualMachine("exampleVirtualMachine", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    networkInterfaceIds: [exampleNetworkInterface.id],
    vmSize: "Standard_F2",
    storage_image_reference: {
        publisher: "Canonical",
        offer: "UbuntuServer",
        sku: "16.04-LTS",
        version: "latest",
    },
    storage_os_disk: {
        name: "osdisk",
        caching: "ReadWrite",
        createOption: "FromImage",
        managedDiskType: "Standard_LRS",
    },
    os_profile: {
        computerName: "pctest-vm",
        adminUsername: "testadmin",
        adminPassword: "Password1234!",
    },
    os_profile_linux_config: {
        disablePasswordAuthentication: false,
    },
});
const exampleExtension = new azure.compute.Extension("exampleExtension", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    virtualMachineName: exampleVirtualMachine.name,
    publisher: "Microsoft.Azure.NetworkWatcher",
    type: "NetworkWatcherAgentLinux",
    typeHandlerVersion: "1.4",
    autoUpgradeMinorVersion: true,
});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleNetworkPacketCapture = new azure.network.NetworkPacketCapture("exampleNetworkPacketCapture", {
    networkWatcherName: exampleNetworkWatcher.name,
    resourceGroupName: exampleResourceGroup.name,
    targetResourceId: exampleVirtualMachine.id,
    storage_location: {
        storageAccountId: exampleAccount.id,
    },
});

constructor

new NetworkPacketCapture(name: string, args: NetworkPacketCaptureArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkPacketCapture resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkPacketCaptureState, opts?: pulumi.CustomResourceOptions): NetworkPacketCapture

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkPacketCapture

Returns true if the given object is an instance of NetworkPacketCapture. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property filters

public filters: pulumi.Output<NetworkPacketCaptureFilter[] | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maximumBytesPerPacket

public maximumBytesPerPacket: pulumi.Output<number | undefined>;

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.

property maximumBytesPerSession

public maximumBytesPerSession: pulumi.Output<number | undefined>;

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

property maximumCaptureDuration

public maximumCaptureDuration: pulumi.Output<number | undefined>;

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

property name

public name: pulumi.Output<string>;

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

property networkWatcherName

public networkWatcherName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property storageLocation

public storageLocation: pulumi.Output<NetworkPacketCaptureStorageLocation>;

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

property targetResourceId

public targetResourceId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkSecurityGroup

class NetworkSecurityGroup extends CustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    security_rule: [{
        name: "test123",
        priority: 100,
        direction: "Inbound",
        access: "Allow",
        protocol: "Tcp",
        sourcePortRange: "*",
        destinationPortRange: "*",
        sourceAddressPrefix: "*",
        destinationAddressPrefix: "*",
    }],
    tags: {
        environment: "Production",
    },
});

constructor

new NetworkSecurityGroup(name: string, args: NetworkSecurityGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkSecurityGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkSecurityGroupState, opts?: pulumi.CustomResourceOptions): NetworkSecurityGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkSecurityGroup

Returns true if the given object is an instance of NetworkSecurityGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

The name of the security rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property securityRules

public securityRules: pulumi.Output<NetworkSecurityGroupSecurityRule[]>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkSecurityRule

class NetworkSecurityRule extends CustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleNetworkSecurityRule = new azure.network.NetworkSecurityRule("exampleNetworkSecurityRule", {
    priority: 100,
    direction: "Outbound",
    access: "Allow",
    protocol: "Tcp",
    sourcePortRange: "*",
    destinationPortRange: "*",
    sourceAddressPrefix: "*",
    destinationAddressPrefix: "*",
    resourceGroupName: exampleResourceGroup.name,
    networkSecurityGroupName: exampleNetworkSecurityGroup.name,
});

constructor

new NetworkSecurityRule(name: string, args: NetworkSecurityRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkSecurityRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkSecurityRuleState, opts?: pulumi.CustomResourceOptions): NetworkSecurityRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkSecurityRule

Returns true if the given object is an instance of NetworkSecurityRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property access

public access: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

A description for this rule. Restricted to 140 characters.

property destinationAddressPrefix

public destinationAddressPrefix: pulumi.Output<string | undefined>;

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 destinationAddressPrefixes is not specified.

property destinationAddressPrefixes

public destinationAddressPrefixes: pulumi.Output<string[] | undefined>;

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

property destinationApplicationSecurityGroupIds

public destinationApplicationSecurityGroupIds: pulumi.Output<string | undefined>;

A List of destination Application Security Group ID’s

property destinationPortRange

public destinationPortRange: pulumi.Output<string | undefined>;

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

property destinationPortRanges

public destinationPortRanges: pulumi.Output<string[] | undefined>;

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

property direction

public direction: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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.

property networkSecurityGroupName

public networkSecurityGroupName: pulumi.Output<string>;

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

property priority

public priority: pulumi.Output<number>;

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.

property protocol

public protocol: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property sourceAddressPrefix

public sourceAddressPrefix: pulumi.Output<string | undefined>;

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 sourceAddressPrefixes is not specified.

property sourceAddressPrefixes

public sourceAddressPrefixes: pulumi.Output<string[] | undefined>;

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

property sourceApplicationSecurityGroupIds

public sourceApplicationSecurityGroupIds: pulumi.Output<string | undefined>;

A List of source Application Security Group ID’s

property sourcePortRange

public sourcePortRange: pulumi.Output<string | undefined>;

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

property sourcePortRanges

public sourcePortRanges: pulumi.Output<string[] | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkWatcher

class NetworkWatcher extends CustomResource

Manages a Network Watcher.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleNetworkWatcher = new azure.network.NetworkWatcher("exampleNetworkWatcher", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});

constructor

new NetworkWatcher(name: string, args: NetworkWatcherArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkWatcher resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkWatcherState, opts?: pulumi.CustomResourceOptions): NetworkWatcher

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkWatcher

Returns true if the given object is an instance of NetworkWatcher. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkWatcherFlowLog

class NetworkWatcherFlowLog extends CustomResource

Manages a Network Watcher Flow Log.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const testResourceGroup = new azure.core.ResourceGroup("testResourceGroup", {location: "eastus"});
const testNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("testNetworkSecurityGroup", {
    location: testResourceGroup.location,
    resourceGroupName: testResourceGroup.name,
});
const testNetworkWatcher = new azure.network.NetworkWatcher("testNetworkWatcher", {
    location: testResourceGroup.location,
    resourceGroupName: testResourceGroup.name,
});
const testAccount = new azure.storage.Account("testAccount", {
    resourceGroupName: testResourceGroup.name,
    location: testResourceGroup.location,
    accountTier: "Standard",
    accountKind: "StorageV2",
    accountReplicationType: "LRS",
    enableHttpsTrafficOnly: true,
});
const testAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("testAnalyticsWorkspace", {
    location: testResourceGroup.location,
    resourceGroupName: testResourceGroup.name,
    sku: "PerGB2018",
});
const testNetworkWatcherFlowLog = new azure.network.NetworkWatcherFlowLog("testNetworkWatcherFlowLog", {
    networkWatcherName: testNetworkWatcher.name,
    resourceGroupName: testResourceGroup.name,
    networkSecurityGroupId: testNetworkSecurityGroup.id,
    storageAccountId: testAccount.id,
    enabled: true,
    retention_policy: {
        enabled: true,
        days: 7,
    },
    traffic_analytics: {
        enabled: true,
        workspaceId: testAnalyticsWorkspace.workspaceId,
        workspaceRegion: testAnalyticsWorkspace.location,
        workspaceResourceId: testAnalyticsWorkspace.id,
        intervalInMinutes: 10,
    },
});

constructor

new NetworkWatcherFlowLog(name: string, args: NetworkWatcherFlowLogArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkWatcherFlowLog resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkWatcherFlowLogState, opts?: pulumi.CustomResourceOptions): NetworkWatcherFlowLog

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkWatcherFlowLog

Returns true if the given object is an instance of NetworkWatcherFlowLog. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean>;

Boolean flag to enable/disable traffic analytics.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property networkSecurityGroupId

public networkSecurityGroupId: pulumi.Output<string>;

The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.

property networkWatcherName

public networkWatcherName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property retentionPolicy

public retentionPolicy: pulumi.Output<NetworkWatcherFlowLogRetentionPolicy>;

A retentionPolicy block as documented below.

property storageAccountId

public storageAccountId: pulumi.Output<string>;

The ID of the Storage Account where flow logs are stored.

property trafficAnalytics

public trafficAnalytics: pulumi.Output<NetworkWatcherFlowLogTrafficAnalytics | undefined>;

A trafficAnalytics block as documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<number>;

The version (revision) of the flow log. Possible values are 1 and 2.

Resource PacketCapture

class PacketCapture extends CustomResource

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

NOTE: This resource has been deprecated in favour of the azure.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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleNetworkWatcher = new azure.network.NetworkWatcher("exampleNetworkWatcher", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
const exampleVirtualMachine = new azure.compute.VirtualMachine("exampleVirtualMachine", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    networkInterfaceIds: [exampleNetworkInterface.id],
    vmSize: "Standard_F2",
    storage_image_reference: {
        publisher: "Canonical",
        offer: "UbuntuServer",
        sku: "16.04-LTS",
        version: "latest",
    },
    storage_os_disk: {
        name: "osdisk",
        caching: "ReadWrite",
        createOption: "FromImage",
        managedDiskType: "Standard_LRS",
    },
    os_profile: {
        computerName: "pctest-vm",
        adminUsername: "testadmin",
        adminPassword: "Password1234!",
    },
    os_profile_linux_config: {
        disablePasswordAuthentication: false,
    },
});
const exampleExtension = new azure.compute.Extension("exampleExtension", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    virtualMachineName: exampleVirtualMachine.name,
    publisher: "Microsoft.Azure.NetworkWatcher",
    type: "NetworkWatcherAgentLinux",
    typeHandlerVersion: "1.4",
    autoUpgradeMinorVersion: true,
});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const examplePacketCapture = new azure.network.PacketCapture("examplePacketCapture", {
    networkWatcherName: exampleNetworkWatcher.name,
    resourceGroupName: exampleResourceGroup.name,
    targetResourceId: exampleVirtualMachine.id,
    storage_location: {
        storageAccountId: exampleAccount.id,
    },
});

constructor

new PacketCapture(name: string, args: PacketCaptureArgs, opts?: pulumi.CustomResourceOptions)

Create a PacketCapture resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PacketCaptureState, opts?: pulumi.CustomResourceOptions): PacketCapture

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PacketCapture

Returns true if the given object is an instance of PacketCapture. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property filters

public filters: pulumi.Output<PacketCaptureFilter[] | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property maximumBytesPerPacket

public maximumBytesPerPacket: pulumi.Output<number | undefined>;

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.

property maximumBytesPerSession

public maximumBytesPerSession: pulumi.Output<number | undefined>;

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

property maximumCaptureDuration

public maximumCaptureDuration: pulumi.Output<number | undefined>;

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

property name

public name: pulumi.Output<string>;

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

property networkWatcherName

public networkWatcherName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property storageLocation

public storageLocation: pulumi.Output<PacketCaptureStorageLocation>;

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

property targetResourceId

public targetResourceId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource PointToPointVpnGateway

class PointToPointVpnGateway extends CustomResource

Manages a Point-to-Site VPN Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.network.PointToPointVpnGateway("example", {
    location: azurerm_resource_group.example.location,
    resourceGroupName: azurerm_resource_group.example.resource_group_name,
    virtualHubId: azurerm_virtual_hub.example.id,
    vpnServerConfigurationId: azurerm_vpn_server_configuration.example.id,
    scaleUnit: 1,
});

constructor

new PointToPointVpnGateway(name: string, args: PointToPointVpnGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a PointToPointVpnGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PointToPointVpnGatewayState, opts?: pulumi.CustomResourceOptions): PointToPointVpnGateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PointToPointVpnGateway

Returns true if the given object is an instance of PointToPointVpnGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionConfiguration

public connectionConfiguration: pulumi.Output<PointToPointVpnGatewayConnectionConfiguration>;

A connectionConfiguration block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property scaleUnit

public scaleUnit: pulumi.Output<number>;

The Scale Unit for this Point-to-Site VPN Gateway.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the Point-to-Site VPN Gateway.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualHubId

public virtualHubId: pulumi.Output<string>;

The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.

property vpnServerConfigurationId

public vpnServerConfigurationId: pulumi.Output<string>;

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.

Resource Profile

class Profile extends CustomResource

Manages a Network Profile.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.1.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.1.0.0/24",
    delegation: [{
        name: "delegation",
        service_delegation: {
            name: "Microsoft.ContainerInstance/containerGroups",
            actions: ["Microsoft.Network/virtualNetworks/subnets/action"],
        },
    }],
});
const exampleProfile = new azure.network.Profile("exampleProfile", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    container_network_interface: {
        name: "examplecnic",
        ip_configuration: [{
            name: "exampleipconfig",
            subnetId: exampleSubnet.id,
        }],
    },
});

constructor

new Profile(name: string, args: ProfileArgs, opts?: pulumi.CustomResourceOptions)

Create a Profile resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProfileState, opts?: pulumi.CustomResourceOptions): Profile

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Profile

Returns true if the given object is an instance of Profile. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property containerNetworkInterface

public containerNetworkInterface: pulumi.Output<ProfileContainerNetworkInterface>;

A containerNetworkInterface block as documented below.

property containerNetworkInterfaceIds

public containerNetworkInterfaceIds: pulumi.Output<string[]>;

A list of Container Network Interface ID’s.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource PublicIp

class PublicIp extends CustomResource

Manages a Public IP Address.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    allocationMethod: "Static",
    tags: {
        environment: "Production",
    },
});

constructor

new PublicIp(name: string, args: PublicIpArgs, opts?: pulumi.CustomResourceOptions)

Create a PublicIp resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PublicIpState, opts?: pulumi.CustomResourceOptions): PublicIp

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PublicIp

Returns true if the given object is an instance of PublicIp. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocationMethod

public allocationMethod: pulumi.Output<string>;

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

property domainNameLabel

public domainNameLabel: pulumi.Output<string | undefined>;

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.

property fqdn

public fqdn: pulumi.Output<string>;

Fully qualified domain name of the A DNS record associated with the public IP. domainNameLabel must be specified to get the fqdn. This is the concatenation of the domainNameLabel and the regionalized DNS zone

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idleTimeoutInMinutes

public idleTimeoutInMinutes: pulumi.Output<number | undefined>;

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

property ipAddress

public ipAddress: pulumi.Output<string>;

The IP address value that was allocated.

property ipVersion

public ipVersion: pulumi.Output<string | undefined>;

The IP Version to use, IPv6 or IPv4.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property publicIpPrefixId

public publicIpPrefixId: pulumi.Output<string | undefined>;

If specified then public IP address allocated will be provided from the public IP prefix resource.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property reverseFqdn

public reverseFqdn: pulumi.Output<string | undefined>;

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.

property sku

public sku: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zones

public zones: pulumi.Output<string | undefined>;

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

Resource PublicIpPrefix

class PublicIpPrefix extends CustomResource

Manages a Public IP Prefix.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePublicIpPrefix = new azure.network.PublicIpPrefix("examplePublicIpPrefix", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    prefixLength: 31,
    tags: {
        environment: "Production",
    },
});

constructor

new PublicIpPrefix(name: string, args: PublicIpPrefixArgs, opts?: pulumi.CustomResourceOptions)

Create a PublicIpPrefix resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PublicIpPrefixState, opts?: pulumi.CustomResourceOptions): PublicIpPrefix

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PublicIpPrefix

Returns true if the given object is an instance of PublicIpPrefix. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipPrefix

public ipPrefix: pulumi.Output<string>;

The IP address prefix value that was allocated.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property prefixLength

public prefixLength: pulumi.Output<number | undefined>;

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.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Public IP Prefix.

property sku

public sku: pulumi.Output<string | undefined>;

The SKU of the Public IP Prefix. Accepted values are Standard. Defaults to Standard. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zones

public zones: pulumi.Output<string | undefined>;

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

Resource Route

class Route extends CustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleRouteTable = new azure.network.RouteTable("exampleRouteTable", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleRoute = new azure.network.Route("exampleRoute", {
    resourceGroupName: exampleResourceGroup.name,
    routeTableName: exampleRouteTable.name,
    addressPrefix: "10.1.0.0/16",
    nextHopType: "vnetlocal",
});

constructor

new Route(name: string, args: RouteArgs, opts?: pulumi.CustomResourceOptions)

Create a Route resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteState, opts?: pulumi.CustomResourceOptions): Route

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Route

Returns true if the given object is an instance of Route. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressPrefix

public addressPrefix: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property nextHopInIpAddress

public nextHopInIpAddress: pulumi.Output<string | undefined>;

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

property nextHopType

public nextHopType: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property routeTableName

public routeTableName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RouteTable

class RouteTable extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleRouteTable = new azure.network.RouteTable("exampleRouteTable", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    disableBgpRoutePropagation: false,
    route: [{
        name: "route1",
        addressPrefix: "10.1.0.0/16",
        nextHopType: "vnetlocal",
    }],
    tags: {
        environment: "Production",
    },
});

constructor

new RouteTable(name: string, args: RouteTableArgs, opts?: pulumi.CustomResourceOptions)

Create a RouteTable resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteTableState, opts?: pulumi.CustomResourceOptions): RouteTable

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouteTable

Returns true if the given object is an instance of RouteTable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property disableBgpRoutePropagation

public disableBgpRoutePropagation: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

The name of the route.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property routes

public routes: pulumi.Output<RouteTableRoute[]>;

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

property subnets

public subnets: pulumi.Output<string[]>;

The collection of Subnets associated with this route table.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Subnet

class Subnet extends CustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["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",
            ],
        },
    }],
});

constructor

new Subnet(name: string, args: SubnetArgs, opts?: pulumi.CustomResourceOptions)

Create a Subnet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetState, opts?: pulumi.CustomResourceOptions): Subnet

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Subnet

Returns true if the given object is an instance of Subnet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressPrefix

DEPRECATED Use the address_prefixes property instead.
public addressPrefix: pulumi.Output<string>;

The address prefix to use for the subnet.

property addressPrefixes

public addressPrefixes: pulumi.Output<string[]>;

The address prefixes to use for the subnet.

property delegations

public delegations: pulumi.Output<SubnetDelegation[] | undefined>;

One or more delegation blocks as defined below.

property enforcePrivateLinkEndpointNetworkPolicies

public enforcePrivateLinkEndpointNetworkPolicies: pulumi.Output<boolean | undefined>;

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.

property enforcePrivateLinkServiceNetworkPolicies

public enforcePrivateLinkServiceNetworkPolicies: pulumi.Output<boolean | undefined>;

Enable or Disable network policies for the private link service on the subnet. Default valule is false. Conflicts with enforcePrivateLinkEndpointNetworkPolicies.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property serviceEndpoints

public serviceEndpoints: pulumi.Output<string[] | undefined>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualNetworkName

public virtualNetworkName: pulumi.Output<string>;

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

Resource SubnetNatGatewayAssociation

class SubnetNatGatewayAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "East US 2"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.2.0/24"],
});
const exampleNatGateway = new azure.network.NatGateway("exampleNatGateway", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnetNatGatewayAssociation = new azure.network.SubnetNatGatewayAssociation("exampleSubnetNatGatewayAssociation", {
    subnetId: exampleSubnet.id,
    natGatewayId: exampleNatGateway.id,
});

constructor

new SubnetNatGatewayAssociation(name: string, args: SubnetNatGatewayAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetNatGatewayAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetNatGatewayAssociationState, opts?: pulumi.CustomResourceOptions): SubnetNatGatewayAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetNatGatewayAssociation

Returns true if the given object is an instance of SubnetNatGatewayAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property natGatewayId

public natGatewayId: pulumi.Output<string>;

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

property subnetId

public subnetId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SubnetNetworkSecurityGroupAssociation

class SubnetNetworkSecurityGroupAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const exampleNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    security_rule: [{
        name: "test123",
        priority: 100,
        direction: "Inbound",
        access: "Allow",
        protocol: "Tcp",
        sourcePortRange: "*",
        destinationPortRange: "*",
        sourceAddressPrefix: "*",
        destinationAddressPrefix: "*",
    }],
});
const exampleSubnetNetworkSecurityGroupAssociation = new azure.network.SubnetNetworkSecurityGroupAssociation("exampleSubnetNetworkSecurityGroupAssociation", {
    subnetId: exampleSubnet.id,
    networkSecurityGroupId: exampleNetworkSecurityGroup.id,
});

constructor

new SubnetNetworkSecurityGroupAssociation(name: string, args: SubnetNetworkSecurityGroupAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetNetworkSecurityGroupAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetNetworkSecurityGroupAssociationState, opts?: pulumi.CustomResourceOptions): SubnetNetworkSecurityGroupAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetNetworkSecurityGroupAssociation

Returns true if the given object is an instance of SubnetNetworkSecurityGroupAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property networkSecurityGroupId

public networkSecurityGroupId: pulumi.Output<string>;

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

property subnetId

public subnetId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SubnetRouteTableAssociation

class SubnetRouteTableAssociation extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const exampleRouteTable = new azure.network.RouteTable("exampleRouteTable", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    route: [{
        name: "example",
        addressPrefix: "10.100.0.0/14",
        nextHopType: "VirtualAppliance",
        nextHopInIpAddress: "10.10.1.1",
    }],
});
const exampleSubnetRouteTableAssociation = new azure.network.SubnetRouteTableAssociation("exampleSubnetRouteTableAssociation", {
    subnetId: exampleSubnet.id,
    routeTableId: exampleRouteTable.id,
});

constructor

new SubnetRouteTableAssociation(name: string, args: SubnetRouteTableAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetRouteTableAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetRouteTableAssociationState, opts?: pulumi.CustomResourceOptions): SubnetRouteTableAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetRouteTableAssociation

Returns true if the given object is an instance of SubnetRouteTableAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property routeTableId

public routeTableId: pulumi.Output<string>;

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

property subnetId

public subnetId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TrafficManagerEndpoint

class TrafficManagerEndpoint extends CustomResource

Manages a Traffic Manager Endpoint.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as random from "@pulumi/random";

const server = new random.RandomId("server", {
    keepers: {
        azi_id: 1,
    },
    byteLength: 8,
});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleTrafficManagerProfile = new azure.network.TrafficManagerProfile("exampleTrafficManagerProfile", {
    resourceGroupName: exampleResourceGroup.name,
    trafficRoutingMethod: "Weighted",
    dns_config: {
        relativeName: server.hex,
        ttl: 100,
    },
    monitor_config: {
        protocol: "http",
        port: 80,
        path: "/",
        intervalInSeconds: 30,
        timeoutInSeconds: 9,
        toleratedNumberOfFailures: 3,
    },
    tags: {
        environment: "Production",
    },
});
const exampleTrafficManagerEndpoint = new azure.network.TrafficManagerEndpoint("exampleTrafficManagerEndpoint", {
    resourceGroupName: exampleResourceGroup.name,
    profileName: exampleTrafficManagerProfile.name,
    type: "externalEndpoints",
    weight: 100,
});

constructor

new TrafficManagerEndpoint(name: string, args: TrafficManagerEndpointArgs, opts?: pulumi.CustomResourceOptions)

Create a TrafficManagerEndpoint resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TrafficManagerEndpointState, opts?: pulumi.CustomResourceOptions): TrafficManagerEndpoint

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TrafficManagerEndpoint

Returns true if the given object is an instance of TrafficManagerEndpoint. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property customHeaders

public customHeaders: pulumi.Output<TrafficManagerEndpointCustomHeader[] | undefined>;

One or more customHeader blocks as defined below

property endpointLocation

public endpointLocation: pulumi.Output<string>;

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.

property endpointMonitorStatus

public endpointMonitorStatus: pulumi.Output<string>;

property endpointStatus

public endpointStatus: pulumi.Output<string>;

The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.

property geoMappings

public geoMappings: pulumi.Output<string[] | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property minChildEndpoints

public minChildEndpoints: pulumi.Output<number | undefined>;

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.

property name

public name: pulumi.Output<string>;

The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.

property priority

public priority: pulumi.Output<number>;

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.

property profileName

public profileName: pulumi.Output<string>;

The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group where the Traffic Manager Profile exists.

property subnets

public subnets: pulumi.Output<TrafficManagerEndpointSubnet[] | undefined>;

One or more subnet blocks as defined below

property target

public target: pulumi.Output<string>;

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.

property targetResourceId

public targetResourceId: pulumi.Output<string | undefined>;

The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.

property type

public type: pulumi.Output<string>;

The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property weight

public weight: pulumi.Output<number>;

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.

Resource TrafficManagerProfile

class TrafficManagerProfile extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as random from "@pulumi/random";

const server = new random.RandomId("server", {
    keepers: {
        azi_id: 1,
    },
    byteLength: 8,
});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleTrafficManagerProfile = new azure.network.TrafficManagerProfile("exampleTrafficManagerProfile", {
    resourceGroupName: exampleResourceGroup.name,
    trafficRoutingMethod: "Weighted",
    dns_config: {
        relativeName: server.hex,
        ttl: 100,
    },
    monitor_config: {
        protocol: "http",
        port: 80,
        path: "/",
        intervalInSeconds: 30,
        timeoutInSeconds: 9,
        toleratedNumberOfFailures: 3,
    },
    tags: {
        environment: "Production",
    },
});

constructor

new TrafficManagerProfile(name: string, args: TrafficManagerProfileArgs, opts?: pulumi.CustomResourceOptions)

Create a TrafficManagerProfile resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TrafficManagerProfileState, opts?: pulumi.CustomResourceOptions): TrafficManagerProfile

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TrafficManagerProfile

Returns true if the given object is an instance of TrafficManagerProfile. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dnsConfig

public dnsConfig: pulumi.Output<TrafficManagerProfileDnsConfig>;

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

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the created Profile.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property monitorConfig

public monitorConfig: pulumi.Output<TrafficManagerProfileMonitorConfig>;

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

property name

public name: pulumi.Output<string>;

The name of the Traffic Manager profile. Changing this forces a new resource to be created.

property profileStatus

public profileStatus: pulumi.Output<string>;

The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Traffic Manager profile.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property trafficRoutingMethod

public trafficRoutingMethod: pulumi.Output<string>;

Specifies the algorithm used to route traffic, possible values are:

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource VirtualHub

class VirtualHub extends CustomResource

Manages a Virtual Hub within a Virtual WAN.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualWan = new azure.network.VirtualWan("exampleVirtualWan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("exampleVirtualHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.1.0/24",
});

constructor

new VirtualHub(name: string, args: VirtualHubArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualHub resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualHubState, opts?: pulumi.CustomResourceOptions): VirtualHub

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualHub

Returns true if the given object is an instance of VirtualHub. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressPrefix

public addressPrefix: pulumi.Output<string>;

The Address Prefix which should be used for this Virtual Hub.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.

property routes

public routes: pulumi.Output<VirtualHubRoute[] | undefined>;

One or more route blocks as defined below.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the Virtual Hub.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualWanId

public virtualWanId: pulumi.Output<string>;

The ID of a Virtual WAN within which the Virtual Hub should be created.

Resource VirtualHubConnection

class VirtualHubConnection extends CustomResource

Manages a Connection for a Virtual Hub.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["172.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const test = new azure.network.VirtualWan("test", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("exampleVirtualHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualWanId: azurerm_virtual_wan.example.id,
    addressPrefix: "10.0.1.0/24",
});
const exampleVirtualHubConnection = new azure.network.VirtualHubConnection("exampleVirtualHubConnection", {
    virtualHubId: exampleVirtualHub.id,
    remoteVirtualNetworkId: exampleVirtualNetwork.id,
});

constructor

new VirtualHubConnection(name: string, args: VirtualHubConnectionArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualHubConnection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualHubConnectionState, opts?: pulumi.CustomResourceOptions): VirtualHubConnection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualHubConnection

Returns true if the given object is an instance of VirtualHubConnection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property hubToVitualNetworkTrafficAllowed

public hubToVitualNetworkTrafficAllowed: pulumi.Output<boolean | undefined>;

Is the Virtual Hub traffic allowed to transit via the Remote Virtual Network? Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property internetSecurityEnabled

public internetSecurityEnabled: pulumi.Output<boolean | undefined>;

Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

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.

property remoteVirtualNetworkId

public remoteVirtualNetworkId: pulumi.Output<string>;

The ID of the Virtual Network which the Virtual Hub should be connected to. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualHubId

public virtualHubId: pulumi.Output<string>;

The ID of the Virtual Hub within which this connection should be created. Changing this forces a new resource to be created.

property vitualNetworkToHubGatewaysTrafficAllowed

public vitualNetworkToHubGatewaysTrafficAllowed: pulumi.Output<boolean | undefined>;

Is Remote Virtual Network traffic allowed to transit the Hub’s Virtual Network Gateway’s? Changing this forces a new resource to be created.

Resource VirtualNetwork

class VirtualNetwork extends CustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleDdosProtectionPlan = new azure.network.DdosProtectionPlan("exampleDdosProtectionPlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
    dnsServers: [
        "10.0.0.4",
        "10.0.0.5",
    ],
    ddos_protection_plan: {
        id: exampleDdosProtectionPlan.id,
        enable: true,
    },
    subnet: [
        {
            name: "subnet1",
            addressPrefix: "10.0.1.0/24",
        },
        {
            name: "subnet2",
            addressPrefix: "10.0.2.0/24",
        },
        {
            name: "subnet3",
            addressPrefix: "10.0.3.0/24",
            securityGroup: exampleNetworkSecurityGroup.id,
        },
    ],
    tags: {
        environment: "Production",
    },
});

constructor

new VirtualNetwork(name: string, args: VirtualNetworkArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualNetwork resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualNetworkState, opts?: pulumi.CustomResourceOptions): VirtualNetwork

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualNetwork

Returns true if the given object is an instance of VirtualNetwork. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressSpaces

public addressSpaces: pulumi.Output<string[]>;

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.

property ddosProtectionPlan

public ddosProtectionPlan: pulumi.Output<VirtualNetworkDdosProtectionPlan | undefined>;

A ddosProtectionPlan block as documented below.

property dnsServers

public dnsServers: pulumi.Output<string[] | undefined>;

List of IP addresses of DNS servers

property guid

public guid: pulumi.Output<string>;

The GUID of the virtual network.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property subnets

public subnets: pulumi.Output<VirtualNetworkSubnet[]>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource VirtualNetworkGateway

class VirtualNetworkGateway extends CustomResource

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)

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Dynamic",
});
const exampleVirtualNetworkGateway = new azure.network.VirtualNetworkGateway("exampleVirtualNetworkGateway", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    type: "Vpn",
    vpnType: "RouteBased",
    activeActive: false,
    enableBgp: false,
    sku: "Basic",
    ip_configuration: [{
        name: "vnetGatewayConfig",
        publicIpAddressId: examplePublicIp.id,
        privateIpAddressAllocation: "Dynamic",
        subnetId: exampleSubnet.id,
    }],
    vpn_client_configuration: {
        addressSpaces: ["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",
        }],
    },
});

constructor

new VirtualNetworkGateway(name: string, args: VirtualNetworkGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualNetworkGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualNetworkGatewayState, opts?: pulumi.CustomResourceOptions): VirtualNetworkGateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualNetworkGateway

Returns true if the given object is an instance of VirtualNetworkGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property activeActive

public activeActive: pulumi.Output<boolean>;

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.

property bgpSettings

public bgpSettings: pulumi.Output<VirtualNetworkGatewayBgpSettings>;

property defaultLocalNetworkGatewayId

public defaultLocalNetworkGatewayId: pulumi.Output<string | undefined>;

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.

property enableBgp

public enableBgp: pulumi.Output<boolean>;

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

property generation

public generation: pulumi.Output<string>;

The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipConfigurations

public ipConfigurations: pulumi.Output<VirtualNetworkGatewayIpConfiguration[]>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

A user-defined name of the revoked certificate.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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.

property sku

public sku: pulumi.Output<string>;

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, vpnType and generation arguments. A PolicyBased gateway only supports the Basic sku. Further, the UltraPerformance sku is only supported by an ExpressRoute gateway.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property type

public type: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpnClientConfiguration

public vpnClientConfiguration: pulumi.Output<VirtualNetworkGatewayVpnClientConfiguration | undefined>;

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

property vpnType

public vpnType: pulumi.Output<string | undefined>;

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

Resource VirtualNetworkGatewayConnection

class VirtualNetworkGatewayConnection extends CustomResource

Manages a connection in an existing Virtual Network Gateway.

Example Usage

Site-to-Site connection
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const onpremiseLocalNetworkGateway = new azure.network.LocalNetworkGateway("onpremiseLocalNetworkGateway", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    gatewayAddress: "168.62.225.23",
    addressSpaces: ["10.1.1.0/24"],
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Dynamic",
});
const exampleVirtualNetworkGateway = new azure.network.VirtualNetworkGateway("exampleVirtualNetworkGateway", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    type: "Vpn",
    vpnType: "RouteBased",
    activeActive: false,
    enableBgp: false,
    sku: "Basic",
    ip_configuration: [{
        publicIpAddressId: examplePublicIp.id,
        privateIpAddressAllocation: "Dynamic",
        subnetId: exampleSubnet.id,
    }],
});
const onpremiseVirtualNetworkGatewayConnection = new azure.network.VirtualNetworkGatewayConnection("onpremiseVirtualNetworkGatewayConnection", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    type: "IPsec",
    virtualNetworkGatewayId: exampleVirtualNetworkGateway.id,
    localNetworkGatewayId: onpremiseLocalNetworkGateway.id,
    sharedKey: "4-v3ry-53cr37-1p53c-5h4r3d-k3y",
});
VNet-to-VNet connection
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const usResourceGroup = new azure.core.ResourceGroup("usResourceGroup", {location: "East US"});
const usVirtualNetwork = new azure.network.VirtualNetwork("usVirtualNetwork", {
    location: usResourceGroup.location,
    resourceGroupName: usResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
});
const usGateway = new azure.network.Subnet("usGateway", {
    resourceGroupName: usResourceGroup.name,
    virtualNetworkName: usVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const usPublicIp = new azure.network.PublicIp("usPublicIp", {
    location: usResourceGroup.location,
    resourceGroupName: usResourceGroup.name,
    allocationMethod: "Dynamic",
});
const usVirtualNetworkGateway = new azure.network.VirtualNetworkGateway("usVirtualNetworkGateway", {
    location: usResourceGroup.location,
    resourceGroupName: usResourceGroup.name,
    type: "Vpn",
    vpnType: "RouteBased",
    sku: "Basic",
    ip_configuration: [{
        publicIpAddressId: usPublicIp.id,
        privateIpAddressAllocation: "Dynamic",
        subnetId: usGateway.id,
    }],
});
const europeResourceGroup = new azure.core.ResourceGroup("europeResourceGroup", {location: "West Europe"});
const europeVirtualNetwork = new azure.network.VirtualNetwork("europeVirtualNetwork", {
    location: europeResourceGroup.location,
    resourceGroupName: europeResourceGroup.name,
    addressSpaces: ["10.1.0.0/16"],
});
const europeGateway = new azure.network.Subnet("europeGateway", {
    resourceGroupName: europeResourceGroup.name,
    virtualNetworkName: europeVirtualNetwork.name,
    addressPrefix: "10.1.1.0/24",
});
const europePublicIp = new azure.network.PublicIp("europePublicIp", {
    location: europeResourceGroup.location,
    resourceGroupName: europeResourceGroup.name,
    allocationMethod: "Dynamic",
});
const europeVirtualNetworkGateway = new azure.network.VirtualNetworkGateway("europeVirtualNetworkGateway", {
    location: europeResourceGroup.location,
    resourceGroupName: europeResourceGroup.name,
    type: "Vpn",
    vpnType: "RouteBased",
    sku: "Basic",
    ip_configuration: [{
        publicIpAddressId: europePublicIp.id,
        privateIpAddressAllocation: "Dynamic",
        subnetId: europeGateway.id,
    }],
});
const usToEurope = new azure.network.VirtualNetworkGatewayConnection("usToEurope", {
    location: usResourceGroup.location,
    resourceGroupName: usResourceGroup.name,
    type: "Vnet2Vnet",
    virtualNetworkGatewayId: usVirtualNetworkGateway.id,
    peerVirtualNetworkGatewayId: europeVirtualNetworkGateway.id,
    sharedKey: "4-v3ry-53cr37-1p53c-5h4r3d-k3y",
});
const europeToUs = new azure.network.VirtualNetworkGatewayConnection("europeToUs", {
    location: europeResourceGroup.location,
    resourceGroupName: europeResourceGroup.name,
    type: "Vnet2Vnet",
    virtualNetworkGatewayId: europeVirtualNetworkGateway.id,
    peerVirtualNetworkGatewayId: usVirtualNetworkGateway.id,
    sharedKey: "4-v3ry-53cr37-1p53c-5h4r3d-k3y",
});

constructor

new VirtualNetworkGatewayConnection(name: string, args: VirtualNetworkGatewayConnectionArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualNetworkGatewayConnection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualNetworkGatewayConnectionState, opts?: pulumi.CustomResourceOptions): VirtualNetworkGatewayConnection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualNetworkGatewayConnection

Returns true if the given object is an instance of VirtualNetworkGatewayConnection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property authorizationKey

public authorizationKey: pulumi.Output<string | undefined>;

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

property connectionProtocol

public connectionProtocol: pulumi.Output<string>;

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.

property enableBgp

public enableBgp: pulumi.Output<boolean>;

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

property expressRouteCircuitId

public expressRouteCircuitId: pulumi.Output<string | undefined>;

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.

property expressRouteGatewayBypass

public expressRouteGatewayBypass: pulumi.Output<boolean>;

If true, data packets will bypass ExpressRoute Gateway for data forwarding This is only valid for ExpressRoute connections.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipsecPolicy

public ipsecPolicy: pulumi.Output<VirtualNetworkGatewayConnectionIpsecPolicy | undefined>;

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

property localNetworkGatewayId

public localNetworkGatewayId: pulumi.Output<string | undefined>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property peerVirtualNetworkGatewayId

public peerVirtualNetworkGatewayId: pulumi.Output<string | undefined>;

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.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property routingWeight

public routingWeight: pulumi.Output<number>;

The routing weight. Defaults to 10.

property sharedKey

public sharedKey: pulumi.Output<string | undefined>;

The shared IPSec key. A key could be provided if a Site-to-Site, VNet-to-VNet or ExpressRoute connection is created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property type

public type: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property usePolicyBasedTrafficSelectors

public usePolicyBasedTrafficSelectors: pulumi.Output<boolean>;

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

property virtualNetworkGatewayId

public virtualNetworkGatewayId: pulumi.Output<string>;

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

Resource VirtualNetworkPeering

class VirtualNetworkPeering extends CustomResource

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West US"});
const example_1VirtualNetwork = new azure.network.VirtualNetwork("example-1VirtualNetwork", {
    resourceGroupName: example.name,
    addressSpaces: ["10.0.1.0/24"],
    location: "West US",
});
const example_2VirtualNetwork = new azure.network.VirtualNetwork("example-2VirtualNetwork", {
    resourceGroupName: example.name,
    addressSpaces: ["10.0.2.0/24"],
    location: "West US",
});
const example_1VirtualNetworkPeering = new azure.network.VirtualNetworkPeering("example-1VirtualNetworkPeering", {
    resourceGroupName: example.name,
    virtualNetworkName: example_1VirtualNetwork.name,
    remoteVirtualNetworkId: example_2VirtualNetwork.id,
});
const example_2VirtualNetworkPeering = new azure.network.VirtualNetworkPeering("example-2VirtualNetworkPeering", {
    resourceGroupName: example.name,
    virtualNetworkName: example_2VirtualNetwork.name,
    remoteVirtualNetworkId: example_1VirtualNetwork.id,
});

Note

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

constructor

new VirtualNetworkPeering(name: string, args: VirtualNetworkPeeringArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualNetworkPeering resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualNetworkPeeringState, opts?: pulumi.CustomResourceOptions): VirtualNetworkPeering

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualNetworkPeering

Returns true if the given object is an instance of VirtualNetworkPeering. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowForwardedTraffic

public allowForwardedTraffic: pulumi.Output<boolean>;

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

property allowGatewayTransit

public allowGatewayTransit: pulumi.Output<boolean>;

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

property allowVirtualNetworkAccess

public allowVirtualNetworkAccess: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property remoteVirtualNetworkId

public remoteVirtualNetworkId: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property useRemoteGateways

public useRemoteGateways: pulumi.Output<boolean>;

Controls if remote gateways can be used on the local virtual network. If the flag is set to true, and allowGatewayTransit 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.

property virtualNetworkName

public virtualNetworkName: pulumi.Output<string>;

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

Resource VirtualWan

class VirtualWan extends CustomResource

Manages a Virtual WAN.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualWan = new azure.network.VirtualWan("exampleVirtualWan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});

constructor

new VirtualWan(name: string, args: VirtualWanArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualWan resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualWanState, opts?: pulumi.CustomResourceOptions): VirtualWan

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VirtualWan

Returns true if the given object is an instance of VirtualWan. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowBranchToBranchTraffic

public allowBranchToBranchTraffic: pulumi.Output<boolean | undefined>;

Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.

property allowVnetToVnetTraffic

public allowVnetToVnetTraffic: pulumi.Output<boolean | undefined>;

Boolean flag to specify whether VNet to VNet traffic is allowed. Defaults to false.

property disableVpnEncryption

public disableVpnEncryption: pulumi.Output<boolean | undefined>;

Boolean flag to specify whether VPN encryption is disabled. Defaults to false.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property office365LocalBreakoutCategory

public office365LocalBreakoutCategory: pulumi.Output<string | undefined>;

Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the Virtual WAN.

property type

public type: pulumi.Output<string | undefined>;

Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource VpnGateway

class VpnGateway extends CustomResource

Manages a VPN Gateway within a Virtual Hub, which enables Site-to-Site communication.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
});
const exampleVirtualWan = new azure.network.VirtualWan("exampleVirtualWan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("exampleVirtualHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.1.0/24",
});
const exampleVpnGateway = new azure.network.VpnGateway("exampleVpnGateway", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    virtualHubId: exampleVirtualHub.id,
});

constructor

new VpnGateway(name: string, args: VpnGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a VpnGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpnGatewayState, opts?: pulumi.CustomResourceOptions): VpnGateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VpnGateway

Returns true if the given object is an instance of VpnGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bgpSettings

public bgpSettings: pulumi.Output<VpnGatewayBgpSetting[]>;

A bgpSettings block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.

property scaleUnit

public scaleUnit: pulumi.Output<number | undefined>;

The Scale Unit for this VPN Gateway. Defaults to 1.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the VPN Gateway.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualHubId

public virtualHubId: pulumi.Output<string>;

The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.

Resource VpnServerConfiguration

class VpnServerConfiguration extends CustomResource

Manages a VPN Server Configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {location: "West Europe"});
const test = new azure.network.VpnServerConfiguration("test", {
    resourceGroupName: example.name,
    location: example.location,
    vpnAuthenticationTypes: ["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=
`,
    }],
});

constructor

new VpnServerConfiguration(name: string, args: VpnServerConfigurationArgs, opts?: pulumi.CustomResourceOptions)

Create a VpnServerConfiguration resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpnServerConfigurationState, opts?: pulumi.CustomResourceOptions): VpnServerConfiguration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VpnServerConfiguration

Returns true if the given object is an instance of VpnServerConfiguration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property azureActiveDirectoryAuthentications

public azureActiveDirectoryAuthentications: pulumi.Output<VpnServerConfigurationAzureActiveDirectoryAuthentication[] | undefined>;

A azureActiveDirectoryAuthentication block as defined below.

property clientRevokedCertificates

public clientRevokedCertificates: pulumi.Output<VpnServerConfigurationClientRevokedCertificate[] | undefined>;

One or more clientRevokedCertificate blocks as defined below.

property clientRootCertificates

public clientRootCertificates: pulumi.Output<VpnServerConfigurationClientRootCertificate[] | undefined>;

One or more clientRootCertificate blocks as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipsecPolicy

public ipsecPolicy: pulumi.Output<VpnServerConfigurationIpsecPolicy | undefined>;

A ipsecPolicy block as defined below.

property location

public location: pulumi.Output<string>;

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

property radiusServer

public radiusServer: pulumi.Output<VpnServerConfigurationRadiusServer | undefined>;

A radiusServer block as defined below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpnAuthenticationTypes

public vpnAuthenticationTypes: pulumi.Output<string>;

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

property vpnProtocols

public vpnProtocols: pulumi.Output<string[]>;

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

Functions

Function getApplicationSecurityGroup

getApplicationSecurityGroup(args: GetApplicationSecurityGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetApplicationSecurityGroupResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getApplicationSecurityGroup({
    name: "tf-appsecuritygroup",
    resourceGroupName: "my-resource-group",
});
export const applicationSecurityGroupId = example.then(example => example.id);

Function getExpressRouteCircuit

getExpressRouteCircuit(args: GetExpressRouteCircuitArgs, opts?: pulumi.InvokeOptions): Promise<GetExpressRouteCircuitResult>

Use this data source to access information about an existing ExpressRoute circuit.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getExpressRouteCircuit({
    resourceGroupName: azurerm_resource_group.example.name,
    name: azurerm_express_route_circuit.example.name,
});
export const expressRouteCircuitId = example.then(example => example.id);
export const serviceKey = example.then(example => example.serviceKey);

Function getFirewall

getFirewall(args: GetFirewallArgs, opts?: pulumi.InvokeOptions): Promise<GetFirewallResult>

Use this data source to access information about an existing Azure Firewall.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getFirewall({
    name: "firewall1",
    resourceGroupName: "firewall-RG",
});
export const firewallPrivateIp = example.then(example => example.ipConfigurations[0].privateIpAddress);

Function getGatewayConnection

getGatewayConnection(args: GetGatewayConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetGatewayConnectionResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getGatewayConnection({
    name: "production",
    resourceGroupName: "networking",
});
export const virtualNetworkGatewayConnectionId = example.then(example => example.id);

Function getNatGateway

getNatGateway(args: GetNatGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetNatGatewayResult>

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

Function getNetworkDdosProtectionPlan

getNetworkDdosProtectionPlan(args: GetNetworkDdosProtectionPlanArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkDdosProtectionPlanResult>

Use this data source to access information about an existing Azure Network DDoS Protection Plan.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getNetworkDdosProtectionPlan({
    name: azurerm_network_ddos_protection_plan.example.name,
    resourceGroupName: azurerm_network_ddos_protection_plan.example.resource_group_name,
});
export const ddosProtectionPlanId = example.then(example => example.id);

Function getNetworkInterface

getNetworkInterface(args: GetNetworkInterfaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkInterfaceResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getNetworkInterface({
    name: "acctest-nic",
    resourceGroupName: "networking",
});
export const networkInterfaceId = example.then(example => example.id);

Function getNetworkSecurityGroup

getNetworkSecurityGroup(args: GetNetworkSecurityGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkSecurityGroupResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getNetworkSecurityGroup({
    name: azurerm_network_security_group.example.name,
    resourceGroupName: azurerm_resource_group.example.name,
});
export const location = example.then(example => example.location);

Function getNetworkWatcher

getNetworkWatcher(args: GetNetworkWatcherArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkWatcherResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getNetworkWatcher({
    name: azurerm_network_watcher.example.name,
    resourceGroupName: azurerm_resource_group.example.name,
});
export const networkWatcherId = example.then(example => example.id);

Function getPublicIP

getPublicIP(args: GetPublicIPArgs, opts?: pulumi.InvokeOptions): Promise<GetPublicIPResult>

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

Example Usage

Reference An Existing)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getPublicIP({
    name: "name_of_public_ip",
    resourceGroupName: "name_of_resource_group",
});
export const domainNameLabel = example.then(example => example.domainNameLabel);
export const publicIpAddress = example.then(example => example.ipAddress);
Retrieve The Dynamic Public IP Of A New VM)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US 2"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.2.0/24",
});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Dynamic",
    idleTimeoutInMinutes: 30,
    tags: {
        environment: "test",
    },
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ip_configuration: [{
        name: "testconfiguration1",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Static",
        privateIpAddress: "10.0.2.5",
        publicIpAddressId: examplePublicIp.id,
    }],
});
const exampleVirtualMachine = new azure.compute.VirtualMachine("exampleVirtualMachine", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    networkInterfaceIds: [exampleNetworkInterface.id],
});
// ...
const examplePublicIP = pulumi.all([examplePublicIp.name, exampleVirtualMachine.resourceGroupName]).apply(([name, resourceGroupName]) => azure.network.getPublicIP({
    name: name,
    resourceGroupName: resourceGroupName,
}));
export const publicIpAddress = examplePublicIp.ipAddress;

Function getPublicIpPrefix

getPublicIpPrefix(args: GetPublicIpPrefixArgs, opts?: pulumi.InvokeOptions): Promise<GetPublicIpPrefixResult>

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

Example Usage

Reference An Existing)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getPublicIpPrefix({
    name: "name_of_public_ip",
    resourceGroupName: "name_of_resource_group",
});
export const publicIpPrefix = example.then(example => example.ipPrefix);

Function getPublicIPs

getPublicIPs(args: GetPublicIPsArgs, opts?: pulumi.InvokeOptions): Promise<GetPublicIPsResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.network.getPublicIPs({
    attached: false,
    resourceGroupName: "pip-test",
}, { async: true }));

Function getRouteTable

getRouteTable(args: GetRouteTableArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteTableResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.network.getRouteTable({
    name: "myroutetable",
    resourceGroupName: "some-resource-group",
}, { async: true }));

Function getServiceTags

getServiceTags(args: GetServiceTagsArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceTagsResult>

Use this data source to access information about Service Tags.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getServiceTags({
    location: "West Europe",
    service: "AzureKeyVault",
    locationFilter: "northeurope",
});
export const addressPrefixes = data.azurerm_service_tags.example.address_prefixes;

Function getSubnet

getSubnet(args: GetSubnetArgs, opts?: pulumi.InvokeOptions): Promise<GetSubnetResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getSubnet({
    name: "backend",
    virtualNetworkName: "production",
    resourceGroupName: "networking",
});
export const subnetId = example.then(example => example.id);

Function getTrafficManager

getTrafficManager(args: GetTrafficManagerArgs, opts?: pulumi.InvokeOptions): Promise<GetTrafficManagerResult>

Use this data source to access the ID of a specified Traffic Manager Geographical Location within the Geographical Hierarchy.

Example Usage

World)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getTrafficManager({
    name: "World",
});
export const locationCode = example.then(example => example.id);

Function getVirtualHub

getVirtualHub(args: GetVirtualHubArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualHubResult>

Uses this data source to access information about an existing Virtual Hub.

Virtual Hub Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getVirtualHub({
    name: "example-hub",
    resourceGroupName: "example-resources",
});
export const virtualHubId = example.then(example => example.id);

Function getVirtualNetwork

getVirtualNetwork(args: GetVirtualNetworkArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualNetworkResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getVirtualNetwork({
    name: "production",
    resourceGroupName: "networking",
});
export const virtualNetworkId = example.then(example => example.id);

Function getVirtualNetworkGateway

getVirtualNetworkGateway(args: GetVirtualNetworkGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualNetworkGatewayResult>

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getVirtualNetworkGateway({
    name: "production",
    resourceGroupName: "networking",
});
export const virtualNetworkGatewayId = example.then(example => example.id);

Others

interface ApplicationGatewayArgs

interface ApplicationGatewayArgs

The set of arguments for constructing a ApplicationGateway resource.

property authenticationCertificates

authenticationCertificates?: pulumi.Input<pulumi.Input<ApplicationGatewayAuthenticationCertificate>[]>;

One or more authenticationCertificate blocks as defined below.

property autoscaleConfiguration

autoscaleConfiguration?: pulumi.Input<ApplicationGatewayAutoscaleConfiguration>;

A autoscaleConfiguration block as defined below.

property backendAddressPools

backendAddressPools: pulumi.Input<pulumi.Input<ApplicationGatewayBackendAddressPool>[]>;

One or more backendAddressPool blocks as defined below.

property backendHttpSettings

backendHttpSettings: pulumi.Input<pulumi.Input<ApplicationGatewayBackendHttpSetting>[]>;

One or more backendHttpSettings blocks as defined below.

property customErrorConfigurations

customErrorConfigurations?: pulumi.Input<pulumi.Input<ApplicationGatewayCustomErrorConfiguration>[]>;

One or more customErrorConfiguration blocks as defined below.

property enableHttp2

enableHttp2?: pulumi.Input<boolean>;

Is HTTP2 enabled on the application gateway resource? Defaults to false.

property firewallPolicyId

firewallPolicyId?: pulumi.Input<string>;

The resource ID of a firewall policy.

property frontendIpConfigurations

frontendIpConfigurations: pulumi.Input<pulumi.Input<ApplicationGatewayFrontendIpConfiguration>[]>;

One or more frontendIpConfiguration blocks as defined below.

property frontendPorts

frontendPorts: pulumi.Input<pulumi.Input<ApplicationGatewayFrontendPort>[]>;

One or more frontendPort blocks as defined below.

property gatewayIpConfigurations

gatewayIpConfigurations: pulumi.Input<pulumi.Input<ApplicationGatewayGatewayIpConfiguration>[]>;

One or more gatewayIpConfiguration blocks as defined below.

property httpListeners

httpListeners: pulumi.Input<pulumi.Input<ApplicationGatewayHttpListener>[]>;

One or more httpListener blocks as defined below.

property identity

identity?: pulumi.Input<ApplicationGatewayIdentity>;

A identity block.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property probes

probes?: pulumi.Input<pulumi.Input<ApplicationGatewayProbe>[]>;

One or more probe blocks as defined below.

property redirectConfigurations

redirectConfigurations?: pulumi.Input<pulumi.Input<ApplicationGatewayRedirectConfiguration>[]>;

A redirectConfiguration block as defined below.

property requestRoutingRules

requestRoutingRules: pulumi.Input<pulumi.Input<ApplicationGatewayRequestRoutingRule>[]>;

One or more requestRoutingRule blocks as defined below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property rewriteRuleSets

rewriteRuleSets?: pulumi.Input<pulumi.Input<ApplicationGatewayRewriteRuleSet>[]>;

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

property sku

sku: pulumi.Input<ApplicationGatewaySku>;

A sku block as defined below.

property sslCertificates

sslCertificates?: pulumi.Input<pulumi.Input<ApplicationGatewaySslCertificate>[]>;

One or more sslCertificate blocks as defined below.

property sslPolicies

sslPolicies?: pulumi.Input<pulumi.Input<ApplicationGatewaySslPolicy>[]>;

a ssl policy block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property trustedRootCertificates

trustedRootCertificates?: pulumi.Input<pulumi.Input<ApplicationGatewayTrustedRootCertificate>[]>;

One or more trustedRootCertificate blocks as defined below.

property urlPathMaps

urlPathMaps?: pulumi.Input<pulumi.Input<ApplicationGatewayUrlPathMap>[]>;

One or more urlPathMap blocks as defined below.

property wafConfiguration

wafConfiguration?: pulumi.Input<ApplicationGatewayWafConfiguration>;

A wafConfiguration block as defined below.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

A collection of availability zones to spread the Application Gateway over.

interface ApplicationGatewayState

interface ApplicationGatewayState

Input properties used for looking up and filtering ApplicationGateway resources.

property authenticationCertificates

authenticationCertificates?: pulumi.Input<pulumi.Input<ApplicationGatewayAuthenticationCertificate>[]>;

One or more authenticationCertificate blocks as defined below.

property autoscaleConfiguration

autoscaleConfiguration?: pulumi.Input<ApplicationGatewayAutoscaleConfiguration>;

A autoscaleConfiguration block as defined below.

property backendAddressPools

backendAddressPools?: pulumi.Input<pulumi.Input<ApplicationGatewayBackendAddressPool>[]>;

One or more backendAddressPool blocks as defined below.

property backendHttpSettings

backendHttpSettings?: pulumi.Input<pulumi.Input<ApplicationGatewayBackendHttpSetting>[]>;

One or more backendHttpSettings blocks as defined below.

property customErrorConfigurations

customErrorConfigurations?: pulumi.Input<pulumi.Input<ApplicationGatewayCustomErrorConfiguration>[]>;

One or more customErrorConfiguration blocks as defined below.

property enableHttp2

enableHttp2?: pulumi.Input<boolean>;

Is HTTP2 enabled on the application gateway resource? Defaults to false.

property firewallPolicyId

firewallPolicyId?: pulumi.Input<string>;

The resource ID of a firewall policy.

property frontendIpConfigurations

frontendIpConfigurations?: pulumi.Input<pulumi.Input<ApplicationGatewayFrontendIpConfiguration>[]>;

One or more frontendIpConfiguration blocks as defined below.

property frontendPorts

frontendPorts?: pulumi.Input<pulumi.Input<ApplicationGatewayFrontendPort>[]>;

One or more frontendPort blocks as defined below.

property gatewayIpConfigurations

gatewayIpConfigurations?: pulumi.Input<pulumi.Input<ApplicationGatewayGatewayIpConfiguration>[]>;

One or more gatewayIpConfiguration blocks as defined below.

property httpListeners

httpListeners?: pulumi.Input<pulumi.Input<ApplicationGatewayHttpListener>[]>;

One or more httpListener blocks as defined below.

property identity

identity?: pulumi.Input<ApplicationGatewayIdentity>;

A identity block.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property probes

probes?: pulumi.Input<pulumi.Input<ApplicationGatewayProbe>[]>;

One or more probe blocks as defined below.

property redirectConfigurations

redirectConfigurations?: pulumi.Input<pulumi.Input<ApplicationGatewayRedirectConfiguration>[]>;

A redirectConfiguration block as defined below.

property requestRoutingRules

requestRoutingRules?: pulumi.Input<pulumi.Input<ApplicationGatewayRequestRoutingRule>[]>;

One or more requestRoutingRule blocks as defined below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property rewriteRuleSets

rewriteRuleSets?: pulumi.Input<pulumi.Input<ApplicationGatewayRewriteRuleSet>[]>;

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

property sku

sku?: pulumi.Input<ApplicationGatewaySku>;

A sku block as defined below.

property sslCertificates

sslCertificates?: pulumi.Input<pulumi.Input<ApplicationGatewaySslCertificate>[]>;

One or more sslCertificate blocks as defined below.

property sslPolicies

sslPolicies?: pulumi.Input<pulumi.Input<ApplicationGatewaySslPolicy>[]>;

a ssl policy block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property trustedRootCertificates

trustedRootCertificates?: pulumi.Input<pulumi.Input<ApplicationGatewayTrustedRootCertificate>[]>;

One or more trustedRootCertificate blocks as defined below.

property urlPathMaps

urlPathMaps?: pulumi.Input<pulumi.Input<ApplicationGatewayUrlPathMap>[]>;

One or more urlPathMap blocks as defined below.

property wafConfiguration

wafConfiguration?: pulumi.Input<ApplicationGatewayWafConfiguration>;

A wafConfiguration block as defined below.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

A collection of availability zones to spread the Application Gateway over.

interface ApplicationSecurityGroupArgs

interface ApplicationSecurityGroupArgs

The set of arguments for constructing a ApplicationSecurityGroup resource.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ApplicationSecurityGroupState

interface ApplicationSecurityGroupState

Input properties used for looking up and filtering ApplicationSecurityGroup resources.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface DdosProtectionPlanArgs

interface DdosProtectionPlanArgs

The set of arguments for constructing a DdosProtectionPlan resource.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the Network DDoS Protection Plan. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface DdosProtectionPlanState

interface DdosProtectionPlanState

Input properties used for looking up and filtering DdosProtectionPlan resources.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the Network DDoS Protection Plan. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property virtualNetworkIds

virtualNetworkIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Virtual Network ID’s associated with the DDoS Protection Plan.

interface ExpressRouteCircuitArgs

interface ExpressRouteCircuitArgs

The set of arguments for constructing a ExpressRouteCircuit resource.

property allowClassicOperations

allowClassicOperations?: pulumi.Input<boolean>;

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

property bandwidthInMbps

bandwidthInMbps: pulumi.Input<number>;

The bandwidth in Mbps of the circuit being created.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property peeringLocation

peeringLocation: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property serviceProviderName

serviceProviderName: pulumi.Input<string>;

The name of the ExpressRoute Service Provider.

property sku

sku: pulumi.Input<ExpressRouteCircuitSku>;

A sku block for the ExpressRoute circuit as documented below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ExpressRouteCircuitAuthorizationArgs

interface ExpressRouteCircuitAuthorizationArgs

The set of arguments for constructing a ExpressRouteCircuitAuthorization resource.

property expressRouteCircuitName

expressRouteCircuitName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

interface ExpressRouteCircuitAuthorizationState

interface ExpressRouteCircuitAuthorizationState

Input properties used for looking up and filtering ExpressRouteCircuitAuthorization resources.

property authorizationKey

authorizationKey?: pulumi.Input<string>;

The Authorization Key.

property authorizationUseStatus

authorizationUseStatus?: pulumi.Input<string>;

The authorization use status.

property expressRouteCircuitName

expressRouteCircuitName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

interface ExpressRouteCircuitPeeringArgs

interface ExpressRouteCircuitPeeringArgs

The set of arguments for constructing a ExpressRouteCircuitPeering resource.

property expressRouteCircuitName

expressRouteCircuitName: pulumi.Input<string>;

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

property microsoftPeeringConfig

microsoftPeeringConfig?: pulumi.Input<ExpressRouteCircuitPeeringMicrosoftPeeringConfig>;

A microsoftPeeringConfig block as defined below. Required when peeringType is set to MicrosoftPeering.

property peerAsn

peerAsn?: pulumi.Input<number>;

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

property peeringType

peeringType: pulumi.Input<string>;

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

property primaryPeerAddressPrefix

primaryPeerAddressPrefix: pulumi.Input<string>;

A /30 subnet for the primary link.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: pulumi.Input<string>;

A /30 subnet for the secondary link.

property sharedKey

sharedKey?: pulumi.Input<string>;

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

property vlanId

vlanId: pulumi.Input<number>;

A valid VLAN ID to establish this peering on.

interface ExpressRouteCircuitPeeringState

interface ExpressRouteCircuitPeeringState

Input properties used for looking up and filtering ExpressRouteCircuitPeering resources.

property azureAsn

azureAsn?: pulumi.Input<number>;

The ASN used by Azure.

property expressRouteCircuitName

expressRouteCircuitName?: pulumi.Input<string>;

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

property microsoftPeeringConfig

microsoftPeeringConfig?: pulumi.Input<ExpressRouteCircuitPeeringMicrosoftPeeringConfig>;

A microsoftPeeringConfig block as defined below. Required when peeringType is set to MicrosoftPeering.

property peerAsn

peerAsn?: pulumi.Input<number>;

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

property peeringType

peeringType?: pulumi.Input<string>;

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

property primaryAzurePort

primaryAzurePort?: pulumi.Input<string>;

The Primary Port used by Azure for this Peering.

property primaryPeerAddressPrefix

primaryPeerAddressPrefix?: pulumi.Input<string>;

A /30 subnet for the primary link.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryAzurePort

secondaryAzurePort?: pulumi.Input<string>;

The Secondary Port used by Azure for this Peering.

property secondaryPeerAddressPrefix

secondaryPeerAddressPrefix?: pulumi.Input<string>;

A /30 subnet for the secondary link.

property sharedKey

sharedKey?: pulumi.Input<string>;

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

property vlanId

vlanId?: pulumi.Input<number>;

A valid VLAN ID to establish this peering on.

interface ExpressRouteCircuitState

interface ExpressRouteCircuitState

Input properties used for looking up and filtering ExpressRouteCircuit resources.

property allowClassicOperations

allowClassicOperations?: pulumi.Input<boolean>;

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

property bandwidthInMbps

bandwidthInMbps?: pulumi.Input<number>;

The bandwidth in Mbps of the circuit being created.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property peeringLocation

peeringLocation?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property serviceKey

serviceKey?: pulumi.Input<string>;

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

property serviceProviderName

serviceProviderName?: pulumi.Input<string>;

The name of the ExpressRoute Service Provider.

property serviceProviderProvisioningState

serviceProviderProvisioningState?: pulumi.Input<string>;

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

property sku

sku?: pulumi.Input<ExpressRouteCircuitSku>;

A sku block for the ExpressRoute circuit as documented below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ExpressRouteGatewayArgs

interface ExpressRouteGatewayArgs

The set of arguments for constructing a ExpressRouteGateway resource.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property scaleUnits

scaleUnits: pulumi.Input<number>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property virtualHubId

virtualHubId: pulumi.Input<string>;

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

interface ExpressRouteGatewayState

interface ExpressRouteGatewayState

Input properties used for looking up and filtering ExpressRouteGateway resources.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property scaleUnits

scaleUnits?: pulumi.Input<number>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property virtualHubId

virtualHubId?: pulumi.Input<string>;

The ID of a Virtual HUB within which the ExpressRoute gateway should be created.

interface FirewallApplicationRuleCollectionArgs

interface FirewallApplicationRuleCollectionArgs

The set of arguments for constructing a FirewallApplicationRuleCollection resource.

property action

action: pulumi.Input<string>;

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

property azureFirewallName

azureFirewallName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property priority

priority: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property rules

rules: pulumi.Input<pulumi.Input<FirewallApplicationRuleCollectionRule>[]>;

One or more rule blocks as defined below.

interface FirewallApplicationRuleCollectionState

interface FirewallApplicationRuleCollectionState

Input properties used for looking up and filtering FirewallApplicationRuleCollection resources.

property action

action?: pulumi.Input<string>;

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

property azureFirewallName

azureFirewallName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property priority

priority?: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property rules

rules?: pulumi.Input<pulumi.Input<FirewallApplicationRuleCollectionRule>[]>;

One or more rule blocks as defined below.

interface FirewallArgs

interface FirewallArgs

The set of arguments for constructing a Firewall resource.

property ipConfigurations

ipConfigurations: pulumi.Input<pulumi.Input<FirewallIpConfiguration>[]>;

A ipConfiguration block as documented below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

Specifies the availability zones in which the Azure Firewall should be created.

interface FirewallNatRuleCollectionArgs

interface FirewallNatRuleCollectionArgs

The set of arguments for constructing a FirewallNatRuleCollection resource.

property action

action: pulumi.Input<string>;

Specifies the action the rule will apply to matching traffic. Possible values are Dnat and Snat.

property azureFirewallName

azureFirewallName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property priority

priority: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property rules

rules: pulumi.Input<pulumi.Input<FirewallNatRuleCollectionRule>[]>;

One or more rule blocks as defined below.

interface FirewallNatRuleCollectionState

interface FirewallNatRuleCollectionState

Input properties used for looking up and filtering FirewallNatRuleCollection resources.

property action

action?: pulumi.Input<string>;

Specifies the action the rule will apply to matching traffic. Possible values are Dnat and Snat.

property azureFirewallName

azureFirewallName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property priority

priority?: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property rules

rules?: pulumi.Input<pulumi.Input<FirewallNatRuleCollectionRule>[]>;

One or more rule blocks as defined below.

interface FirewallNetworkRuleCollectionArgs

interface FirewallNetworkRuleCollectionArgs

The set of arguments for constructing a FirewallNetworkRuleCollection resource.

property action

action: pulumi.Input<string>;

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

property azureFirewallName

azureFirewallName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property priority

priority: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property rules

rules: pulumi.Input<pulumi.Input<FirewallNetworkRuleCollectionRule>[]>;

One or more rule blocks as defined below.

interface FirewallNetworkRuleCollectionState

interface FirewallNetworkRuleCollectionState

Input properties used for looking up and filtering FirewallNetworkRuleCollection resources.

property action

action?: pulumi.Input<string>;

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

property azureFirewallName

azureFirewallName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property priority

priority?: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property rules

rules?: pulumi.Input<pulumi.Input<FirewallNetworkRuleCollectionRule>[]>;

One or more rule blocks as defined below.

interface FirewallState

interface FirewallState

Input properties used for looking up and filtering Firewall resources.

property ipConfigurations

ipConfigurations?: pulumi.Input<pulumi.Input<FirewallIpConfiguration>[]>;

A ipConfiguration block as documented below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

Specifies the availability zones in which the Azure Firewall should be created.

interface GetApplicationSecurityGroupArgs

interface GetApplicationSecurityGroupArgs

A collection of arguments for invoking getApplicationSecurityGroup.

property name

name: string;

The name of the Application Security Group.

property resourceGroupName

resourceGroupName: string;

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

interface GetApplicationSecurityGroupResult

interface GetApplicationSecurityGroupResult

A collection of values returned by getApplicationSecurityGroup.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The supported Azure location where the Application Security Group exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

interface GetExpressRouteCircuitArgs

interface GetExpressRouteCircuitArgs

A collection of arguments for invoking getExpressRouteCircuit.

property name

name: string;

The name of the ExpressRoute circuit.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the ExpressRoute circuit exists.

interface GetExpressRouteCircuitResult

interface GetExpressRouteCircuitResult

A collection of values returned by getExpressRouteCircuit.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure location where the ExpressRoute circuit exists

property name

name: string;

property peerings

peerings: GetExpressRouteCircuitPeering[];

A peerings block for the ExpressRoute circuit as documented below

property resourceGroupName

resourceGroupName: string;

property serviceKey

serviceKey: string;

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

property serviceProviderProperties

serviceProviderProperties: GetExpressRouteCircuitServiceProviderProperty[];

A serviceProviderProperties block for the ExpressRoute circuit as documented below

property serviceProviderProvisioningState

serviceProviderProvisioningState: string;

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

property sku

sku: GetExpressRouteCircuitSku;

A sku block for the ExpressRoute circuit as documented below.

interface GetFirewallArgs

interface GetFirewallArgs

A collection of arguments for invoking getFirewall.

property name

name: string;

The name of the Azure Firewall.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group in which the Azure Firewall exists.

interface GetFirewallResult

interface GetFirewallResult

A collection of values returned by getFirewall.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipConfigurations

ipConfigurations: GetFirewallIpConfiguration[];

A ipConfiguration block as defined below.

property location

location: string;

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

interface GetGatewayConnectionArgs

interface GetGatewayConnectionArgs

A collection of arguments for invoking getGatewayConnection.

property name

name: string;

Specifies the name of the Virtual Network Gateway Connection.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the Virtual Network Gateway Connection is located in.

interface GetGatewayConnectionResult

interface GetGatewayConnectionResult

A collection of values returned by getGatewayConnection.

property authorizationKey

authorizationKey: string;

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

property connectionProtocol

connectionProtocol: string;

property egressBytesTransferred

egressBytesTransferred: number;

property enableBgp

enableBgp: boolean;

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

property expressRouteCircuitId

expressRouteCircuitId: string;

The ID of the Express Route Circuit (i.e. when type is ExpressRoute).

property expressRouteGatewayBypass

expressRouteGatewayBypass: boolean;

If true, data packets will bypass ExpressRoute Gateway for data forwarding. This is only valid for ExpressRoute connections.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ingressBytesTransferred

ingressBytesTransferred: number;

property ipsecPolicies

ipsecPolicies: GetGatewayConnectionIpsecPolicy[];

property localNetworkGatewayId

localNetworkGatewayId: string;

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

property location

location: string;

The location/region where the connection is located.

property name

name: string;

property peerVirtualNetworkGatewayId

peerVirtualNetworkGatewayId: string;

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

property resourceGroupName

resourceGroupName: string;

property resourceGuid

resourceGuid: string;

property routingWeight

routingWeight: number;

The routing weight.

property sharedKey

sharedKey: string;

The shared IPSec key.

property tags

tags: {[key: string]: string};

A mapping of tags to assign to the resource.

property type

type: string;

The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet).

property usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors: boolean;

If true, policy-based traffic selectors are enabled for this connection. Enabling policy-based traffic selectors requires an ipsecPolicy block.

property virtualNetworkGatewayId

virtualNetworkGatewayId: string;

The ID of the Virtual Network Gateway in which the connection is created.

interface GetNatGatewayArgs

interface GetNatGatewayArgs

A collection of arguments for invoking getNatGateway.

property name

name: string;

Specifies the Name of the NAT Gateway.

property publicIpAddressIds

publicIpAddressIds?: string[];

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

property publicIpPrefixIds

publicIpPrefixIds?: string[];

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the Resource Group where the NAT Gateway exists.

interface GetNatGatewayResult

interface GetNatGatewayResult

A collection of values returned by getNatGateway.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property idleTimeoutInMinutes

idleTimeoutInMinutes: number;

The idle timeout in minutes which is used for the NAT Gateway.

property location

location: string;

The location where the NAT Gateway exists.

property name

name: string;

property publicIpAddressIds

publicIpAddressIds: string[];

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

property publicIpPrefixIds

publicIpPrefixIds: string[];

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

property resourceGroupName

resourceGroupName: string;

property resourceGuid

resourceGuid: string;

The Resource GUID of the NAT Gateway.

property skuName

skuName: string;

The SKU used by the NAT Gateway.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

property zones

zones: string[];

A list of Availability Zones which the NAT Gateway exists in.

interface GetNetworkDdosProtectionPlanArgs

interface GetNetworkDdosProtectionPlanArgs

A collection of arguments for invoking getNetworkDdosProtectionPlan.

property name

name: string;

The name of the Network DDoS Protection Plan.

property resourceGroupName

resourceGroupName: string;

The name of the resource group where the Network DDoS Protection Plan exists.

property tags

tags?: undefined | {[key: string]: string};

A mapping of tags assigned to the resource.

interface GetNetworkDdosProtectionPlanResult

interface GetNetworkDdosProtectionPlanResult

A collection of values returned by getNetworkDdosProtectionPlan.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

Specifies the supported Azure location where the resource exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags?: undefined | {[key: string]: string};

A mapping of tags assigned to the resource.

property virtualNetworkIds

virtualNetworkIds: string[];

The Resource ID list of the Virtual Networks associated with DDoS Protection Plan.

interface GetNetworkInterfaceArgs

interface GetNetworkInterfaceArgs

A collection of arguments for invoking getNetworkInterface.

property name

name: string;

Specifies the name of the Network Interface.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the Network Interface is located in.

interface GetNetworkInterfaceResult

interface GetNetworkInterfaceResult

A collection of values returned by getNetworkInterface.

property appliedDnsServers

appliedDnsServers: string[];

List of DNS servers applied to the specified Network Interface.

property dnsServers

dnsServers: string[];

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

property enableAcceleratedNetworking

enableAcceleratedNetworking: boolean;

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

property enableIpForwarding

enableIpForwarding: boolean;

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

property id

id: string;

The provider-assigned unique ID for this managed resource.

property internalDnsNameLabel

internalDnsNameLabel: string;

The internal dns name label of the specified Network Interface.

property ipConfigurations

ipConfigurations: GetNetworkInterfaceIpConfiguration[];

One or more ipConfiguration blocks as defined below.

property location

location: string;

The location of the specified Network Interface.

property macAddress

macAddress: string;

The MAC address used by the specified Network Interface.

property name

name: string;

The name of the IP Configuration.

property networkSecurityGroupId

networkSecurityGroupId: string;

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

property privateIpAddress

privateIpAddress: string;

The Private IP Address assigned to this Network Interface.

property privateIpAddresses

privateIpAddresses: string[];

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

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

List the tags associated to the specified Network Interface.

property virtualMachineId

virtualMachineId: string;

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

interface GetNetworkSecurityGroupArgs

interface GetNetworkSecurityGroupArgs

A collection of arguments for invoking getNetworkSecurityGroup.

property name

name: string;

Specifies the Name of the Network Security Group.

property resourceGroupName

resourceGroupName: string;

Specifies the Name of the Resource Group within which the Network Security Group exists

interface GetNetworkSecurityGroupResult

interface GetNetworkSecurityGroupResult

A collection of values returned by getNetworkSecurityGroup.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The supported Azure location where the resource exists.

property name

name: string;

The name of the security rule.

property resourceGroupName

resourceGroupName: string;

property securityRules

securityRules: GetNetworkSecurityGroupSecurityRule[];

One or more securityRule blocks as defined below.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

interface GetNetworkWatcherArgs

interface GetNetworkWatcherArgs

A collection of arguments for invoking getNetworkWatcher.

property name

name: string;

Specifies the Name of the Network Watcher.

property resourceGroupName

resourceGroupName: string;

Specifies the Name of the Resource Group within which the Network Watcher exists.

interface GetNetworkWatcherResult

interface GetNetworkWatcherResult

A collection of values returned by getNetworkWatcher.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The supported Azure location where the resource exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

interface GetPublicIPArgs

interface GetPublicIPArgs

A collection of arguments for invoking getPublicIP.

property name

name: string;

Specifies the name of the public IP address.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group.

property tags

tags?: undefined | {[key: string]: string};

A mapping of tags to assigned to the resource.

property zones

zones?: string[];

interface GetPublicIpPrefixArgs

interface GetPublicIpPrefixArgs

A collection of arguments for invoking getPublicIpPrefix.

property name

name: string;

Specifies the name of the public IP prefix.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group.

property zones

zones?: string[];

interface GetPublicIpPrefixResult

interface GetPublicIpPrefixResult

A collection of values returned by getPublicIpPrefix.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipPrefix

ipPrefix: string;

property location

location: string;

The supported Azure location where the resource exists.

property name

name: string;

The name of the Public IP prefix resource.

property prefixLength

prefixLength: number;

The number of bits of the prefix.

property resourceGroupName

resourceGroupName: string;

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

property sku

sku: string;

The SKU of the Public IP Prefix.

property tags

tags: {[key: string]: string};

A mapping of tags to assigned to the resource.

property zones

zones: string[];

interface GetPublicIPResult

interface GetPublicIPResult

A collection of values returned by getPublicIP.

property allocationMethod

allocationMethod: string;

property domainNameLabel

domainNameLabel: string;

The label for the Domain Name.

property fqdn

fqdn: string;

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.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property idleTimeoutInMinutes

idleTimeoutInMinutes: number;

Specifies the timeout for the TCP idle connection.

property ipAddress

ipAddress: string;

The IP address value that was allocated.

property ipVersion

ipVersion: string;

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

property location

location: string;

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property reverseFqdn

reverseFqdn: string;

property sku

sku: string;

property tags

tags?: undefined | {[key: string]: string};

A mapping of tags to assigned to the resource.

property zones

zones: string[];

interface GetPublicIPsArgs

interface GetPublicIPsArgs

A collection of arguments for invoking getPublicIPs.

property allocationType

allocationType?: undefined | string;

The Allocation Type for the Public IP Address. Possible values include Static or Dynamic.

property attached

attached?: undefined | false | true;

Filter to include IP Addresses which are attached to a device, such as a VM/LB (true) or unattached (false).

property namePrefix

namePrefix?: undefined | string;

A prefix match used for the IP Addresses name field, case sensitive.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group.

interface GetPublicIPsResult

interface GetPublicIPsResult

A collection of values returned by getPublicIPs.

property allocationType

allocationType?: undefined | string;

property attached

attached?: undefined | false | true;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property namePrefix

namePrefix?: undefined | string;

property publicIps

publicIps: GetPublicIPsPublicIp[];

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

property resourceGroupName

resourceGroupName: string;

interface GetRouteTableArgs

interface GetRouteTableArgs

A collection of arguments for invoking getRouteTable.

property name

name: string;

The name of the Route Table.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group in which the Route Table exists.

interface GetRouteTableResult

interface GetRouteTableResult

A collection of values returned by getRouteTable.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure Region in which the Route Table exists.

property name

name: string;

The name of the Route.

property resourceGroupName

resourceGroupName: string;

property routes

routes: GetRouteTableRoute[];

One or more route blocks as documented below.

property subnets

subnets: string[];

The collection of Subnets associated with this route table.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the Route Table.

interface GetServiceTagsArgs

interface GetServiceTagsArgs

A collection of arguments for invoking getServiceTags.

property location

location: string;

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 locationFilter instead. More information can be found here: Service Tags URL parameters.

property locationFilter

locationFilter?: undefined | string;

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.

property service

service: string;

The type of the service for which address prefixes will be fetched. Available service tags can be found here: Available service tags.

interface GetServiceTagsResult

interface GetServiceTagsResult

A collection of values returned by getServiceTags.

property addressPrefixes

addressPrefixes: string[];

List of address prefixes for the service type (and optionally a specific region).

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

property locationFilter

locationFilter?: undefined | string;

property service

service: string;

interface GetSubnetArgs

interface GetSubnetArgs

A collection of arguments for invoking getSubnet.

property name

name: string;

Specifies the name of the Subnet.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the Virtual Network is located in.

property virtualNetworkName

virtualNetworkName: string;

Specifies the name of the Virtual Network this Subnet is located within.

interface GetSubnetResult

interface GetSubnetResult

A collection of values returned by getSubnet.

property addressPrefix

addressPrefix: string;

(Deprecated) The address prefix used for the subnet.

property addressPrefixes

addressPrefixes: string[];

The address prefixes for the subnet.

property enforcePrivateLinkEndpointNetworkPolicies

enforcePrivateLinkEndpointNetworkPolicies: boolean;

Enable or Disable network policies for the private link endpoint on the subnet.

property enforcePrivateLinkServiceNetworkPolicies

enforcePrivateLinkServiceNetworkPolicies: boolean;

Enable or Disable network policies for the private link service on the subnet.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property networkSecurityGroupId

networkSecurityGroupId: string;

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

property resourceGroupName

resourceGroupName: string;

property routeTableId

routeTableId: string;

The ID of the Route Table associated with this subnet.

property serviceEndpoints

serviceEndpoints: string[];

A list of Service Endpoints within this subnet.

property virtualNetworkName

virtualNetworkName: string;

interface GetTrafficManagerArgs

interface GetTrafficManagerArgs

A collection of arguments for invoking getTrafficManager.

property name

name: string;

Specifies the name of the Location, for example World, Europe or Germany.

interface GetTrafficManagerResult

interface GetTrafficManagerResult

A collection of values returned by getTrafficManager.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

interface GetVirtualHubArgs

interface GetVirtualHubArgs

A collection of arguments for invoking getVirtualHub.

property name

name: string;

The name of the Virtual Hub.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the Virtual Hub exists.

interface GetVirtualHubResult

interface GetVirtualHubResult

A collection of values returned by getVirtualHub.

property addressPrefix

addressPrefix: string;

The Address Prefix used for this Virtual Hub.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The Azure Region where the Virtual Hub exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the Virtual Hub.

property virtualWanId

virtualWanId: string;

The ID of the Virtual WAN within which the Virtual Hub exists.

interface GetVirtualNetworkArgs

interface GetVirtualNetworkArgs

A collection of arguments for invoking getVirtualNetwork.

property name

name: string;

Specifies the name of the Virtual Network.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the Virtual Network is located in.

interface GetVirtualNetworkGatewayArgs

interface GetVirtualNetworkGatewayArgs

A collection of arguments for invoking getVirtualNetworkGateway.

property name

name: string;

Specifies the name of the Virtual Network Gateway.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the Virtual Network Gateway is located in.

interface GetVirtualNetworkGatewayResult

interface GetVirtualNetworkGatewayResult

A collection of values returned by getVirtualNetworkGateway.

property activeActive

activeActive: boolean;

Is this an Active-Active Gateway?

property bgpSettings

bgpSettings: GetVirtualNetworkGatewayBgpSetting[];

property defaultLocalNetworkGatewayId

defaultLocalNetworkGatewayId: string;

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.

property enableBgp

enableBgp: boolean;

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

property generation

generation: string;

The Generation of the Virtual Network Gateway.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipConfigurations

ipConfigurations: GetVirtualNetworkGatewayIpConfiguration[];

One or two ipConfiguration blocks documented below.

property location

location: string;

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

property name

name: string;

The user-defined name of the revoked certificate.

property resourceGroupName

resourceGroupName: string;

property sku

sku: string;

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

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

property type

type: string;

The type of the Virtual Network Gateway.

property vpnClientConfigurations

vpnClientConfigurations: GetVirtualNetworkGatewayVpnClientConfiguration[];

A vpnClientConfiguration block which is documented below.

property vpnType

vpnType: string;

The routing type of the Virtual Network Gateway.

interface GetVirtualNetworkResult

interface GetVirtualNetworkResult

A collection of values returned by getVirtualNetwork.

property addressSpaces

addressSpaces: string[];

The list of address spaces used by the virtual network.

property dnsServers

dnsServers: string[];

The list of DNS servers used by the virtual network.

property guid

guid: string;

The GUID of the virtual network.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

Location of the virtual network.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property subnets

subnets: string[];

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

property vnetPeerings

vnetPeerings: {[key: string]: string};

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

interface LocalNetworkGatewayArgs

interface LocalNetworkGatewayArgs

The set of arguments for constructing a LocalNetworkGateway resource.

property addressSpaces

addressSpaces: pulumi.Input<pulumi.Input<string>[]>;

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

property bgpSettings

bgpSettings?: pulumi.Input<LocalNetworkGatewayBgpSettings>;

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

property gatewayAddress

gatewayAddress: pulumi.Input<string>;

The IP address of the gateway to which to connect.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface LocalNetworkGatewayState

interface LocalNetworkGatewayState

Input properties used for looking up and filtering LocalNetworkGateway resources.

property addressSpaces

addressSpaces?: pulumi.Input<pulumi.Input<string>[]>;

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

property bgpSettings

bgpSettings?: pulumi.Input<LocalNetworkGatewayBgpSettings>;

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

property gatewayAddress

gatewayAddress?: pulumi.Input<string>;

The IP address of the gateway to which to connect.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NatGatewayArgs

interface NatGatewayArgs

The set of arguments for constructing a NatGateway resource.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

The idle timeout which should be used in minutes. Defaults to 4.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property publicIpAddressIds

DEPRECATED Inline Public IP Address ID Deprecations have been deprecated in favour of the azurerm_nat_gateway_public_ip_association resource. This field will be removed in the next major version of the Azure Provider.
publicIpAddressIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Public IP Address ID’s which should be associated with the NAT Gateway resource.

property publicIpPrefixIds

publicIpPrefixIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Public IP Prefix ID’s which should be associated with the NAT Gateway resource.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.

property skuName

skuName?: pulumi.Input<string>;

The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

A list of availability zones where the NAT Gateway should be provisioned. Changing this forces a new resource to be created.

interface NatGatewayPublicIpAssociationArgs

interface NatGatewayPublicIpAssociationArgs

The set of arguments for constructing a NatGatewayPublicIpAssociation resource.

property natGatewayId

natGatewayId: pulumi.Input<string>;

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

property publicIpAddressId

publicIpAddressId: pulumi.Input<string>;

The ID of the Public IP which this Nat Gateway which should be connected to. Changing this forces a new resource to be created.

interface NatGatewayPublicIpAssociationState

interface NatGatewayPublicIpAssociationState

Input properties used for looking up and filtering NatGatewayPublicIpAssociation resources.

property natGatewayId

natGatewayId?: pulumi.Input<string>;

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

property publicIpAddressId

publicIpAddressId?: pulumi.Input<string>;

The ID of the Public IP which this Nat Gateway which should be connected to. Changing this forces a new resource to be created.

interface NatGatewayState

interface NatGatewayState

Input properties used for looking up and filtering NatGateway resources.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

The idle timeout which should be used in minutes. Defaults to 4.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property publicIpAddressIds

DEPRECATED Inline Public IP Address ID Deprecations have been deprecated in favour of the azurerm_nat_gateway_public_ip_association resource. This field will be removed in the next major version of the Azure Provider.
publicIpAddressIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Public IP Address ID’s which should be associated with the NAT Gateway resource.

property publicIpPrefixIds

publicIpPrefixIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Public IP Prefix ID’s which should be associated with the NAT Gateway resource.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.

property resourceGuid

resourceGuid?: pulumi.Input<string>;

The resource GUID property of the NAT Gateway.

property skuName

skuName?: pulumi.Input<string>;

The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

A list of availability zones where the NAT Gateway should be provisioned. Changing this forces a new resource to be created.

interface NetworkConnectionMonitorArgs

interface NetworkConnectionMonitorArgs

The set of arguments for constructing a NetworkConnectionMonitor resource.

property autoStart

autoStart?: pulumi.Input<boolean>;

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

property destination

destination: pulumi.Input<NetworkConnectionMonitorDestination>;

A destination block as defined below.

property intervalInSeconds

intervalInSeconds?: pulumi.Input<number>;

Monitoring interval in seconds. Defaults to 60.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkWatcherName

networkWatcherName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property source

source: pulumi.Input<NetworkConnectionMonitorSource>;

A source block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NetworkConnectionMonitorState

interface NetworkConnectionMonitorState

Input properties used for looking up and filtering NetworkConnectionMonitor resources.

property autoStart

autoStart?: pulumi.Input<boolean>;

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

property destination

destination?: pulumi.Input<NetworkConnectionMonitorDestination>;

A destination block as defined below.

property intervalInSeconds

intervalInSeconds?: pulumi.Input<number>;

Monitoring interval in seconds. Defaults to 60.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkWatcherName

networkWatcherName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property source

source?: pulumi.Input<NetworkConnectionMonitorSource>;

A source block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NetworkInterfaceApplicationGatewayBackendAddressPoolAssociationArgs

interface NetworkInterfaceApplicationGatewayBackendAddressPoolAssociationArgs

The set of arguments for constructing a NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation resource.

property backendAddressPoolId

backendAddressPoolId: pulumi.Input<string>;

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.

property ipConfigurationName

ipConfigurationName: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId: pulumi.Input<string>;

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

interface NetworkInterfaceApplicationGatewayBackendAddressPoolAssociationState

interface NetworkInterfaceApplicationGatewayBackendAddressPoolAssociationState

Input properties used for looking up and filtering NetworkInterfaceApplicationGatewayBackendAddressPoolAssociation resources.

property backendAddressPoolId

backendAddressPoolId?: pulumi.Input<string>;

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.

property ipConfigurationName

ipConfigurationName?: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

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

interface NetworkInterfaceApplicationSecurityGroupAssociationArgs

interface NetworkInterfaceApplicationSecurityGroupAssociationArgs

The set of arguments for constructing a NetworkInterfaceApplicationSecurityGroupAssociation resource.

property applicationSecurityGroupId

applicationSecurityGroupId: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId: pulumi.Input<string>;

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

interface NetworkInterfaceApplicationSecurityGroupAssociationState

interface NetworkInterfaceApplicationSecurityGroupAssociationState

Input properties used for looking up and filtering NetworkInterfaceApplicationSecurityGroupAssociation resources.

property applicationSecurityGroupId

applicationSecurityGroupId?: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

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

interface NetworkInterfaceArgs

interface NetworkInterfaceArgs

The set of arguments for constructing a NetworkInterface resource.

property dnsServers

dnsServers?: pulumi.Input<pulumi.Input<string>[]>;

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

property enableAcceleratedNetworking

enableAcceleratedNetworking?: pulumi.Input<boolean>;

Should Accelerated Networking be enabled? Defaults to false.

property enableIpForwarding

enableIpForwarding?: pulumi.Input<boolean>;

Should IP Forwarding be enabled? Defaults to false.

property internalDnsNameLabel

internalDnsNameLabel?: pulumi.Input<string>;

The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.

property ipConfigurations

ipConfigurations: pulumi.Input<pulumi.Input<NetworkInterfaceIpConfiguration>[]>;

One or more ipConfiguration blocks as defined below.

property location

location?: pulumi.Input<string>;

The location where the Network Interface should exist. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NetworkInterfaceBackendAddressPoolAssociationArgs

interface NetworkInterfaceBackendAddressPoolAssociationArgs

The set of arguments for constructing a NetworkInterfaceBackendAddressPoolAssociation resource.

property backendAddressPoolId

backendAddressPoolId: pulumi.Input<string>;

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.

property ipConfigurationName

ipConfigurationName: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId: pulumi.Input<string>;

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

interface NetworkInterfaceBackendAddressPoolAssociationState

interface NetworkInterfaceBackendAddressPoolAssociationState

Input properties used for looking up and filtering NetworkInterfaceBackendAddressPoolAssociation resources.

property backendAddressPoolId

backendAddressPoolId?: pulumi.Input<string>;

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.

property ipConfigurationName

ipConfigurationName?: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

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

interface NetworkInterfaceNatRuleAssociationArgs

interface NetworkInterfaceNatRuleAssociationArgs

The set of arguments for constructing a NetworkInterfaceNatRuleAssociation resource.

property ipConfigurationName

ipConfigurationName: pulumi.Input<string>;

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.

property natRuleId

natRuleId: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId: pulumi.Input<string>;

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

interface NetworkInterfaceNatRuleAssociationState

interface NetworkInterfaceNatRuleAssociationState

Input properties used for looking up and filtering NetworkInterfaceNatRuleAssociation resources.

property ipConfigurationName

ipConfigurationName?: pulumi.Input<string>;

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.

property natRuleId

natRuleId?: pulumi.Input<string>;

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.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

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

interface NetworkInterfaceSecurityGroupAssociationArgs

interface NetworkInterfaceSecurityGroupAssociationArgs

The set of arguments for constructing a NetworkInterfaceSecurityGroupAssociation resource.

property networkInterfaceId

networkInterfaceId: pulumi.Input<string>;

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

property networkSecurityGroupId

networkSecurityGroupId: pulumi.Input<string>;

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

interface NetworkInterfaceSecurityGroupAssociationState

interface NetworkInterfaceSecurityGroupAssociationState

Input properties used for looking up and filtering NetworkInterfaceSecurityGroupAssociation resources.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

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

property networkSecurityGroupId

networkSecurityGroupId?: pulumi.Input<string>;

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

interface NetworkInterfaceState

interface NetworkInterfaceState

Input properties used for looking up and filtering NetworkInterface resources.

property appliedDnsServers

appliedDnsServers?: pulumi.Input<pulumi.Input<string>[]>;

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.

property dnsServers

dnsServers?: pulumi.Input<pulumi.Input<string>[]>;

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

property enableAcceleratedNetworking

enableAcceleratedNetworking?: pulumi.Input<boolean>;

Should Accelerated Networking be enabled? Defaults to false.

property enableIpForwarding

enableIpForwarding?: pulumi.Input<boolean>;

Should IP Forwarding be enabled? Defaults to false.

property internalDnsNameLabel

internalDnsNameLabel?: pulumi.Input<string>;

The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.

property internalDomainNameSuffix

internalDomainNameSuffix?: pulumi.Input<string>;

Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.

property ipConfigurations

ipConfigurations?: pulumi.Input<pulumi.Input<NetworkInterfaceIpConfiguration>[]>;

One or more ipConfiguration blocks as defined below.

property location

location?: pulumi.Input<string>;

The location where the Network Interface should exist. Changing this forces a new resource to be created.

property macAddress

macAddress?: pulumi.Input<string>;

The Media Access Control (MAC) Address of the Network Interface.

property name

name?: pulumi.Input<string>;

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

property privateIpAddress

privateIpAddress?: pulumi.Input<string>;

The Static IP Address which should be used.

property privateIpAddresses

privateIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;

The private IP addresses of the network interface.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property virtualMachineId

virtualMachineId?: pulumi.Input<string>;

The ID of the Virtual Machine which this Network Interface is connected to.

interface NetworkPacketCaptureArgs

interface NetworkPacketCaptureArgs

The set of arguments for constructing a NetworkPacketCapture resource.

property filters

filters?: pulumi.Input<pulumi.Input<NetworkPacketCaptureFilter>[]>;

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

property maximumBytesPerPacket

maximumBytesPerPacket?: pulumi.Input<number>;

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.

property maximumBytesPerSession

maximumBytesPerSession?: pulumi.Input<number>;

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

property maximumCaptureDuration

maximumCaptureDuration?: pulumi.Input<number>;

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

property name

name?: pulumi.Input<string>;

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

property networkWatcherName

networkWatcherName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property storageLocation

storageLocation: pulumi.Input<NetworkPacketCaptureStorageLocation>;

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

property targetResourceId

targetResourceId: pulumi.Input<string>;

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

interface NetworkPacketCaptureState

interface NetworkPacketCaptureState

Input properties used for looking up and filtering NetworkPacketCapture resources.

property filters

filters?: pulumi.Input<pulumi.Input<NetworkPacketCaptureFilter>[]>;

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

property maximumBytesPerPacket

maximumBytesPerPacket?: pulumi.Input<number>;

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.

property maximumBytesPerSession

maximumBytesPerSession?: pulumi.Input<number>;

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

property maximumCaptureDuration

maximumCaptureDuration?: pulumi.Input<number>;

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

property name

name?: pulumi.Input<string>;

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

property networkWatcherName

networkWatcherName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property storageLocation

storageLocation?: pulumi.Input<NetworkPacketCaptureStorageLocation>;

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

property targetResourceId

targetResourceId?: pulumi.Input<string>;

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

interface NetworkSecurityGroupArgs

interface NetworkSecurityGroupArgs

The set of arguments for constructing a NetworkSecurityGroup resource.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the security rule.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property securityRules

securityRules?: pulumi.Input<pulumi.Input<NetworkSecurityGroupSecurityRule>[]>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NetworkSecurityGroupState

interface NetworkSecurityGroupState

Input properties used for looking up and filtering NetworkSecurityGroup resources.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the security rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property securityRules

securityRules?: pulumi.Input<pulumi.Input<NetworkSecurityGroupSecurityRule>[]>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NetworkSecurityRuleArgs

interface NetworkSecurityRuleArgs

The set of arguments for constructing a NetworkSecurityRule resource.

property access

access: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

A description for this rule. Restricted to 140 characters.

property destinationAddressPrefix

destinationAddressPrefix?: pulumi.Input<string>;

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 destinationAddressPrefixes is not specified.

property destinationAddressPrefixes

destinationAddressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

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

property destinationApplicationSecurityGroupIds

destinationApplicationSecurityGroupIds?: pulumi.Input<string>;

A List of destination Application Security Group ID’s

property destinationPortRange

destinationPortRange?: pulumi.Input<string>;

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

property destinationPortRanges

destinationPortRanges?: pulumi.Input<pulumi.Input<string>[]>;

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

property direction

direction: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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.

property networkSecurityGroupName

networkSecurityGroupName: pulumi.Input<string>;

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

property priority

priority: pulumi.Input<number>;

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.

property protocol

protocol: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property sourceAddressPrefix

sourceAddressPrefix?: pulumi.Input<string>;

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 sourceAddressPrefixes is not specified.

property sourceAddressPrefixes

sourceAddressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

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

property sourceApplicationSecurityGroupIds

sourceApplicationSecurityGroupIds?: pulumi.Input<string>;

A List of source Application Security Group ID’s

property sourcePortRange

sourcePortRange?: pulumi.Input<string>;

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

property sourcePortRanges

sourcePortRanges?: pulumi.Input<pulumi.Input<string>[]>;

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

interface NetworkSecurityRuleState

interface NetworkSecurityRuleState

Input properties used for looking up and filtering NetworkSecurityRule resources.

property access

access?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

A description for this rule. Restricted to 140 characters.

property destinationAddressPrefix

destinationAddressPrefix?: pulumi.Input<string>;

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 destinationAddressPrefixes is not specified.

property destinationAddressPrefixes

destinationAddressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

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

property destinationApplicationSecurityGroupIds

destinationApplicationSecurityGroupIds?: pulumi.Input<string>;

A List of destination Application Security Group ID’s

property destinationPortRange

destinationPortRange?: pulumi.Input<string>;

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

property destinationPortRanges

destinationPortRanges?: pulumi.Input<pulumi.Input<string>[]>;

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

property direction

direction?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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.

property networkSecurityGroupName

networkSecurityGroupName?: pulumi.Input<string>;

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

property priority

priority?: pulumi.Input<number>;

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.

property protocol

protocol?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property sourceAddressPrefix

sourceAddressPrefix?: pulumi.Input<string>;

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 sourceAddressPrefixes is not specified.

property sourceAddressPrefixes

sourceAddressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

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

property sourceApplicationSecurityGroupIds

sourceApplicationSecurityGroupIds?: pulumi.Input<string>;

A List of source Application Security Group ID’s

property sourcePortRange

sourcePortRange?: pulumi.Input<string>;

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

property sourcePortRanges

sourcePortRanges?: pulumi.Input<pulumi.Input<string>[]>;

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

interface NetworkWatcherArgs

interface NetworkWatcherArgs

The set of arguments for constructing a NetworkWatcher resource.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NetworkWatcherFlowLogArgs

interface NetworkWatcherFlowLogArgs

The set of arguments for constructing a NetworkWatcherFlowLog resource.

property enabled

enabled: pulumi.Input<boolean>;

Boolean flag to enable/disable traffic analytics.

property networkSecurityGroupId

networkSecurityGroupId: pulumi.Input<string>;

The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.

property networkWatcherName

networkWatcherName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property retentionPolicy

retentionPolicy: pulumi.Input<NetworkWatcherFlowLogRetentionPolicy>;

A retentionPolicy block as documented below.

property storageAccountId

storageAccountId: pulumi.Input<string>;

The ID of the Storage Account where flow logs are stored.

property trafficAnalytics

trafficAnalytics?: pulumi.Input<NetworkWatcherFlowLogTrafficAnalytics>;

A trafficAnalytics block as documented below.

property version

version?: pulumi.Input<number>;

The version (revision) of the flow log. Possible values are 1 and 2.

interface NetworkWatcherFlowLogState

interface NetworkWatcherFlowLogState

Input properties used for looking up and filtering NetworkWatcherFlowLog resources.

property enabled

enabled?: pulumi.Input<boolean>;

Boolean flag to enable/disable traffic analytics.

property networkSecurityGroupId

networkSecurityGroupId?: pulumi.Input<string>;

The ID of the Network Security Group for which to enable flow logs for. Changing this forces a new resource to be created.

property networkWatcherName

networkWatcherName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property retentionPolicy

retentionPolicy?: pulumi.Input<NetworkWatcherFlowLogRetentionPolicy>;

A retentionPolicy block as documented below.

property storageAccountId

storageAccountId?: pulumi.Input<string>;

The ID of the Storage Account where flow logs are stored.

property trafficAnalytics

trafficAnalytics?: pulumi.Input<NetworkWatcherFlowLogTrafficAnalytics>;

A trafficAnalytics block as documented below.

property version

version?: pulumi.Input<number>;

The version (revision) of the flow log. Possible values are 1 and 2.

interface NetworkWatcherState

interface NetworkWatcherState

Input properties used for looking up and filtering NetworkWatcher resources.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface PacketCaptureArgs

interface PacketCaptureArgs

The set of arguments for constructing a PacketCapture resource.

property filters

filters?: pulumi.Input<pulumi.Input<PacketCaptureFilter>[]>;

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

property maximumBytesPerPacket

maximumBytesPerPacket?: pulumi.Input<number>;

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.

property maximumBytesPerSession

maximumBytesPerSession?: pulumi.Input<number>;

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

property maximumCaptureDuration

maximumCaptureDuration?: pulumi.Input<number>;

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

property name

name?: pulumi.Input<string>;

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

property networkWatcherName

networkWatcherName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property storageLocation

storageLocation: pulumi.Input<PacketCaptureStorageLocation>;

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

property targetResourceId

targetResourceId: pulumi.Input<string>;

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

interface PacketCaptureState

interface PacketCaptureState

Input properties used for looking up and filtering PacketCapture resources.

property filters

filters?: pulumi.Input<pulumi.Input<PacketCaptureFilter>[]>;

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

property maximumBytesPerPacket

maximumBytesPerPacket?: pulumi.Input<number>;

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.

property maximumBytesPerSession

maximumBytesPerSession?: pulumi.Input<number>;

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

property maximumCaptureDuration

maximumCaptureDuration?: pulumi.Input<number>;

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

property name

name?: pulumi.Input<string>;

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

property networkWatcherName

networkWatcherName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property storageLocation

storageLocation?: pulumi.Input<PacketCaptureStorageLocation>;

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

property targetResourceId

targetResourceId?: pulumi.Input<string>;

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

interface PointToPointVpnGatewayArgs

interface PointToPointVpnGatewayArgs

The set of arguments for constructing a PointToPointVpnGateway resource.

property connectionConfiguration

connectionConfiguration: pulumi.Input<PointToPointVpnGatewayConnectionConfiguration>;

A connectionConfiguration block as defined below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

property scaleUnit

scaleUnit: pulumi.Input<number>;

The Scale Unit for this Point-to-Site VPN Gateway.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Point-to-Site VPN Gateway.

property virtualHubId

virtualHubId: pulumi.Input<string>;

The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.

property vpnServerConfigurationId

vpnServerConfigurationId: pulumi.Input<string>;

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.

interface PointToPointVpnGatewayState

interface PointToPointVpnGatewayState

Input properties used for looking up and filtering PointToPointVpnGateway resources.

property connectionConfiguration

connectionConfiguration?: pulumi.Input<PointToPointVpnGatewayConnectionConfiguration>;

A connectionConfiguration block as defined below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the Point-to-Site VPN Gateway. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

property scaleUnit

scaleUnit?: pulumi.Input<number>;

The Scale Unit for this Point-to-Site VPN Gateway.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Point-to-Site VPN Gateway.

property virtualHubId

virtualHubId?: pulumi.Input<string>;

The ID of the Virtual Hub where this Point-to-Site VPN Gateway should exist. Changing this forces a new resource to be created.

property vpnServerConfigurationId

vpnServerConfigurationId?: pulumi.Input<string>;

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.

interface ProfileArgs

interface ProfileArgs

The set of arguments for constructing a Profile resource.

property containerNetworkInterface

containerNetworkInterface: pulumi.Input<ProfileContainerNetworkInterface>;

A containerNetworkInterface block as documented below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ProfileState

interface ProfileState

Input properties used for looking up and filtering Profile resources.

property containerNetworkInterface

containerNetworkInterface?: pulumi.Input<ProfileContainerNetworkInterface>;

A containerNetworkInterface block as documented below.

property containerNetworkInterfaceIds

containerNetworkInterfaceIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of Container Network Interface ID’s.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface PublicIpArgs

interface PublicIpArgs

The set of arguments for constructing a PublicIp resource.

property allocationMethod

allocationMethod: pulumi.Input<string>;

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

property domainNameLabel

domainNameLabel?: pulumi.Input<string>;

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.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

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

property ipVersion

ipVersion?: pulumi.Input<string>;

The IP Version to use, IPv6 or IPv4.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property publicIpPrefixId

publicIpPrefixId?: pulumi.Input<string>;

If specified then public IP address allocated will be provided from the public IP prefix resource.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property reverseFqdn

reverseFqdn?: pulumi.Input<string>;

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.

property sku

sku?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<string>;

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

interface PublicIpPrefixArgs

interface PublicIpPrefixArgs

The set of arguments for constructing a PublicIpPrefix resource.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property prefixLength

prefixLength?: pulumi.Input<number>;

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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Public IP Prefix.

property sku

sku?: pulumi.Input<string>;

The SKU of the Public IP Prefix. Accepted values are Standard. Defaults to Standard. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<string>;

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

interface PublicIpPrefixState

interface PublicIpPrefixState

Input properties used for looking up and filtering PublicIpPrefix resources.

property ipPrefix

ipPrefix?: pulumi.Input<string>;

The IP address prefix value that was allocated.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property prefixLength

prefixLength?: pulumi.Input<number>;

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.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Public IP Prefix.

property sku

sku?: pulumi.Input<string>;

The SKU of the Public IP Prefix. Accepted values are Standard. Defaults to Standard. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<string>;

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

interface PublicIpState

interface PublicIpState

Input properties used for looking up and filtering PublicIp resources.

property allocationMethod

allocationMethod?: pulumi.Input<string>;

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

property domainNameLabel

domainNameLabel?: pulumi.Input<string>;

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.

property fqdn

fqdn?: pulumi.Input<string>;

Fully qualified domain name of the A DNS record associated with the public IP. domainNameLabel must be specified to get the fqdn. This is the concatenation of the domainNameLabel and the regionalized DNS zone

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

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

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP address value that was allocated.

property ipVersion

ipVersion?: pulumi.Input<string>;

The IP Version to use, IPv6 or IPv4.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property publicIpPrefixId

publicIpPrefixId?: pulumi.Input<string>;

If specified then public IP address allocated will be provided from the public IP prefix resource.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property reverseFqdn

reverseFqdn?: pulumi.Input<string>;

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.

property sku

sku?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<string>;

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

interface RouteArgs

interface RouteArgs

The set of arguments for constructing a Route resource.

property addressPrefix

addressPrefix: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property nextHopInIpAddress

nextHopInIpAddress?: pulumi.Input<string>;

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

property nextHopType

nextHopType: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property routeTableName

routeTableName: pulumi.Input<string>;

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

interface RouteState

interface RouteState

Input properties used for looking up and filtering Route resources.

property addressPrefix

addressPrefix?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property nextHopInIpAddress

nextHopInIpAddress?: pulumi.Input<string>;

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

property nextHopType

nextHopType?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property routeTableName

routeTableName?: pulumi.Input<string>;

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

interface RouteTableArgs

interface RouteTableArgs

The set of arguments for constructing a RouteTable resource.

property disableBgpRoutePropagation

disableBgpRoutePropagation?: pulumi.Input<boolean>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the route.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property routes

routes?: pulumi.Input<pulumi.Input<RouteTableRoute>[]>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface RouteTableState

interface RouteTableState

Input properties used for looking up and filtering RouteTable resources.

property disableBgpRoutePropagation

disableBgpRoutePropagation?: pulumi.Input<boolean>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the route.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property routes

routes?: pulumi.Input<pulumi.Input<RouteTableRoute>[]>;

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

property subnets

subnets?: pulumi.Input<pulumi.Input<string>[]>;

The collection of Subnets associated with this route table.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface SubnetArgs

interface SubnetArgs

The set of arguments for constructing a Subnet resource.

property addressPrefix

DEPRECATED Use the address_prefixes property instead.
addressPrefix?: pulumi.Input<string>;

The address prefix to use for the subnet.

property addressPrefixes

addressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

The address prefixes to use for the subnet.

property delegations

delegations?: pulumi.Input<pulumi.Input<SubnetDelegation>[]>;

One or more delegation blocks as defined below.

property enforcePrivateLinkEndpointNetworkPolicies

enforcePrivateLinkEndpointNetworkPolicies?: pulumi.Input<boolean>;

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.

property enforcePrivateLinkServiceNetworkPolicies

enforcePrivateLinkServiceNetworkPolicies?: pulumi.Input<boolean>;

Enable or Disable network policies for the private link service on the subnet. Default valule is false. Conflicts with enforcePrivateLinkEndpointNetworkPolicies.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property serviceEndpoints

serviceEndpoints?: pulumi.Input<pulumi.Input<string>[]>;

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.

property virtualNetworkName

virtualNetworkName: pulumi.Input<string>;

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

interface SubnetNatGatewayAssociationArgs

interface SubnetNatGatewayAssociationArgs

The set of arguments for constructing a SubnetNatGatewayAssociation resource.

property natGatewayId

natGatewayId: pulumi.Input<string>;

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

property subnetId

subnetId: pulumi.Input<string>;

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

interface SubnetNatGatewayAssociationState

interface SubnetNatGatewayAssociationState

Input properties used for looking up and filtering SubnetNatGatewayAssociation resources.

property natGatewayId

natGatewayId?: pulumi.Input<string>;

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

property subnetId

subnetId?: pulumi.Input<string>;

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

interface SubnetNetworkSecurityGroupAssociationArgs

interface SubnetNetworkSecurityGroupAssociationArgs

The set of arguments for constructing a SubnetNetworkSecurityGroupAssociation resource.

property networkSecurityGroupId

networkSecurityGroupId: pulumi.Input<string>;

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

property subnetId

subnetId: pulumi.Input<string>;

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

interface SubnetNetworkSecurityGroupAssociationState

interface SubnetNetworkSecurityGroupAssociationState

Input properties used for looking up and filtering SubnetNetworkSecurityGroupAssociation resources.

property networkSecurityGroupId

networkSecurityGroupId?: pulumi.Input<string>;

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

property subnetId

subnetId?: pulumi.Input<string>;

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

interface SubnetRouteTableAssociationArgs

interface SubnetRouteTableAssociationArgs

The set of arguments for constructing a SubnetRouteTableAssociation resource.

property routeTableId

routeTableId: pulumi.Input<string>;

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

property subnetId

subnetId: pulumi.Input<string>;

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

interface SubnetRouteTableAssociationState

interface SubnetRouteTableAssociationState

Input properties used for looking up and filtering SubnetRouteTableAssociation resources.

property routeTableId

routeTableId?: pulumi.Input<string>;

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

property subnetId

subnetId?: pulumi.Input<string>;

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

interface SubnetState

interface SubnetState

Input properties used for looking up and filtering Subnet resources.

property addressPrefix

DEPRECATED Use the address_prefixes property instead.
addressPrefix?: pulumi.Input<string>;

The address prefix to use for the subnet.

property addressPrefixes

addressPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

The address prefixes to use for the subnet.

property delegations

delegations?: pulumi.Input<pulumi.Input<SubnetDelegation>[]>;

One or more delegation blocks as defined below.

property enforcePrivateLinkEndpointNetworkPolicies

enforcePrivateLinkEndpointNetworkPolicies?: pulumi.Input<boolean>;

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.

property enforcePrivateLinkServiceNetworkPolicies

enforcePrivateLinkServiceNetworkPolicies?: pulumi.Input<boolean>;

Enable or Disable network policies for the private link service on the subnet. Default valule is false. Conflicts with enforcePrivateLinkEndpointNetworkPolicies.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property serviceEndpoints

serviceEndpoints?: pulumi.Input<pulumi.Input<string>[]>;

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.

property virtualNetworkName

virtualNetworkName?: pulumi.Input<string>;

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

interface TrafficManagerEndpointArgs

interface TrafficManagerEndpointArgs

The set of arguments for constructing a TrafficManagerEndpoint resource.

property customHeaders

customHeaders?: pulumi.Input<pulumi.Input<TrafficManagerEndpointCustomHeader>[]>;

One or more customHeader blocks as defined below

property endpointLocation

endpointLocation?: pulumi.Input<string>;

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.

property endpointStatus

endpointStatus?: pulumi.Input<string>;

The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.

property geoMappings

geoMappings?: pulumi.Input<pulumi.Input<string>[]>;

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.

property minChildEndpoints

minChildEndpoints?: pulumi.Input<number>;

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.

property name

name?: pulumi.Input<string>;

The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.

property priority

priority?: pulumi.Input<number>;

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.

property profileName

profileName: pulumi.Input<string>;

The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group where the Traffic Manager Profile exists.

property subnets

subnets?: pulumi.Input<pulumi.Input<TrafficManagerEndpointSubnet>[]>;

One or more subnet blocks as defined below

property target

target?: pulumi.Input<string>;

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.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.

property type

type: pulumi.Input<string>;

The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints

property weight

weight?: pulumi.Input<number>;

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.

interface TrafficManagerEndpointState

interface TrafficManagerEndpointState

Input properties used for looking up and filtering TrafficManagerEndpoint resources.

property customHeaders

customHeaders?: pulumi.Input<pulumi.Input<TrafficManagerEndpointCustomHeader>[]>;

One or more customHeader blocks as defined below

property endpointLocation

endpointLocation?: pulumi.Input<string>;

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.

property endpointMonitorStatus

endpointMonitorStatus?: pulumi.Input<string>;

property endpointStatus

endpointStatus?: pulumi.Input<string>;

The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.

property geoMappings

geoMappings?: pulumi.Input<pulumi.Input<string>[]>;

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.

property minChildEndpoints

minChildEndpoints?: pulumi.Input<number>;

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.

property name

name?: pulumi.Input<string>;

The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.

property priority

priority?: pulumi.Input<number>;

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.

property profileName

profileName?: pulumi.Input<string>;

The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group where the Traffic Manager Profile exists.

property subnets

subnets?: pulumi.Input<pulumi.Input<TrafficManagerEndpointSubnet>[]>;

One or more subnet blocks as defined below

property target

target?: pulumi.Input<string>;

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.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.

property type

type?: pulumi.Input<string>;

The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints

property weight

weight?: pulumi.Input<number>;

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.

interface TrafficManagerProfileArgs

interface TrafficManagerProfileArgs

The set of arguments for constructing a TrafficManagerProfile resource.

property dnsConfig

dnsConfig: pulumi.Input<TrafficManagerProfileDnsConfig>;

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

property monitorConfig

monitorConfig: pulumi.Input<TrafficManagerProfileMonitorConfig>;

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

property name

name?: pulumi.Input<string>;

The name of the Traffic Manager profile. Changing this forces a new resource to be created.

property profileStatus

profileStatus?: pulumi.Input<string>;

The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Traffic Manager profile.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property trafficRoutingMethod

trafficRoutingMethod: pulumi.Input<string>;

Specifies the algorithm used to route traffic, possible values are:

interface TrafficManagerProfileState

interface TrafficManagerProfileState

Input properties used for looking up and filtering TrafficManagerProfile resources.

property dnsConfig

dnsConfig?: pulumi.Input<TrafficManagerProfileDnsConfig>;

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

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the created Profile.

property monitorConfig

monitorConfig?: pulumi.Input<TrafficManagerProfileMonitorConfig>;

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

property name

name?: pulumi.Input<string>;

The name of the Traffic Manager profile. Changing this forces a new resource to be created.

property profileStatus

profileStatus?: pulumi.Input<string>;

The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Traffic Manager profile.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property trafficRoutingMethod

trafficRoutingMethod?: pulumi.Input<string>;

Specifies the algorithm used to route traffic, possible values are:

interface VirtualHubArgs

interface VirtualHubArgs

The set of arguments for constructing a VirtualHub resource.

property addressPrefix

addressPrefix: pulumi.Input<string>;

The Address Prefix which should be used for this Virtual Hub.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.

property routes

routes?: pulumi.Input<pulumi.Input<VirtualHubRoute>[]>;

One or more route blocks as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Virtual Hub.

property virtualWanId

virtualWanId: pulumi.Input<string>;

The ID of a Virtual WAN within which the Virtual Hub should be created.

interface VirtualHubConnectionArgs

interface VirtualHubConnectionArgs

The set of arguments for constructing a VirtualHubConnection resource.

property hubToVitualNetworkTrafficAllowed

hubToVitualNetworkTrafficAllowed?: pulumi.Input<boolean>;

Is the Virtual Hub traffic allowed to transit via the Remote Virtual Network? Changing this forces a new resource to be created.

property internetSecurityEnabled

internetSecurityEnabled?: pulumi.Input<boolean>;

Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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.

property remoteVirtualNetworkId

remoteVirtualNetworkId: pulumi.Input<string>;

The ID of the Virtual Network which the Virtual Hub should be connected to. Changing this forces a new resource to be created.

property virtualHubId

virtualHubId: pulumi.Input<string>;

The ID of the Virtual Hub within which this connection should be created. Changing this forces a new resource to be created.

property vitualNetworkToHubGatewaysTrafficAllowed

vitualNetworkToHubGatewaysTrafficAllowed?: pulumi.Input<boolean>;

Is Remote Virtual Network traffic allowed to transit the Hub’s Virtual Network Gateway’s? Changing this forces a new resource to be created.

interface VirtualHubConnectionState

interface VirtualHubConnectionState

Input properties used for looking up and filtering VirtualHubConnection resources.

property hubToVitualNetworkTrafficAllowed

hubToVitualNetworkTrafficAllowed?: pulumi.Input<boolean>;

Is the Virtual Hub traffic allowed to transit via the Remote Virtual Network? Changing this forces a new resource to be created.

property internetSecurityEnabled

internetSecurityEnabled?: pulumi.Input<boolean>;

Should Internet Security be enabled to secure internet traffic? Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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.

property remoteVirtualNetworkId

remoteVirtualNetworkId?: pulumi.Input<string>;

The ID of the Virtual Network which the Virtual Hub should be connected to. Changing this forces a new resource to be created.

property virtualHubId

virtualHubId?: pulumi.Input<string>;

The ID of the Virtual Hub within which this connection should be created. Changing this forces a new resource to be created.

property vitualNetworkToHubGatewaysTrafficAllowed

vitualNetworkToHubGatewaysTrafficAllowed?: pulumi.Input<boolean>;

Is Remote Virtual Network traffic allowed to transit the Hub’s Virtual Network Gateway’s? Changing this forces a new resource to be created.

interface VirtualHubState

interface VirtualHubState

Input properties used for looking up and filtering VirtualHub resources.

property addressPrefix

addressPrefix?: pulumi.Input<string>;

The Address Prefix which should be used for this Virtual Hub.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.

property routes

routes?: pulumi.Input<pulumi.Input<VirtualHubRoute>[]>;

One or more route blocks as defined below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Virtual Hub.

property virtualWanId

virtualWanId?: pulumi.Input<string>;

The ID of a Virtual WAN within which the Virtual Hub should be created.

interface VirtualNetworkArgs

interface VirtualNetworkArgs

The set of arguments for constructing a VirtualNetwork resource.

property addressSpaces

addressSpaces: pulumi.Input<pulumi.Input<string>[]>;

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.

property ddosProtectionPlan

ddosProtectionPlan?: pulumi.Input<VirtualNetworkDdosProtectionPlan>;

A ddosProtectionPlan block as documented below.

property dnsServers

dnsServers?: pulumi.Input<pulumi.Input<string>[]>;

List of IP addresses of DNS servers

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property subnets

subnets?: pulumi.Input<pulumi.Input<VirtualNetworkSubnet>[]>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface VirtualNetworkGatewayArgs

interface VirtualNetworkGatewayArgs

The set of arguments for constructing a VirtualNetworkGateway resource.

property activeActive

activeActive?: pulumi.Input<boolean>;

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.

property bgpSettings

bgpSettings?: pulumi.Input<VirtualNetworkGatewayBgpSettings>;

property defaultLocalNetworkGatewayId

defaultLocalNetworkGatewayId?: pulumi.Input<string>;

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.

property enableBgp

enableBgp?: pulumi.Input<boolean>;

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

property generation

generation?: pulumi.Input<string>;

The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None.

property ipConfigurations

ipConfigurations: pulumi.Input<pulumi.Input<VirtualNetworkGatewayIpConfiguration>[]>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

A user-defined name of the revoked certificate.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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.

property sku

sku: pulumi.Input<string>;

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, vpnType and generation arguments. A PolicyBased gateway only supports the Basic sku. Further, the UltraPerformance sku is only supported by an ExpressRoute gateway.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property type

type: pulumi.Input<string>;

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

property vpnClientConfiguration

vpnClientConfiguration?: pulumi.Input<VirtualNetworkGatewayVpnClientConfiguration>;

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

property vpnType

vpnType?: pulumi.Input<string>;

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

interface VirtualNetworkGatewayConnectionArgs

interface VirtualNetworkGatewayConnectionArgs

The set of arguments for constructing a VirtualNetworkGatewayConnection resource.

property authorizationKey

authorizationKey?: pulumi.Input<string>;

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

property connectionProtocol

connectionProtocol?: pulumi.Input<string>;

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.

property enableBgp

enableBgp?: pulumi.Input<boolean>;

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

property expressRouteCircuitId

expressRouteCircuitId?: pulumi.Input<string>;

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.

property expressRouteGatewayBypass

expressRouteGatewayBypass?: pulumi.Input<boolean>;

If true, data packets will bypass ExpressRoute Gateway for data forwarding This is only valid for ExpressRoute connections.

property ipsecPolicy

ipsecPolicy?: pulumi.Input<VirtualNetworkGatewayConnectionIpsecPolicy>;

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

property localNetworkGatewayId

localNetworkGatewayId?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property peerVirtualNetworkGatewayId

peerVirtualNetworkGatewayId?: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property routingWeight

routingWeight?: pulumi.Input<number>;

The routing weight. Defaults to 10.

property sharedKey

sharedKey?: pulumi.Input<string>;

The shared IPSec key. A key could be provided if a Site-to-Site, VNet-to-VNet or ExpressRoute connection is created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property type

type: pulumi.Input<string>;

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.

property usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors?: pulumi.Input<boolean>;

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

property virtualNetworkGatewayId

virtualNetworkGatewayId: pulumi.Input<string>;

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

interface VirtualNetworkGatewayConnectionState

interface VirtualNetworkGatewayConnectionState

Input properties used for looking up and filtering VirtualNetworkGatewayConnection resources.

property authorizationKey

authorizationKey?: pulumi.Input<string>;

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

property connectionProtocol

connectionProtocol?: pulumi.Input<string>;

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.

property enableBgp

enableBgp?: pulumi.Input<boolean>;

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

property expressRouteCircuitId

expressRouteCircuitId?: pulumi.Input<string>;

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.

property expressRouteGatewayBypass

expressRouteGatewayBypass?: pulumi.Input<boolean>;

If true, data packets will bypass ExpressRoute Gateway for data forwarding This is only valid for ExpressRoute connections.

property ipsecPolicy

ipsecPolicy?: pulumi.Input<VirtualNetworkGatewayConnectionIpsecPolicy>;

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

property localNetworkGatewayId

localNetworkGatewayId?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property peerVirtualNetworkGatewayId

peerVirtualNetworkGatewayId?: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property routingWeight

routingWeight?: pulumi.Input<number>;

The routing weight. Defaults to 10.

property sharedKey

sharedKey?: pulumi.Input<string>;

The shared IPSec key. A key could be provided if a Site-to-Site, VNet-to-VNet or ExpressRoute connection is created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property type

type?: pulumi.Input<string>;

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.

property usePolicyBasedTrafficSelectors

usePolicyBasedTrafficSelectors?: pulumi.Input<boolean>;

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

property virtualNetworkGatewayId

virtualNetworkGatewayId?: pulumi.Input<string>;

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

interface VirtualNetworkGatewayState

interface VirtualNetworkGatewayState

Input properties used for looking up and filtering VirtualNetworkGateway resources.

property activeActive

activeActive?: pulumi.Input<boolean>;

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.

property bgpSettings

bgpSettings?: pulumi.Input<VirtualNetworkGatewayBgpSettings>;

property defaultLocalNetworkGatewayId

defaultLocalNetworkGatewayId?: pulumi.Input<string>;

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.

property enableBgp

enableBgp?: pulumi.Input<boolean>;

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

property generation

generation?: pulumi.Input<string>;

The Generation of the Virtual Network gateway. Possible values include Generation1, Generation2 or None.

property ipConfigurations

ipConfigurations?: pulumi.Input<pulumi.Input<VirtualNetworkGatewayIpConfiguration>[]>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

A user-defined name of the revoked certificate.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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.

property sku

sku?: pulumi.Input<string>;

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, vpnType and generation arguments. A PolicyBased gateway only supports the Basic sku. Further, the UltraPerformance sku is only supported by an ExpressRoute gateway.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property type

type?: pulumi.Input<string>;

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

property vpnClientConfiguration

vpnClientConfiguration?: pulumi.Input<VirtualNetworkGatewayVpnClientConfiguration>;

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

property vpnType

vpnType?: pulumi.Input<string>;

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

interface VirtualNetworkPeeringArgs

interface VirtualNetworkPeeringArgs

The set of arguments for constructing a VirtualNetworkPeering resource.

property allowForwardedTraffic

allowForwardedTraffic?: pulumi.Input<boolean>;

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

property allowGatewayTransit

allowGatewayTransit?: pulumi.Input<boolean>;

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

property allowVirtualNetworkAccess

allowVirtualNetworkAccess?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property remoteVirtualNetworkId

remoteVirtualNetworkId: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property useRemoteGateways

useRemoteGateways?: pulumi.Input<boolean>;

Controls if remote gateways can be used on the local virtual network. If the flag is set to true, and allowGatewayTransit 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.

property virtualNetworkName

virtualNetworkName: pulumi.Input<string>;

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

interface VirtualNetworkPeeringState

interface VirtualNetworkPeeringState

Input properties used for looking up and filtering VirtualNetworkPeering resources.

property allowForwardedTraffic

allowForwardedTraffic?: pulumi.Input<boolean>;

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

property allowGatewayTransit

allowGatewayTransit?: pulumi.Input<boolean>;

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

property allowVirtualNetworkAccess

allowVirtualNetworkAccess?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property remoteVirtualNetworkId

remoteVirtualNetworkId?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property useRemoteGateways

useRemoteGateways?: pulumi.Input<boolean>;

Controls if remote gateways can be used on the local virtual network. If the flag is set to true, and allowGatewayTransit 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.

property virtualNetworkName

virtualNetworkName?: pulumi.Input<string>;

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

interface VirtualNetworkState

interface VirtualNetworkState

Input properties used for looking up and filtering VirtualNetwork resources.

property addressSpaces

addressSpaces?: pulumi.Input<pulumi.Input<string>[]>;

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.

property ddosProtectionPlan

ddosProtectionPlan?: pulumi.Input<VirtualNetworkDdosProtectionPlan>;

A ddosProtectionPlan block as documented below.

property dnsServers

dnsServers?: pulumi.Input<pulumi.Input<string>[]>;

List of IP addresses of DNS servers

property guid

guid?: pulumi.Input<string>;

The GUID of the virtual network.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property subnets

subnets?: pulumi.Input<pulumi.Input<VirtualNetworkSubnet>[]>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface VirtualWanArgs

interface VirtualWanArgs

The set of arguments for constructing a VirtualWan resource.

property allowBranchToBranchTraffic

allowBranchToBranchTraffic?: pulumi.Input<boolean>;

Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.

property allowVnetToVnetTraffic

allowVnetToVnetTraffic?: pulumi.Input<boolean>;

Boolean flag to specify whether VNet to VNet traffic is allowed. Defaults to false.

property disableVpnEncryption

disableVpnEncryption?: pulumi.Input<boolean>;

Boolean flag to specify whether VPN encryption is disabled. Defaults to false.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property office365LocalBreakoutCategory

office365LocalBreakoutCategory?: pulumi.Input<string>;

Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Virtual WAN.

property type

type?: pulumi.Input<string>;

Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

interface VirtualWanState

interface VirtualWanState

Input properties used for looking up and filtering VirtualWan resources.

property allowBranchToBranchTraffic

allowBranchToBranchTraffic?: pulumi.Input<boolean>;

Boolean flag to specify whether branch to branch traffic is allowed. Defaults to true.

property allowVnetToVnetTraffic

allowVnetToVnetTraffic?: pulumi.Input<boolean>;

Boolean flag to specify whether VNet to VNet traffic is allowed. Defaults to false.

property disableVpnEncryption

disableVpnEncryption?: pulumi.Input<boolean>;

Boolean flag to specify whether VPN encryption is disabled. Defaults to false.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property office365LocalBreakoutCategory

office365LocalBreakoutCategory?: pulumi.Input<string>;

Specifies the Office365 local breakout category. Possible values include: Optimize, OptimizeAndAllow, All, None. Defaults to None.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the Virtual WAN.

property type

type?: pulumi.Input<string>;

Specifies the Virtual WAN type. Possible Values include: Basic and Standard. Defaults to Standard.

interface VpnGatewayArgs

interface VpnGatewayArgs

The set of arguments for constructing a VpnGateway resource.

property bgpSettings

bgpSettings?: pulumi.Input<pulumi.Input<VpnGatewayBgpSetting>[]>;

A bgpSettings block as defined below.

property location

location?: pulumi.Input<string>;

The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.

property scaleUnit

scaleUnit?: pulumi.Input<number>;

The Scale Unit for this VPN Gateway. Defaults to 1.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the VPN Gateway.

property virtualHubId

virtualHubId: pulumi.Input<string>;

The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.

interface VpnGatewayState

interface VpnGatewayState

Input properties used for looking up and filtering VpnGateway resources.

property bgpSettings

bgpSettings?: pulumi.Input<pulumi.Input<VpnGatewayBgpSetting>[]>;

A bgpSettings block as defined below.

property location

location?: pulumi.Input<string>;

The Azure location where this VPN Gateway should be created. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The Name which should be used for this VPN Gateway. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The Name of the Resource Group in which this VPN Gateway should be created. Changing this forces a new resource to be created.

property scaleUnit

scaleUnit?: pulumi.Input<number>;

The Scale Unit for this VPN Gateway. Defaults to 1.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the VPN Gateway.

property virtualHubId

virtualHubId?: pulumi.Input<string>;

The ID of the Virtual Hub within which this VPN Gateway should be created. Changing this forces a new resource to be created.

interface VpnServerConfigurationArgs

interface VpnServerConfigurationArgs

The set of arguments for constructing a VpnServerConfiguration resource.

property azureActiveDirectoryAuthentications

azureActiveDirectoryAuthentications?: pulumi.Input<pulumi.Input<VpnServerConfigurationAzureActiveDirectoryAuthentication>[]>;

A azureActiveDirectoryAuthentication block as defined below.

property clientRevokedCertificates

clientRevokedCertificates?: pulumi.Input<pulumi.Input<VpnServerConfigurationClientRevokedCertificate>[]>;

One or more clientRevokedCertificate blocks as defined below.

property clientRootCertificates

clientRootCertificates?: pulumi.Input<pulumi.Input<VpnServerConfigurationClientRootCertificate>[]>;

One or more clientRootCertificate blocks as defined below.

property ipsecPolicy

ipsecPolicy?: pulumi.Input<VpnServerConfigurationIpsecPolicy>;

A ipsecPolicy block as defined below.

property location

location?: pulumi.Input<string>;

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

property radiusServer

radiusServer?: pulumi.Input<VpnServerConfigurationRadiusServer>;

A radiusServer block as defined below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property vpnAuthenticationTypes

vpnAuthenticationTypes: pulumi.Input<string>;

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

property vpnProtocols

vpnProtocols?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

interface VpnServerConfigurationState

interface VpnServerConfigurationState

Input properties used for looking up and filtering VpnServerConfiguration resources.

property azureActiveDirectoryAuthentications

azureActiveDirectoryAuthentications?: pulumi.Input<pulumi.Input<VpnServerConfigurationAzureActiveDirectoryAuthentication>[]>;

A azureActiveDirectoryAuthentication block as defined below.

property clientRevokedCertificates

clientRevokedCertificates?: pulumi.Input<pulumi.Input<VpnServerConfigurationClientRevokedCertificate>[]>;

One or more clientRevokedCertificate blocks as defined below.

property clientRootCertificates

clientRootCertificates?: pulumi.Input<pulumi.Input<VpnServerConfigurationClientRootCertificate>[]>;

One or more clientRootCertificate blocks as defined below.

property ipsecPolicy

ipsecPolicy?: pulumi.Input<VpnServerConfigurationIpsecPolicy>;

A ipsecPolicy block as defined below.

property location

location?: pulumi.Input<string>;

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

property radiusServer

radiusServer?: pulumi.Input<VpnServerConfigurationRadiusServer>;

A radiusServer block as defined below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

property vpnAuthenticationTypes

vpnAuthenticationTypes?: pulumi.Input<string>;

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

property vpnProtocols

vpnProtocols?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.