Delen via

Set-SecretInfo

  • Referentie
Module:
Microsoft.PowerShell.SecretManagement

Voegt extra geheime metagegevens toe of vervangt deze aan een geheim dat momenteel is opgeslagen in een kluis.

Syntaxis

Set-SecretInfo
   [-Name] <String>
   -SecureStringSecret <SecureString>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SecretInfo
   [-Name] <String>
   -Secret <Object>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SecretInfo
   -SecretInfo <SecretInformation>
   [-Vault] <String>
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Deze cmdlet voegt aanvullende metagegevensgegevens toe aan een opgeslagen geheim. Ondersteuning voor metagegevens is een optionele functie voor een extensiekluis. Als een kluis geen ondersteuning biedt voor geheime metagegevens, retourneert de cmdlet een fout.

Metagegevens worden niet veilig opgeslagen in een kluis. Metagegevens mogen geen gevoelige informatie bevatten.

Voorbeelden

Voorbeeld 1

Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Get-SecretInfo -Name Secret1 -Vault Vault1 | Select-Object Name,Metadata

Name         Metadata
----         --------
Secret1 {[Expiration, 5/1/2022 12:00:00 AM]}

In dit voorbeeld worden metagegevens toegevoegd aan het Secret1 geheim dat is opgeslagen in Vault1 kluis. Get-SecretInfo haalt de metagegevens voor Secret1 op om de toegevoegde metagegevens weer te geven.

Voorbeeld 2

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.

In dit voorbeeld worden metagegevens toegevoegd aan het Secret2 geheim dat is opgeslagen in Vault2 kluis. Vault2 biedt echter geen ondersteuning voor metagegevens. De opdracht mislukt en retourneert een fout.

Parameters

-Confirm

U wordt gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Metadata

Hiermee geeft u een Hashtable met sleutel-waardeparen te koppelen aan het geheim in de kluis. De opgegeven extensiekluis biedt mogelijk geen ondersteuning voor geheime metagegevens. Als de kluis geen ondersteuning biedt voor metagegevens, mislukt de bewerking en wordt er een fout geretourneerd. De waarden van metagegevens in de hashtabel moeten een van de volgende typen zijn:

  • tekenreeks
  • DateTime-

Metagegevens worden niet veilig opgeslagen in een kluis. Metagegevens mogen geen gevoelige informatie bevatten.

Type:Hashtable
Position:1
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Name

Hiermee geeft u de naam van het geheim waaraan metagegevens moeten worden toegevoegd. Jokertekens (*) zijn niet toegestaan.

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-NoClobber

Geeft aan dat de opdracht een fout moet uitvoeren als er al een geheim met dezelfde naam bestaat in de kluis. Deze cmdlet werkt standaard het geheim bij met de nieuwe waarde als deze al bestaat.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Secret

Hiermee geeft u de waarde van het geheim. Het objecttype moet een van de ondersteunde typen zijn:

  • Byte[]
  • tekenreeks
  • SecureString-
  • PSCredential-
  • Hashtable-
Type:Object
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SecretInfo

Hiermee geeft u een SecretInformation object dat een opgeslagen geheim beschrijft dat wordt geretourneerd door Get-SecretInfo. Hierdoor kunnen geheimen van de ene extensiekluis naar de andere worden gekopieerd.

Type:SecretInformation
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SecureStringSecret

Hiermee geeft u de waarde van het geheim op als een SecretString-object.

Type:SecureString
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Vault

Hiermee geeft u de naam op van de kluis die het geheim bevat om de metagegevens voor toe te voegen of bij te werken. Jokertekens (*) zijn niet toegestaan. Deze cmdlet zoekt standaard naar het geheim in de standaardkluis van de huidige gebruiker.

Type:String
Position:2
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-WhatIf

Toont wat er zou gebeuren als de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

Hashtable

Uitvoerwaarden

None