New-AzVMSqlServerKeyVaultCredentialConfig

Module:

Az.Compute Module

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

Syntax

Default (Default)

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CredentialName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Enable

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ResourceGroupName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ServicePrincipalName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ServicePrincipalSecret

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

Parameter properties

Type:	SecureString
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

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

Inputs

String

SwitchParameter

SecureString

Outputs

KeyVaultCredentialSettings