| external help file | Module Name | online version | schema |
|---|---|---|---|
Microsoft.PowerShell.SecretManagement.dll-Help.xml |
Microsoft.PowerShell.SecretManagement |
2.0.0 |
Adds or replaces additional secret metadata to a secret currently stored in a vault.
Set-SecretInfo [-Name] <String> [-Metadata] <Hashtable> [[-Vault] <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-SecretInfo [-Metadata] <Hashtable> -InputObject <SecretInformation> [-WhatIf] [-Confirm]
[<CommonParameters>]
This cmdlet adds additional secret metadata to an existing secret. Metadata support is an optional feature for an extension vault. An error will be thrown if a vault does not support secret metadata. Metadata is a Hashtable object containing Name/Value pairs. The value type is restricted to the following:
- string
- int
- DateTime
Metadata is not stored securely in a vault. Metadata should not contain sensitive information.
PS C:\> Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }
PS C:\> Get-SecretInfo -Name Secret1 -Vault Vault1 | Select-Object Name,Metadata
Name Metadata
---- --------
Secret1 {[Expiration, 5/1/2022 12:00:00 AM]}This example adds metadata to the 'Secret1' secret stored in 'Vault1' vault. The metadata is then retrieved for 'Secret1' using the 'Get-SecretInfo' command.
PS C:\> Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Set-SecretInfo: Cannot set secret metadata Secret2. Vault Vault2 does not support secret metadata.This example adds metadata to the 'Secret2' secret stored in 'Vault2' vault. However, Vault2 does not support metadata and an error is generated.
PS C:\> Get-SecretInfo -Name Secret3 | Set-SecretInfo -Metadata @{ Created = (Get-Date) }This example pipes a SecretInformation object to the 'Set-SecretInfo' command and adds metadata to the associated secret.
This parameter takes a SecretInformation object that defines the secret to be updated.
Type: SecretInformation
Parameter Sets: InfoParameterSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseHashtable containing Name/Value pair that are stored in the vault. The specified extension vault may not support secret metadata, in which case the operation will fail. The metadata Name/Value value type must be one of the following:
- string
- int
- DateTime
Type: Hashtable
Parameter Sets: NameParameterSet
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseType: Hashtable
Parameter Sets: InfoParameterSet
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseName of secret for which the metadata is added.
Type: String
Parameter Sets: NameParameterSet
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional name of vault to which the secret is added. If omitted, the secret will be added to the default vault.
Type: String
Parameter Sets: NameParameterSet
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.