Unifi v0.0.3 published on Monday, Dec 5, 2022 by Pulumiverse
unifi.iam.getGroup
Explore with Pulumi AI
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>
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]
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: unifi:iam/getGroup:getGroup
arguments:
# arguments dictionary
The following arguments are supported:
getGroup Result
The following output properties are available:
- Id string
- The ID of this AP group.
- Qos
Rate intMax Down - Qos
Rate intMax Up - 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.
- Qos
Rate intMax Down - Qos
Rate intMax Up - 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.
- qos
Rate IntegerMax Down - qos
Rate IntegerMax Up - 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.
- qos
Rate numberMax Down - qos
Rate numberMax Up - 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_ intmax_ down - qos_
rate_ intmax_ up - 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.
- qos
Rate NumberMax Down - qos
Rate NumberMax Up - 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.