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

panos.AddressGroup

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 AddressGroup Resource

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

    Constructor syntax

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

@overload
def AddressGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 location: Optional[AddressGroupLocationArgs] = None,
                 description: Optional[str] = None,
                 disable_override: Optional[str] = None,
                 dynamic: Optional[AddressGroupDynamicArgs] = None,
                 name: Optional[str] = None,
                 statics: Optional[Sequence[str]] = None,
                 tags: Optional[Sequence[str]] = None)
    func NewAddressGroup(ctx *Context, name string, args AddressGroupArgs, opts ...ResourceOption) (*AddressGroup, error)
    public AddressGroup(string name, AddressGroupArgs args, CustomResourceOptions? opts = null)
    public AddressGroup(String name, AddressGroupArgs args)
public AddressGroup(String name, AddressGroupArgs args, CustomResourceOptions options)

    type: panos:AddressGroup
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 AddressGroupArgs
    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 AddressGroupArgs
    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 AddressGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddressGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddressGroupArgs
    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 addressGroupResource = new Panos.AddressGroup("addressGroupResource", new()
{
    Location = new Panos.Inputs.AddressGroupLocationArgs
    {
        DeviceGroup = new Panos.Inputs.AddressGroupLocationDeviceGroupArgs
        {
            Name = "string",
            PanoramaDevice = "string",
        },
        Shared = null,
        Vsys = new Panos.Inputs.AddressGroupLocationVsysArgs
        {
            Name = "string",
            NgfwDevice = "string",
        },
    },
    Description = "string",
    DisableOverride = "string",
    Dynamic = new Panos.Inputs.AddressGroupDynamicArgs
    {
        Filter = "string",
    },
    Name = "string",
    Statics = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := panos.NewAddressGroup(ctx, "addressGroupResource", &panos.AddressGroupArgs{
	Location: &panos.AddressGroupLocationArgs{
		DeviceGroup: &panos.AddressGroupLocationDeviceGroupArgs{
			Name:           pulumi.String("string"),
			PanoramaDevice: pulumi.String("string"),
		},
		Shared: &panos.AddressGroupLocationSharedArgs{},
		Vsys: &panos.AddressGroupLocationVsysArgs{
			Name:       pulumi.String("string"),
			NgfwDevice: pulumi.String("string"),
		},
	},
	Description:     pulumi.String("string"),
	DisableOverride: pulumi.String("string"),
	Dynamic: &panos.AddressGroupDynamicArgs{
		Filter: pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Statics: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var addressGroupResource = new AddressGroup("addressGroupResource", AddressGroupArgs.builder()
    .location(AddressGroupLocationArgs.builder()
        .deviceGroup(AddressGroupLocationDeviceGroupArgs.builder()
            .name("string")
            .panoramaDevice("string")
            .build())
        .shared()
        .vsys(AddressGroupLocationVsysArgs.builder()
            .name("string")
            .ngfwDevice("string")
            .build())
        .build())
    .description("string")
    .disableOverride("string")
    .dynamic(AddressGroupDynamicArgs.builder()
        .filter("string")
        .build())
    .name("string")
    .statics("string")
    .tags("string")
    .build());

    address_group_resource = panos.AddressGroup("addressGroupResource",
    location={
        "device_group": {
            "name": "string",
            "panorama_device": "string",
        },
        "shared": {},
        "vsys": {
            "name": "string",
            "ngfw_device": "string",
        },
    },
    description="string",
    disable_override="string",
    dynamic={
        "filter": "string",
    },
    name="string",
    statics=["string"],
    tags=["string"])

    const addressGroupResource = new panos.AddressGroup("addressGroupResource", {
    location: {
        deviceGroup: {
            name: "string",
            panoramaDevice: "string",
        },
        shared: {},
        vsys: {
            name: "string",
            ngfwDevice: "string",
        },
    },
    description: "string",
    disableOverride: "string",
    dynamic: {
        filter: "string",
    },
    name: "string",
    statics: ["string"],
    tags: ["string"],
});

    type: panos:AddressGroup
properties:
    description: string
    disableOverride: string
    dynamic:
        filter: string
    location:
        deviceGroup:
            name: string
            panoramaDevice: string
        shared: {}
        vsys:
            name: string
            ngfwDevice: string
    name: string
    statics:
        - string
    tags:
        - string

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

    Location AddressGroupLocation
    The location of this object.
    Description string
    DisableOverride string
    disable object override in child device groups
    Dynamic AddressGroupDynamic
    Name string
    Statics List<string>
    Tags List<string>
    Location AddressGroupLocationArgs
    The location of this object.
    Description string
    DisableOverride string
    disable object override in child device groups
    Dynamic AddressGroupDynamicArgs
    Name string
    Statics []string
    Tags []string
    location AddressGroupLocation
    The location of this object.
    description String
    disableOverride String
    disable object override in child device groups
    dynamic AddressGroupDynamic
    name String
    statics List<String>
    tags List<String>
    location AddressGroupLocation
    The location of this object.
    description string
    disableOverride string
    disable object override in child device groups
    dynamic AddressGroupDynamic
    name string
    statics string[]
    tags string[]
    location AddressGroupLocationArgs
    The location of this object.
    description str
    disable_override str
    disable object override in child device groups
    dynamic AddressGroupDynamicArgs
    name str
    statics Sequence[str]
    tags Sequence[str]
    location Property Map
    The location of this object.
    description String
    disableOverride String
    disable object override in child device groups
    dynamic Property Map
    name String
    statics List<String>
    tags List<String>

    Outputs

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

    Get an existing AddressGroup 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?: AddressGroupState, opts?: CustomResourceOptions): AddressGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disable_override: Optional[str] = None,
        dynamic: Optional[AddressGroupDynamicArgs] = None,
        location: Optional[AddressGroupLocationArgs] = None,
        name: Optional[str] = None,
        statics: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None) -> AddressGroup
    func GetAddressGroup(ctx *Context, name string, id IDInput, state *AddressGroupState, opts ...ResourceOption) (*AddressGroup, error)
    public static AddressGroup Get(string name, Input<string> id, AddressGroupState? state, CustomResourceOptions? opts = null)
    public static AddressGroup get(String name, Output<String> id, AddressGroupState state, CustomResourceOptions options)
    resources:  _:    type: panos:AddressGroup    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
    DisableOverride string
    disable object override in child device groups
    Dynamic AddressGroupDynamic
    Location AddressGroupLocation
    The location of this object.
    Name string
    Statics List<string>
    Tags List<string>
    Description string
    DisableOverride string
    disable object override in child device groups
    Dynamic AddressGroupDynamicArgs
    Location AddressGroupLocationArgs
    The location of this object.
    Name string
    Statics []string
    Tags []string
    description String
    disableOverride String
    disable object override in child device groups
    dynamic AddressGroupDynamic
    location AddressGroupLocation
    The location of this object.
    name String
    statics List<String>
    tags List<String>
    description string
    disableOverride string
    disable object override in child device groups
    dynamic AddressGroupDynamic
    location AddressGroupLocation
    The location of this object.
    name string
    statics string[]
    tags string[]
    description str
    disable_override str
    disable object override in child device groups
    dynamic AddressGroupDynamicArgs
    location AddressGroupLocationArgs
    The location of this object.
    name str
    statics Sequence[str]
    tags Sequence[str]
    description String
    disableOverride String
    disable object override in child device groups
    dynamic Property Map
    location Property Map
    The location of this object.
    name String
    statics List<String>
    tags List<String>

    Supporting Types

    AddressGroupDynamic, AddressGroupDynamicArgs

    Filter string
    tag-based filter
    Filter string
    tag-based filter
    filter String
    tag-based filter
    filter string
    tag-based filter
    filter str
    tag-based filter
    filter String
    tag-based filter

    AddressGroupLocation, AddressGroupLocationArgs

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

    AddressGroupLocationDeviceGroup, AddressGroupLocationDeviceGroupArgs

    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

    AddressGroupLocationVsys, AddressGroupLocationVsysArgs

    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 group 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 = “example-address-group”

    }

    $ pulumi import panos:index/addressGroup:AddressGroup example $(echo '{"location":{"device_group":{"name":"example-device-group","panorama_device":"localhost.localdomain"}},"name":"example-address-group"}' | 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