Get-DSVaultPermission
2025-01-30
Get-DSVaultPermission
SYNOPSIS
Get the vault permissions.
SYNTAX
__AllParameterSets
Get-DSVaultPermission [-VaultID] <guid> -PrincipalTypes <string[]> [-AsLegacyResponse]
[<CommonParameters>]
ALIASES
This cmdlet has the following aliases,
DESCRIPTION
Get the vault permissions.
EXAMPLES
EXAMPLE
PS C:> $response = Get-DSVaultPermission -VaultID $vaultID -PrincipalType Applications; $apps = response.Data | Select Name, Description, IsMember; Set-DSVaultApplication -VaultID $vaultID -AllowedApplicationsList $apps[1].Name,$apps[3].Name -Update
Fetch all the applications for the vault $vaultID and keep only their name, description and isMember attributes. Update the second and fourth applications of the list, changing their membership status.
PARAMETERS
-AsLegacyResponse
In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-PrincipalTypes
Specify the type of users.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-VaultID
Specify the ID of the desired vault.
Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 0
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
For more information, type "Get-Help Get-DSVaultPermission -detailed". For technical information, type "Get-Help Get-DSVaultPermission -full".