Set-SqlCredential

Синтаксис

ByPath (по умолчанию)

Set-SqlCredential
    [-Identity] <String>
    [[-Secret] <SecureString>]
    [[-Path] <String>]
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObject

Set-SqlCredential
    [-Identity] <String>
    [[-Secret] <SecureString>]
    [-InputObject] <Credential>
    [-Script]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Примеры

Example 1: Set the identity of a SQL credential object

PS C:\> Set-SqlCredential -Path SQLSERVER:\SQL\Computer\Instance\Credentials\MySqlCredential -Identity "MyStorageAccount"

Example 2: Set the identity of a SQL credential object using the pipeline

PS C:\> $Cred = Get-SqlCredential -Name "MySqlCredential"
PS C:\> $Cred | Set-SqlCredential -Identity "MyStorageAccount"

Example 3: Set the identity of a SQL credential object prompting the user

PS C:\> $Secret = Read-Host "Please enter the storage account access key"
PS C:\> Set-SqlCredential -Identity "MyStorageAccount" -Secret $Secret

Параметры

-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.

Свойства параметра

Наборы параметров

-Identity

Specifies the user or account name for the resource SQL Server needs to authenticate to. For Windows Azure storage service, this is the name of the Windows Azure storage account.

Свойства параметра

Наборы параметров

-InputObject

Specifies an input Credential object. To get this object, use the Get-SqlCredential cmdlet.

Свойства параметра

Наборы параметров

-Path

Specifies the path to the credential 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.

Свойства параметра

Наборы параметров

-Secret

Specifies the password for the user or account. For Windows Azure storage service, this is the access key value for the Windows Azure storage account.

Свойства параметра

Наборы параметров

-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