1. Packages
  2. Panos Provider
  3. API Docs
  4. Addresses
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks

panos.Addresses

Explore with Pulumi AI

panos logo
panos 2.0.0 published on Tuesday, Apr 15, 2025 by paloaltonetworks

    Example Usage

    Create Addresses Resource

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

    Constructor syntax

    new Addresses(name: string, args: AddressesArgs, opts?: CustomResourceOptions);
    @overload
    def Addresses(resource_name: str,
                  args: AddressesArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Addresses(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  addresses: Optional[Mapping[str, AddressesAddressesArgs]] = None,
                  location: Optional[AddressesLocationArgs] = None)
    func NewAddresses(ctx *Context, name string, args AddressesArgs, opts ...ResourceOption) (*Addresses, error)
    public Addresses(string name, AddressesArgs args, CustomResourceOptions? opts = null)
    public Addresses(String name, AddressesArgs args)
    public Addresses(String name, AddressesArgs args, CustomResourceOptions options)
    
    type: panos:Addresses
    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 AddressesArgs
    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 AddressesArgs
    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 AddressesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddressesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddressesArgs
    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 addressesResource = new Panos.Addresses("addressesResource", new()
    {
        Addresses = 
        {
            { "string", new Panos.Inputs.AddressesAddressesArgs
            {
                Description = "string",
                DisableOverride = "string",
                Fqdn = "string",
                IpNetmask = "string",
                IpRange = "string",
                IpWildcard = "string",
                Tags = new[]
                {
                    "string",
                },
            } },
        },
        Location = new Panos.Inputs.AddressesLocationArgs
        {
            DeviceGroup = new Panos.Inputs.AddressesLocationDeviceGroupArgs
            {
                Name = "string",
                PanoramaDevice = "string",
            },
            Shared = null,
            Vsys = new Panos.Inputs.AddressesLocationVsysArgs
            {
                Name = "string",
                NgfwDevice = "string",
            },
        },
    });
    
    example, err := panos.NewAddresses(ctx, "addressesResource", &panos.AddressesArgs{
    	Addresses: panos.AddressesAddressesMap{
    		"string": &panos.AddressesAddressesArgs{
    			Description:     pulumi.String("string"),
    			DisableOverride: pulumi.String("string"),
    			Fqdn:            pulumi.String("string"),
    			IpNetmask:       pulumi.String("string"),
    			IpRange:         pulumi.String("string"),
    			IpWildcard:      pulumi.String("string"),
    			Tags: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Location: &panos.AddressesLocationArgs{
    		DeviceGroup: &panos.AddressesLocationDeviceGroupArgs{
    			Name:           pulumi.String("string"),
    			PanoramaDevice: pulumi.String("string"),
    		},
    		Shared: &panos.AddressesLocationSharedArgs{},
    		Vsys: &panos.AddressesLocationVsysArgs{
    			Name:       pulumi.String("string"),
    			NgfwDevice: pulumi.String("string"),
    		},
    	},
    })
    
    var addressesResource = new Addresses("addressesResource", AddressesArgs.builder()
        .addresses(Map.of("string", Map.ofEntries(
            Map.entry("description", "string"),
            Map.entry("disableOverride", "string"),
            Map.entry("fqdn", "string"),
            Map.entry("ipNetmask", "string"),
            Map.entry("ipRange", "string"),
            Map.entry("ipWildcard", "string"),
            Map.entry("tags", "string")
        )))
        .location(AddressesLocationArgs.builder()
            .deviceGroup(AddressesLocationDeviceGroupArgs.builder()
                .name("string")
                .panoramaDevice("string")
                .build())
            .shared()
            .vsys(AddressesLocationVsysArgs.builder()
                .name("string")
                .ngfwDevice("string")
                .build())
            .build())
        .build());
    
    addresses_resource = panos.Addresses("addressesResource",
        addresses={
            "string": {
                "description": "string",
                "disable_override": "string",
                "fqdn": "string",
                "ip_netmask": "string",
                "ip_range": "string",
                "ip_wildcard": "string",
                "tags": ["string"],
            },
        },
        location={
            "device_group": {
                "name": "string",
                "panorama_device": "string",
            },
            "shared": {},
            "vsys": {
                "name": "string",
                "ngfw_device": "string",
            },
        })
    
    const addressesResource = new panos.Addresses("addressesResource", {
        addresses: {
            string: {
                description: "string",
                disableOverride: "string",
                fqdn: "string",
                ipNetmask: "string",
                ipRange: "string",
                ipWildcard: "string",
                tags: ["string"],
            },
        },
        location: {
            deviceGroup: {
                name: "string",
                panoramaDevice: "string",
            },
            shared: {},
            vsys: {
                name: "string",
                ngfwDevice: "string",
            },
        },
    });
    
    type: panos:Addresses
    properties:
        addresses:
            string:
                description: string
                disableOverride: string
                fqdn: string
                ipNetmask: string
                ipRange: string
                ipWildcard: string
                tags:
                    - string
        location:
            deviceGroup:
                name: string
                panoramaDevice: string
            shared: {}
            vsys:
                name: string
                ngfwDevice: string
    

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

    Addresses Dictionary<string, AddressesAddressesArgs>
    Location AddressesLocation
    The location of this object.
    Addresses map[string]AddressesAddressesArgs
    Location AddressesLocationArgs
    The location of this object.
    addresses Map<String,AddressesAddressesArgs>
    location AddressesLocation
    The location of this object.
    addresses {[key: string]: AddressesAddressesArgs}
    location AddressesLocation
    The location of this object.
    addresses Mapping[str, AddressesAddressesArgs]
    location AddressesLocationArgs
    The location of this object.
    addresses Map<Property Map>
    location Property Map
    The location of this object.

    Outputs

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

    Get an existing Addresses 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?: AddressesState, opts?: CustomResourceOptions): Addresses
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            addresses: Optional[Mapping[str, AddressesAddressesArgs]] = None,
            location: Optional[AddressesLocationArgs] = None) -> Addresses
    func GetAddresses(ctx *Context, name string, id IDInput, state *AddressesState, opts ...ResourceOption) (*Addresses, error)
    public static Addresses Get(string name, Input<string> id, AddressesState? state, CustomResourceOptions? opts = null)
    public static Addresses get(String name, Output<String> id, AddressesState state, CustomResourceOptions options)
    resources:  _:    type: panos:Addresses    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:
    Addresses Dictionary<string, AddressesAddressesArgs>
    Location AddressesLocation
    The location of this object.
    Addresses map[string]AddressesAddressesArgs
    Location AddressesLocationArgs
    The location of this object.
    addresses Map<String,AddressesAddressesArgs>
    location AddressesLocation
    The location of this object.
    addresses {[key: string]: AddressesAddressesArgs}
    location AddressesLocation
    The location of this object.
    addresses Mapping[str, AddressesAddressesArgs]
    location AddressesLocationArgs
    The location of this object.
    addresses Map<Property Map>
    location Property Map
    The location of this object.

    Supporting Types

    AddressesAddresses, AddressesAddressesArgs

    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.
    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.
    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.
    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.
    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.
    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.
    tags List<String>
    The administrative tags.

    AddressesLocation, AddressesLocationArgs

    DeviceGroup AddressesLocationDeviceGroup
    Located in a specific Device Group
    Shared AddressesLocationShared
    Panorama shared object
    Vsys AddressesLocationVsys
    Located in a specific Virtual System
    DeviceGroup AddressesLocationDeviceGroup
    Located in a specific Device Group
    Shared AddressesLocationShared
    Panorama shared object
    Vsys AddressesLocationVsys
    Located in a specific Virtual System
    deviceGroup AddressesLocationDeviceGroup
    Located in a specific Device Group
    shared AddressesLocationShared
    Panorama shared object
    vsys AddressesLocationVsys
    Located in a specific Virtual System
    deviceGroup AddressesLocationDeviceGroup
    Located in a specific Device Group
    shared AddressesLocationShared
    Panorama shared object
    vsys AddressesLocationVsys
    Located in a specific Virtual System
    device_group AddressesLocationDeviceGroup
    Located in a specific Device Group
    shared AddressesLocationShared
    Panorama shared object
    vsys AddressesLocationVsys
    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

    AddressesLocationDeviceGroup, AddressesLocationDeviceGroupArgs

    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

    AddressesLocationVsys, AddressesLocationVsysArgs

    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

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

    {

    location = {

    device_group = {
    
      name = "example-device-group"
    
      panorama_device = "localhost.localdomain"
    
    }
    

    }

    names = [

    "foo",
    
    "bar"
    

    ]

    }

    $ pulumi import panos:index/addresses:Addresses example $(echo '{"location":{"device_group":{"name":"example-device-group","panorama_device":"localhost.localdomain"}},"names":["foo","bar"]}' | 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