Remove-RefreshDBPoolApiKey

SYNOPSIS

This function removes the DBPool API key to the default PowerShell SecretManagement vault.

SYNTAX

Remove-RefreshDBPoolApiKey [[-SecretName] <String>] [[-SecretStoreName] <String>] [-Force] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

This function removes the DBPool API key from the specified SecretManagement vault.

EXAMPLES

EXAMPLE 1

Removes the API key from the SecretManagement vault.

Remove-RefreshDBPoolApiKey

EXAMPLE 2

Removes the API key from the 'Custom_SecretsVault' SecretManagement vault with the name 'Different_SecretName'.

Remove-RefreshDBPoolApiKey -SecretName 'Different_SecretName' -SecretStoreName 'Custom_SecretsVault' -Force

PARAMETERS

-SecretName

The name to use for the secret in the SecretManagement vault. Defaults to 'DBPool_ApiKey'.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: DBPool_ApiKey
Accept pipeline input: False
Accept wildcard characters: False

-SecretStoreName

The name of the SecretManagement vault where the secret is stored. Defaults to the value of the environment variable 'Datto_SecretStore'.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: Datto_SecretStore
Accept pipeline input: False
Accept wildcard characters: False

-Force

If specified, forces the function to remove the secret from the vault.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows 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: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

N/A

OUTPUTS

N/A

NOTES

N/A

https://datto-dbpool-refresh.kentsapp.com/Internal/apiKey/Remove-RefreshDBPoolApiKey/