@bdzscaler/pulumi-zia/getDeviceGroups.d.ts

A Pulumi package for creating and managing zia cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * * [Official documentation](https://help.zscaler.com/zia/device-groups#/deviceGroups-get)
 * * [API documentation](https://help.zscaler.com/zia/device-groups#/deviceGroups-get)
 *
 * Use the **zia_device_groups** data source to get information about a device group in the Zscaler Internet Access cloud or via the API. This data source can then be associated with resources such as: URL Filtering Rules
 *
 * ## Example Usage
 */
export declare function getDeviceGroups(args?: GetDeviceGroupsArgs, opts?: pulumi.InvokeOptions): Promise<GetDeviceGroupsResult>;
/**
 * A collection of arguments for invoking getDeviceGroups.
 */
export interface GetDeviceGroupsArgs {
    /**
     * The name of the device group to be exported.
     */
    name?: string;
}
/**
 * A collection of values returned by getDeviceGroups.
 */
export interface GetDeviceGroupsResult {
    /**
     * (String) The device group's description.
     */
    readonly description: string;
    /**
     * (int) The number of devices within the group.
     */
    readonly deviceCount: number;
    /**
     * (String) The names of devices that belong to the device group. The device names are comma-separated.
     */
    readonly deviceNames: string;
    /**
     * (String) The device group type. i.e ``ZCC_OS``, ``NON_ZCC``, ``CBI``
     */
    readonly groupType: string;
    /**
     * (String) The unique identifer for the device group.
     */
    readonly id: number;
    /**
     * (String) The device group name.
     */
    readonly name?: string;
    /**
     * (String) The operating system (OS).
     */
    readonly osType: string;
    /**
     * (Boolean) Indicates whether this is a predefined device group. If this value is set to true, the group is predefined.
     */
    readonly predefined: boolean;
}
/**
 * * [Official documentation](https://help.zscaler.com/zia/device-groups#/deviceGroups-get)
 * * [API documentation](https://help.zscaler.com/zia/device-groups#/deviceGroups-get)
 *
 * Use the **zia_device_groups** data source to get information about a device group in the Zscaler Internet Access cloud or via the API. This data source can then be associated with resources such as: URL Filtering Rules
 *
 * ## Example Usage
 */
export declare function getDeviceGroupsOutput(args?: GetDeviceGroupsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDeviceGroupsResult>;
/**
 * A collection of arguments for invoking getDeviceGroups.
 */
export interface GetDeviceGroupsOutputArgs {
    /**
     * The name of the device group to be exported.
     */
    name?: pulumi.Input<string>;
}