workload_tag_group¶

The following methods allow for interaction with the ZPA Workload Tag Group Controller API endpoints.

Methods are accessible via zpa.workload_tag_group

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class WorkloadTagGroupAPI¶

Bases: APIClient

A Client object for the Workload Tag Group resource.

get_workload_tag_group_summary(query_params=None)¶

Workload tag group summary endpoints.

Parameters:

{dict} (query_params) –

Map of query parameters for the request.

[query_params.page] {str}: Specifies the page number.

[query_params.page_size] {str}: Specifies the page size.: If not provided, the default page size is 20. The max page size is 500.

[query_params.search] {str}: Search string for filtering results.

Returns:

A tuple containing (list of WorkloadTagGroup instances, Response, error)

Return type:

Tuple

Examples

>>> workload_tag_group_list, _, err = client.zpa.workload_tag_group.list_workload_tag_groups(
... query_params={'search': 'Extranet01', 'page': '1', 'page_size': '100'})
... if err:
...     print(f"Error listing extranet resources: {err}")
...     return
... print(f"Total workload tag groups found: {len(workload_tag_group_list)}")
... for workload_tag_group in workload_tag_group_list:
...     print(workload_tag_group.as_dict())