Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Unifi
  4. API Docs
  5. ap
  6. getGroup
Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

unifi.ap.getGroup

unifi logo
Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

    The unifi.ap.Group data source can be used to retrieve the ID for an AP group by name.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";

const _default = unifi.ap.getGroup({});

    import pulumi
import pulumi_unifi as unifi

default = unifi.ap.get_group()

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/ap"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ap.LookupGroup(ctx, &ap.LookupGroupArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumiverse.Unifi;

return await Deployment.RunAsync(() => 
{
    var @default = Unifi.Ap.GetGroup.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.ap.ApFunctions;
import com.pulumi.unifi.ap.inputs.GetGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = ApFunctions.getGroup(GetGroupArgs.builder()
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      function: unifi:ap:getGroup
      arguments: {}

    pulumi {
  required_providers {
    unifi = {
      source = "pulumi/unifi"
    }
  }
}

data "unifi_ap_getgroup" "default" {
}

    Using getGroup

    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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
    def get_group(name: Optional[str] = None,
              site: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(name: pulumi.Input[Optional[str]] = None,
              site: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
    func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

    public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: unifi:ap/getGroup:getGroup
  arguments:
    # arguments dictionary
    data "unifi_ap_get_group" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name String
    The name of the AP group to look up, leave blank to look up the default AP group.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name str
    The name of the AP group to look up, leave blank to look up the default AP group.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name String
    The name of the AP group to look up, leave blank to look up the default AP group.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

    getGroup Result

    The following output properties are available:

    Id string
    The unique identifier of this resource.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    Id string
    The unique identifier of this resource.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    id string
    The unique identifier of this resource.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    id String
    The unique identifier of this resource.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name String
    The name of the AP group to look up, leave blank to look up the default AP group.
    id string
    The unique identifier of this resource.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name string
    The name of the AP group to look up, leave blank to look up the default AP group.
    id str
    The unique identifier of this resource.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name str
    The name of the AP group to look up, leave blank to look up the default AP group.
    id String
    The unique identifier of this resource.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    name String
    The name of the AP group to look up, leave blank to look up the default AP group.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Viewing docs for Unifi v0.3.0
    published on Wednesday, Jul 8, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-unifi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial