1. Packages
  2. Unifi
  3. API Docs
  4. getApGroup
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse

unifi.getApGroup

Explore with Pulumi AI

Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse

unifi.getApGroup 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 "@pulumi/unifi";

const default = unifi.getApGroup({});
Copy
import pulumi
import pulumi_unifi as unifi

default = unifi.get_ap_group()
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := unifi.GetApGroup(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumi.Unifi;

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

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.UnifiFunctions;
import com.pulumi.unifi.inputs.GetApGroupArgs;
import java.util.List;
import java.util.ArrayList;
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 = UnifiFunctions.getApGroup();

    }
}
Copy
variables:
  default:
    fn::invoke:
      Function: unifi:getApGroup
      Arguments: {}
Copy

Using getApGroup

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 getApGroup(args: GetApGroupArgs, opts?: InvokeOptions): Promise<GetApGroupResult>
function getApGroupOutput(args: GetApGroupOutputArgs, opts?: InvokeOptions): Output<GetApGroupResult>
Copy
def get_ap_group(name: Optional[str] = None,
                 site: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetApGroupResult
def get_ap_group_output(name: Optional[pulumi.Input[str]] = None,
                 site: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetApGroupResult]
Copy
func GetApGroup(ctx *Context, args *GetApGroupArgs, opts ...InvokeOption) (*GetApGroupResult, error)
func GetApGroupOutput(ctx *Context, args *GetApGroupOutputArgs, opts ...InvokeOption) GetApGroupResultOutput
Copy

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

public static class GetApGroup 
{
    public static Task<GetApGroupResult> InvokeAsync(GetApGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetApGroupResult> Invoke(GetApGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApGroupResult> getApGroup(GetApGroupArgs args, InvokeOptions options)
public static Output<GetApGroupResult> getApGroup(GetApGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: unifi:index/getApGroup:getApGroup
  arguments:
    # arguments dictionary
Copy

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 site the AP group is associated with.
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 site the AP group is associated with.
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 site the AP group is associated with.
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 site the AP group is associated with.
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 site the AP group is associated with.
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 site the AP group is associated with.

getApGroup Result

The following output properties are available:

Id string
The ID of this AP group.
Site string
The name of the site the AP group is associated with.
Name string
The name of the AP group to look up, leave blank to look up the default AP group.
Id string
The ID of this AP group.
Site string
The name of the site the AP group is associated with.
Name string
The name of the AP group to look up, leave blank to look up the default AP group.
id String
The ID of this AP group.
site String
The name of the site the AP group is associated with.
name String
The name of the AP group to look up, leave blank to look up the default AP group.
id string
The ID of this AP group.
site string
The name of the site the AP group is associated with.
name string
The name of the AP group to look up, leave blank to look up the default AP group.
id str
The ID of this AP group.
site str
The name of the site the AP group is associated with.
name str
The name of the AP group to look up, leave blank to look up the default AP group.
id String
The ID of this AP group.
site String
The name of the site the AP group is associated with.
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 v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse