Remove-SqlCredential

语法

ByPath （默认值）

Remove-SqlCredential
    [-Path] <String[]>
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject

Remove-SqlCredential
    [-InputObject] <Credential[]>
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

示例

Example 1: Remove a SQL credential

PS C:\> Remove-SqlCredential -Path "SQLSERVER:\SQL\Computer\Instance\Credentials\MySqlCredential"

Example 2: Remove a SQL credential through input pipe

PS C:\> $Cred = Get-SqlCredential -Name MySqlCredential -Path "SQLSERVER:\SQL\Computer\Instance\Credentials\MySqlCredential"
PS C:\> $Cred | Remove-SqlCredential

参数

-AccessToken

The access token used to authenticate to SQL Server, as an alternative to user/password or Windows Authentication.

This can be used, for example, to connect to SQL Azure DB and SQL Azure Managed Instance using a Service Principal or a Managed Identity.

The parameter to use can be either a string representing the token or a PSAccessToken object as returned by running Get-AzAccessToken -ResourceUrl https://database.windows.net.

This parameter is new in v22 of the module.

参数属性

参数集

-Confirm

Prompts you for confirmation before running the cmdlet.

参数属性

参数集

-Encrypt

The encryption type to use when connecting to SQL Server.

This value maps to the Encrypt property SqlConnectionEncryptOption on the SqlConnection object of the Microsoft.Data.SqlClient driver.

In v22 of the module, the default is Optional (for compatibility with v21). In v23+ of the module, the default value will be 'Mandatory', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

参数属性

参数集

-HostNameInCertificate

The host name to be used in validating the SQL Server TLS/SSL certificate. You must pass this parameter if your SQL Server instance is enabled for Force Encryption and you want to connect to an instance using hostname/shortname. If this parameter is omitted then passing the Fully Qualified Domain Name (FQDN) to -ServerInstance is necessary to connect to a SQL Server instance enabled for Force Encryption.

This parameter is new in v22 of the module.

参数属性

参数集

-InputObject

Specifies an input credential object, as an array. You can use the Get-SqlCredential to get the object.

参数属性

参数集

-Path

Specifies the path of the credential, as an array, on which this cmdlet performs this operation. For instance, SQLSERVER:\SQL\Computer\Instance\Credentials\Credential.

参数属性

参数集

-Script

Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.

参数属性

参数集

-TrustServerCertificate

Indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.

In v22 of the module, the default is $true (for compatibility with v21). In v23+ of the module, the default value will be '$false', which may create a breaking change for existing scripts.

This parameter is new in v22 of the module.

参数属性

参数集

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

参数属性

参数集

CommonParameters

输入

Microsoft.SqlServer.Management.Smo.Credential

相关链接

• Get-SqlCredential
• New-SqlCredential
• Set-SqlCredential