Skip to content

key

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

key

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
main.bicep
main.bicep
 
 
main.json
main.json
 
 
version.json
version.json
 
 

README.md

Azure SQL Server Keys [Microsoft.Sql/servers/keys]

This module deploys an Azure SQL Server Key.

Navigation

Resource Types

Resource Type API Version
Microsoft.Sql/servers/keys 2022-05-01-preview

Parameters

Required parameters

Parameter Type Description
name string The name of the key. Must follow the [] pattern.

Conditional parameters

Parameter Type Description
serverName string The name of the parent SQL server. Required if the template is used in a standalone deployment.

Optional parameters

Parameter Type Description
enableDefaultTelemetry bool Enable telemetry via a Globally Unique Identifier (GUID).
serverKeyType string The encryption protector type like "ServiceManaged", "AzureKeyVault".
uri string The URI of the key. If the ServerKeyType is AzureKeyVault, then either the URI or the keyVaultName/keyName combination is required.

Parameter: name

The name of the key. Must follow the [] pattern.

  • Required: Yes
  • Type: string

Parameter: serverName

The name of the parent SQL server. Required if the template is used in a standalone deployment.

  • Required: Yes
  • Type: string

Parameter: enableDefaultTelemetry

Enable telemetry via a Globally Unique Identifier (GUID).

  • Required: No
  • Type: bool
  • Default: True

Parameter: serverKeyType

The encryption protector type like "ServiceManaged", "AzureKeyVault".

  • Required: No
  • Type: string
  • Default: 'ServiceManaged'
  • Allowed: 
    [
  'AzureKeyVault'
  'ServiceManaged'
]

Parameter: uri

The URI of the key. If the ServerKeyType is AzureKeyVault, then either the URI or the keyVaultName/keyName combination is required.

  • Required: No
  • Type: string
  • Default: ''

Outputs

Output Type Description
name string The name of the deployed server key.
resourceGroupName string The resource group of the deployed server key.
resourceId string The resource ID of the deployed server key.

Cross-referenced modules

None