Set-PSUSecretVault

Update a model-backed Azure Key Vault registration in PowerShell Universal.

SYNOPSIS

Updates a model-backed secret vault registration.

SYNTAX

Set-PSUSecretVault -Id <Int64> [<VaultOptions>] [<ConnectionOptions>] [<CommonParameters>]
Set-PSUSecretVault -Name <String> [<VaultOptions>] [<ConnectionOptions>] [<CommonParameters>]
Set-PSUSecretVault -Vault <Vault> [<VaultOptions>] [<ConnectionOptions>] [<CommonParameters>]

<VaultOptions>: [-NewName <String>] [-Type <String>] [-Description <String>] [-VaultUri <String>] [-AuthenticationType <VaultAuthenticationType>] [-TenantId <String>] [-ClientId <String>] [-ClientSecretVariable <String>] [-ManagedIdentityClientId <String>]. <ConnectionOptions>: [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies].

DESCRIPTION

Updates a vault registration by numeric ID, name, or vault object from the pipeline. Only supplied properties change. -Name selects the existing vault; use -NewName to rename it (an empty new name is rejected). Configure the vault URI and authentication settings without writing client secret values into vault configuration: supply the name of a PSU secret variable instead.

EXAMPLES

Set-PSUSecretVault -Name 'Production Key Vault' `
    -VaultUri 'https://prod2.vault.azure.net/'

Get-PSUSecretVault -Name 'Production Key Vault' |
    Set-PSUSecretVault -AuthenticationType ManagedIdentity `
        -ManagedIdentityClientId '11111111-1111-1111-1111-111111111111'

PARAMETERS

Parameter	Description
-Id	Numeric registration ID.
-Name	Existing registration name (not the new name).
-Vault	Vault object; accepts pipeline input.
-NewName	New nonempty registration name.
-Type	Vault provider type (Azure Key Vault uses AzureKeyVault).
-Description	New registration description.
-VaultUri	New Azure Key Vault URI.
-AuthenticationType	Authentication mode: Default, ManagedIdentity, or ClientSecret.
-TenantId	Entra ID tenant ID for client-secret authentication.
-ClientId	Entra ID application client ID for client-secret authentication.
-ClientSecretVariable	Name of the PSU secret variable holding the application client secret.
-ManagedIdentityClientId	Client ID for a user-assigned managed identity.
-ComputerName	PSU Management API URL or host name (alias -Uri).
-AppToken	Management API app token.
-Credential	Management API credentials.
-UseDefaultCredentials	Uses current Windows credentials.
-Integrated	Uses the in-process management client.
-TrustCertificate	Ignores certificate validation errors.
-Cookies	Reuses session authentication cookies.

OUTPUTS

PowerShellUniversal.Vault.

RELATED LINKS

Get-PSUSecretVault · New-PSUSecretVault · Remove-PSUSecretVault

PERMISSIONS

The access token requires platform.vaults/update to run this cmdlet remotely.