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

panos.DeviceGroup

Explore with Pulumi AI

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

    Example Usage

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

const example = new panos.DeviceGroup("example", {location: {
    panorama: {},
}});

    import pulumi
import pulumi_panos as panos

example = panos.DeviceGroup("example", location={
    "panorama": {},
})

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/panos/v2/panos"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := panos.NewDeviceGroup(ctx, "example", &panos.DeviceGroupArgs{
			Location: &panos.DeviceGroupLocationArgs{
				Panorama: &panos.DeviceGroupLocationPanoramaArgs{},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Panos = Pulumi.Panos;

return await Deployment.RunAsync(() => 
{
    var example = new Panos.DeviceGroup("example", new()
    {
        Location = new Panos.Inputs.DeviceGroupLocationArgs
        {
            Panorama = null,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.panos.DeviceGroup;
import com.pulumi.panos.DeviceGroupArgs;
import com.pulumi.panos.inputs.DeviceGroupLocationArgs;
import com.pulumi.panos.inputs.DeviceGroupLocationPanoramaArgs;
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 DeviceGroup("example", DeviceGroupArgs.builder()
            .location(DeviceGroupLocationArgs.builder()
                .panorama()
                .build())
            .build());

    }
}

    resources:
  example:
    type: panos:DeviceGroup
    properties:
      location:
        panorama: {}

    Create DeviceGroup Resource

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

    Constructor syntax

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

@overload
def DeviceGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                location: Optional[DeviceGroupLocationArgs] = None,
                authorization_code: Optional[str] = None,
                description: Optional[str] = None,
                devices: Optional[Sequence[DeviceGroupDeviceArgs]] = None,
                name: Optional[str] = None,
                templates: Optional[Sequence[str]] = None)
    func NewDeviceGroup(ctx *Context, name string, args DeviceGroupArgs, opts ...ResourceOption) (*DeviceGroup, error)
    public DeviceGroup(string name, DeviceGroupArgs args, CustomResourceOptions? opts = null)
    public DeviceGroup(String name, DeviceGroupArgs args)
public DeviceGroup(String name, DeviceGroupArgs args, CustomResourceOptions options)

    type: panos:DeviceGroup
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 DeviceGroupArgs
    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 DeviceGroupArgs
    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 DeviceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceGroupArgs
    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 deviceGroupResource = new Panos.DeviceGroup("deviceGroupResource", new()
{
    Location = new Panos.Inputs.DeviceGroupLocationArgs
    {
        Panorama = new Panos.Inputs.DeviceGroupLocationPanoramaArgs
        {
            PanoramaDevice = "string",
        },
    },
    AuthorizationCode = "string",
    Description = "string",
    Devices = new[]
    {
        new Panos.Inputs.DeviceGroupDeviceArgs
        {
            Name = "string",
            Vsys = new[]
            {
                "string",
            },
        },
    },
    Name = "string",
    Templates = new[]
    {
        "string",
    },
});

    example, err := panos.NewDeviceGroup(ctx, "deviceGroupResource", &panos.DeviceGroupArgs{
	Location: &panos.DeviceGroupLocationArgs{
		Panorama: &panos.DeviceGroupLocationPanoramaArgs{
			PanoramaDevice: pulumi.String("string"),
		},
	},
	AuthorizationCode: pulumi.String("string"),
	Description:       pulumi.String("string"),
	Devices: panos.DeviceGroupDeviceArray{
		&panos.DeviceGroupDeviceArgs{
			Name: pulumi.String("string"),
			Vsys: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Name: pulumi.String("string"),
	Templates: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var deviceGroupResource = new DeviceGroup("deviceGroupResource", DeviceGroupArgs.builder()
    .location(DeviceGroupLocationArgs.builder()
        .panorama(DeviceGroupLocationPanoramaArgs.builder()
            .panoramaDevice("string")
            .build())
        .build())
    .authorizationCode("string")
    .description("string")
    .devices(DeviceGroupDeviceArgs.builder()
        .name("string")
        .vsys("string")
        .build())
    .name("string")
    .templates("string")
    .build());

    device_group_resource = panos.DeviceGroup("deviceGroupResource",
    location={
        "panorama": {
            "panorama_device": "string",
        },
    },
    authorization_code="string",
    description="string",
    devices=[{
        "name": "string",
        "vsys": ["string"],
    }],
    name="string",
    templates=["string"])

    const deviceGroupResource = new panos.DeviceGroup("deviceGroupResource", {
    location: {
        panorama: {
            panoramaDevice: "string",
        },
    },
    authorizationCode: "string",
    description: "string",
    devices: [{
        name: "string",
        vsys: ["string"],
    }],
    name: "string",
    templates: ["string"],
});

    type: panos:DeviceGroup
properties:
    authorizationCode: string
    description: string
    devices:
        - name: string
          vsys:
            - string
    location:
        panorama:
            panoramaDevice: string
    name: string
    templates:
        - string

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

    Location DeviceGroupLocation
    The location of this object.
    AuthorizationCode string
    Authorization code
    Description string
    The description.
    Devices List<DeviceGroupDevice>
    List of devices
    Name string
    The name of the service.
    Templates List<string>
    List of reference templates
    Location DeviceGroupLocationArgs
    The location of this object.
    AuthorizationCode string
    Authorization code
    Description string
    The description.
    Devices []DeviceGroupDeviceArgs
    List of devices
    Name string
    The name of the service.
    Templates []string
    List of reference templates
    location DeviceGroupLocation
    The location of this object.
    authorizationCode String
    Authorization code
    description String
    The description.
    devices List<DeviceGroupDevice>
    List of devices
    name String
    The name of the service.
    templates List<String>
    List of reference templates
    location DeviceGroupLocation
    The location of this object.
    authorizationCode string
    Authorization code
    description string
    The description.
    devices DeviceGroupDevice[]
    List of devices
    name string
    The name of the service.
    templates string[]
    List of reference templates
    location DeviceGroupLocationArgs
    The location of this object.
    authorization_code str
    Authorization code
    description str
    The description.
    devices Sequence[DeviceGroupDeviceArgs]
    List of devices
    name str
    The name of the service.
    templates Sequence[str]
    List of reference templates
    location Property Map
    The location of this object.
    authorizationCode String
    Authorization code
    description String
    The description.
    devices List<Property Map>
    List of devices
    name String
    The name of the service.
    templates List<String>
    List of reference templates

    Outputs

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

    Get an existing DeviceGroup 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?: DeviceGroupState, opts?: CustomResourceOptions): DeviceGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorization_code: Optional[str] = None,
        description: Optional[str] = None,
        devices: Optional[Sequence[DeviceGroupDeviceArgs]] = None,
        location: Optional[DeviceGroupLocationArgs] = None,
        name: Optional[str] = None,
        templates: Optional[Sequence[str]] = None) -> DeviceGroup
    func GetDeviceGroup(ctx *Context, name string, id IDInput, state *DeviceGroupState, opts ...ResourceOption) (*DeviceGroup, error)
    public static DeviceGroup Get(string name, Input<string> id, DeviceGroupState? state, CustomResourceOptions? opts = null)
    public static DeviceGroup get(String name, Output<String> id, DeviceGroupState state, CustomResourceOptions options)
    resources:  _:    type: panos:DeviceGroup    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:
    AuthorizationCode string
    Authorization code
    Description string
    The description.
    Devices List<DeviceGroupDevice>
    List of devices
    Location DeviceGroupLocation
    The location of this object.
    Name string
    The name of the service.
    Templates List<string>
    List of reference templates
    AuthorizationCode string
    Authorization code
    Description string
    The description.
    Devices []DeviceGroupDeviceArgs
    List of devices
    Location DeviceGroupLocationArgs
    The location of this object.
    Name string
    The name of the service.
    Templates []string
    List of reference templates
    authorizationCode String
    Authorization code
    description String
    The description.
    devices List<DeviceGroupDevice>
    List of devices
    location DeviceGroupLocation
    The location of this object.
    name String
    The name of the service.
    templates List<String>
    List of reference templates
    authorizationCode string
    Authorization code
    description string
    The description.
    devices DeviceGroupDevice[]
    List of devices
    location DeviceGroupLocation
    The location of this object.
    name string
    The name of the service.
    templates string[]
    List of reference templates
    authorization_code str
    Authorization code
    description str
    The description.
    devices Sequence[DeviceGroupDeviceArgs]
    List of devices
    location DeviceGroupLocationArgs
    The location of this object.
    name str
    The name of the service.
    templates Sequence[str]
    List of reference templates
    authorizationCode String
    Authorization code
    description String
    The description.
    devices List<Property Map>
    List of devices
    location Property Map
    The location of this object.
    name String
    The name of the service.
    templates List<String>
    List of reference templates

    Supporting Types

    DeviceGroupDevice, DeviceGroupDeviceArgs

    Name string
    Vsys List<string>
    Name string
    Vsys []string
    name String
    vsys List<String>
    name string
    vsys string[]
    name str
    vsys Sequence[str]
    name String
    vsys List<String>

    DeviceGroupLocation, DeviceGroupLocationArgs

    Panorama DeviceGroupLocationPanorama
    Located in a specific Panorama.
    Panorama DeviceGroupLocationPanorama
    Located in a specific Panorama.
    panorama DeviceGroupLocationPanorama
    Located in a specific Panorama.
    panorama DeviceGroupLocationPanorama
    Located in a specific Panorama.
    panorama DeviceGroupLocationPanorama
    Located in a specific Panorama.
    panorama Property Map
    Located in a specific Panorama.

    DeviceGroupLocationPanorama, DeviceGroupLocationPanoramaArgs

    PanoramaDevice string
    The Panorama device.
    PanoramaDevice string
    The Panorama device.
    panoramaDevice String
    The Panorama device.
    panoramaDevice string
    The Panorama device.
    panorama_device str
    The Panorama device.
    panoramaDevice String
    The Panorama device.

    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