1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. BandwidthControlRule
Zscaler Internet Access v1.2.0 published on Friday, Feb 20, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.BandwidthControlRule

zia logo
Zscaler Internet Access v1.2.0 published on Friday, Feb 20, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    Use the zia_bandwidth_control_rule resource allows the creation and management of ZIA Bandwidth Control Rules in the Zscaler Internet Access cloud or via the API.

    NOTE: Bandwidth control rule resource is only supported via Zscaler OneAPI.

    Example Usage

    By Name

    data "zia_bandwidth_classes_web_conferencing" "this" {
    name = "BANDWIDTH_CAT_WEBCONF"
}

resource "zia_bandwidth_control_rule" "this" {
    name = "Streaming Media Bandwidth"
    description = "Streaming Media Bandwidth"
    state = "ENABLED"
    order = 1
    rank = 7
    min_bandwidth = 5
    max_bandwidth = 100
    protocols = ["ANY_RULE"]
    bandwidth_classes  {
        id = [data.zia_bandwidth_classes_web_conferencing.this.id]
    }
    labels  {
        id = [1503197]
    }
    location_groups {
        id = [8061255]
    }
    time_windows {
        id = [483]
    }
}

    Create BandwidthControlRule Resource

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

    Constructor syntax

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

@overload
def BandwidthControlRule(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         order: Optional[int] = None,
                         protocols: Optional[Sequence[str]] = None,
                         location_groups: Optional[BandwidthControlRuleLocationGroupsArgs] = None,
                         bandwidth_classes: Optional[BandwidthControlRuleBandwidthClassesArgs] = None,
                         locations: Optional[BandwidthControlRuleLocationsArgs] = None,
                         max_bandwidth: Optional[int] = None,
                         min_bandwidth: Optional[int] = None,
                         name: Optional[str] = None,
                         labels: Optional[BandwidthControlRuleLabelsArgs] = None,
                         description: Optional[str] = None,
                         rank: Optional[int] = None,
                         state: Optional[str] = None,
                         time_windows: Optional[BandwidthControlRuleTimeWindowsArgs] = None)
    func NewBandwidthControlRule(ctx *Context, name string, args BandwidthControlRuleArgs, opts ...ResourceOption) (*BandwidthControlRule, error)
    public BandwidthControlRule(string name, BandwidthControlRuleArgs args, CustomResourceOptions? opts = null)
    public BandwidthControlRule(String name, BandwidthControlRuleArgs args)
public BandwidthControlRule(String name, BandwidthControlRuleArgs args, CustomResourceOptions options)

    type: zia:BandwidthControlRule
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 BandwidthControlRuleArgs
    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 BandwidthControlRuleArgs
    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 BandwidthControlRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BandwidthControlRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BandwidthControlRuleArgs
    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 bandwidthControlRuleResource = new Zia.BandwidthControlRule("bandwidthControlRuleResource", new()
{
    Order = 0,
    Protocols = new[]
    {
        "string",
    },
    LocationGroups = new Zia.Inputs.BandwidthControlRuleLocationGroupsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    BandwidthClasses = new Zia.Inputs.BandwidthControlRuleBandwidthClassesArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Locations = new Zia.Inputs.BandwidthControlRuleLocationsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    MaxBandwidth = 0,
    MinBandwidth = 0,
    Name = "string",
    Labels = new Zia.Inputs.BandwidthControlRuleLabelsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
    Description = "string",
    Rank = 0,
    State = "string",
    TimeWindows = new Zia.Inputs.BandwidthControlRuleTimeWindowsArgs
    {
        Ids = new[]
        {
            0,
        },
    },
});

    example, err := zia.NewBandwidthControlRule(ctx, "bandwidthControlRuleResource", &zia.BandwidthControlRuleArgs{
	Order: pulumi.Int(0),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	LocationGroups: &zia.BandwidthControlRuleLocationGroupsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	BandwidthClasses: &zia.BandwidthControlRuleBandwidthClassesArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Locations: &zia.BandwidthControlRuleLocationsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	MaxBandwidth: pulumi.Int(0),
	MinBandwidth: pulumi.Int(0),
	Name:         pulumi.String("string"),
	Labels: &zia.BandwidthControlRuleLabelsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Description: pulumi.String("string"),
	Rank:        pulumi.Int(0),
	State:       pulumi.String("string"),
	TimeWindows: &zia.BandwidthControlRuleTimeWindowsArgs{
		Ids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
})

    var bandwidthControlRuleResource = new BandwidthControlRule("bandwidthControlRuleResource", BandwidthControlRuleArgs.builder()
    .order(0)
    .protocols("string")
    .locationGroups(BandwidthControlRuleLocationGroupsArgs.builder()
        .ids(0)
        .build())
    .bandwidthClasses(BandwidthControlRuleBandwidthClassesArgs.builder()
        .ids(0)
        .build())
    .locations(BandwidthControlRuleLocationsArgs.builder()
        .ids(0)
        .build())
    .maxBandwidth(0)
    .minBandwidth(0)
    .name("string")
    .labels(BandwidthControlRuleLabelsArgs.builder()
        .ids(0)
        .build())
    .description("string")
    .rank(0)
    .state("string")
    .timeWindows(BandwidthControlRuleTimeWindowsArgs.builder()
        .ids(0)
        .build())
    .build());

    bandwidth_control_rule_resource = zia.BandwidthControlRule("bandwidthControlRuleResource",
    order=0,
    protocols=["string"],
    location_groups={
        "ids": [0],
    },
    bandwidth_classes={
        "ids": [0],
    },
    locations={
        "ids": [0],
    },
    max_bandwidth=0,
    min_bandwidth=0,
    name="string",
    labels={
        "ids": [0],
    },
    description="string",
    rank=0,
    state="string",
    time_windows={
        "ids": [0],
    })

    const bandwidthControlRuleResource = new zia.BandwidthControlRule("bandwidthControlRuleResource", {
    order: 0,
    protocols: ["string"],
    locationGroups: {
        ids: [0],
    },
    bandwidthClasses: {
        ids: [0],
    },
    locations: {
        ids: [0],
    },
    maxBandwidth: 0,
    minBandwidth: 0,
    name: "string",
    labels: {
        ids: [0],
    },
    description: "string",
    rank: 0,
    state: "string",
    timeWindows: {
        ids: [0],
    },
});

    type: zia:BandwidthControlRule
properties:
    bandwidthClasses:
        ids:
            - 0
    description: string
    labels:
        ids:
            - 0
    locationGroups:
        ids:
            - 0
    locations:
        ids:
            - 0
    maxBandwidth: 0
    minBandwidth: 0
    name: string
    order: 0
    protocols:
        - string
    rank: 0
    state: string
    timeWindows:
        ids:
            - 0

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

    Order int
    The order of the bandwidth control rule
    Protocols List<string>
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    BandwidthClasses zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleBandwidthClasses
    The bandwidth control rulees to which you want to apply this rule
    Description string
    (Optional) Additional information about the rule
    Labels zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleLabels
    Labels that are applicable to the rule
    LocationGroups zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleLocationGroups
    Name-ID pairs of the location groups to which the rule must be applied.
    Locations zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleLocations
    Name-ID pairs of locations for which rule must be applied
    MaxBandwidth int
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    MinBandwidth int
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    Name string
    The bandwidth control rule name
    Rank int
    (Optional) Admin rank of the Bandwidth Control policy rule
    State string
    (Optional) Administrative state of the rule.
    TimeWindows zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleTimeWindows
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    Order int
    The order of the bandwidth control rule
    Protocols []string
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    BandwidthClasses BandwidthControlRuleBandwidthClassesArgs
    The bandwidth control rulees to which you want to apply this rule
    Description string
    (Optional) Additional information about the rule
    Labels BandwidthControlRuleLabelsArgs
    Labels that are applicable to the rule
    LocationGroups BandwidthControlRuleLocationGroupsArgs
    Name-ID pairs of the location groups to which the rule must be applied.
    Locations BandwidthControlRuleLocationsArgs
    Name-ID pairs of locations for which rule must be applied
    MaxBandwidth int
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    MinBandwidth int
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    Name string
    The bandwidth control rule name
    Rank int
    (Optional) Admin rank of the Bandwidth Control policy rule
    State string
    (Optional) Administrative state of the rule.
    TimeWindows BandwidthControlRuleTimeWindowsArgs
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    order Integer
    The order of the bandwidth control rule
    protocols List<String>
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    bandwidthClasses BandwidthControlRuleBandwidthClasses
    The bandwidth control rulees to which you want to apply this rule
    description String
    (Optional) Additional information about the rule
    labels BandwidthControlRuleLabels
    Labels that are applicable to the rule
    locationGroups BandwidthControlRuleLocationGroups
    Name-ID pairs of the location groups to which the rule must be applied.
    locations BandwidthControlRuleLocations
    Name-ID pairs of locations for which rule must be applied
    maxBandwidth Integer
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    minBandwidth Integer
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name String
    The bandwidth control rule name
    rank Integer
    (Optional) Admin rank of the Bandwidth Control policy rule
    state String
    (Optional) Administrative state of the rule.
    timeWindows BandwidthControlRuleTimeWindows
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    order number
    The order of the bandwidth control rule
    protocols string[]
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    bandwidthClasses BandwidthControlRuleBandwidthClasses
    The bandwidth control rulees to which you want to apply this rule
    description string
    (Optional) Additional information about the rule
    labels BandwidthControlRuleLabels
    Labels that are applicable to the rule
    locationGroups BandwidthControlRuleLocationGroups
    Name-ID pairs of the location groups to which the rule must be applied.
    locations BandwidthControlRuleLocations
    Name-ID pairs of locations for which rule must be applied
    maxBandwidth number
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    minBandwidth number
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name string
    The bandwidth control rule name
    rank number
    (Optional) Admin rank of the Bandwidth Control policy rule
    state string
    (Optional) Administrative state of the rule.
    timeWindows BandwidthControlRuleTimeWindows
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    order int
    The order of the bandwidth control rule
    protocols Sequence[str]
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    bandwidth_classes BandwidthControlRuleBandwidthClassesArgs
    The bandwidth control rulees to which you want to apply this rule
    description str
    (Optional) Additional information about the rule
    labels BandwidthControlRuleLabelsArgs
    Labels that are applicable to the rule
    location_groups BandwidthControlRuleLocationGroupsArgs
    Name-ID pairs of the location groups to which the rule must be applied.
    locations BandwidthControlRuleLocationsArgs
    Name-ID pairs of locations for which rule must be applied
    max_bandwidth int
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    min_bandwidth int
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name str
    The bandwidth control rule name
    rank int
    (Optional) Admin rank of the Bandwidth Control policy rule
    state str
    (Optional) Administrative state of the rule.
    time_windows BandwidthControlRuleTimeWindowsArgs
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    order Number
    The order of the bandwidth control rule
    protocols List<String>
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    bandwidthClasses Property Map
    The bandwidth control rulees to which you want to apply this rule
    description String
    (Optional) Additional information about the rule
    labels Property Map
    Labels that are applicable to the rule
    locationGroups Property Map
    Name-ID pairs of the location groups to which the rule must be applied.
    locations Property Map
    Name-ID pairs of locations for which rule must be applied
    maxBandwidth Number
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    minBandwidth Number
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name String
    The bandwidth control rule name
    rank Number
    (Optional) Admin rank of the Bandwidth Control policy rule
    state String
    (Optional) Administrative state of the rule.
    timeWindows Property Map
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BandwidthControlRule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId int
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleId int
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId Integer
    id string
    The provider-assigned unique ID for this managed resource.
    ruleId number
    id str
    The provider-assigned unique ID for this managed resource.
    rule_id int
    id String
    The provider-assigned unique ID for this managed resource.
    ruleId Number

    Look up Existing BandwidthControlRule Resource

    Get an existing BandwidthControlRule 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?: BandwidthControlRuleState, opts?: CustomResourceOptions): BandwidthControlRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth_classes: Optional[BandwidthControlRuleBandwidthClassesArgs] = None,
        description: Optional[str] = None,
        labels: Optional[BandwidthControlRuleLabelsArgs] = None,
        location_groups: Optional[BandwidthControlRuleLocationGroupsArgs] = None,
        locations: Optional[BandwidthControlRuleLocationsArgs] = None,
        max_bandwidth: Optional[int] = None,
        min_bandwidth: Optional[int] = None,
        name: Optional[str] = None,
        order: Optional[int] = None,
        protocols: Optional[Sequence[str]] = None,
        rank: Optional[int] = None,
        rule_id: Optional[int] = None,
        state: Optional[str] = None,
        time_windows: Optional[BandwidthControlRuleTimeWindowsArgs] = None) -> BandwidthControlRule
    func GetBandwidthControlRule(ctx *Context, name string, id IDInput, state *BandwidthControlRuleState, opts ...ResourceOption) (*BandwidthControlRule, error)
    public static BandwidthControlRule Get(string name, Input<string> id, BandwidthControlRuleState? state, CustomResourceOptions? opts = null)
    public static BandwidthControlRule get(String name, Output<String> id, BandwidthControlRuleState state, CustomResourceOptions options)
    resources:  _:    type: zia:BandwidthControlRule    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:
    BandwidthClasses zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleBandwidthClasses
    The bandwidth control rulees to which you want to apply this rule
    Description string
    (Optional) Additional information about the rule
    Labels zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleLabels
    Labels that are applicable to the rule
    LocationGroups zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleLocationGroups
    Name-ID pairs of the location groups to which the rule must be applied.
    Locations zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleLocations
    Name-ID pairs of locations for which rule must be applied
    MaxBandwidth int
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    MinBandwidth int
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    Name string
    The bandwidth control rule name
    Order int
    The order of the bandwidth control rule
    Protocols List<string>
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    Rank int
    (Optional) Admin rank of the Bandwidth Control policy rule
    RuleId int
    State string
    (Optional) Administrative state of the rule.
    TimeWindows zscaler.PulumiPackage.Zia.Inputs.BandwidthControlRuleTimeWindows
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    BandwidthClasses BandwidthControlRuleBandwidthClassesArgs
    The bandwidth control rulees to which you want to apply this rule
    Description string
    (Optional) Additional information about the rule
    Labels BandwidthControlRuleLabelsArgs
    Labels that are applicable to the rule
    LocationGroups BandwidthControlRuleLocationGroupsArgs
    Name-ID pairs of the location groups to which the rule must be applied.
    Locations BandwidthControlRuleLocationsArgs
    Name-ID pairs of locations for which rule must be applied
    MaxBandwidth int
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    MinBandwidth int
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    Name string
    The bandwidth control rule name
    Order int
    The order of the bandwidth control rule
    Protocols []string
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    Rank int
    (Optional) Admin rank of the Bandwidth Control policy rule
    RuleId int
    State string
    (Optional) Administrative state of the rule.
    TimeWindows BandwidthControlRuleTimeWindowsArgs
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    bandwidthClasses BandwidthControlRuleBandwidthClasses
    The bandwidth control rulees to which you want to apply this rule
    description String
    (Optional) Additional information about the rule
    labels BandwidthControlRuleLabels
    Labels that are applicable to the rule
    locationGroups BandwidthControlRuleLocationGroups
    Name-ID pairs of the location groups to which the rule must be applied.
    locations BandwidthControlRuleLocations
    Name-ID pairs of locations for which rule must be applied
    maxBandwidth Integer
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    minBandwidth Integer
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name String
    The bandwidth control rule name
    order Integer
    The order of the bandwidth control rule
    protocols List<String>
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    rank Integer
    (Optional) Admin rank of the Bandwidth Control policy rule
    ruleId Integer
    state String
    (Optional) Administrative state of the rule.
    timeWindows BandwidthControlRuleTimeWindows
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    bandwidthClasses BandwidthControlRuleBandwidthClasses
    The bandwidth control rulees to which you want to apply this rule
    description string
    (Optional) Additional information about the rule
    labels BandwidthControlRuleLabels
    Labels that are applicable to the rule
    locationGroups BandwidthControlRuleLocationGroups
    Name-ID pairs of the location groups to which the rule must be applied.
    locations BandwidthControlRuleLocations
    Name-ID pairs of locations for which rule must be applied
    maxBandwidth number
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    minBandwidth number
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name string
    The bandwidth control rule name
    order number
    The order of the bandwidth control rule
    protocols string[]
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    rank number
    (Optional) Admin rank of the Bandwidth Control policy rule
    ruleId number
    state string
    (Optional) Administrative state of the rule.
    timeWindows BandwidthControlRuleTimeWindows
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    bandwidth_classes BandwidthControlRuleBandwidthClassesArgs
    The bandwidth control rulees to which you want to apply this rule
    description str
    (Optional) Additional information about the rule
    labels BandwidthControlRuleLabelsArgs
    Labels that are applicable to the rule
    location_groups BandwidthControlRuleLocationGroupsArgs
    Name-ID pairs of the location groups to which the rule must be applied.
    locations BandwidthControlRuleLocationsArgs
    Name-ID pairs of locations for which rule must be applied
    max_bandwidth int
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    min_bandwidth int
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name str
    The bandwidth control rule name
    order int
    The order of the bandwidth control rule
    protocols Sequence[str]
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    rank int
    (Optional) Admin rank of the Bandwidth Control policy rule
    rule_id int
    state str
    (Optional) Administrative state of the rule.
    time_windows BandwidthControlRuleTimeWindowsArgs
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied
    bandwidthClasses Property Map
    The bandwidth control rulees to which you want to apply this rule
    description String
    (Optional) Additional information about the rule
    labels Property Map
    Labels that are applicable to the rule
    locationGroups Property Map
    Name-ID pairs of the location groups to which the rule must be applied.
    locations Property Map
    Name-ID pairs of locations for which rule must be applied
    maxBandwidth Number
    (Optional) The maximum percentage of a location's bandwidth to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    minBandwidth Number
    (Optional) The minimum percentage of a location's bandwidth you want to be guaranteed for each selected bandwidth class. This percentage includes bandwidth for uploads and downloads.
    name String
    The bandwidth control rule name
    order Number
    The order of the bandwidth control rule
    protocols List<String>
    (List of Object) Protocol criteria. Supported values: WEBSOCKETSSL_RULE, WEBSOCKET_RULE, DOHTTPS_RULE, TUNNELSSL_RULE, HTTP_PROXY, FOHTTP_RULE, FTP_RULE, HTTPS_RULE, HTTP_RULE, SSL_RULE, SSL_RULE, TUNNEL_RULE
    rank Number
    (Optional) Admin rank of the Bandwidth Control policy rule
    ruleId Number
    state String
    (Optional) Administrative state of the rule.
    timeWindows Property Map
    The Name-ID pairs of time windows to which the bandwidth control rule must be applied

    Supporting Types

    BandwidthControlRuleBandwidthClasses, BandwidthControlRuleBandwidthClassesArgs

    Ids List<int>
    (Number) Identifier that uniquely identifies an entity
    Ids []int
    (Number) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Number) Identifier that uniquely identifies an entity
    ids number[]
    (Number) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Number) Identifier that uniquely identifies an entity
    ids List<Number>
    (Number) Identifier that uniquely identifies an entity

    BandwidthControlRuleLabels, BandwidthControlRuleLabelsArgs

    Ids List<int>
    (Number) Identifier that uniquely identifies an entity
    Ids []int
    (Number) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Number) Identifier that uniquely identifies an entity
    ids number[]
    (Number) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Number) Identifier that uniquely identifies an entity
    ids List<Number>
    (Number) Identifier that uniquely identifies an entity

    BandwidthControlRuleLocationGroups, BandwidthControlRuleLocationGroupsArgs

    Ids List<int>
    (Number) Identifier that uniquely identifies an entity
    Ids []int
    (Number) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Number) Identifier that uniquely identifies an entity
    ids number[]
    (Number) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Number) Identifier that uniquely identifies an entity
    ids List<Number>
    (Number) Identifier that uniquely identifies an entity

    BandwidthControlRuleLocations, BandwidthControlRuleLocationsArgs

    Ids List<int>
    (Number) Identifier that uniquely identifies an entity
    Ids []int
    (Number) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Number) Identifier that uniquely identifies an entity
    ids number[]
    (Number) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Number) Identifier that uniquely identifies an entity
    ids List<Number>
    (Number) Identifier that uniquely identifies an entity

    BandwidthControlRuleTimeWindows, BandwidthControlRuleTimeWindowsArgs

    Ids List<int>
    (Number) Identifier that uniquely identifies an entity
    Ids []int
    (Number) Identifier that uniquely identifies an entity
    ids List<Integer>
    (Number) Identifier that uniquely identifies an entity
    ids number[]
    (Number) Identifier that uniquely identifies an entity
    ids Sequence[int]
    (Number) Identifier that uniquely identifies an entity
    ids List<Number>
    (Number) Identifier that uniquely identifies an entity

    Import

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

    zia_bandwidth_control_rule can be imported by using <RULE_ID> or <RULE_NAME> as the import ID.

    For example:

    $ pulumi import zia:index/bandwidthControlRule:BandwidthControlRule this <rule_id>

    $ pulumi import zia:index/bandwidthControlRule:BandwidthControlRule this <"rule_name">

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v1.2.0 published on Friday, Feb 20, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Meet Neo: Your AI Platform Teammate