Zscaler Private Access v1.0.1, Jun 5 25

Zscaler Private Access v1.0.1 published on Thursday, Jun 5, 2025 by Zscaler

zpa.ServiceEdgeAssistantSchedule

Explore with Pulumi AI

Zscaler Private Access v1.0.1 published on Thursday, Jun 5, 2025 by Zscaler

Use the zpa_service_edge_assistant_schedule resource sets the scheduled frequency at which the disconnected Service Edges are eligible for deletion. The supported value for frequency is days. The frequencyInterval field is the number of days after an Service Edge disconnects for it to become eligible for deletion. The minimum supported value for frequencyInterval is 5.

NOTE - When enabling the Assistant Schedule for the first time, you must provide the customer_id information. If you authenticated using environment variables and used ZPA_CUSTOMER_ID environment variable, you don’t have to define the customer_id attribute in the HCL configuration, and the provider will automatically use the value from the environment variable ZPA_CUSTOMER_ID

Example Usage

Defined Customer ID Value

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

const _this = new zpa.ServiceEdgeAssistantSchedule("this", {
    customerId: "123456789101112",
    deleteDisabled: true,
    enabled: true,
    frequency: "days",
    frequencyInterval: "5",
});

import pulumi
import zscaler_pulumi_zpa as zpa

this = zpa.ServiceEdgeAssistantSchedule("this",
    customer_id="123456789101112",
    delete_disabled=True,
    enabled=True,
    frequency="days",
    frequency_interval="5")

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 {
		_, err := zpa.NewServiceEdgeAssistantSchedule(ctx, "this", &zpa.ServiceEdgeAssistantScheduleArgs{
			CustomerId:        pulumi.String("123456789101112"),
			DeleteDisabled:    pulumi.Bool(true),
			Enabled:           pulumi.Bool(true),
			Frequency:         pulumi.String("days"),
			FrequencyInterval: pulumi.String("5"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = zscaler.PulumiPackage.Zpa;

return await Deployment.RunAsync(() => 
{
    var @this = new Zpa.ServiceEdgeAssistantSchedule("this", new()
    {
        CustomerId = "123456789101112",
        DeleteDisabled = true,
        Enabled = true,
        Frequency = "days",
        FrequencyInterval = "5",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ServiceEdgeAssistantSchedule;
import com.pulumi.zpa.ServiceEdgeAssistantScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new ServiceEdgeAssistantSchedule("this", ServiceEdgeAssistantScheduleArgs.builder()
            .customerId("123456789101112")
            .deleteDisabled(true)
            .enabled(true)
            .frequency("days")
            .frequencyInterval("5")
            .build());

    }
}

resources:
  this:
    type: zpa:ServiceEdgeAssistantSchedule
    properties:
      customerId: '123456789101112'
      deleteDisabled: true
      enabled: true
      frequency: days
      frequencyInterval: '5'

Customer ID Via Environment Variable

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

const _this = new zpa.ServiceEdgeAssistantSchedule("this", {
    deleteDisabled: true,
    enabled: true,
    frequency: "days",
    frequencyInterval: "5",
});

import pulumi
import zscaler_pulumi_zpa as zpa

this = zpa.ServiceEdgeAssistantSchedule("this",
    delete_disabled=True,
    enabled=True,
    frequency="days",
    frequency_interval="5")

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 {
		_, err := zpa.NewServiceEdgeAssistantSchedule(ctx, "this", &zpa.ServiceEdgeAssistantScheduleArgs{
			DeleteDisabled:    pulumi.Bool(true),
			Enabled:           pulumi.Bool(true),
			Frequency:         pulumi.String("days"),
			FrequencyInterval: pulumi.String("5"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = zscaler.PulumiPackage.Zpa;

return await Deployment.RunAsync(() => 
{
    var @this = new Zpa.ServiceEdgeAssistantSchedule("this", new()
    {
        DeleteDisabled = true,
        Enabled = true,
        Frequency = "days",
        FrequencyInterval = "5",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.ServiceEdgeAssistantSchedule;
import com.pulumi.zpa.ServiceEdgeAssistantScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new ServiceEdgeAssistantSchedule("this", ServiceEdgeAssistantScheduleArgs.builder()
            .deleteDisabled(true)
            .enabled(true)
            .frequency("days")
            .frequencyInterval("5")
            .build());

    }
}

resources:
  this:
    type: zpa:ServiceEdgeAssistantSchedule
    properties:
      deleteDisabled: true
      enabled: true
      frequency: days
      frequencyInterval: '5'

Create ServiceEdgeAssistantSchedule Resource

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

Constructor syntax

new ServiceEdgeAssistantSchedule(name: string, args?: ServiceEdgeAssistantScheduleArgs, opts?: CustomResourceOptions);

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

@overload
def ServiceEdgeAssistantSchedule(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 customer_id: Optional[str] = None,
                                 delete_disabled: Optional[bool] = None,
                                 enabled: Optional[bool] = None,
                                 frequency: Optional[str] = None,
                                 frequency_interval: Optional[str] = None)

func NewServiceEdgeAssistantSchedule(ctx *Context, name string, args *ServiceEdgeAssistantScheduleArgs, opts ...ResourceOption) (*ServiceEdgeAssistantSchedule, error)

public ServiceEdgeAssistantSchedule(string name, ServiceEdgeAssistantScheduleArgs? args = null, CustomResourceOptions? opts = null)

public ServiceEdgeAssistantSchedule(String name, ServiceEdgeAssistantScheduleArgs args)
public ServiceEdgeAssistantSchedule(String name, ServiceEdgeAssistantScheduleArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args ServiceEdgeAssistantScheduleArgs: 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 serviceEdgeAssistantScheduleResource = new Zpa.ServiceEdgeAssistantSchedule("serviceEdgeAssistantScheduleResource", new()
{
    CustomerId = "string",
    DeleteDisabled = false,
    Enabled = false,
    Frequency = "string",
    FrequencyInterval = "string",
});

example, err := zpa.NewServiceEdgeAssistantSchedule(ctx, "serviceEdgeAssistantScheduleResource", &zpa.ServiceEdgeAssistantScheduleArgs{
	CustomerId:        pulumi.String("string"),
	DeleteDisabled:    pulumi.Bool(false),
	Enabled:           pulumi.Bool(false),
	Frequency:         pulumi.String("string"),
	FrequencyInterval: pulumi.String("string"),
})

var serviceEdgeAssistantScheduleResource = new ServiceEdgeAssistantSchedule("serviceEdgeAssistantScheduleResource", ServiceEdgeAssistantScheduleArgs.builder()
    .customerId("string")
    .deleteDisabled(false)
    .enabled(false)
    .frequency("string")
    .frequencyInterval("string")
    .build());

service_edge_assistant_schedule_resource = zpa.ServiceEdgeAssistantSchedule("serviceEdgeAssistantScheduleResource",
    customer_id="string",
    delete_disabled=False,
    enabled=False,
    frequency="string",
    frequency_interval="string")

const serviceEdgeAssistantScheduleResource = new zpa.ServiceEdgeAssistantSchedule("serviceEdgeAssistantScheduleResource", {
    customerId: "string",
    deleteDisabled: false,
    enabled: false,
    frequency: "string",
    frequencyInterval: "string",
});

type: zpa:ServiceEdgeAssistantSchedule
properties:
    customerId: string
    deleteDisabled: false
    enabled: false
    frequency: string
    frequencyInterval: string

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

CustomerId string
DeleteDisabled bool
Enabled bool
Frequency string
FrequencyInterval string

CustomerId string
DeleteDisabled bool
Enabled bool
Frequency string
FrequencyInterval string

customerId String
deleteDisabled Boolean
enabled Boolean
frequency String
frequencyInterval String

customerId string
deleteDisabled boolean
enabled boolean
frequency string
frequencyInterval string

customer_id str
delete_disabled bool
enabled bool
frequency str
frequency_interval str

customerId String
deleteDisabled Boolean
enabled Boolean
frequency String
frequencyInterval String

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        customer_id: Optional[str] = None,
        delete_disabled: Optional[bool] = None,
        enabled: Optional[bool] = None,
        frequency: Optional[str] = None,
        frequency_interval: Optional[str] = None) -> ServiceEdgeAssistantSchedule

func GetServiceEdgeAssistantSchedule(ctx *Context, name string, id IDInput, state *ServiceEdgeAssistantScheduleState, opts ...ResourceOption) (*ServiceEdgeAssistantSchedule, error)

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

public static ServiceEdgeAssistantSchedule get(String name, Output<String> id, ServiceEdgeAssistantScheduleState state, CustomResourceOptions options)

resources:  _:    type: zpa:ServiceEdgeAssistantSchedule    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CustomerId string
DeleteDisabled bool
Enabled bool
Frequency string
FrequencyInterval string

CustomerId string
DeleteDisabled bool
Enabled bool
Frequency string
FrequencyInterval string

customerId String
deleteDisabled Boolean
enabled Boolean
frequency String
frequencyInterval String

customerId string
deleteDisabled boolean
enabled boolean
frequency string
frequencyInterval string

customer_id str
delete_disabled bool
enabled bool
frequency str
frequency_interval str

customerId String
deleteDisabled Boolean
enabled Boolean
frequency String
frequencyInterval String

Import

Import is not currently supported for this resource.

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 v1.0.1 published on Thursday, Jun 5, 2025 by Zscaler

zscaler/pulumi-zpa

zpa.ServiceEdgeAssistantSchedule

On this page

On this page

Example Usage

Defined Customer ID Value

Customer ID Via Environment Variable

Create ServiceEdgeAssistantSchedule Resource

Constructor syntax

Parameters

Constructor example

ServiceEdgeAssistantSchedule Resource Properties

Inputs

Outputs

Look up Existing ServiceEdgeAssistantSchedule Resource

Import

Package Details

On this page

On this page