Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harbor
  3. API Docs
  4. getGroups
Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

harbor.getGroups

Explore with Pulumi AI

Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

Example Usage

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

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

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>
Copy
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]
Copy
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: harbor:index/getGroups:getGroups
  arguments:
    # arguments dictionary
Copy

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 This property is required. string
The name of the group to filter by.
GroupType This property is required. int
Id This property is required. int
The ID of this resource.
LdapGroupDn This property is required. string
The LDAP group DN to filter by.
GroupName This property is required. string
The name of the group to filter by.
GroupType This property is required. int
Id This property is required. int
The ID of this resource.
LdapGroupDn This property is required. string
The LDAP group DN to filter by.
groupName This property is required. String
The name of the group to filter by.
groupType This property is required. Integer
id This property is required. Integer
The ID of this resource.
ldapGroupDn This property is required. String
The LDAP group DN to filter by.
groupName This property is required. string
The name of the group to filter by.
groupType This property is required. number
id This property is required. number
The ID of this resource.
ldapGroupDn This property is required. string
The LDAP group DN to filter by.
group_name This property is required. str
The name of the group to filter by.
group_type This property is required. int
id This property is required. int
The ID of this resource.
ldap_group_dn This property is required. str
The LDAP group DN to filter by.
groupName This property is required. String
The name of the group to filter by.
groupType This property is required. Number
id This property is required. Number
The ID of this resource.
ldapGroupDn This property is required. 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 v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor