Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. ServiceEdgeGroup
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

zpa.ServiceEdgeGroup

Explore with Pulumi AI

zpa logo
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa

    The zpa_service_edge_group resource creates a service edge group in the Zscaler Private Access cloud. This resource can then be referenced in a service edge connector.

    Example Usage

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

// ZPA Service Edge Group resource - Trusted Network
const serviceEdgeGroupSjc = new zpa.ServiceEdgeGroup("serviceEdgeGroupSjc", {
    description: "Service Edge Group in San Jose",
    enabled: true,
    isPublic: true,
    upgradeDay: "SUNDAY",
    upgradeTimeInSecs: "66600",
    latitude: "37.3382082",
    longitude: "-121.8863286",
    location: "San Jose, CA, USA",
    versionProfileName: "New Release",
    trustedNetworks: [{
        ids: [data.zpa_trusted_network.example.id],
    }],
});

    import pulumi
import zscaler_pulumi_zpa as zpa

# ZPA Service Edge Group resource - Trusted Network
service_edge_group_sjc = zpa.ServiceEdgeGroup("serviceEdgeGroupSjc",
    description="Service Edge Group in San Jose",
    enabled=True,
    is_public=True,
    upgrade_day="SUNDAY",
    upgrade_time_in_secs="66600",
    latitude="37.3382082",
    longitude="-121.8863286",
    location="San Jose, CA, USA",
    version_profile_name="New Release",
    trusted_networks=[zpa.ServiceEdgeGroupTrustedNetworkArgs(
        ids=[data["zpa_trusted_network"]["example"]["id"]],
    )])

    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 Service Edge Group resource - Trusted Network
		_, err := zpa.NewServiceEdgeGroup(ctx, "serviceEdgeGroupSjc", &zpa.ServiceEdgeGroupArgs{
			Description:        pulumi.String("Service Edge Group in San Jose"),
			Enabled:            pulumi.Bool(true),
			IsPublic:           pulumi.Bool(true),
			UpgradeDay:         pulumi.String("SUNDAY"),
			UpgradeTimeInSecs:  pulumi.String("66600"),
			Latitude:           pulumi.String("37.3382082"),
			Longitude:          pulumi.String("-121.8863286"),
			Location:           pulumi.String("San Jose, CA, USA"),
			VersionProfileName: pulumi.String("New Release"),
			TrustedNetworks: zpa.ServiceEdgeGroupTrustedNetworkArray{
				&zpa.ServiceEdgeGroupTrustedNetworkArgs{
					Ids: pulumi.StringArray{
						data.Zpa_trusted_network.Example.Id,
					},
				},
			},
		})
		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 Service Edge Group resource - Trusted Network
    var serviceEdgeGroupSjc = new Zpa.ServiceEdgeGroup("serviceEdgeGroupSjc", new()
    {
        Description = "Service Edge Group in San Jose",
        Enabled = true,
        IsPublic = true,
        UpgradeDay = "SUNDAY",
        UpgradeTimeInSecs = "66600",
        Latitude = "37.3382082",
        Longitude = "-121.8863286",
        Location = "San Jose, CA, USA",
        VersionProfileName = "New Release",
        TrustedNetworks = new[]
        {
            new Zpa.Inputs.ServiceEdgeGroupTrustedNetworkArgs
            {
                Ids = new[]
                {
                    data.Zpa_trusted_network.Example.Id,
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ServiceEdgeGroup;
import com.pulumi.zpa.ServiceEdgeGroupArgs;
import com.pulumi.zpa.inputs.ServiceEdgeGroupTrustedNetworkArgs;
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 Service Edge Group resource - Trusted Network
        var serviceEdgeGroupSjc = new ServiceEdgeGroup("serviceEdgeGroupSjc", ServiceEdgeGroupArgs.builder()
            .description("Service Edge Group in San Jose")
            .enabled(true)
            .isPublic(true)
            .upgradeDay("SUNDAY")
            .upgradeTimeInSecs("66600")
            .latitude("37.3382082")
            .longitude("-121.8863286")
            .location("San Jose, CA, USA")
            .versionProfileName("New Release")
            .trustedNetworks(ServiceEdgeGroupTrustedNetworkArgs.builder()
                .ids(data.zpa_trusted_network().example().id())
                .build())
            .build());

    }
}

    resources:
  # ZPA Service Edge Group resource - Trusted Network
  serviceEdgeGroupSjc:
    type: zpa:ServiceEdgeGroup
    properties:
      description: Service Edge Group in San Jose
      enabled: true
      isPublic: true
      upgradeDay: SUNDAY
      upgradeTimeInSecs: '66600'
      latitude: '37.3382082'
      longitude: '-121.8863286'
      location: San Jose, CA, USA
      versionProfileName: New Release
      trustedNetworks:
        - ids:
            - ${data.zpa_trusted_network.example.id}

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

// ZPA Service Edge Group resource - No Trusted Network
const serviceEdgeGroupNyc = new zpa.ServiceEdgeGroup("serviceEdgeGroupNyc", {
    description: "Service Edge Group in New York",
    enabled: true,
    isPublic: true,
    latitude: "40.7128",
    location: "New York, NY, USA",
    longitude: "-73.935242",
    upgradeDay: "SUNDAY",
    upgradeTimeInSecs: "66600",
    versionProfileName: "New Release",
});

    import pulumi
import zscaler_pulumi_zpa as zpa

# ZPA Service Edge Group resource - No Trusted Network
service_edge_group_nyc = zpa.ServiceEdgeGroup("serviceEdgeGroupNyc",
    description="Service Edge Group in New York",
    enabled=True,
    is_public=True,
    latitude="40.7128",
    location="New York, NY, USA",
    longitude="-73.935242",
    upgrade_day="SUNDAY",
    upgrade_time_in_secs="66600",
    version_profile_name="New Release")

    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 Service Edge Group resource - No Trusted Network
		_, err := zpa.NewServiceEdgeGroup(ctx, "serviceEdgeGroupNyc", &zpa.ServiceEdgeGroupArgs{
			Description:        pulumi.String("Service Edge Group in New York"),
			Enabled:            pulumi.Bool(true),
			IsPublic:           pulumi.Bool(true),
			Latitude:           pulumi.String("40.7128"),
			Location:           pulumi.String("New York, NY, USA"),
			Longitude:          pulumi.String("-73.935242"),
			UpgradeDay:         pulumi.String("SUNDAY"),
			UpgradeTimeInSecs:  pulumi.String("66600"),
			VersionProfileName: pulumi.String("New Release"),
		})
		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 Service Edge Group resource - No Trusted Network
    var serviceEdgeGroupNyc = new Zpa.ServiceEdgeGroup("serviceEdgeGroupNyc", new()
    {
        Description = "Service Edge Group in New York",
        Enabled = true,
        IsPublic = true,
        Latitude = "40.7128",
        Location = "New York, NY, USA",
        Longitude = "-73.935242",
        UpgradeDay = "SUNDAY",
        UpgradeTimeInSecs = "66600",
        VersionProfileName = "New Release",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ServiceEdgeGroup;
import com.pulumi.zpa.ServiceEdgeGroupArgs;
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 Service Edge Group resource - No Trusted Network
        var serviceEdgeGroupNyc = new ServiceEdgeGroup("serviceEdgeGroupNyc", ServiceEdgeGroupArgs.builder()
            .description("Service Edge Group in New York")
            .enabled(true)
            .isPublic(true)
            .latitude("40.7128")
            .location("New York, NY, USA")
            .longitude("-73.935242")
            .upgradeDay("SUNDAY")
            .upgradeTimeInSecs("66600")
            .versionProfileName("New Release")
            .build());

    }
}

    resources:
  # ZPA Service Edge Group resource - No Trusted Network
  serviceEdgeGroupNyc:
    type: zpa:ServiceEdgeGroup
    properties:
      description: Service Edge Group in New York
      enabled: true
      isPublic: true
      latitude: '40.7128'
      location: New York, NY, USA
      longitude: '-73.935242'
      upgradeDay: SUNDAY
      upgradeTimeInSecs: '66600'
      versionProfileName: New Release

    Create ServiceEdgeGroup Resource

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

    Constructor syntax

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

@overload
def ServiceEdgeGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     latitude: Optional[str] = None,
                     longitude: Optional[str] = None,
                     location: Optional[str] = None,
                     grace_distance_value: Optional[str] = None,
                     name: Optional[str] = None,
                     city_country: Optional[str] = None,
                     grace_distance_value_unit: Optional[str] = None,
                     is_public: Optional[bool] = None,
                     enabled: Optional[bool] = None,
                     description: Optional[str] = None,
                     country_code: Optional[str] = None,
                     microtenant_id: Optional[str] = None,
                     grace_distance_enabled: Optional[bool] = None,
                     override_version_profile: Optional[bool] = None,
                     service_edges: Optional[Sequence[ServiceEdgeGroupServiceEdgeArgs]] = None,
                     trusted_networks: Optional[Sequence[ServiceEdgeGroupTrustedNetworkArgs]] = None,
                     upgrade_day: Optional[str] = None,
                     upgrade_time_in_secs: Optional[str] = None,
                     version_profile_id: Optional[str] = None,
                     version_profile_name: Optional[str] = None,
                     version_profile_visibility_scope: Optional[str] = None)
    func NewServiceEdgeGroup(ctx *Context, name string, args ServiceEdgeGroupArgs, opts ...ResourceOption) (*ServiceEdgeGroup, error)
    public ServiceEdgeGroup(string name, ServiceEdgeGroupArgs args, CustomResourceOptions? opts = null)
    public ServiceEdgeGroup(String name, ServiceEdgeGroupArgs args)
public ServiceEdgeGroup(String name, ServiceEdgeGroupArgs args, CustomResourceOptions options)

    type: zpa:ServiceEdgeGroup
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 ServiceEdgeGroupArgs
    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 ServiceEdgeGroupArgs
    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 ServiceEdgeGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceEdgeGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceEdgeGroupArgs
    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 serviceEdgeGroupResource = new Zpa.ServiceEdgeGroup("serviceEdgeGroupResource", new()
{
    Latitude = "string",
    Longitude = "string",
    Location = "string",
    GraceDistanceValue = "string",
    Name = "string",
    CityCountry = "string",
    GraceDistanceValueUnit = "string",
    IsPublic = false,
    Enabled = false,
    Description = "string",
    CountryCode = "string",
    MicrotenantId = "string",
    GraceDistanceEnabled = false,
    OverrideVersionProfile = false,
    ServiceEdges = new[]
    {
        new Zpa.Inputs.ServiceEdgeGroupServiceEdgeArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    TrustedNetworks = new[]
    {
        new Zpa.Inputs.ServiceEdgeGroupTrustedNetworkArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    UpgradeDay = "string",
    UpgradeTimeInSecs = "string",
    VersionProfileId = "string",
    VersionProfileName = "string",
    VersionProfileVisibilityScope = "string",
});

    example, err := zpa.NewServiceEdgeGroup(ctx, "serviceEdgeGroupResource", &zpa.ServiceEdgeGroupArgs{
	Latitude:               pulumi.String("string"),
	Longitude:              pulumi.String("string"),
	Location:               pulumi.String("string"),
	GraceDistanceValue:     pulumi.String("string"),
	Name:                   pulumi.String("string"),
	CityCountry:            pulumi.String("string"),
	GraceDistanceValueUnit: pulumi.String("string"),
	IsPublic:               pulumi.Bool(false),
	Enabled:                pulumi.Bool(false),
	Description:            pulumi.String("string"),
	CountryCode:            pulumi.String("string"),
	MicrotenantId:          pulumi.String("string"),
	GraceDistanceEnabled:   pulumi.Bool(false),
	OverrideVersionProfile: pulumi.Bool(false),
	ServiceEdges: zpa.ServiceEdgeGroupServiceEdgeArray{
		&zpa.ServiceEdgeGroupServiceEdgeArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	TrustedNetworks: zpa.ServiceEdgeGroupTrustedNetworkArray{
		&zpa.ServiceEdgeGroupTrustedNetworkArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	UpgradeDay:                    pulumi.String("string"),
	UpgradeTimeInSecs:             pulumi.String("string"),
	VersionProfileId:              pulumi.String("string"),
	VersionProfileName:            pulumi.String("string"),
	VersionProfileVisibilityScope: pulumi.String("string"),
})

    var serviceEdgeGroupResource = new ServiceEdgeGroup("serviceEdgeGroupResource", ServiceEdgeGroupArgs.builder()
    .latitude("string")
    .longitude("string")
    .location("string")
    .graceDistanceValue("string")
    .name("string")
    .cityCountry("string")
    .graceDistanceValueUnit("string")
    .isPublic(false)
    .enabled(false)
    .description("string")
    .countryCode("string")
    .microtenantId("string")
    .graceDistanceEnabled(false)
    .overrideVersionProfile(false)
    .serviceEdges(ServiceEdgeGroupServiceEdgeArgs.builder()
        .ids("string")
        .build())
    .trustedNetworks(ServiceEdgeGroupTrustedNetworkArgs.builder()
        .ids("string")
        .build())
    .upgradeDay("string")
    .upgradeTimeInSecs("string")
    .versionProfileId("string")
    .versionProfileName("string")
    .versionProfileVisibilityScope("string")
    .build());

    service_edge_group_resource = zpa.ServiceEdgeGroup("serviceEdgeGroupResource",
    latitude="string",
    longitude="string",
    location="string",
    grace_distance_value="string",
    name="string",
    city_country="string",
    grace_distance_value_unit="string",
    is_public=False,
    enabled=False,
    description="string",
    country_code="string",
    microtenant_id="string",
    grace_distance_enabled=False,
    override_version_profile=False,
    service_edges=[{
        "ids": ["string"],
    }],
    trusted_networks=[{
        "ids": ["string"],
    }],
    upgrade_day="string",
    upgrade_time_in_secs="string",
    version_profile_id="string",
    version_profile_name="string",
    version_profile_visibility_scope="string")

    const serviceEdgeGroupResource = new zpa.ServiceEdgeGroup("serviceEdgeGroupResource", {
    latitude: "string",
    longitude: "string",
    location: "string",
    graceDistanceValue: "string",
    name: "string",
    cityCountry: "string",
    graceDistanceValueUnit: "string",
    isPublic: false,
    enabled: false,
    description: "string",
    countryCode: "string",
    microtenantId: "string",
    graceDistanceEnabled: false,
    overrideVersionProfile: false,
    serviceEdges: [{
        ids: ["string"],
    }],
    trustedNetworks: [{
        ids: ["string"],
    }],
    upgradeDay: "string",
    upgradeTimeInSecs: "string",
    versionProfileId: "string",
    versionProfileName: "string",
    versionProfileVisibilityScope: "string",
});

    type: zpa:ServiceEdgeGroup
properties:
    cityCountry: string
    countryCode: string
    description: string
    enabled: false
    graceDistanceEnabled: false
    graceDistanceValue: string
    graceDistanceValueUnit: string
    isPublic: false
    latitude: string
    location: string
    longitude: string
    microtenantId: string
    name: string
    overrideVersionProfile: false
    serviceEdges:
        - ids:
            - string
    trustedNetworks:
        - ids:
            - string
    upgradeDay: string
    upgradeTimeInSecs: string
    versionProfileId: string
    versionProfileName: string
    versionProfileVisibilityScope: string

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

    Latitude string
    Latitude for the Service Edge Group.
    Location string
    Location for the Service Edge Group.
    Longitude string
    Longitude for the Service Edge Group.
    CityCountry string
    CountryCode string
    Description string
    Description of the Service Edge Group.
    Enabled bool
    Whether this Service Edge Group is enabled or not.
    GraceDistanceEnabled bool
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    GraceDistanceValue string
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    GraceDistanceValueUnit string
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    IsPublic bool
    Enable or disable public access for the Service Edge Group.
    MicrotenantId string
    Name string
    Name of the Service Edge Group.
    OverrideVersionProfile bool
    Whether the default version profile of the App Connector Group is applied or overridden.
    ServiceEdges List<Zscaler.Zpa.Inputs.ServiceEdgeGroupServiceEdge>
    TrustedNetworks List<Zscaler.Zpa.Inputs.ServiceEdgeGroupTrustedNetwork>
    List of trusted network IDs.
    UpgradeDay string
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    UpgradeTimeInSecs string
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    VersionProfileId string
    ID of the version profile.
    VersionProfileName string
    ID of the version profile.
    VersionProfileVisibilityScope string
    ID of the version profile.
    Latitude string
    Latitude for the Service Edge Group.
    Location string
    Location for the Service Edge Group.
    Longitude string
    Longitude for the Service Edge Group.
    CityCountry string
    CountryCode string
    Description string
    Description of the Service Edge Group.
    Enabled bool
    Whether this Service Edge Group is enabled or not.
    GraceDistanceEnabled bool
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    GraceDistanceValue string
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    GraceDistanceValueUnit string
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    IsPublic bool
    Enable or disable public access for the Service Edge Group.
    MicrotenantId string
    Name string
    Name of the Service Edge Group.
    OverrideVersionProfile bool
    Whether the default version profile of the App Connector Group is applied or overridden.
    ServiceEdges []ServiceEdgeGroupServiceEdgeArgs
    TrustedNetworks []ServiceEdgeGroupTrustedNetworkArgs
    List of trusted network IDs.
    UpgradeDay string
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    UpgradeTimeInSecs string
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    VersionProfileId string
    ID of the version profile.
    VersionProfileName string
    ID of the version profile.
    VersionProfileVisibilityScope string
    ID of the version profile.
    latitude String
    Latitude for the Service Edge Group.
    location String
    Location for the Service Edge Group.
    longitude String
    Longitude for the Service Edge Group.
    cityCountry String
    countryCode String
    description String
    Description of the Service Edge Group.
    enabled Boolean
    Whether this Service Edge Group is enabled or not.
    graceDistanceEnabled Boolean
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    graceDistanceValue String
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    graceDistanceValueUnit String
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    isPublic Boolean
    Enable or disable public access for the Service Edge Group.
    microtenantId String
    name String
    Name of the Service Edge Group.
    overrideVersionProfile Boolean
    Whether the default version profile of the App Connector Group is applied or overridden.
    serviceEdges List<ServiceEdgeGroupServiceEdge>
    trustedNetworks List<ServiceEdgeGroupTrustedNetwork>
    List of trusted network IDs.
    upgradeDay String
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgradeTimeInSecs String
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    versionProfileId String
    ID of the version profile.
    versionProfileName String
    ID of the version profile.
    versionProfileVisibilityScope String
    ID of the version profile.
    latitude string
    Latitude for the Service Edge Group.
    location string
    Location for the Service Edge Group.
    longitude string
    Longitude for the Service Edge Group.
    cityCountry string
    countryCode string
    description string
    Description of the Service Edge Group.
    enabled boolean
    Whether this Service Edge Group is enabled or not.
    graceDistanceEnabled boolean
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    graceDistanceValue string
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    graceDistanceValueUnit string
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    isPublic boolean
    Enable or disable public access for the Service Edge Group.
    microtenantId string
    name string
    Name of the Service Edge Group.
    overrideVersionProfile boolean
    Whether the default version profile of the App Connector Group is applied or overridden.
    serviceEdges ServiceEdgeGroupServiceEdge[]
    trustedNetworks ServiceEdgeGroupTrustedNetwork[]
    List of trusted network IDs.
    upgradeDay string
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgradeTimeInSecs string
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    versionProfileId string
    ID of the version profile.
    versionProfileName string
    ID of the version profile.
    versionProfileVisibilityScope string
    ID of the version profile.
    latitude str
    Latitude for the Service Edge Group.
    location str
    Location for the Service Edge Group.
    longitude str
    Longitude for the Service Edge Group.
    city_country str
    country_code str
    description str
    Description of the Service Edge Group.
    enabled bool
    Whether this Service Edge Group is enabled or not.
    grace_distance_enabled bool
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    grace_distance_value str
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    grace_distance_value_unit str
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    is_public bool
    Enable or disable public access for the Service Edge Group.
    microtenant_id str
    name str
    Name of the Service Edge Group.
    override_version_profile bool
    Whether the default version profile of the App Connector Group is applied or overridden.
    service_edges Sequence[ServiceEdgeGroupServiceEdgeArgs]
    trusted_networks Sequence[ServiceEdgeGroupTrustedNetworkArgs]
    List of trusted network IDs.
    upgrade_day str
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgrade_time_in_secs str
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    version_profile_id str
    ID of the version profile.
    version_profile_name str
    ID of the version profile.
    version_profile_visibility_scope str
    ID of the version profile.
    latitude String
    Latitude for the Service Edge Group.
    location String
    Location for the Service Edge Group.
    longitude String
    Longitude for the Service Edge Group.
    cityCountry String
    countryCode String
    description String
    Description of the Service Edge Group.
    enabled Boolean
    Whether this Service Edge Group is enabled or not.
    graceDistanceEnabled Boolean
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    graceDistanceValue String
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    graceDistanceValueUnit String
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    isPublic Boolean
    Enable or disable public access for the Service Edge Group.
    microtenantId String
    name String
    Name of the Service Edge Group.
    overrideVersionProfile Boolean
    Whether the default version profile of the App Connector Group is applied or overridden.
    serviceEdges List<Property Map>
    trustedNetworks List<Property Map>
    List of trusted network IDs.
    upgradeDay String
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgradeTimeInSecs String
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    versionProfileId String
    ID of the version profile.
    versionProfileName String
    ID of the version profile.
    versionProfileVisibilityScope String
    ID of the version profile.

    Outputs

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

    Get an existing ServiceEdgeGroup 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?: ServiceEdgeGroupState, opts?: CustomResourceOptions): ServiceEdgeGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        city_country: Optional[str] = None,
        country_code: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        grace_distance_enabled: Optional[bool] = None,
        grace_distance_value: Optional[str] = None,
        grace_distance_value_unit: Optional[str] = None,
        is_public: Optional[bool] = None,
        latitude: Optional[str] = None,
        location: Optional[str] = None,
        longitude: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        override_version_profile: Optional[bool] = None,
        service_edges: Optional[Sequence[ServiceEdgeGroupServiceEdgeArgs]] = None,
        trusted_networks: Optional[Sequence[ServiceEdgeGroupTrustedNetworkArgs]] = None,
        upgrade_day: Optional[str] = None,
        upgrade_time_in_secs: Optional[str] = None,
        version_profile_id: Optional[str] = None,
        version_profile_name: Optional[str] = None,
        version_profile_visibility_scope: Optional[str] = None) -> ServiceEdgeGroup
    func GetServiceEdgeGroup(ctx *Context, name string, id IDInput, state *ServiceEdgeGroupState, opts ...ResourceOption) (*ServiceEdgeGroup, error)
    public static ServiceEdgeGroup Get(string name, Input<string> id, ServiceEdgeGroupState? state, CustomResourceOptions? opts = null)
    public static ServiceEdgeGroup get(String name, Output<String> id, ServiceEdgeGroupState 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:
    CityCountry string
    CountryCode string
    Description string
    Description of the Service Edge Group.
    Enabled bool
    Whether this Service Edge Group is enabled or not.
    GraceDistanceEnabled bool
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    GraceDistanceValue string
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    GraceDistanceValueUnit string
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    IsPublic bool
    Enable or disable public access for the Service Edge Group.
    Latitude string
    Latitude for the Service Edge Group.
    Location string
    Location for the Service Edge Group.
    Longitude string
    Longitude for the Service Edge Group.
    MicrotenantId string
    Name string
    Name of the Service Edge Group.
    OverrideVersionProfile bool
    Whether the default version profile of the App Connector Group is applied or overridden.
    ServiceEdges List<Zscaler.Zpa.Inputs.ServiceEdgeGroupServiceEdge>
    TrustedNetworks List<Zscaler.Zpa.Inputs.ServiceEdgeGroupTrustedNetwork>
    List of trusted network IDs.
    UpgradeDay string
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    UpgradeTimeInSecs string
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    VersionProfileId string
    ID of the version profile.
    VersionProfileName string
    ID of the version profile.
    VersionProfileVisibilityScope string
    ID of the version profile.
    CityCountry string
    CountryCode string
    Description string
    Description of the Service Edge Group.
    Enabled bool
    Whether this Service Edge Group is enabled or not.
    GraceDistanceEnabled bool
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    GraceDistanceValue string
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    GraceDistanceValueUnit string
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    IsPublic bool
    Enable or disable public access for the Service Edge Group.
    Latitude string
    Latitude for the Service Edge Group.
    Location string
    Location for the Service Edge Group.
    Longitude string
    Longitude for the Service Edge Group.
    MicrotenantId string
    Name string
    Name of the Service Edge Group.
    OverrideVersionProfile bool
    Whether the default version profile of the App Connector Group is applied or overridden.
    ServiceEdges []ServiceEdgeGroupServiceEdgeArgs
    TrustedNetworks []ServiceEdgeGroupTrustedNetworkArgs
    List of trusted network IDs.
    UpgradeDay string
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    UpgradeTimeInSecs string
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    VersionProfileId string
    ID of the version profile.
    VersionProfileName string
    ID of the version profile.
    VersionProfileVisibilityScope string
    ID of the version profile.
    cityCountry String
    countryCode String
    description String
    Description of the Service Edge Group.
    enabled Boolean
    Whether this Service Edge Group is enabled or not.
    graceDistanceEnabled Boolean
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    graceDistanceValue String
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    graceDistanceValueUnit String
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    isPublic Boolean
    Enable or disable public access for the Service Edge Group.
    latitude String
    Latitude for the Service Edge Group.
    location String
    Location for the Service Edge Group.
    longitude String
    Longitude for the Service Edge Group.
    microtenantId String
    name String
    Name of the Service Edge Group.
    overrideVersionProfile Boolean
    Whether the default version profile of the App Connector Group is applied or overridden.
    serviceEdges List<ServiceEdgeGroupServiceEdge>
    trustedNetworks List<ServiceEdgeGroupTrustedNetwork>
    List of trusted network IDs.
    upgradeDay String
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgradeTimeInSecs String
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    versionProfileId String
    ID of the version profile.
    versionProfileName String
    ID of the version profile.
    versionProfileVisibilityScope String
    ID of the version profile.
    cityCountry string
    countryCode string
    description string
    Description of the Service Edge Group.
    enabled boolean
    Whether this Service Edge Group is enabled or not.
    graceDistanceEnabled boolean
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    graceDistanceValue string
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    graceDistanceValueUnit string
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    isPublic boolean
    Enable or disable public access for the Service Edge Group.
    latitude string
    Latitude for the Service Edge Group.
    location string
    Location for the Service Edge Group.
    longitude string
    Longitude for the Service Edge Group.
    microtenantId string
    name string
    Name of the Service Edge Group.
    overrideVersionProfile boolean
    Whether the default version profile of the App Connector Group is applied or overridden.
    serviceEdges ServiceEdgeGroupServiceEdge[]
    trustedNetworks ServiceEdgeGroupTrustedNetwork[]
    List of trusted network IDs.
    upgradeDay string
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgradeTimeInSecs string
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    versionProfileId string
    ID of the version profile.
    versionProfileName string
    ID of the version profile.
    versionProfileVisibilityScope string
    ID of the version profile.
    city_country str
    country_code str
    description str
    Description of the Service Edge Group.
    enabled bool
    Whether this Service Edge Group is enabled or not.
    grace_distance_enabled bool
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    grace_distance_value str
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    grace_distance_value_unit str
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    is_public bool
    Enable or disable public access for the Service Edge Group.
    latitude str
    Latitude for the Service Edge Group.
    location str
    Location for the Service Edge Group.
    longitude str
    Longitude for the Service Edge Group.
    microtenant_id str
    name str
    Name of the Service Edge Group.
    override_version_profile bool
    Whether the default version profile of the App Connector Group is applied or overridden.
    service_edges Sequence[ServiceEdgeGroupServiceEdgeArgs]
    trusted_networks Sequence[ServiceEdgeGroupTrustedNetworkArgs]
    List of trusted network IDs.
    upgrade_day str
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgrade_time_in_secs str
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    version_profile_id str
    ID of the version profile.
    version_profile_name str
    ID of the version profile.
    version_profile_visibility_scope str
    ID of the version profile.
    cityCountry String
    countryCode String
    description String
    Description of the Service Edge Group.
    enabled Boolean
    Whether this Service Edge Group is enabled or not.
    graceDistanceEnabled Boolean
    If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.
    graceDistanceValue String
    Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge
    graceDistanceValueUnit String
    Indicates the grace distance unit of measure in miles or kilometers. This value is only required if grace_distance_value is set to true
    isPublic Boolean
    Enable or disable public access for the Service Edge Group.
    latitude String
    Latitude for the Service Edge Group.
    location String
    Location for the Service Edge Group.
    longitude String
    Longitude for the Service Edge Group.
    microtenantId String
    name String
    Name of the Service Edge Group.
    overrideVersionProfile Boolean
    Whether the default version profile of the App Connector Group is applied or overridden.
    serviceEdges List<Property Map>
    trustedNetworks List<Property Map>
    List of trusted network IDs.
    upgradeDay String
    Service Edges in this group will attempt to update to a newer version of the software during this specified day.
    upgradeTimeInSecs String
    Service Edges in this group will attempt to update to a newer version of the software during this specified time.
    versionProfileId String
    ID of the version profile.
    versionProfileName String
    ID of the version profile.
    versionProfileVisibilityScope String
    ID of the version profile.

    Supporting Types

    ServiceEdgeGroupServiceEdge, ServiceEdgeGroupServiceEdgeArgs

    Ids List<string>
    Ids []string
    ids List<String>
    ids string[]
    ids Sequence[str]
    ids List<String>

    ServiceEdgeGroupTrustedNetwork, ServiceEdgeGroupTrustedNetworkArgs

    Ids List<string>
    Ids []string
    ids List<String>
    ids string[]
    ids Sequence[str]
    ids List<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

    Service Edge Group can be imported; use <SERVER EDGE GROUP ID> or <SERVER EDGE GROUP NAME> as the import ID.

    For example:

    $ pulumi import zpa:index/serviceEdgeGroup:ServiceEdgeGroup example <service_edge_group_id>

    or

    $ pulumi import zpa:index/serviceEdgeGroup:ServiceEdgeGroup example <service_edge_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.
    zpa logo
    Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zpa