New-AzVMSqlServerKeyVaultCredentialConfig

Creates a configuration object for SQL server key vault credential on a virtual machine.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzVMSqlServerKeyVaultCredentialConfig
   [-ResourceGroupName] <String>
   [-Enable]
   [-CredentialName <String>]
   [-AzureKeyVaultUrl <String>]
   [-ServicePrincipalName <String>]
   [-ServicePrincipalSecret <SecureString>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzVMSqlServerKeyVaultCredentialConfig cmdlet creates a configuration object for SQL server key vault credential on a virtual machine.

Examples

Example 1

New-AzVMSqlServerKeyVaultCredentialConfig -ResourceGroupName "ResourceGroup11" -Enable -AzureKeyVaultUrl https://myvault.vault.azure.net/ -CredentialName test1

ResourceGroupName      : ResourceGroup11
Enable                 : True
CredentialName         : test1
AzureKeyVaultUrl       : https://myvault.vault.azure.net/
ServicePrincipalName   :
ServicePrincipalSecret :
Credentials            :

Parameters

-AzureKeyVaultUrl

Azure Key Vault service URL

Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-CredentialName
Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Enable
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ResourceGroupName
Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ServicePrincipalName
Type:String
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ServicePrincipalSecret
Type:SecureString
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

SwitchParameter

SecureString

Outputs

KeyVaultCredentialSettings