Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Panos Provider
  3. API Docs
  4. Zone
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-panos

panos.Zone

Explore with Pulumi AI

panos logo
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks
paloaltonetworks/terraform-provider-panos

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.panos.Template;
import com.pulumi.panos.TemplateArgs;
import com.pulumi.panos.inputs.TemplateLocationArgs;
import com.pulumi.panos.inputs.TemplateLocationPanoramaArgs;
import com.pulumi.panos.EthernetInterface;
import com.pulumi.panos.EthernetInterfaceArgs;
import com.pulumi.panos.inputs.EthernetInterfaceLocationArgs;
import com.pulumi.panos.inputs.EthernetInterfaceLocationTemplateArgs;
import com.pulumi.panos.inputs.EthernetInterfaceLayer3Args;
import com.pulumi.panos.Zone;
import com.pulumi.panos.ZoneArgs;
import com.pulumi.panos.inputs.ZoneLocationArgs;
import com.pulumi.panos.inputs.ZoneLocationTemplateArgs;
import com.pulumi.panos.inputs.ZoneDeviceAclArgs;
import com.pulumi.panos.inputs.ZoneNetworkArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Template("example", TemplateArgs.builder()
            .location(TemplateLocationArgs.builder()
                .panorama()
                .build())
            .build());

        var iface1 = new EthernetInterface("iface1", EthernetInterfaceArgs.builder()
            .location(EthernetInterfaceLocationArgs.builder()
                .template(EthernetInterfaceLocationTemplateArgs.builder()
                    .name(example.name())
                    .vsys("vsys1")
                    .build())
                .build())
            .layer3()
            .build());

        var iface2 = new EthernetInterface("iface2", EthernetInterfaceArgs.builder()
            .location(EthernetInterfaceLocationArgs.builder()
                .template(EthernetInterfaceLocationTemplateArgs.builder()
                    .name(example.name())
                    .vsys("vsys1")
                    .build())
                .build())
            .layer3()
            .build());

        var zone = new Zone("zone", ZoneArgs.builder()
            .location(ZoneLocationArgs.builder()
                .template(ZoneLocationTemplateArgs.builder()
                    .name(example.name())
                    .vsys("vsys1")
                    .build())
                .build())
            .deviceAcl()
            .enableDeviceIdentification(true)
            .enableUserIdentification(true)
            .network(ZoneNetworkArgs.builder()
                .layer3(                
                    "ethernet1/1",
                    "ethernet1/2")
                .enable_packet_buffer_protection(true)
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(                
                    iface1,
                    iface2)
                .build());

    }
}

    resources:
  zone:
    type: panos:Zone
    properties:
      location:
        template:
          name: ${example.name}
          vsys: vsys1
      deviceAcl: {}
      enableDeviceIdentification: true
      enableUserIdentification: true
      network:
        layer3:
          - ethernet1/1
          - ethernet1/2
        enable_packet_buffer_protection: true
    options:
      dependsOn:
        - ${iface1}
        - ${iface2}
  example:
    type: panos:Template
    properties:
      location:
        panorama: {}
  iface1:
    type: panos:EthernetInterface
    properties:
      location:
        template:
          name: ${example.name}
          vsys: vsys1
      layer3: {}
  iface2:
    type: panos:EthernetInterface
    properties:
      location:
        template:
          name: ${example.name}
          vsys: vsys1
      layer3: {}

    Create Zone Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Zone(name: string, args: ZoneArgs, opts?: CustomResourceOptions);
    @overload
def Zone(resource_name: str,
         args: ZoneArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Zone(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         location: Optional[ZoneLocationArgs] = None,
         device_acl: Optional[ZoneDeviceAclArgs] = None,
         enable_device_identification: Optional[bool] = None,
         enable_user_identification: Optional[bool] = None,
         name: Optional[str] = None,
         network: Optional[ZoneNetworkArgs] = None,
         user_acl: Optional[ZoneUserAclArgs] = None)
    func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
    public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
    public Zone(String name, ZoneArgs args)
public Zone(String name, ZoneArgs args, CustomResourceOptions options)

    type: panos:Zone
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var zoneResource = new Panos.Zone("zoneResource", new()
{
    Location = new Panos.Inputs.ZoneLocationArgs
    {
        Template = new Panos.Inputs.ZoneLocationTemplateArgs
        {
            Name = "string",
            NgfwDevice = "string",
            PanoramaDevice = "string",
            Vsys = "string",
        },
        TemplateStack = new Panos.Inputs.ZoneLocationTemplateStackArgs
        {
            Name = "string",
            NgfwDevice = "string",
            PanoramaDevice = "string",
        },
        Vsys = new Panos.Inputs.ZoneLocationVsysArgs
        {
            Name = "string",
            NgfwDevice = "string",
        },
    },
    DeviceAcl = new Panos.Inputs.ZoneDeviceAclArgs
    {
        ExcludeLists = new[]
        {
            "string",
        },
        IncludeLists = new[]
        {
            "string",
        },
    },
    EnableDeviceIdentification = false,
    EnableUserIdentification = false,
    Name = "string",
    Network = new Panos.Inputs.ZoneNetworkArgs
    {
        EnablePacketBufferProtection = false,
        Externals = new[]
        {
            "string",
        },
        Layer2s = new[]
        {
            "string",
        },
        Layer3s = new[]
        {
            "string",
        },
        LogSetting = "string",
        NetInspection = false,
        Taps = new[]
        {
            "string",
        },
        Tunnel = null,
        VirtualWires = new[]
        {
            "string",
        },
        ZoneProtectionProfile = "string",
    },
    UserAcl = new Panos.Inputs.ZoneUserAclArgs
    {
        ExcludeLists = new[]
        {
            "string",
        },
        IncludeLists = new[]
        {
            "string",
        },
    },
});

    example, err := panos.NewZone(ctx, "zoneResource", &panos.ZoneArgs{
	Location: &panos.ZoneLocationArgs{
		Template: &panos.ZoneLocationTemplateArgs{
			Name:           pulumi.String("string"),
			NgfwDevice:     pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
			Vsys:           pulumi.String("string"),
		},
		TemplateStack: &panos.ZoneLocationTemplateStackArgs{
			Name:           pulumi.String("string"),
			NgfwDevice:     pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
		},
		Vsys: &panos.ZoneLocationVsysArgs{
			Name:       pulumi.String("string"),
			NgfwDevice: pulumi.String("string"),
		},
	},
	DeviceAcl: &panos.ZoneDeviceAclArgs{
		ExcludeLists: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludeLists: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	EnableDeviceIdentification: pulumi.Bool(false),
	EnableUserIdentification:   pulumi.Bool(false),
	Name:                       pulumi.String("string"),
	Network: &panos.ZoneNetworkArgs{
		EnablePacketBufferProtection: pulumi.Bool(false),
		Externals: pulumi.StringArray{
			pulumi.String("string"),
		},
		Layer2s: pulumi.StringArray{
			pulumi.String("string"),
		},
		Layer3s: pulumi.StringArray{
			pulumi.String("string"),
		},
		LogSetting:    pulumi.String("string"),
		NetInspection: pulumi.Bool(false),
		Taps: pulumi.StringArray{
			pulumi.String("string"),
		},
		Tunnel: &panos.ZoneNetworkTunnelArgs{},
		VirtualWires: pulumi.StringArray{
			pulumi.String("string"),
		},
		ZoneProtectionProfile: pulumi.String("string"),
	},
	UserAcl: &panos.ZoneUserAclArgs{
		ExcludeLists: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludeLists: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
    .location(ZoneLocationArgs.builder()
        .template(ZoneLocationTemplateArgs.builder()
            .name("string")
            .ngfwDevice("string")
            .panoramaDevice("string")
            .vsys("string")
            .build())
        .templateStack(ZoneLocationTemplateStackArgs.builder()
            .name("string")
            .ngfwDevice("string")
            .panoramaDevice("string")
            .build())
        .vsys(ZoneLocationVsysArgs.builder()
            .name("string")
            .ngfwDevice("string")
            .build())
        .build())
    .deviceAcl(ZoneDeviceAclArgs.builder()
        .excludeLists("string")
        .includeLists("string")
        .build())
    .enableDeviceIdentification(false)
    .enableUserIdentification(false)
    .name("string")
    .network(ZoneNetworkArgs.builder()
        .enablePacketBufferProtection(false)
        .externals("string")
        .layer2s("string")
        .layer3s("string")
        .logSetting("string")
        .netInspection(false)
        .taps("string")
        .tunnel()
        .virtualWires("string")
        .zoneProtectionProfile("string")
        .build())
    .userAcl(ZoneUserAclArgs.builder()
        .excludeLists("string")
        .includeLists("string")
        .build())
    .build());

    zone_resource = panos.Zone("zoneResource",
    location={
        "template": {
            "name": "string",
            "ngfw_device": "string",
            "panorama_device": "string",
            "vsys": "string",
        },
        "template_stack": {
            "name": "string",
            "ngfw_device": "string",
            "panorama_device": "string",
        },
        "vsys": {
            "name": "string",
            "ngfw_device": "string",
        },
    },
    device_acl={
        "exclude_lists": ["string"],
        "include_lists": ["string"],
    },
    enable_device_identification=False,
    enable_user_identification=False,
    name="string",
    network={
        "enable_packet_buffer_protection": False,
        "externals": ["string"],
        "layer2s": ["string"],
        "layer3s": ["string"],
        "log_setting": "string",
        "net_inspection": False,
        "taps": ["string"],
        "tunnel": {},
        "virtual_wires": ["string"],
        "zone_protection_profile": "string",
    },
    user_acl={
        "exclude_lists": ["string"],
        "include_lists": ["string"],
    })

    const zoneResource = new panos.Zone("zoneResource", {
    location: {
        template: {
            name: "string",
            ngfwDevice: "string",
            panoramaDevice: "string",
            vsys: "string",
        },
        templateStack: {
            name: "string",
            ngfwDevice: "string",
            panoramaDevice: "string",
        },
        vsys: {
            name: "string",
            ngfwDevice: "string",
        },
    },
    deviceAcl: {
        excludeLists: ["string"],
        includeLists: ["string"],
    },
    enableDeviceIdentification: false,
    enableUserIdentification: false,
    name: "string",
    network: {
        enablePacketBufferProtection: false,
        externals: ["string"],
        layer2s: ["string"],
        layer3s: ["string"],
        logSetting: "string",
        netInspection: false,
        taps: ["string"],
        tunnel: {},
        virtualWires: ["string"],
        zoneProtectionProfile: "string",
    },
    userAcl: {
        excludeLists: ["string"],
        includeLists: ["string"],
    },
});

    type: panos:Zone
properties:
    deviceAcl:
        excludeLists:
            - string
        includeLists:
            - string
    enableDeviceIdentification: false
    enableUserIdentification: false
    location:
        template:
            name: string
            ngfwDevice: string
            panoramaDevice: string
            vsys: string
        templateStack:
            name: string
            ngfwDevice: string
            panoramaDevice: string
        vsys:
            name: string
            ngfwDevice: string
    name: string
    network:
        enablePacketBufferProtection: false
        externals:
            - string
        layer2s:
            - string
        layer3s:
            - string
        logSetting: string
        netInspection: false
        taps:
            - string
        tunnel: {}
        virtualWires:
            - string
        zoneProtectionProfile: string
    userAcl:
        excludeLists:
            - string
        includeLists:
            - string

    Zone Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Zone resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Zone resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Zone Resource

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

    public static get(name: string, id: Input<ID>, state?: ZoneState, opts?: CustomResourceOptions): Zone
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_acl: Optional[ZoneDeviceAclArgs] = None,
        enable_device_identification: Optional[bool] = None,
        enable_user_identification: Optional[bool] = None,
        location: Optional[ZoneLocationArgs] = None,
        name: Optional[str] = None,
        network: Optional[ZoneNetworkArgs] = None,
        user_acl: Optional[ZoneUserAclArgs] = None) -> Zone
    func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
    public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
    public static Zone get(String name, Output<String> id, ZoneState state, CustomResourceOptions options)
    resources:  _:    type: panos:Zone    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:

    Supporting Types

    ZoneDeviceAcl, ZoneDeviceAclArgs

    ExcludeLists List<string>
    IncludeLists List<string>
    ExcludeLists []string
    IncludeLists []string
    excludeLists List<String>
    includeLists List<String>
    excludeLists string[]
    includeLists string[]
    exclude_lists Sequence[str]
    include_lists Sequence[str]
    excludeLists List<String>
    includeLists List<String>

    ZoneLocation, ZoneLocationArgs

    Template ZoneLocationTemplate
    Located in a specific template
    TemplateStack ZoneLocationTemplateStack
    Located in a specific template stack
    Vsys ZoneLocationVsys
    Located in a specific Virtual System
    Template ZoneLocationTemplate
    Located in a specific template
    TemplateStack ZoneLocationTemplateStack
    Located in a specific template stack
    Vsys ZoneLocationVsys
    Located in a specific Virtual System
    template ZoneLocationTemplate
    Located in a specific template
    templateStack ZoneLocationTemplateStack
    Located in a specific template stack
    vsys ZoneLocationVsys
    Located in a specific Virtual System
    template ZoneLocationTemplate
    Located in a specific template
    templateStack ZoneLocationTemplateStack
    Located in a specific template stack
    vsys ZoneLocationVsys
    Located in a specific Virtual System
    template ZoneLocationTemplate
    Located in a specific template
    template_stack ZoneLocationTemplateStack
    Located in a specific template stack
    vsys ZoneLocationVsys
    Located in a specific Virtual System
    template Property Map
    Located in a specific template
    templateStack Property Map
    Located in a specific template stack
    vsys Property Map
    Located in a specific Virtual System

    ZoneLocationTemplate, ZoneLocationTemplateArgs

    Name string
    Specific Panorama template
    NgfwDevice string
    The NGFW device
    PanoramaDevice string
    Specific Panorama device
    Vsys string
    The vsys.
    Name string
    Specific Panorama template
    NgfwDevice string
    The NGFW device
    PanoramaDevice string
    Specific Panorama device
    Vsys string
    The vsys.
    name String
    Specific Panorama template
    ngfwDevice String
    The NGFW device
    panoramaDevice String
    Specific Panorama device
    vsys String
    The vsys.
    name string
    Specific Panorama template
    ngfwDevice string
    The NGFW device
    panoramaDevice string
    Specific Panorama device
    vsys string
    The vsys.
    name str
    Specific Panorama template
    ngfw_device str
    The NGFW device
    panorama_device str
    Specific Panorama device
    vsys str
    The vsys.
    name String
    Specific Panorama template
    ngfwDevice String
    The NGFW device
    panoramaDevice String
    Specific Panorama device
    vsys String
    The vsys.

    ZoneLocationTemplateStack, ZoneLocationTemplateStackArgs

    Name string
    Specific Panorama template stack
    NgfwDevice string
    The NGFW device
    PanoramaDevice string
    Specific Panorama device
    Name string
    Specific Panorama template stack
    NgfwDevice string
    The NGFW device
    PanoramaDevice string
    Specific Panorama device
    name String
    Specific Panorama template stack
    ngfwDevice String
    The NGFW device
    panoramaDevice String
    Specific Panorama device
    name string
    Specific Panorama template stack
    ngfwDevice string
    The NGFW device
    panoramaDevice string
    Specific Panorama device
    name str
    Specific Panorama template stack
    ngfw_device str
    The NGFW device
    panorama_device str
    Specific Panorama device
    name String
    Specific Panorama template stack
    ngfwDevice String
    The NGFW device
    panoramaDevice String
    Specific Panorama device

    ZoneLocationVsys, ZoneLocationVsysArgs

    Name string
    The Virtual System name
    NgfwDevice string
    The NGFW device name
    Name string
    The Virtual System name
    NgfwDevice string
    The NGFW device name
    name String
    The Virtual System name
    ngfwDevice String
    The NGFW device name
    name string
    The Virtual System name
    ngfwDevice string
    The NGFW device name
    name str
    The Virtual System name
    ngfw_device str
    The NGFW device name
    name String
    The Virtual System name
    ngfwDevice String
    The NGFW device name

    ZoneNetwork, ZoneNetworkArgs

    EnablePacketBufferProtection bool
    Externals List<string>
    Layer2s List<string>
    Layer3s List<string>
    LogSetting string
    Log setting for forwarding scan logs
    NetInspection bool
    Taps List<string>
    Tunnel ZoneNetworkTunnel
    VirtualWires List<string>
    ZoneProtectionProfile string
    Zone protection profile
    EnablePacketBufferProtection bool
    Externals []string
    Layer2s []string
    Layer3s []string
    LogSetting string
    Log setting for forwarding scan logs
    NetInspection bool
    Taps []string
    Tunnel ZoneNetworkTunnel
    VirtualWires []string
    ZoneProtectionProfile string
    Zone protection profile
    enablePacketBufferProtection Boolean
    externals List<String>
    layer2s List<String>
    layer3s List<String>
    logSetting String
    Log setting for forwarding scan logs
    netInspection Boolean
    taps List<String>
    tunnel ZoneNetworkTunnel
    virtualWires List<String>
    zoneProtectionProfile String
    Zone protection profile
    enablePacketBufferProtection boolean
    externals string[]
    layer2s string[]
    layer3s string[]
    logSetting string
    Log setting for forwarding scan logs
    netInspection boolean
    taps string[]
    tunnel ZoneNetworkTunnel
    virtualWires string[]
    zoneProtectionProfile string
    Zone protection profile
    enable_packet_buffer_protection bool
    externals Sequence[str]
    layer2s Sequence[str]
    layer3s Sequence[str]
    log_setting str
    Log setting for forwarding scan logs
    net_inspection bool
    taps Sequence[str]
    tunnel ZoneNetworkTunnel
    virtual_wires Sequence[str]
    zone_protection_profile str
    Zone protection profile
    enablePacketBufferProtection Boolean
    externals List<String>
    layer2s List<String>
    layer3s List<String>
    logSetting String
    Log setting for forwarding scan logs
    netInspection Boolean
    taps List<String>
    tunnel Property Map
    virtualWires List<String>
    zoneProtectionProfile String
    Zone protection profile

    ZoneUserAcl, ZoneUserAclArgs

    ExcludeLists List<string>
    IncludeLists List<string>
    ExcludeLists []string
    IncludeLists []string
    excludeLists List<String>
    includeLists List<String>
    excludeLists string[]
    includeLists string[]
    exclude_lists Sequence[str]
    include_lists Sequence[str]
    excludeLists List<String>
    includeLists List<String>

    Package Details

    Repository
    panos paloaltonetworks/terraform-provider-panos
    License
    Notes
    This Pulumi package is based on the panos Terraform Provider.
    panos logo
    panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks
    paloaltonetworks/terraform-provider-panos