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

panos.Address

Explore with Pulumi AI

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

    Example Usage

    Create Address Resource

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

    Constructor syntax

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

@overload
def Address(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[AddressLocationArgs] = None,
            description: Optional[str] = None,
            disable_override: Optional[str] = None,
            fqdn: Optional[str] = None,
            ip_netmask: Optional[str] = None,
            ip_range: Optional[str] = None,
            ip_wildcard: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[str]] = None)
    func NewAddress(ctx *Context, name string, args AddressArgs, opts ...ResourceOption) (*Address, error)
    public Address(string name, AddressArgs args, CustomResourceOptions? opts = null)
    public Address(String name, AddressArgs args)
public Address(String name, AddressArgs args, CustomResourceOptions options)

    type: panos:Address
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 AddressArgs
    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 AddressArgs
    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 AddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddressArgs
    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 addressResource = new Panos.Address("addressResource", new()
{
    Location = new Panos.Inputs.AddressLocationArgs
    {
        DeviceGroup = new Panos.Inputs.AddressLocationDeviceGroupArgs
        {
            Name = "string",
            PanoramaDevice = "string",
        },
        Shared = null,
        Vsys = new Panos.Inputs.AddressLocationVsysArgs
        {
            Name = "string",
            NgfwDevice = "string",
        },
    },
    Description = "string",
    DisableOverride = "string",
    Fqdn = "string",
    IpNetmask = "string",
    IpRange = "string",
    IpWildcard = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := panos.NewAddress(ctx, "addressResource", &panos.AddressArgs{
	Location: &panos.AddressLocationArgs{
		DeviceGroup: &panos.AddressLocationDeviceGroupArgs{
			Name:           pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
		},
		Shared: &panos.AddressLocationSharedArgs{},
		Vsys: &panos.AddressLocationVsysArgs{
			Name:       pulumi.String("string"),
			NgfwDevice: pulumi.String("string"),
		},
	},
	Description:     pulumi.String("string"),
	DisableOverride: pulumi.String("string"),
	Fqdn:            pulumi.String("string"),
	IpNetmask:       pulumi.String("string"),
	IpRange:         pulumi.String("string"),
	IpWildcard:      pulumi.String("string"),
	Name:            pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var addressResource = new Address("addressResource", AddressArgs.builder()
    .location(AddressLocationArgs.builder()
        .deviceGroup(AddressLocationDeviceGroupArgs.builder()
            .name("string")
            .panoramaDevice("string")
            .build())
        .shared()
        .vsys(AddressLocationVsysArgs.builder()
            .name("string")
            .ngfwDevice("string")
            .build())
        .build())
    .description("string")
    .disableOverride("string")
    .fqdn("string")
    .ipNetmask("string")
    .ipRange("string")
    .ipWildcard("string")
    .name("string")
    .tags("string")
    .build());

    address_resource = panos.Address("addressResource",
    location={
        "device_group": {
            "name": "string",
            "panorama_device": "string",
        },
        "shared": {},
        "vsys": {
            "name": "string",
            "ngfw_device": "string",
        },
    },
    description="string",
    disable_override="string",
    fqdn="string",
    ip_netmask="string",
    ip_range="string",
    ip_wildcard="string",
    name="string",
    tags=["string"])

    const addressResource = new panos.Address("addressResource", {
    location: {
        deviceGroup: {
            name: "string",
            panoramaDevice: "string",
        },
        shared: {},
        vsys: {
            name: "string",
            ngfwDevice: "string",
        },
    },
    description: "string",
    disableOverride: "string",
    fqdn: "string",
    ipNetmask: "string",
    ipRange: "string",
    ipWildcard: "string",
    name: "string",
    tags: ["string"],
});

    type: panos:Address
properties:
    description: string
    disableOverride: string
    fqdn: string
    ipNetmask: string
    ipRange: string
    ipWildcard: string
    location:
        deviceGroup:
            name: string
            panoramaDevice: string
        shared: {}
        vsys:
            name: string
            ngfwDevice: string
    name: string
    tags:
        - string

    Address 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 Address resource accepts the following input properties:

    Location AddressLocation
    The location of this object.
    Description string
    The description.
    DisableOverride string
    disable object override in child device groups
    Fqdn string
    The FQDN value.
    IpNetmask string
    The IP netmask value.
    IpRange string
    The IP range value.
    IpWildcard string
    The IP wildcard value.
    Name string
    Tags List<string>
    The administrative tags.
    Location AddressLocationArgs
    The location of this object.
    Description string
    The description.
    DisableOverride string
    disable object override in child device groups
    Fqdn string
    The FQDN value.
    IpNetmask string
    The IP netmask value.
    IpRange string
    The IP range value.
    IpWildcard string
    The IP wildcard value.
    Name string
    Tags []string
    The administrative tags.
    location AddressLocation
    The location of this object.
    description String
    The description.
    disableOverride String
    disable object override in child device groups
    fqdn String
    The FQDN value.
    ipNetmask String
    The IP netmask value.
    ipRange String
    The IP range value.
    ipWildcard String
    The IP wildcard value.
    name String
    tags List<String>
    The administrative tags.
    location AddressLocation
    The location of this object.
    description string
    The description.
    disableOverride string
    disable object override in child device groups
    fqdn string
    The FQDN value.
    ipNetmask string
    The IP netmask value.
    ipRange string
    The IP range value.
    ipWildcard string
    The IP wildcard value.
    name string
    tags string[]
    The administrative tags.
    location AddressLocationArgs
    The location of this object.
    description str
    The description.
    disable_override str
    disable object override in child device groups
    fqdn str
    The FQDN value.
    ip_netmask str
    The IP netmask value.
    ip_range str
    The IP range value.
    ip_wildcard str
    The IP wildcard value.
    name str
    tags Sequence[str]
    The administrative tags.
    location Property Map
    The location of this object.
    description String
    The description.
    disableOverride String
    disable object override in child device groups
    fqdn String
    The FQDN value.
    ipNetmask String
    The IP netmask value.
    ipRange String
    The IP range value.
    ipWildcard String
    The IP wildcard value.
    name String
    tags List<String>
    The administrative tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Address 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 Address Resource

    Get an existing Address 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?: AddressState, opts?: CustomResourceOptions): Address
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disable_override: Optional[str] = None,
        fqdn: Optional[str] = None,
        ip_netmask: Optional[str] = None,
        ip_range: Optional[str] = None,
        ip_wildcard: Optional[str] = None,
        location: Optional[AddressLocationArgs] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> Address
    func GetAddress(ctx *Context, name string, id IDInput, state *AddressState, opts ...ResourceOption) (*Address, error)
    public static Address Get(string name, Input<string> id, AddressState? state, CustomResourceOptions? opts = null)
    public static Address get(String name, Output<String> id, AddressState state, CustomResourceOptions options)
    resources:  _:    type: panos:Address    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:
    Description string
    The description.
    DisableOverride string
    disable object override in child device groups
    Fqdn string
    The FQDN value.
    IpNetmask string
    The IP netmask value.
    IpRange string
    The IP range value.
    IpWildcard string
    The IP wildcard value.
    Location AddressLocation
    The location of this object.
    Name string
    Tags List<string>
    The administrative tags.
    Description string
    The description.
    DisableOverride string
    disable object override in child device groups
    Fqdn string
    The FQDN value.
    IpNetmask string
    The IP netmask value.
    IpRange string
    The IP range value.
    IpWildcard string
    The IP wildcard value.
    Location AddressLocationArgs
    The location of this object.
    Name string
    Tags []string
    The administrative tags.
    description String
    The description.
    disableOverride String
    disable object override in child device groups
    fqdn String
    The FQDN value.
    ipNetmask String
    The IP netmask value.
    ipRange String
    The IP range value.
    ipWildcard String
    The IP wildcard value.
    location AddressLocation
    The location of this object.
    name String
    tags List<String>
    The administrative tags.
    description string
    The description.
    disableOverride string
    disable object override in child device groups
    fqdn string
    The FQDN value.
    ipNetmask string
    The IP netmask value.
    ipRange string
    The IP range value.
    ipWildcard string
    The IP wildcard value.
    location AddressLocation
    The location of this object.
    name string
    tags string[]
    The administrative tags.
    description str
    The description.
    disable_override str
    disable object override in child device groups
    fqdn str
    The FQDN value.
    ip_netmask str
    The IP netmask value.
    ip_range str
    The IP range value.
    ip_wildcard str
    The IP wildcard value.
    location AddressLocationArgs
    The location of this object.
    name str
    tags Sequence[str]
    The administrative tags.
    description String
    The description.
    disableOverride String
    disable object override in child device groups
    fqdn String
    The FQDN value.
    ipNetmask String
    The IP netmask value.
    ipRange String
    The IP range value.
    ipWildcard String
    The IP wildcard value.
    location Property Map
    The location of this object.
    name String
    tags List<String>
    The administrative tags.

    Supporting Types

    AddressLocation, AddressLocationArgs

    DeviceGroup AddressLocationDeviceGroup
    Located in a specific Device Group
    Shared AddressLocationShared
    Panorama shared object
    Vsys AddressLocationVsys
    Located in a specific Virtual System
    DeviceGroup AddressLocationDeviceGroup
    Located in a specific Device Group
    Shared AddressLocationShared
    Panorama shared object
    Vsys AddressLocationVsys
    Located in a specific Virtual System
    deviceGroup AddressLocationDeviceGroup
    Located in a specific Device Group
    shared AddressLocationShared
    Panorama shared object
    vsys AddressLocationVsys
    Located in a specific Virtual System
    deviceGroup AddressLocationDeviceGroup
    Located in a specific Device Group
    shared AddressLocationShared
    Panorama shared object
    vsys AddressLocationVsys
    Located in a specific Virtual System
    device_group AddressLocationDeviceGroup
    Located in a specific Device Group
    shared AddressLocationShared
    Panorama shared object
    vsys AddressLocationVsys
    Located in a specific Virtual System
    deviceGroup Property Map
    Located in a specific Device Group
    shared Property Map
    Panorama shared object
    vsys Property Map
    Located in a specific Virtual System

    AddressLocationDeviceGroup, AddressLocationDeviceGroupArgs

    Name string
    Device Group name
    PanoramaDevice string
    Panorama device name
    Name string
    Device Group name
    PanoramaDevice string
    Panorama device name
    name String
    Device Group name
    panoramaDevice String
    Panorama device name
    name string
    Device Group name
    panoramaDevice string
    Panorama device name
    name str
    Device Group name
    panorama_device str
    Panorama device name
    name String
    Device Group name
    panoramaDevice String
    Panorama device name

    AddressLocationVsys, AddressLocationVsysArgs

    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

    Import

    An address can be imported by providing the following base64 encoded object as the ID

    {

    location = {

    device_group = {

  name            = "example-device-group"

  panorama_device = "localhost.localdomain"

}

    }

    name = “addr1”

    }

    $ pulumi import panos:index/address:Address example $(echo '{"location":{"device_group":{"name":"example-device-group","panorama_device":"localhost.localdomain"}},"name":"addr1"}' | base64)

    To learn more about importing existing cloud resources, see Importing resources.

    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