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

panos.ServiceGroup

Explore with Pulumi AI

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

    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.DeviceGroup;
    import com.pulumi.panos.DeviceGroupArgs;
    import com.pulumi.panos.inputs.DeviceGroupLocationArgs;
    import com.pulumi.panos.inputs.DeviceGroupLocationPanoramaArgs;
    import com.pulumi.panos.Service;
    import com.pulumi.panos.ServiceArgs;
    import com.pulumi.panos.inputs.ServiceLocationArgs;
    import com.pulumi.panos.inputs.ServiceProtocolArgs;
    import com.pulumi.panos.inputs.ServiceProtocolTcpArgs;
    import com.pulumi.panos.ServiceGroup;
    import com.pulumi.panos.ServiceGroupArgs;
    import com.pulumi.panos.inputs.ServiceGroupLocationArgs;
    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 exampleDeviceGroup = new DeviceGroup("exampleDeviceGroup", DeviceGroupArgs.builder()
                .location(DeviceGroupLocationArgs.builder()
                    .panorama()
                    .build())
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()
                .location(ServiceLocationArgs.builder()
                    .device_group(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .description("example service")
                .protocol(ServiceProtocolArgs.builder()
                    .tcp(ServiceProtocolTcpArgs.builder()
                        .destinationPort("80")
                        .build())
                    .build())
                .build());
    
            var exampleServiceGroup = new ServiceGroup("exampleServiceGroup", ServiceGroupArgs.builder()
                .location(ServiceGroupLocationArgs.builder()
                    .device_group(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build())
                .members(exampleService.name())
                .build());
    
        }
    }
    
    resources:
      exampleService:
        type: panos:Service
        properties:
          location:
            device_group:
              name: ${exampleDeviceGroup.name}
          description: example service
          protocol:
            tcp:
              destinationPort: '80'
      exampleServiceGroup:
        type: panos:ServiceGroup
        properties:
          location:
            device_group:
              name: ${exampleDeviceGroup.name}
          members:
            - ${exampleService.name}
      exampleDeviceGroup:
        type: panos:DeviceGroup
        properties:
          location:
            panorama: {}
    

    Create ServiceGroup Resource

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

    Constructor syntax

    new ServiceGroup(name: string, args: ServiceGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceGroup(resource_name: str,
                     args: ServiceGroupArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     location: Optional[ServiceGroupLocationArgs] = None,
                     disable_override: Optional[str] = None,
                     members: Optional[Sequence[str]] = None,
                     name: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None)
    func NewServiceGroup(ctx *Context, name string, args ServiceGroupArgs, opts ...ResourceOption) (*ServiceGroup, error)
    public ServiceGroup(string name, ServiceGroupArgs args, CustomResourceOptions? opts = null)
    public ServiceGroup(String name, ServiceGroupArgs args)
    public ServiceGroup(String name, ServiceGroupArgs args, CustomResourceOptions options)
    
    type: panos:ServiceGroup
    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 ServiceGroupArgs
    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 ServiceGroupArgs
    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 ServiceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceGroupArgs
    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 serviceGroupResource = new Panos.ServiceGroup("serviceGroupResource", new()
    {
        Location = new Panos.Inputs.ServiceGroupLocationArgs
        {
            DeviceGroup = new Panos.Inputs.ServiceGroupLocationDeviceGroupArgs
            {
                Name = "string",
                PanoramaDevice = "string",
            },
            Shared = null,
            Vsys = new Panos.Inputs.ServiceGroupLocationVsysArgs
            {
                Name = "string",
                NgfwDevice = "string",
            },
        },
        DisableOverride = "string",
        Members = new[]
        {
            "string",
        },
        Name = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := panos.NewServiceGroup(ctx, "serviceGroupResource", &panos.ServiceGroupArgs{
    	Location: &panos.ServiceGroupLocationArgs{
    		DeviceGroup: &panos.ServiceGroupLocationDeviceGroupArgs{
    			Name:           pulumi.String("string"),
    			PanoramaDevice: pulumi.String("string"),
    		},
    		Shared: &panos.ServiceGroupLocationSharedArgs{},
    		Vsys: &panos.ServiceGroupLocationVsysArgs{
    			Name:       pulumi.String("string"),
    			NgfwDevice: pulumi.String("string"),
    		},
    	},
    	DisableOverride: pulumi.String("string"),
    	Members: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var serviceGroupResource = new ServiceGroup("serviceGroupResource", ServiceGroupArgs.builder()
        .location(ServiceGroupLocationArgs.builder()
            .deviceGroup(ServiceGroupLocationDeviceGroupArgs.builder()
                .name("string")
                .panoramaDevice("string")
                .build())
            .shared()
            .vsys(ServiceGroupLocationVsysArgs.builder()
                .name("string")
                .ngfwDevice("string")
                .build())
            .build())
        .disableOverride("string")
        .members("string")
        .name("string")
        .tags("string")
        .build());
    
    service_group_resource = panos.ServiceGroup("serviceGroupResource",
        location={
            "device_group": {
                "name": "string",
                "panorama_device": "string",
            },
            "shared": {},
            "vsys": {
                "name": "string",
                "ngfw_device": "string",
            },
        },
        disable_override="string",
        members=["string"],
        name="string",
        tags=["string"])
    
    const serviceGroupResource = new panos.ServiceGroup("serviceGroupResource", {
        location: {
            deviceGroup: {
                name: "string",
                panoramaDevice: "string",
            },
            shared: {},
            vsys: {
                name: "string",
                ngfwDevice: "string",
            },
        },
        disableOverride: "string",
        members: ["string"],
        name: "string",
        tags: ["string"],
    });
    
    type: panos:ServiceGroup
    properties:
        disableOverride: string
        location:
            deviceGroup:
                name: string
                panoramaDevice: string
            shared: {}
            vsys:
                name: string
                ngfwDevice: string
        members:
            - string
        name: string
        tags:
            - string
    

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

    Location ServiceGroupLocation
    The location of this object.
    DisableOverride string
    disable object override in child device groups
    Members List<string>
    Name string
    Tags List<string>
    Location ServiceGroupLocationArgs
    The location of this object.
    DisableOverride string
    disable object override in child device groups
    Members []string
    Name string
    Tags []string
    location ServiceGroupLocation
    The location of this object.
    disableOverride String
    disable object override in child device groups
    members List<String>
    name String
    tags List<String>
    location ServiceGroupLocation
    The location of this object.
    disableOverride string
    disable object override in child device groups
    members string[]
    name string
    tags string[]
    location ServiceGroupLocationArgs
    The location of this object.
    disable_override str
    disable object override in child device groups
    members Sequence[str]
    name str
    tags Sequence[str]
    location Property Map
    The location of this object.
    disableOverride String
    disable object override in child device groups
    members List<String>
    name String
    tags List<String>

    Outputs

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

    Get an existing ServiceGroup 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?: ServiceGroupState, opts?: CustomResourceOptions): ServiceGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            disable_override: Optional[str] = None,
            location: Optional[ServiceGroupLocationArgs] = None,
            members: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> ServiceGroup
    func GetServiceGroup(ctx *Context, name string, id IDInput, state *ServiceGroupState, opts ...ResourceOption) (*ServiceGroup, error)
    public static ServiceGroup Get(string name, Input<string> id, ServiceGroupState? state, CustomResourceOptions? opts = null)
    public static ServiceGroup get(String name, Output<String> id, ServiceGroupState state, CustomResourceOptions options)
    resources:  _:    type: panos:ServiceGroup    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:
    DisableOverride string
    disable object override in child device groups
    Location ServiceGroupLocation
    The location of this object.
    Members List<string>
    Name string
    Tags List<string>
    DisableOverride string
    disable object override in child device groups
    Location ServiceGroupLocationArgs
    The location of this object.
    Members []string
    Name string
    Tags []string
    disableOverride String
    disable object override in child device groups
    location ServiceGroupLocation
    The location of this object.
    members List<String>
    name String
    tags List<String>
    disableOverride string
    disable object override in child device groups
    location ServiceGroupLocation
    The location of this object.
    members string[]
    name string
    tags string[]
    disable_override str
    disable object override in child device groups
    location ServiceGroupLocationArgs
    The location of this object.
    members Sequence[str]
    name str
    tags Sequence[str]
    disableOverride String
    disable object override in child device groups
    location Property Map
    The location of this object.
    members List<String>
    name String
    tags List<String>

    Supporting Types

    ServiceGroupLocation, ServiceGroupLocationArgs

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

    ServiceGroupLocationDeviceGroup, ServiceGroupLocationDeviceGroupArgs

    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

    ServiceGroupLocationVsys, ServiceGroupLocationVsysArgs

    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

    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