Skip to main content

WorkloadGroups Collection

Iterate over WorkloadGroup resources in Zscaler Cloud & Branch Connector.

Returned items are WorkloadGroup resources — access their fields via dot notation.

Iterate all items​

import zssdk
session = zssdk.Session(profile_name="beta")

# Yield each item; pagination (if any) is handled automatically
for item in session.ztw.workload_groups.all():
    print(item.id)

# Materialize the full list
all_items = list(session.ztw.workload_groups.all())
print(f"Total items: {len(all_items)}")

Iterate by page​

# Paginated collections yield each server page; simple collections yield one page
for page in session.ztw.workload_groups().pages():
    print(f"Got a page with {len(page)} items")
    for item in page:
        print(item.id)

Server-side pagination​

This collection paginates server-side via the ListWorkloadGroups operation.

Pagination tokenValue
Stylepage
Input tokenpage
Output tokentotalPages
Limit keypageSize
Result key@
# Tune the per-request batch size and cap total yielded items
for item in session.ztw.workload_groups.page_size(50).limit(100):
    print(item.id)

See the Pagination guide for the full pagination model.

# Server-side filtering (query params sent to the API)
for item in session.ztw.workload_groups.filter(page="value"):
    print(item.id)

# Client-side JMESPath on each page
for item in session.ztw.workload_groups.search("[?contains(name, 'prod')]"):
    print(item.id)

Resource Type​

Each item is a WorkloadGroup instance with standard CRUDL and any custom actions defined on that resource.