1. Packages
  2. Harbor
  3. API Docs
  4. getGroups
Viewing docs for Harbor v3.10.21
published on Monday, Jun 30, 2025 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-harbor

harbor.getGroups

harbor logo
Viewing docs for Harbor v3.10.21
published on Monday, Jun 30, 2025 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-harbor

    Example Usage

    data "harbor_groups" "example" {
  group_name = "example-group"
}

output "group_ids" {
  value = [data.harbor_groups.example.*.id]
}

    Using getGroups

    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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>
    def get_groups(group_name: Optional[str] = None,
               ldap_group_dn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(group_name: Optional[pulumi.Input[str]] = None,
               ldap_group_dn: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
    func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

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

    public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: harbor:index/getGroups:getGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GroupName string
    The name of the group to filter by.
    LdapGroupDn string
    The LDAP group DN to filter by.
    GroupName string
    The name of the group to filter by.
    LdapGroupDn string
    The LDAP group DN to filter by.
    groupName String
    The name of the group to filter by.
    ldapGroupDn String
    The LDAP group DN to filter by.
    groupName string
    The name of the group to filter by.
    ldapGroupDn string
    The LDAP group DN to filter by.
    group_name str
    The name of the group to filter by.
    ldap_group_dn str
    The LDAP group DN to filter by.
    groupName String
    The name of the group to filter by.
    ldapGroupDn String
    The LDAP group DN to filter by.

    getGroups Result

    The following output properties are available:

    Groups List<Pulumiverse.Harbor.Outputs.GetGroupsGroup>
    Id string
    The provider-assigned unique ID for this managed resource.
    GroupName string
    The name of the group to filter by.
    LdapGroupDn string
    The LDAP group DN to filter by.
    Groups []GetGroupsGroup
    Id string
    The provider-assigned unique ID for this managed resource.
    GroupName string
    The name of the group to filter by.
    LdapGroupDn string
    The LDAP group DN to filter by.
    groups List<GetGroupsGroup>
    id String
    The provider-assigned unique ID for this managed resource.
    groupName String
    The name of the group to filter by.
    ldapGroupDn String
    The LDAP group DN to filter by.
    groups GetGroupsGroup[]
    id string
    The provider-assigned unique ID for this managed resource.
    groupName string
    The name of the group to filter by.
    ldapGroupDn string
    The LDAP group DN to filter by.
    groups Sequence[GetGroupsGroup]
    id str
    The provider-assigned unique ID for this managed resource.
    group_name str
    The name of the group to filter by.
    ldap_group_dn str
    The LDAP group DN to filter by.
    groups List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    groupName String
    The name of the group to filter by.
    ldapGroupDn String
    The LDAP group DN to filter by.

    Supporting Types

    GetGroupsGroup

    GroupName string
    The name of the group to filter by.
    GroupType int
    Id int
    The ID of this resource.
    LdapGroupDn string
    The LDAP group DN to filter by.
    GroupName string
    The name of the group to filter by.
    GroupType int
    Id int
    The ID of this resource.
    LdapGroupDn string
    The LDAP group DN to filter by.
    groupName String
    The name of the group to filter by.
    groupType Integer
    id Integer
    The ID of this resource.
    ldapGroupDn String
    The LDAP group DN to filter by.
    groupName string
    The name of the group to filter by.
    groupType number
    id number
    The ID of this resource.
    ldapGroupDn string
    The LDAP group DN to filter by.
    group_name str
    The name of the group to filter by.
    group_type int
    id int
    The ID of this resource.
    ldap_group_dn str
    The LDAP group DN to filter by.
    groupName String
    The name of the group to filter by.
    groupType Number
    id Number
    The ID of this resource.
    ldapGroupDn String
    The LDAP group DN to filter by.

    Package Details

    Repository
    harbor pulumiverse/pulumi-harbor
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harbor Terraform Provider.
    harbor logo
    Viewing docs for Harbor v3.10.21
    published on Monday, Jun 30, 2025 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-harbor
      Try Pulumi Cloud free. Your team will thank you.