Zscaler Private Access v0.0.10, Apr 9 24

Zscaler Private Access v0.0.10 published on Tuesday, Apr 9, 2024 by Zscaler

zpa.SegmentGroup

Explore with Pulumi AI

Zscaler Private Access v0.0.10 published on Tuesday, Apr 9, 2024 by Zscaler

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as zpa from "@bdzscaler/pulumi-zpa";

// ZPA Segment Group resource
const testSegmentGroup = new zpa.SegmentGroup("testSegmentGroup", {
    description: "test1-segment-group",
    enabled: true,
});

import pulumi
import zscaler_pulumi_zpa as zpa

# ZPA Segment Group resource
test_segment_group = zpa.SegmentGroup("testSegmentGroup",
    description="test1-segment-group",
    enabled=True)

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zpa/sdk/go/zpa"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// ZPA Segment Group resource
		_, err := zpa.NewSegmentGroup(ctx, "testSegmentGroup", &zpa.SegmentGroupArgs{
			Description: pulumi.String("test1-segment-group"),
			Enabled:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = Zscaler.Zpa;

return await Deployment.RunAsync(() => 
{
    // ZPA Segment Group resource
    var testSegmentGroup = new Zpa.SegmentGroup("testSegmentGroup", new()
    {
        Description = "test1-segment-group",
        Enabled = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.SegmentGroup;
import com.pulumi.zpa.SegmentGroupArgs;
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) {
        // ZPA Segment Group resource
        var testSegmentGroup = new SegmentGroup("testSegmentGroup", SegmentGroupArgs.builder()        
            .description("test1-segment-group")
            .enabled(true)
            .build());

    }
}

resources:
  # ZPA Segment Group resource
  testSegmentGroup:
    type: zpa:SegmentGroup
    properties:
      description: test1-segment-group
      enabled: true

Create SegmentGroup Resource

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

Constructor syntax

new SegmentGroup(name: string, args?: SegmentGroupArgs, opts?: CustomResourceOptions);

@overload
def SegmentGroup(resource_name: str,
                 args: Optional[SegmentGroupArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def SegmentGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 applications: Optional[Sequence[SegmentGroupApplicationArgs]] = None,
                 description: Optional[str] = None,
                 enabled: Optional[bool] = None,
                 microtenant_id: Optional[str] = None,
                 name: Optional[str] = None)

func NewSegmentGroup(ctx *Context, name string, args *SegmentGroupArgs, opts ...ResourceOption) (*SegmentGroup, error)

public SegmentGroup(string name, SegmentGroupArgs? args = null, CustomResourceOptions? opts = null)

public SegmentGroup(String name, SegmentGroupArgs args)
public SegmentGroup(String name, SegmentGroupArgs args, CustomResourceOptions options)

type: zpa:SegmentGroup
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 SegmentGroupArgs: 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 SegmentGroupArgs: 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 SegmentGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SegmentGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SegmentGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

var segmentGroupResource = new Zpa.SegmentGroup("segmentGroupResource", new()
{
    Applications = new[]
    {
        new Zpa.Inputs.SegmentGroupApplicationArgs
        {
            Id = "string",
        },
    },
    Description = "string",
    Enabled = false,
    MicrotenantId = "string",
    Name = "string",
});

example, err := zpa.NewSegmentGroup(ctx, "segmentGroupResource", &zpa.SegmentGroupArgs{
	Applications: zpa.SegmentGroupApplicationArray{
		&zpa.SegmentGroupApplicationArgs{
			Id: pulumi.String("string"),
		},
	},
	Description:   pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	MicrotenantId: pulumi.String("string"),
	Name:          pulumi.String("string"),
})

var segmentGroupResource = new SegmentGroup("segmentGroupResource", SegmentGroupArgs.builder()        
    .applications(SegmentGroupApplicationArgs.builder()
        .id("string")
        .build())
    .description("string")
    .enabled(false)
    .microtenantId("string")
    .name("string")
    .build());

segment_group_resource = zpa.SegmentGroup("segmentGroupResource",
    applications=[zpa.SegmentGroupApplicationArgs(
        id="string",
    )],
    description="string",
    enabled=False,
    microtenant_id="string",
    name="string")

const segmentGroupResource = new zpa.SegmentGroup("segmentGroupResource", {
    applications: [{
        id: "string",
    }],
    description: "string",
    enabled: false,
    microtenantId: "string",
    name: "string",
});

type: zpa:SegmentGroup
properties:
    applications:
        - id: string
    description: string
    enabled: false
    microtenantId: string
    name: string

SegmentGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The SegmentGroup resource accepts the following input properties:

Applications List<Zscaler.Zpa.Inputs.SegmentGroupApplication>
Description string: Description of the app group.
Enabled bool: Whether this app group is enabled or not.
MicrotenantId string
Name string: Name of the app group.

Applications []SegmentGroupApplicationArgs
Description string: Description of the app group.
Enabled bool: Whether this app group is enabled or not.
MicrotenantId string
Name string: Name of the app group.

applications List<SegmentGroupApplication>
description String: Description of the app group.
enabled Boolean: Whether this app group is enabled or not.
microtenantId String
name String: Name of the app group.

applications SegmentGroupApplication[]
description string: Description of the app group.
enabled boolean: Whether this app group is enabled or not.
microtenantId string
name string: Name of the app group.

applications Sequence[SegmentGroupApplicationArgs]
description str: Description of the app group.
enabled bool: Whether this app group is enabled or not.
microtenant_id str
name str: Name of the app group.

applications List<Property Map>
description String: Description of the app group.
enabled Boolean: Whether this app group is enabled or not.
microtenantId String
name String: Name of the app group.

Outputs

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

Get an existing SegmentGroup 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?: SegmentGroupState, opts?: CustomResourceOptions): SegmentGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        applications: Optional[Sequence[SegmentGroupApplicationArgs]] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None) -> SegmentGroup

func GetSegmentGroup(ctx *Context, name string, id IDInput, state *SegmentGroupState, opts ...ResourceOption) (*SegmentGroup, error)

public static SegmentGroup Get(string name, Input<string> id, SegmentGroupState? state, CustomResourceOptions? opts = null)

public static SegmentGroup get(String name, Output<String> id, SegmentGroupState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

Applications List<Zscaler.Zpa.Inputs.SegmentGroupApplication>
Description string: Description of the app group.
Enabled bool: Whether this app group is enabled or not.
MicrotenantId string
Name string: Name of the app group.

Applications []SegmentGroupApplicationArgs
Description string: Description of the app group.
Enabled bool: Whether this app group is enabled or not.
MicrotenantId string
Name string: Name of the app group.

applications List<SegmentGroupApplication>
description String: Description of the app group.
enabled Boolean: Whether this app group is enabled or not.
microtenantId String
name String: Name of the app group.

applications SegmentGroupApplication[]
description string: Description of the app group.
enabled boolean: Whether this app group is enabled or not.
microtenantId string
name string: Name of the app group.

applications Sequence[SegmentGroupApplicationArgs]
description str: Description of the app group.
enabled bool: Whether this app group is enabled or not.
microtenant_id str
name str: Name of the app group.

applications List<Property Map>
description String: Description of the app group.
enabled Boolean: Whether this app group is enabled or not.
microtenantId String
name String: Name of the app group.

Supporting Types

SegmentGroupApplication, SegmentGroupApplicationArgs

Id string

Id string

id String

id string

id str

id String

Import

Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZPA configurations into Terraform-compliant HashiCorp Configuration Language.

Visit

segment_group can be imported by using <SEGMENT GROUP ID> or <SEGMENT GROUP NAME> as the import ID.

For example:

$ pulumi import zpa:index/segmentGroup:SegmentGroup example <segment_group_id>

$ pulumi import zpa:index/segmentGroup:SegmentGroup example <segment_group_name>

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

Package Details

Repository: zpa zscaler/pulumi-zpa
License: MIT
Notes: This Pulumi package is based on the zpa Terraform Provider.

Zscaler Private Access v0.0.10 published on Tuesday, Apr 9, 2024 by Zscaler

zscaler/pulumi-zpa

zpa.SegmentGroup

On this page

On this page

Example Usage

Create SegmentGroup Resource

Constructor syntax

Parameters

Example

SegmentGroup Resource Properties

Inputs

Outputs

Look up Existing SegmentGroup Resource

Supporting Types

SegmentGroupApplication, SegmentGroupApplicationArgs

Import

Package Details

On this page

On this page