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

zpa.ServerGroup

Explore with Pulumi AI

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

Example Usage

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

// Create a App Connector Group
const exampleConnectorGroup = new zpa.ConnectorGroup("exampleConnectorGroup", {
    description: "Example",
    enabled: true,
    cityCountry: "San Jose, CA",
    countryCode: "US",
    latitude: "37.338",
    longitude: "-121.8863",
    location: "San Jose, CA, US",
    upgradeDay: "SUNDAY",
    upgradeTimeInSecs: "66600",
    overrideVersionProfile: true,
    versionProfileId: "0",
    dnsQueryType: "IPV4",
});
// Create a Server Group resource with Dynamic Discovery Enabled
const exampleServerGroup = new zpa.ServerGroup("exampleServerGroup", {
    description: "Example",
    enabled: true,
    dynamicDiscovery: true,
    appConnectorGroups: [{
        ids: [exampleConnectorGroup.id],
    }],
}, {
    dependsOn: [exampleConnectorGroup],
});
Copy
import pulumi
import zscaler_pulumi_zpa as zpa

# Create a App Connector Group
example_connector_group = zpa.ConnectorGroup("exampleConnectorGroup",
    description="Example",
    enabled=True,
    city_country="San Jose, CA",
    country_code="US",
    latitude="37.338",
    longitude="-121.8863",
    location="San Jose, CA, US",
    upgrade_day="SUNDAY",
    upgrade_time_in_secs="66600",
    override_version_profile=True,
    version_profile_id="0",
    dns_query_type="IPV4")
# Create a Server Group resource with Dynamic Discovery Enabled
example_server_group = zpa.ServerGroup("exampleServerGroup",
    description="Example",
    enabled=True,
    dynamic_discovery=True,
    app_connector_groups=[zpa.ServerGroupAppConnectorGroupArgs(
        ids=[example_connector_group.id],
    )],
    opts = pulumi.ResourceOptions(depends_on=[example_connector_group]))
Copy
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 {
		// Create a App Connector Group
		exampleConnectorGroup, err := zpa.NewConnectorGroup(ctx, "exampleConnectorGroup", &zpa.ConnectorGroupArgs{
			Description:            pulumi.String("Example"),
			Enabled:                pulumi.Bool(true),
			CityCountry:            pulumi.String("San Jose, CA"),
			CountryCode:            pulumi.String("US"),
			Latitude:               pulumi.String("37.338"),
			Longitude:              pulumi.String("-121.8863"),
			Location:               pulumi.String("San Jose, CA, US"),
			UpgradeDay:             pulumi.String("SUNDAY"),
			UpgradeTimeInSecs:      pulumi.String("66600"),
			OverrideVersionProfile: pulumi.Bool(true),
			VersionProfileId:       pulumi.String("0"),
			DnsQueryType:           pulumi.String("IPV4"),
		})
		if err != nil {
			return err
		}
		// Create a Server Group resource with Dynamic Discovery Enabled
		_, err = zpa.NewServerGroup(ctx, "exampleServerGroup", &zpa.ServerGroupArgs{
			Description:      pulumi.String("Example"),
			Enabled:          pulumi.Bool(true),
			DynamicDiscovery: pulumi.Bool(true),
			AppConnectorGroups: zpa.ServerGroupAppConnectorGroupArray{
				&zpa.ServerGroupAppConnectorGroupArgs{
					Ids: pulumi.StringArray{
						exampleConnectorGroup.ID(),
					},
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleConnectorGroup,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = Zscaler.Zpa;

return await Deployment.RunAsync(() => 
{
    // Create a App Connector Group
    var exampleConnectorGroup = new Zpa.ConnectorGroup("exampleConnectorGroup", new()
    {
        Description = "Example",
        Enabled = true,
        CityCountry = "San Jose, CA",
        CountryCode = "US",
        Latitude = "37.338",
        Longitude = "-121.8863",
        Location = "San Jose, CA, US",
        UpgradeDay = "SUNDAY",
        UpgradeTimeInSecs = "66600",
        OverrideVersionProfile = true,
        VersionProfileId = "0",
        DnsQueryType = "IPV4",
    });

    // Create a Server Group resource with Dynamic Discovery Enabled
    var exampleServerGroup = new Zpa.ServerGroup("exampleServerGroup", new()
    {
        Description = "Example",
        Enabled = true,
        DynamicDiscovery = true,
        AppConnectorGroups = new[]
        {
            new Zpa.Inputs.ServerGroupAppConnectorGroupArgs
            {
                Ids = new[]
                {
                    exampleConnectorGroup.Id,
                },
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleConnectorGroup,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ConnectorGroup;
import com.pulumi.zpa.ConnectorGroupArgs;
import com.pulumi.zpa.ServerGroup;
import com.pulumi.zpa.ServerGroupArgs;
import com.pulumi.zpa.inputs.ServerGroupAppConnectorGroupArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        // Create a App Connector Group
        var exampleConnectorGroup = new ConnectorGroup("exampleConnectorGroup", ConnectorGroupArgs.builder()
            .description("Example")
            .enabled(true)
            .cityCountry("San Jose, CA")
            .countryCode("US")
            .latitude("37.338")
            .longitude("-121.8863")
            .location("San Jose, CA, US")
            .upgradeDay("SUNDAY")
            .upgradeTimeInSecs("66600")
            .overrideVersionProfile(true)
            .versionProfileId(0)
            .dnsQueryType("IPV4")
            .build());

        // Create a Server Group resource with Dynamic Discovery Enabled
        var exampleServerGroup = new ServerGroup("exampleServerGroup", ServerGroupArgs.builder()
            .description("Example")
            .enabled(true)
            .dynamicDiscovery(true)
            .appConnectorGroups(ServerGroupAppConnectorGroupArgs.builder()
                .ids(exampleConnectorGroup.id())
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleConnectorGroup)
                .build());

    }
}
Copy
resources:
  # Create a Server Group resource with Dynamic Discovery Enabled
  exampleServerGroup:
    type: zpa:ServerGroup
    properties:
      description: Example
      enabled: true
      dynamicDiscovery: true
      appConnectorGroups:
        - ids:
            - ${exampleConnectorGroup.id}
    options:
      dependson:
        - ${exampleConnectorGroup}
  # Create a App Connector Group
  exampleConnectorGroup:
    type: zpa:ConnectorGroup
    properties:
      description: Example
      enabled: true
      cityCountry: San Jose, CA
      countryCode: US
      latitude: '37.338'
      longitude: '-121.8863'
      location: San Jose, CA, US
      upgradeDay: SUNDAY
      upgradeTimeInSecs: '66600'
      overrideVersionProfile: true
      versionProfileId: 0
      dnsQueryType: IPV4
Copy
import * as pulumi from "@pulumi/pulumi";
import * as zpa from "@bdzscaler/pulumi-zpa";

// Create an application server
const exampleApplicationServer = new zpa.ApplicationServer("exampleApplicationServer", {
    description: "Example",
    address: "server.example.com",
    enabled: true,
});
// Create a App Connector Group
const exampleConnectorGroup = new zpa.ConnectorGroup("exampleConnectorGroup", {
    description: "Example",
    enabled: true,
    cityCountry: "San Jose, CA",
    countryCode: "US",
    latitude: "37.338",
    longitude: "-121.8863",
    location: "San Jose, CA, US",
    upgradeDay: "SUNDAY",
    upgradeTimeInSecs: "66600",
    overrideVersionProfile: true,
    versionProfileId: "0",
    dnsQueryType: "IPV4",
});
// ZPA Server Group resource with Dynamic Discovery Disabled
const exampleServerGroup = new zpa.ServerGroup("exampleServerGroup", {
    description: "Example",
    enabled: true,
    dynamicDiscovery: false,
    servers: [{
        ids: [exampleApplicationServer.id],
    }],
    appConnectorGroups: [{
        ids: [exampleConnectorGroup.id],
    }],
}, {
    dependsOn: [
        exampleConnectorGroup,
        zpa_application_server.server,
    ],
});
Copy
import pulumi
import zscaler_pulumi_zpa as zpa

# Create an application server
example_application_server = zpa.ApplicationServer("exampleApplicationServer",
    description="Example",
    address="server.example.com",
    enabled=True)
# Create a App Connector Group
example_connector_group = zpa.ConnectorGroup("exampleConnectorGroup",
    description="Example",
    enabled=True,
    city_country="San Jose, CA",
    country_code="US",
    latitude="37.338",
    longitude="-121.8863",
    location="San Jose, CA, US",
    upgrade_day="SUNDAY",
    upgrade_time_in_secs="66600",
    override_version_profile=True,
    version_profile_id="0",
    dns_query_type="IPV4")
# ZPA Server Group resource with Dynamic Discovery Disabled
example_server_group = zpa.ServerGroup("exampleServerGroup",
    description="Example",
    enabled=True,
    dynamic_discovery=False,
    servers=[zpa.ServerGroupServerArgs(
        ids=[example_application_server.id],
    )],
    app_connector_groups=[zpa.ServerGroupAppConnectorGroupArgs(
        ids=[example_connector_group.id],
    )],
    opts = pulumi.ResourceOptions(depends_on=[
            example_connector_group,
            zpa_application_server["server"],
        ]))
Copy
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 {
		// Create an application server
		exampleApplicationServer, err := zpa.NewApplicationServer(ctx, "exampleApplicationServer", &zpa.ApplicationServerArgs{
			Description: pulumi.String("Example"),
			Address:     pulumi.String("server.example.com"),
			Enabled:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		// Create a App Connector Group
		exampleConnectorGroup, err := zpa.NewConnectorGroup(ctx, "exampleConnectorGroup", &zpa.ConnectorGroupArgs{
			Description:            pulumi.String("Example"),
			Enabled:                pulumi.Bool(true),
			CityCountry:            pulumi.String("San Jose, CA"),
			CountryCode:            pulumi.String("US"),
			Latitude:               pulumi.String("37.338"),
			Longitude:              pulumi.String("-121.8863"),
			Location:               pulumi.String("San Jose, CA, US"),
			UpgradeDay:             pulumi.String("SUNDAY"),
			UpgradeTimeInSecs:      pulumi.String("66600"),
			OverrideVersionProfile: pulumi.Bool(true),
			VersionProfileId:       pulumi.String("0"),
			DnsQueryType:           pulumi.String("IPV4"),
		})
		if err != nil {
			return err
		}
		// ZPA Server Group resource with Dynamic Discovery Disabled
		_, err = zpa.NewServerGroup(ctx, "exampleServerGroup", &zpa.ServerGroupArgs{
			Description:      pulumi.String("Example"),
			Enabled:          pulumi.Bool(true),
			DynamicDiscovery: pulumi.Bool(false),
			Servers: zpa.ServerGroupServerArray{
				&zpa.ServerGroupServerArgs{
					Ids: pulumi.StringArray{
						exampleApplicationServer.ID(),
					},
				},
			},
			AppConnectorGroups: zpa.ServerGroupAppConnectorGroupArray{
				&zpa.ServerGroupAppConnectorGroupArgs{
					Ids: pulumi.StringArray{
						exampleConnectorGroup.ID(),
					},
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleConnectorGroup,
			zpa_application_server.Server,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = Zscaler.Zpa;

return await Deployment.RunAsync(() => 
{
    // Create an application server
    var exampleApplicationServer = new Zpa.ApplicationServer("exampleApplicationServer", new()
    {
        Description = "Example",
        Address = "server.example.com",
        Enabled = true,
    });

    // Create a App Connector Group
    var exampleConnectorGroup = new Zpa.ConnectorGroup("exampleConnectorGroup", new()
    {
        Description = "Example",
        Enabled = true,
        CityCountry = "San Jose, CA",
        CountryCode = "US",
        Latitude = "37.338",
        Longitude = "-121.8863",
        Location = "San Jose, CA, US",
        UpgradeDay = "SUNDAY",
        UpgradeTimeInSecs = "66600",
        OverrideVersionProfile = true,
        VersionProfileId = "0",
        DnsQueryType = "IPV4",
    });

    // ZPA Server Group resource with Dynamic Discovery Disabled
    var exampleServerGroup = new Zpa.ServerGroup("exampleServerGroup", new()
    {
        Description = "Example",
        Enabled = true,
        DynamicDiscovery = false,
        Servers = new[]
        {
            new Zpa.Inputs.ServerGroupServerArgs
            {
                Ids = new[]
                {
                    exampleApplicationServer.Id,
                },
            },
        },
        AppConnectorGroups = new[]
        {
            new Zpa.Inputs.ServerGroupAppConnectorGroupArgs
            {
                Ids = new[]
                {
                    exampleConnectorGroup.Id,
                },
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleConnectorGroup,
            zpa_application_server.Server,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ApplicationServer;
import com.pulumi.zpa.ApplicationServerArgs;
import com.pulumi.zpa.ConnectorGroup;
import com.pulumi.zpa.ConnectorGroupArgs;
import com.pulumi.zpa.ServerGroup;
import com.pulumi.zpa.ServerGroupArgs;
import com.pulumi.zpa.inputs.ServerGroupServerArgs;
import com.pulumi.zpa.inputs.ServerGroupAppConnectorGroupArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        // Create an application server
        var exampleApplicationServer = new ApplicationServer("exampleApplicationServer", ApplicationServerArgs.builder()
            .description("Example")
            .address("server.example.com")
            .enabled(true)
            .build());

        // Create a App Connector Group
        var exampleConnectorGroup = new ConnectorGroup("exampleConnectorGroup", ConnectorGroupArgs.builder()
            .description("Example")
            .enabled(true)
            .cityCountry("San Jose, CA")
            .countryCode("US")
            .latitude("37.338")
            .longitude("-121.8863")
            .location("San Jose, CA, US")
            .upgradeDay("SUNDAY")
            .upgradeTimeInSecs("66600")
            .overrideVersionProfile(true)
            .versionProfileId(0)
            .dnsQueryType("IPV4")
            .build());

        // ZPA Server Group resource with Dynamic Discovery Disabled
        var exampleServerGroup = new ServerGroup("exampleServerGroup", ServerGroupArgs.builder()
            .description("Example")
            .enabled(true)
            .dynamicDiscovery(false)
            .servers(ServerGroupServerArgs.builder()
                .ids(exampleApplicationServer.id())
                .build())
            .appConnectorGroups(ServerGroupAppConnectorGroupArgs.builder()
                .ids(exampleConnectorGroup.id())
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(                
                    exampleConnectorGroup,
                    zpa_application_server.server())
                .build());

    }
}
Copy
resources:
  # ZPA Server Group resource with Dynamic Discovery Disabled
  exampleServerGroup:
    type: zpa:ServerGroup
    properties:
      description: Example
      enabled: true
      dynamicDiscovery: false
      servers:
        - ids:
            - ${exampleApplicationServer.id}
      appConnectorGroups:
        - ids:
            - ${exampleConnectorGroup.id}
    options:
      dependson:
        - ${exampleConnectorGroup}
        - ${zpa_application_server.server}
  # Create an application server
  exampleApplicationServer:
    type: zpa:ApplicationServer
    properties:
      description: Example
      address: server.example.com
      enabled: true
  # Create a App Connector Group
  exampleConnectorGroup:
    type: zpa:ConnectorGroup
    properties:
      description: Example
      enabled: true
      cityCountry: San Jose, CA
      countryCode: US
      latitude: '37.338'
      longitude: '-121.8863'
      location: San Jose, CA, US
      upgradeDay: SUNDAY
      upgradeTimeInSecs: '66600'
      overrideVersionProfile: true
      versionProfileId: 0
      dnsQueryType: IPV4
Copy

Create ServerGroup Resource

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

Constructor syntax

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

@overload
def ServerGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                app_connector_groups: Optional[Sequence[ServerGroupAppConnectorGroupArgs]] = None,
                applications: Optional[Sequence[ServerGroupApplicationArgs]] = None,
                config_space: Optional[str] = None,
                description: Optional[str] = None,
                dynamic_discovery: Optional[bool] = None,
                enabled: Optional[bool] = None,
                ip_anchored: Optional[bool] = None,
                microtenant_id: Optional[str] = None,
                name: Optional[str] = None,
                servers: Optional[Sequence[ServerGroupServerArgs]] = None)
func NewServerGroup(ctx *Context, name string, args *ServerGroupArgs, opts ...ResourceOption) (*ServerGroup, error)
public ServerGroup(string name, ServerGroupArgs? args = null, CustomResourceOptions? opts = null)
public ServerGroup(String name, ServerGroupArgs args)
public ServerGroup(String name, ServerGroupArgs args, CustomResourceOptions options)

type: zpa:ServerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ServerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ServerGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ServerGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ServerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServerGroupArgs
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 serverGroupResource = new Zpa.ServerGroup("serverGroupResource", new()
{
    AppConnectorGroups = new[]
    {
        new Zpa.Inputs.ServerGroupAppConnectorGroupArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    Applications = new[]
    {
        new Zpa.Inputs.ServerGroupApplicationArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
    ConfigSpace = "string",
    Description = "string",
    DynamicDiscovery = false,
    Enabled = false,
    IpAnchored = false,
    MicrotenantId = "string",
    Name = "string",
    Servers = new[]
    {
        new Zpa.Inputs.ServerGroupServerArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
});
Copy
example, err := zpa.NewServerGroup(ctx, "serverGroupResource", &zpa.ServerGroupArgs{
	AppConnectorGroups: zpa.ServerGroupAppConnectorGroupArray{
		&zpa.ServerGroupAppConnectorGroupArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Applications: zpa.ServerGroupApplicationArray{
		&zpa.ServerGroupApplicationArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ConfigSpace:      pulumi.String("string"),
	Description:      pulumi.String("string"),
	DynamicDiscovery: pulumi.Bool(false),
	Enabled:          pulumi.Bool(false),
	IpAnchored:       pulumi.Bool(false),
	MicrotenantId:    pulumi.String("string"),
	Name:             pulumi.String("string"),
	Servers: zpa.ServerGroupServerArray{
		&zpa.ServerGroupServerArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})
Copy
var serverGroupResource = new ServerGroup("serverGroupResource", ServerGroupArgs.builder()
    .appConnectorGroups(ServerGroupAppConnectorGroupArgs.builder()
        .ids("string")
        .build())
    .applications(ServerGroupApplicationArgs.builder()
        .ids("string")
        .build())
    .configSpace("string")
    .description("string")
    .dynamicDiscovery(false)
    .enabled(false)
    .ipAnchored(false)
    .microtenantId("string")
    .name("string")
    .servers(ServerGroupServerArgs.builder()
        .ids("string")
        .build())
    .build());
Copy
server_group_resource = zpa.ServerGroup("serverGroupResource",
    app_connector_groups=[{
        "ids": ["string"],
    }],
    applications=[{
        "ids": ["string"],
    }],
    config_space="string",
    description="string",
    dynamic_discovery=False,
    enabled=False,
    ip_anchored=False,
    microtenant_id="string",
    name="string",
    servers=[{
        "ids": ["string"],
    }])
Copy
const serverGroupResource = new zpa.ServerGroup("serverGroupResource", {
    appConnectorGroups: [{
        ids: ["string"],
    }],
    applications: [{
        ids: ["string"],
    }],
    configSpace: "string",
    description: "string",
    dynamicDiscovery: false,
    enabled: false,
    ipAnchored: false,
    microtenantId: "string",
    name: "string",
    servers: [{
        ids: ["string"],
    }],
});
Copy
type: zpa:ServerGroup
properties:
    appConnectorGroups:
        - ids:
            - string
    applications:
        - ids:
            - string
    configSpace: string
    description: string
    dynamicDiscovery: false
    enabled: false
    ipAnchored: false
    microtenantId: string
    name: string
    servers:
        - ids:
            - string
Copy

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

AppConnectorGroups List<Zscaler.Zpa.Inputs.ServerGroupAppConnectorGroup>
List of app-connector IDs.
Applications List<Zscaler.Zpa.Inputs.ServerGroupApplication>
This field is a json array of app-connector-id only.
ConfigSpace string
Description string
This field is the description of the server group.
DynamicDiscovery bool
This field controls dynamic discovery of the servers.
Enabled bool
This field defines if the server group is enabled or disabled.
IpAnchored bool
MicrotenantId string
Name string
This field defines the name of the server group.
Servers List<Zscaler.Zpa.Inputs.ServerGroupServer>
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
AppConnectorGroups []ServerGroupAppConnectorGroupArgs
List of app-connector IDs.
Applications []ServerGroupApplicationArgs
This field is a json array of app-connector-id only.
ConfigSpace string
Description string
This field is the description of the server group.
DynamicDiscovery bool
This field controls dynamic discovery of the servers.
Enabled bool
This field defines if the server group is enabled or disabled.
IpAnchored bool
MicrotenantId string
Name string
This field defines the name of the server group.
Servers []ServerGroupServerArgs
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
appConnectorGroups List<ServerGroupAppConnectorGroup>
List of app-connector IDs.
applications List<ServerGroupApplication>
This field is a json array of app-connector-id only.
configSpace String
description String
This field is the description of the server group.
dynamicDiscovery Boolean
This field controls dynamic discovery of the servers.
enabled Boolean
This field defines if the server group is enabled or disabled.
ipAnchored Boolean
microtenantId String
name String
This field defines the name of the server group.
servers List<ServerGroupServer>
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
appConnectorGroups ServerGroupAppConnectorGroup[]
List of app-connector IDs.
applications ServerGroupApplication[]
This field is a json array of app-connector-id only.
configSpace string
description string
This field is the description of the server group.
dynamicDiscovery boolean
This field controls dynamic discovery of the servers.
enabled boolean
This field defines if the server group is enabled or disabled.
ipAnchored boolean
microtenantId string
name string
This field defines the name of the server group.
servers ServerGroupServer[]
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
app_connector_groups Sequence[ServerGroupAppConnectorGroupArgs]
List of app-connector IDs.
applications Sequence[ServerGroupApplicationArgs]
This field is a json array of app-connector-id only.
config_space str
description str
This field is the description of the server group.
dynamic_discovery bool
This field controls dynamic discovery of the servers.
enabled bool
This field defines if the server group is enabled or disabled.
ip_anchored bool
microtenant_id str
name str
This field defines the name of the server group.
servers Sequence[ServerGroupServerArgs]
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
appConnectorGroups List<Property Map>
List of app-connector IDs.
applications List<Property Map>
This field is a json array of app-connector-id only.
configSpace String
description String
This field is the description of the server group.
dynamicDiscovery Boolean
This field controls dynamic discovery of the servers.
enabled Boolean
This field defines if the server group is enabled or disabled.
ipAnchored Boolean
microtenantId String
name String
This field defines the name of the server group.
servers List<Property Map>
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.

Outputs

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

Get an existing ServerGroup 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?: ServerGroupState, opts?: CustomResourceOptions): ServerGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_connector_groups: Optional[Sequence[ServerGroupAppConnectorGroupArgs]] = None,
        applications: Optional[Sequence[ServerGroupApplicationArgs]] = None,
        config_space: Optional[str] = None,
        description: Optional[str] = None,
        dynamic_discovery: Optional[bool] = None,
        enabled: Optional[bool] = None,
        ip_anchored: Optional[bool] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        servers: Optional[Sequence[ServerGroupServerArgs]] = None) -> ServerGroup
func GetServerGroup(ctx *Context, name string, id IDInput, state *ServerGroupState, opts ...ResourceOption) (*ServerGroup, error)
public static ServerGroup Get(string name, Input<string> id, ServerGroupState? state, CustomResourceOptions? opts = null)
public static ServerGroup get(String name, Output<String> id, ServerGroupState state, CustomResourceOptions options)
resources:  _:    type: zpa:ServerGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AppConnectorGroups List<Zscaler.Zpa.Inputs.ServerGroupAppConnectorGroup>
List of app-connector IDs.
Applications List<Zscaler.Zpa.Inputs.ServerGroupApplication>
This field is a json array of app-connector-id only.
ConfigSpace string
Description string
This field is the description of the server group.
DynamicDiscovery bool
This field controls dynamic discovery of the servers.
Enabled bool
This field defines if the server group is enabled or disabled.
IpAnchored bool
MicrotenantId string
Name string
This field defines the name of the server group.
Servers List<Zscaler.Zpa.Inputs.ServerGroupServer>
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
AppConnectorGroups []ServerGroupAppConnectorGroupArgs
List of app-connector IDs.
Applications []ServerGroupApplicationArgs
This field is a json array of app-connector-id only.
ConfigSpace string
Description string
This field is the description of the server group.
DynamicDiscovery bool
This field controls dynamic discovery of the servers.
Enabled bool
This field defines if the server group is enabled or disabled.
IpAnchored bool
MicrotenantId string
Name string
This field defines the name of the server group.
Servers []ServerGroupServerArgs
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
appConnectorGroups List<ServerGroupAppConnectorGroup>
List of app-connector IDs.
applications List<ServerGroupApplication>
This field is a json array of app-connector-id only.
configSpace String
description String
This field is the description of the server group.
dynamicDiscovery Boolean
This field controls dynamic discovery of the servers.
enabled Boolean
This field defines if the server group is enabled or disabled.
ipAnchored Boolean
microtenantId String
name String
This field defines the name of the server group.
servers List<ServerGroupServer>
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
appConnectorGroups ServerGroupAppConnectorGroup[]
List of app-connector IDs.
applications ServerGroupApplication[]
This field is a json array of app-connector-id only.
configSpace string
description string
This field is the description of the server group.
dynamicDiscovery boolean
This field controls dynamic discovery of the servers.
enabled boolean
This field defines if the server group is enabled or disabled.
ipAnchored boolean
microtenantId string
name string
This field defines the name of the server group.
servers ServerGroupServer[]
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
app_connector_groups Sequence[ServerGroupAppConnectorGroupArgs]
List of app-connector IDs.
applications Sequence[ServerGroupApplicationArgs]
This field is a json array of app-connector-id only.
config_space str
description str
This field is the description of the server group.
dynamic_discovery bool
This field controls dynamic discovery of the servers.
enabled bool
This field defines if the server group is enabled or disabled.
ip_anchored bool
microtenant_id str
name str
This field defines the name of the server group.
servers Sequence[ServerGroupServerArgs]
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.
appConnectorGroups List<Property Map>
List of app-connector IDs.
applications List<Property Map>
This field is a json array of app-connector-id only.
configSpace String
description String
This field is the description of the server group.
dynamicDiscovery Boolean
This field controls dynamic discovery of the servers.
enabled Boolean
This field defines if the server group is enabled or disabled.
ipAnchored Boolean
microtenantId String
name String
This field defines the name of the server group.
servers List<Property Map>
This field is a list of servers that are applicable only when dynamic discovery is disabled. Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.

Supporting Types

ServerGroupAppConnectorGroup
, ServerGroupAppConnectorGroupArgs

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

ServerGroupApplication
, ServerGroupApplicationArgs

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

ServerGroupServer
, ServerGroupServerArgs

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

Server Groups can be imported; use <SERVER GROUP ID> or <SERVER GROUP NAME> as the import ID.

For example:

$ pulumi import zpa:index/serverGroup:ServerGroup example <server_group_id>
Copy

or

$ pulumi import zpa:index/serverGroup:ServerGroup example <server_group_name>
Copy

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.12 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zpa