Docs Packages
  1. Packages
  2. Harbor
  3. API Docs
  4. Group
Harbor v3.10.11 published on Wednesday, Jun 19, 2024 by Pulumiverse
pulumiverse/pulumi-harbor

harbor.Group

Explore with Pulumi AI

harbor logo
Harbor v3.10.11 published on Wednesday, Jun 19, 2024 by Pulumiverse
pulumiverse/pulumi-harbor

    Example Usage

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

    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 string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    example, err := harbor.NewGroup(ctx, "groupResource", &harbor.GroupArgs{
	GroupName:   pulumi.String("string"),
	GroupType:   pulumi.Int(0),
	LdapGroupDn: pulumi.String("string"),
})

    var groupResource = new Group("groupResource", GroupArgs.builder()
    .groupName("string")
    .groupType(0)
    .ldapGroupDn("string")
    .build());

    group_resource = harbor.Group("groupResource",
    group_name="string",
    group_type=0,
    ldap_group_dn="string")

    const groupResource = new harbor.Group("groupResource", {
    groupName: "string",
    groupType: 0,
    ldapGroupDn: "string",
});

    type: harbor:Group
properties:
    groupName: string
    groupType: 0
    ldapGroupDn: string

    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

    The Group resource accepts the following input properties:

    GroupName 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 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 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 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 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 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.

    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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 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 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 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 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 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

    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 logo
    Harbor v3.10.11 published on Wednesday, Jun 19, 2024 by Pulumiverse
    pulumiverse/pulumi-harbor