1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getDeviceGroup
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler

    Use this data source to look up a device group by ID or name.

    Using getDeviceGroup

    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 getDeviceGroup(args: GetDeviceGroupArgs, opts?: InvokeOptions): Promise<GetDeviceGroupResult>
    function getDeviceGroupOutput(args: GetDeviceGroupOutputArgs, opts?: InvokeOptions): Output<GetDeviceGroupResult>
    def get_device_group(name: Optional[str] = None,
                         resource_id: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDeviceGroupResult
    def get_device_group_output(name: Optional[pulumi.Input[str]] = None,
                         resource_id: Optional[pulumi.Input[int]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDeviceGroupResult]
    func GetDeviceGroup(ctx *Context, args *GetDeviceGroupArgs, opts ...InvokeOption) (*GetDeviceGroupResult, error)
    func GetDeviceGroupOutput(ctx *Context, args *GetDeviceGroupOutputArgs, opts ...InvokeOption) GetDeviceGroupResultOutput

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

    public static class GetDeviceGroup 
    {
        public static Task<GetDeviceGroupResult> InvokeAsync(GetDeviceGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetDeviceGroupResult> Invoke(GetDeviceGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDeviceGroupResult> getDeviceGroup(GetDeviceGroupArgs args, InvokeOptions options)
    public static Output<GetDeviceGroupResult> getDeviceGroup(GetDeviceGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zia:getDeviceGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the device group to look up.
    ResourceId int
    The ID of the device group to look up.
    Name string
    The name of the device group to look up.
    ResourceId int
    The ID of the device group to look up.
    name String
    The name of the device group to look up.
    resourceId Integer
    The ID of the device group to look up.
    name string
    The name of the device group to look up.
    resourceId number
    The ID of the device group to look up.
    name str
    The name of the device group to look up.
    resource_id int
    The ID of the device group to look up.
    name String
    The name of the device group to look up.
    resourceId Number
    The ID of the device group to look up.

    getDeviceGroup Result

    The following output properties are available:

    List List<zscaler.PulumiPackage.Zia.Outputs.DeviceGroupItem>
    The list of all device groups when no specific filter is provided.
    Description string
    The description of the device group.
    DeviceCount int
    The number of devices in the group.
    DeviceNames string
    The device names in the group.
    GroupType string
    The type of the device group.
    Name string
    The name of the device group.
    OsType string
    The OS type of the device group.
    Predefined bool
    Whether the device group is predefined.
    ResourceId int
    The ID of the device group.
    List []DeviceGroupItem
    The list of all device groups when no specific filter is provided.
    Description string
    The description of the device group.
    DeviceCount int
    The number of devices in the group.
    DeviceNames string
    The device names in the group.
    GroupType string
    The type of the device group.
    Name string
    The name of the device group.
    OsType string
    The OS type of the device group.
    Predefined bool
    Whether the device group is predefined.
    ResourceId int
    The ID of the device group.
    list List<DeviceGroupItem>
    The list of all device groups when no specific filter is provided.
    description String
    The description of the device group.
    deviceCount Integer
    The number of devices in the group.
    deviceNames String
    The device names in the group.
    groupType String
    The type of the device group.
    name String
    The name of the device group.
    osType String
    The OS type of the device group.
    predefined Boolean
    Whether the device group is predefined.
    resourceId Integer
    The ID of the device group.
    list DeviceGroupItem[]
    The list of all device groups when no specific filter is provided.
    description string
    The description of the device group.
    deviceCount number
    The number of devices in the group.
    deviceNames string
    The device names in the group.
    groupType string
    The type of the device group.
    name string
    The name of the device group.
    osType string
    The OS type of the device group.
    predefined boolean
    Whether the device group is predefined.
    resourceId number
    The ID of the device group.
    list Sequence[DeviceGroupItem]
    The list of all device groups when no specific filter is provided.
    description str
    The description of the device group.
    device_count int
    The number of devices in the group.
    device_names str
    The device names in the group.
    group_type str
    The type of the device group.
    name str
    The name of the device group.
    os_type str
    The OS type of the device group.
    predefined bool
    Whether the device group is predefined.
    resource_id int
    The ID of the device group.
    list List<Property Map>
    The list of all device groups when no specific filter is provided.
    description String
    The description of the device group.
    deviceCount Number
    The number of devices in the group.
    deviceNames String
    The device names in the group.
    groupType String
    The type of the device group.
    name String
    The name of the device group.
    osType String
    The OS type of the device group.
    predefined Boolean
    Whether the device group is predefined.
    resourceId Number
    The ID of the device group.

    Supporting Types

    DeviceGroupItem

    Description string
    DeviceCount int
    DeviceNames string
    GroupType string
    Name string
    OsType string
    Predefined bool
    ResourceId int
    Description string
    DeviceCount int
    DeviceNames string
    GroupType string
    Name string
    OsType string
    Predefined bool
    ResourceId int
    description String
    deviceCount Integer
    deviceNames String
    groupType String
    name String
    osType String
    predefined Boolean
    resourceId Integer
    description string
    deviceCount number
    deviceNames string
    groupType string
    name string
    osType string
    predefined boolean
    resourceId number
    description String
    deviceCount Number
    deviceNames String
    groupType String
    name String
    osType String
    predefined Boolean
    resourceId Number

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
      Try Pulumi Cloud free. Your team will thank you.