getGroup

Using getGroup

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
def get_group(alias_id: Optional[str] = None,
              alias_mount_accessor: Optional[str] = None,
              alias_name: Optional[str] = None,
              group_id: Optional[str] = None,
              group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)

Note: This function is named LookupGroup in the Go SDK.

public static class GetGroup {
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

AliasId string
ID of the alias.
AliasMountAccessor string
Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
AliasName string
Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
GroupId string
ID of the group.
GroupName string
Name of the group.
AliasId string
ID of the alias.
AliasMountAccessor string
Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
AliasName string
Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
GroupId string
ID of the group.
GroupName string
Name of the group.
aliasId string
ID of the alias.
aliasMountAccessor string
Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
aliasName string
Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
groupId string
ID of the group.
groupName string
Name of the group.
alias_id str
ID of the alias.
alias_mount_accessor str
Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
alias_name str
Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
group_id str
ID of the group.
group_name str
Name of the group.

getGroup Result

The following output properties are available:

AliasCanonicalId string
Canonical ID of the Alias
AliasCreationTime string
Creation time of the Alias
AliasId string
AliasLastUpdateTime string
Last update time of the alias
AliasMergedFromCanonicalIds List<string>
List of canonical IDs merged with this alias
AliasMetadata Dictionary<string, object>
Arbitrary metadata
AliasMountAccessor string
AliasMountPath string
Authentication mount path which this alias belongs to
AliasMountType string
Authentication mount type which this alias belongs to
AliasName string
CreationTime string
Creation timestamp of the group
DataJson string
A string containing the full data payload retrieved from Vault, serialized in JSON format.
GroupId string
GroupName string
Id string
The provider-assigned unique ID for this managed resource.
LastUpdateTime string
Last updated time of the group
MemberEntityIds List<string>
List of Entity IDs which are members of this group
MemberGroupIds List<string>
List of Group IDs which are members of this group
Metadata Dictionary<string, object>
Arbitrary metadata
ModifyIndex int
Modify index of the group
NamespaceId string
Namespace of which the group is part of
ParentGroupIds List<string>
List of Group IDs which are parents of this group.
Policies List<string>
List of policies attached to the group
Type string
Type of group
AliasCanonicalId string
Canonical ID of the Alias
AliasCreationTime string
Creation time of the Alias
AliasId string
AliasLastUpdateTime string
Last update time of the alias
AliasMergedFromCanonicalIds []string
List of canonical IDs merged with this alias
AliasMetadata map[string]interface{}
Arbitrary metadata
AliasMountAccessor string
AliasMountPath string
Authentication mount path which this alias belongs to
AliasMountType string
Authentication mount type which this alias belongs to
AliasName string
CreationTime string
Creation timestamp of the group
DataJson string
A string containing the full data payload retrieved from Vault, serialized in JSON format.
GroupId string
GroupName string
Id string
The provider-assigned unique ID for this managed resource.
LastUpdateTime string
Last updated time of the group
MemberEntityIds []string
List of Entity IDs which are members of this group
MemberGroupIds []string
List of Group IDs which are members of this group
Metadata map[string]interface{}
Arbitrary metadata
ModifyIndex int
Modify index of the group
NamespaceId string
Namespace of which the group is part of
ParentGroupIds []string
List of Group IDs which are parents of this group.
Policies []string
List of policies attached to the group
Type string
Type of group
aliasCanonicalId string
Canonical ID of the Alias
aliasCreationTime string
Creation time of the Alias
aliasId string
aliasLastUpdateTime string
Last update time of the alias
aliasMergedFromCanonicalIds string[]
List of canonical IDs merged with this alias
aliasMetadata {[key: string]: any}
Arbitrary metadata
aliasMountAccessor string
aliasMountPath string
Authentication mount path which this alias belongs to
aliasMountType string
Authentication mount type which this alias belongs to
aliasName string
creationTime string
Creation timestamp of the group
dataJson string
A string containing the full data payload retrieved from Vault, serialized in JSON format.
groupId string
groupName string
id string
The provider-assigned unique ID for this managed resource.
lastUpdateTime string
Last updated time of the group
memberEntityIds string[]
List of Entity IDs which are members of this group
memberGroupIds string[]
List of Group IDs which are members of this group
metadata {[key: string]: any}
Arbitrary metadata
modifyIndex number
Modify index of the group
namespaceId string
Namespace of which the group is part of
parentGroupIds string[]
List of Group IDs which are parents of this group.
policies string[]
List of policies attached to the group
type string
Type of group
alias_canonical_id str
Canonical ID of the Alias
alias_creation_time str
Creation time of the Alias
alias_id str
alias_last_update_time str
Last update time of the alias
alias_merged_from_canonical_ids Sequence[str]
List of canonical IDs merged with this alias
alias_metadata Mapping[str, Any]
Arbitrary metadata
alias_mount_accessor str
alias_mount_path str
Authentication mount path which this alias belongs to
alias_mount_type str
Authentication mount type which this alias belongs to
alias_name str
creation_time str
Creation timestamp of the group
data_json str
A string containing the full data payload retrieved from Vault, serialized in JSON format.
group_id str
group_name str
id str
The provider-assigned unique ID for this managed resource.
last_update_time str
Last updated time of the group
member_entity_ids Sequence[str]
List of Entity IDs which are members of this group
member_group_ids Sequence[str]
List of Group IDs which are members of this group
metadata Mapping[str, Any]
Arbitrary metadata
modify_index int
Modify index of the group
namespace_id str
Namespace of which the group is part of
parent_group_ids Sequence[str]
List of Group IDs which are parents of this group.
policies Sequence[str]
List of policies attached to the group
type str
Type of group

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.