Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Unifi
  3. API Docs
  4. iam
  5. getGroup
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
pulumiverse/pulumi-unifi

unifi.iam.getGroup

Explore with Pulumi AI

Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
pulumiverse/pulumi-unifi

unifi.iam.Group data source can be used to retrieve the ID for a user group by name.

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

> 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)
}
Copy
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: unifi:iam/getGroup:getGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name string
The name of the user group to look up. Defaults to Default.
Site string
The name of the site the user group is associated with.
Name string
The name of the user group to look up. Defaults to Default.
Site string
The name of the site the user group is associated with.
name String
The name of the user group to look up. Defaults to Default.
site String
The name of the site the user group is associated with.
name string
The name of the user group to look up. Defaults to Default.
site string
The name of the site the user group is associated with.
name str
The name of the user group to look up. Defaults to Default.
site str
The name of the site the user group is associated with.
name String
The name of the user group to look up. Defaults to Default.
site String
The name of the site the user group is associated with.

getGroup Result

The following output properties are available:

Id string
The ID of this AP group.
QosRateMaxDown int
QosRateMaxUp int
Site string
The name of the site the user group is associated with.
Name string
The name of the user group to look up. Defaults to Default.
Id string
The ID of this AP group.
QosRateMaxDown int
QosRateMaxUp int
Site string
The name of the site the user group is associated with.
Name string
The name of the user group to look up. Defaults to Default.
id String
The ID of this AP group.
qosRateMaxDown Integer
qosRateMaxUp Integer
site String
The name of the site the user group is associated with.
name String
The name of the user group to look up. Defaults to Default.
id string
The ID of this AP group.
qosRateMaxDown number
qosRateMaxUp number
site string
The name of the site the user group is associated with.
name string
The name of the user group to look up. Defaults to Default.
id str
The ID of this AP group.
qos_rate_max_down int
qos_rate_max_up int
site str
The name of the site the user group is associated with.
name str
The name of the user group to look up. Defaults to Default.
id String
The ID of this AP group.
qosRateMaxDown Number
qosRateMaxUp Number
site String
The name of the site the user group is associated with.
name String
The name of the user group to look up. Defaults to Default.

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
pulumiverse/pulumi-unifi