Set-SecretInfo
Aggiunge o sostituisce metadati segreti aggiuntivi a un segreto attualmente archiviato in un insieme di credenziali.
Sintassi
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>]
Descrizione
Questo cmdlet aggiunge informazioni aggiuntive sui metadati a un segreto archiviato. Il supporto dei metadati è una funzionalità facoltativa per un insieme di credenziali delle estensioni. Se un insieme di credenziali non supporta i metadati segreti, il cmdlet restituisce un errore.
I metadati non vengono archiviati in modo sicuro in un insieme di credenziali. I metadati non devono contenere informazioni riservate.
Esempio
Esempio 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 questo esempio vengono aggiunti metadati al segreto archiviato nell'insieme Secret1
Vault1
di credenziali. Get-SecretInfo
recupera i metadati per Secret1
visualizzare i metadati aggiunti.
Esempio 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 questo esempio vengono aggiunti metadati al segreto archiviato nell'insieme Secret2
Vault2
di credenziali. Tuttavia, Vault2
non supporta i metadati. Il comando ha esito negativo e restituisce un errore.
Parametri
-Confirm
Richiede la conferma dell'utente prima di eseguire il cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Metadata
Specifica una tabella hash contenente coppie chiave-valore da associare al segreto nell'insieme di credenziali. L'insieme di credenziali di estensione specificato potrebbe non supportare metadati segreti. Se l'insieme di credenziali non supporta i metadati, l'operazione ha esito negativo e restituisce un errore. I valori di tutti i metadati nella tabella hash devono essere uno dei tipi seguenti:
- string
- int
- DateTime
I metadati non vengono archiviati in modo sicuro in un insieme di credenziali. I metadati non devono contenere informazioni riservate.
Type: | Hashtable |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifica il nome del segreto a cui aggiungere metadati. I caratteri jolly (*
) non sono consentiti.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoClobber
Indica che il comando deve eseguire l'errore se un segreto con lo stesso nome esiste già nell'insieme di credenziali. Per impostazione predefinita, questo cmdlet aggiorna il segreto con il nuovo valore se esiste già.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Secret
Specifica il valore del segreto. Il tipo di oggetto deve essere uno dei tipi supportati:
- Byte[]
- Stringa
- Securestring
- PSCredential
- Hashtable
Type: | Object |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SecretInfo
Specifica un oggetto SecretInformation che descrive un segreto archiviato restituito da Get-SecretInfo
.
Ciò consente di copiare i segreti da un insieme di credenziali di estensione a un altro.
Type: | SecretInformation |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SecureStringSecret
Specifica il valore del segreto come oggetto SecretString .
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Vault
Specifica il nome dell'insieme di credenziali contenente il segreto per aggiungere o aggiornare i metadati. I caratteri jolly (*
) non sono consentiti. Per impostazione predefinita, questo cmdlet cerca il segreto nell'insieme di credenziali predefinito dell'utente corrente.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Mostra l'esito in caso di esecuzione del cmdlet. Il cmdlet non viene eseguito.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Input
Output
None