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

zia.getBandwidthControlRule

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 Retrieves all the rules in the Bandwidth Control policy.

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

    Example Usage

    By Name

    
data "zia_bandwidth_control_rule" "this" {
    name = "Streaming Media Bandwidth"
}

    By ID

    
data "zia_bandwidth_control_rule" "this" {
  id = 154658
}

    Using getBandwidthControlRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBandwidthControlRule(args: GetBandwidthControlRuleArgs, opts?: InvokeOptions): Promise<GetBandwidthControlRuleResult>
function getBandwidthControlRuleOutput(args: GetBandwidthControlRuleOutputArgs, opts?: InvokeOptions): Output<GetBandwidthControlRuleResult>
    def get_bandwidth_control_rule(id: Optional[int] = None,
                               name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetBandwidthControlRuleResult
def get_bandwidth_control_rule_output(id: Optional[pulumi.Input[int]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetBandwidthControlRuleResult]
    func LookupBandwidthControlRule(ctx *Context, args *LookupBandwidthControlRuleArgs, opts ...InvokeOption) (*LookupBandwidthControlRuleResult, error)
func LookupBandwidthControlRuleOutput(ctx *Context, args *LookupBandwidthControlRuleOutputArgs, opts ...InvokeOption) LookupBandwidthControlRuleResultOutput

    > Note: This function is named LookupBandwidthControlRule in the Go SDK.

    public static class GetBandwidthControlRule 
{
    public static Task<GetBandwidthControlRuleResult> InvokeAsync(GetBandwidthControlRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetBandwidthControlRuleResult> Invoke(GetBandwidthControlRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBandwidthControlRuleResult> getBandwidthControlRule(GetBandwidthControlRuleArgs args, InvokeOptions options)
public static Output<GetBandwidthControlRuleResult> getBandwidthControlRule(GetBandwidthControlRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: zia:index/getBandwidthControlRule:getBandwidthControlRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    id Integer
    System-generated identifier for bandwidth control rule
    name String
    Rule name.
    id number
    System-generated identifier for bandwidth control rule
    name string
    Rule name.
    id int
    System-generated identifier for bandwidth control rule
    name str
    Rule name.
    id Number
    System-generated identifier for bandwidth control rule
    name String
    Rule name.

    getBandwidthControlRule Result

    The following output properties are available:

    AccessControl string
    BandwidthClasses List<zscaler.PulumiPackage.Zia.Outputs.GetBandwidthControlRuleBandwidthClass>
    Description string
    (string) Additional information about the rule
    Id int
    (Number) Identifier that uniquely identifies an entity
    Labels List<zscaler.PulumiPackage.Zia.Outputs.GetBandwidthControlRuleLabel>
    LastModifiedBies List<zscaler.PulumiPackage.Zia.Outputs.GetBandwidthControlRuleLastModifiedBy>
    LastModifiedTime int
    LocationGroups List<zscaler.PulumiPackage.Zia.Outputs.GetBandwidthControlRuleLocationGroup>
    Locations List<zscaler.PulumiPackage.Zia.Outputs.GetBandwidthControlRuleLocation>
    MaxBandwidth int
    (int) 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
    (int) 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
    Order int
    Protocols List<string>
    (List of string) 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
    (int) Admin rank of the Bandwidth Control policy rule
    State string
    (string) Administrative state of the rule.
    TimeWindows List<zscaler.PulumiPackage.Zia.Outputs.GetBandwidthControlRuleTimeWindow>
    AccessControl string
    BandwidthClasses []GetBandwidthControlRuleBandwidthClass
    Description string
    (string) Additional information about the rule
    Id int
    (Number) Identifier that uniquely identifies an entity
    Labels []GetBandwidthControlRuleLabel
    LastModifiedBies []GetBandwidthControlRuleLastModifiedBy
    LastModifiedTime int
    LocationGroups []GetBandwidthControlRuleLocationGroup
    Locations []GetBandwidthControlRuleLocation
    MaxBandwidth int
    (int) 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
    (int) 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
    Order int
    Protocols []string
    (List of string) 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
    (int) Admin rank of the Bandwidth Control policy rule
    State string
    (string) Administrative state of the rule.
    TimeWindows []GetBandwidthControlRuleTimeWindow
    accessControl String
    bandwidthClasses List<GetBandwidthControlRuleBandwidthClass>
    description String
    (string) Additional information about the rule
    id Integer
    (Number) Identifier that uniquely identifies an entity
    labels List<GetBandwidthControlRuleLabel>
    lastModifiedBies List<GetBandwidthControlRuleLastModifiedBy>
    lastModifiedTime Integer
    locationGroups List<GetBandwidthControlRuleLocationGroup>
    locations List<GetBandwidthControlRuleLocation>
    maxBandwidth Integer
    (int) 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
    (int) 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
    order Integer
    protocols List<String>
    (List of string) 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
    (int) Admin rank of the Bandwidth Control policy rule
    state String
    (string) Administrative state of the rule.
    timeWindows List<GetBandwidthControlRuleTimeWindow>
    accessControl string
    bandwidthClasses GetBandwidthControlRuleBandwidthClass[]
    description string
    (string) Additional information about the rule
    id number
    (Number) Identifier that uniquely identifies an entity
    labels GetBandwidthControlRuleLabel[]
    lastModifiedBies GetBandwidthControlRuleLastModifiedBy[]
    lastModifiedTime number
    locationGroups GetBandwidthControlRuleLocationGroup[]
    locations GetBandwidthControlRuleLocation[]
    maxBandwidth number
    (int) 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
    (int) 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
    order number
    protocols string[]
    (List of string) 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
    (int) Admin rank of the Bandwidth Control policy rule
    state string
    (string) Administrative state of the rule.
    timeWindows GetBandwidthControlRuleTimeWindow[]
    access_control str
    bandwidth_classes Sequence[GetBandwidthControlRuleBandwidthClass]
    description str
    (string) Additional information about the rule
    id int
    (Number) Identifier that uniquely identifies an entity
    labels Sequence[GetBandwidthControlRuleLabel]
    last_modified_bies Sequence[GetBandwidthControlRuleLastModifiedBy]
    last_modified_time int
    location_groups Sequence[GetBandwidthControlRuleLocationGroup]
    locations Sequence[GetBandwidthControlRuleLocation]
    max_bandwidth int
    (int) 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
    (int) 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
    order int
    protocols Sequence[str]
    (List of string) 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
    (int) Admin rank of the Bandwidth Control policy rule
    state str
    (string) Administrative state of the rule.
    time_windows Sequence[GetBandwidthControlRuleTimeWindow]
    accessControl String
    bandwidthClasses List<Property Map>
    description String
    (string) Additional information about the rule
    id Number
    (Number) Identifier that uniquely identifies an entity
    labels List<Property Map>
    lastModifiedBies List<Property Map>
    lastModifiedTime Number
    locationGroups List<Property Map>
    locations List<Property Map>
    maxBandwidth Number
    (int) 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
    (int) 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
    order Number
    protocols List<String>
    (List of string) 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
    (int) Admin rank of the Bandwidth Control policy rule
    state String
    (string) Administrative state of the rule.
    timeWindows List<Property Map>

    Supporting Types

    GetBandwidthControlRuleBandwidthClass

    Extensions Dictionary<string, string>
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    Extensions map[string]string
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    extensions Map<String,String>
    id Integer
    System-generated identifier for bandwidth control rule
    name String
    Rule name.
    extensions {[key: string]: string}
    id number
    System-generated identifier for bandwidth control rule
    name string
    Rule name.
    extensions Mapping[str, str]
    id int
    System-generated identifier for bandwidth control rule
    name str
    Rule name.
    extensions Map<String>
    id Number
    System-generated identifier for bandwidth control rule
    name String
    Rule name.

    GetBandwidthControlRuleLabel

    Extensions Dictionary<string, string>
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    Extensions map[string]string
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    extensions Map<String,String>
    id Integer
    System-generated identifier for bandwidth control rule
    name String
    Rule name.
    extensions {[key: string]: string}
    id number
    System-generated identifier for bandwidth control rule
    name string
    Rule name.
    extensions Mapping[str, str]
    id int
    System-generated identifier for bandwidth control rule
    name str
    Rule name.
    extensions Map<String>
    id Number
    System-generated identifier for bandwidth control rule
    name String
    Rule name.

    GetBandwidthControlRuleLastModifiedBy

    Extensions Dictionary<string, string>
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    Extensions map[string]string
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    extensions Map<String,String>
    id Integer
    System-generated identifier for bandwidth control rule
    name String
    Rule name.
    extensions {[key: string]: string}
    id number
    System-generated identifier for bandwidth control rule
    name string
    Rule name.
    extensions Mapping[str, str]
    id int
    System-generated identifier for bandwidth control rule
    name str
    Rule name.
    extensions Map<String>
    id Number
    System-generated identifier for bandwidth control rule
    name String
    Rule name.

    GetBandwidthControlRuleLocation

    Extensions Dictionary<string, string>
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    Extensions map[string]string
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    extensions Map<String,String>
    id Integer
    System-generated identifier for bandwidth control rule
    name String
    Rule name.
    extensions {[key: string]: string}
    id number
    System-generated identifier for bandwidth control rule
    name string
    Rule name.
    extensions Mapping[str, str]
    id int
    System-generated identifier for bandwidth control rule
    name str
    Rule name.
    extensions Map<String>
    id Number
    System-generated identifier for bandwidth control rule
    name String
    Rule name.

    GetBandwidthControlRuleLocationGroup

    Extensions Dictionary<string, string>
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    Extensions map[string]string
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    extensions Map<String,String>
    id Integer
    System-generated identifier for bandwidth control rule
    name String
    Rule name.
    extensions {[key: string]: string}
    id number
    System-generated identifier for bandwidth control rule
    name string
    Rule name.
    extensions Mapping[str, str]
    id int
    System-generated identifier for bandwidth control rule
    name str
    Rule name.
    extensions Map<String>
    id Number
    System-generated identifier for bandwidth control rule
    name String
    Rule name.

    GetBandwidthControlRuleTimeWindow

    Extensions Dictionary<string, string>
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    Extensions map[string]string
    Id int
    System-generated identifier for bandwidth control rule
    Name string
    Rule name.
    extensions Map<String,String>
    id Integer
    System-generated identifier for bandwidth control rule
    name String
    Rule name.
    extensions {[key: string]: string}
    id number
    System-generated identifier for bandwidth control rule
    name string
    Rule name.
    extensions Mapping[str, str]
    id int
    System-generated identifier for bandwidth control rule
    name str
    Rule name.
    extensions Map<String>
    id Number
    System-generated identifier for bandwidth control rule
    name String
    Rule name.

    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