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

harbor.Group

Explore with Pulumi AI

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

Example Usage

resource "harbor_group" "storage-group" {
  group_name = "storage-group"
  group_type = 3
  ldap_group_dn = "storage-group"
}
Copy

Create Group Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_name: Optional[str] = None,
          group_type: Optional[int] = None,
          ldap_group_dn: Optional[str] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: harbor:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var groupResource = new Harbor.Group("groupResource", new()
{
    GroupName = "string",
    GroupType = 0,
    LdapGroupDn = "string",
});
Copy
example, err := harbor.NewGroup(ctx, "groupResource", &harbor.GroupArgs{
	GroupName:   pulumi.String("string"),
	GroupType:   pulumi.Int(0),
	LdapGroupDn: pulumi.String("string"),
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .groupName("string")
    .groupType(0)
    .ldapGroupDn("string")
    .build());
Copy
group_resource = harbor.Group("groupResource",
    group_name="string",
    group_type=0,
    ldap_group_dn="string")
Copy
const groupResource = new harbor.Group("groupResource", {
    groupName: "string",
    groupType: 0,
    ldapGroupDn: "string",
});
Copy
type: harbor:Group
properties:
    groupName: string
    groupType: 0
    ldapGroupDn: string
Copy

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Group resource accepts the following input properties:

GroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the group.
GroupType This property is required. int
  1. Note: group type 3 is OIDC group.
LdapGroupDn string
The distinguished name of the group within AD/LDAP.
GroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the group.
GroupType This property is required. int
  1. Note: group type 3 is OIDC group.
LdapGroupDn string
The distinguished name of the group within AD/LDAP.
groupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the group.
groupType This property is required. Integer
  1. Note: group type 3 is OIDC group.
ldapGroupDn String
The distinguished name of the group within AD/LDAP.
groupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the group.
groupType This property is required. number
  1. Note: group type 3 is OIDC group.
ldapGroupDn string
The distinguished name of the group within AD/LDAP.
group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the group.
group_type This property is required. int
  1. Note: group type 3 is OIDC group.
ldap_group_dn str
The distinguished name of the group within AD/LDAP.
groupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the group.
groupType This property is required. Number
  1. Note: group type 3 is OIDC group.
ldapGroupDn String
The distinguished name of the group within AD/LDAP.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_name: Optional[str] = None,
        group_type: Optional[int] = None,
        ldap_group_dn: Optional[str] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
resources:  _:    type: harbor:Group    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
GroupName Changes to this property will trigger replacement. string
The name of the group.
GroupType int
  1. Note: group type 3 is OIDC group.
LdapGroupDn string
The distinguished name of the group within AD/LDAP.
GroupName Changes to this property will trigger replacement. string
The name of the group.
GroupType int
  1. Note: group type 3 is OIDC group.
LdapGroupDn string
The distinguished name of the group within AD/LDAP.
groupName Changes to this property will trigger replacement. String
The name of the group.
groupType Integer
  1. Note: group type 3 is OIDC group.
ldapGroupDn String
The distinguished name of the group within AD/LDAP.
groupName Changes to this property will trigger replacement. string
The name of the group.
groupType number
  1. Note: group type 3 is OIDC group.
ldapGroupDn string
The distinguished name of the group within AD/LDAP.
group_name Changes to this property will trigger replacement. str
The name of the group.
group_type int
  1. Note: group type 3 is OIDC group.
ldap_group_dn str
The distinguished name of the group within AD/LDAP.
groupName Changes to this property will trigger replacement. String
The name of the group.
groupType Number
  1. Note: group type 3 is OIDC group.
ldapGroupDn String
The distinguished name of the group within AD/LDAP.

Import

$ pulumi import harbor:index/group:Group storage-group /usergroups/19
Copy

To learn more about importing existing cloud resources, see Importing resources.

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