ServerKey interface

Package:
@azure/arm-sql

A server key.

Extends
ProxyResource

Properties

autoRotationEnabled

Key auto rotation opt-in flag. Either true or false.
creationDate

The server key creation date.
keyVersion

The version of the server key.
kind

Kind of encryption protector. This is metadata used for the Azure portal experience.
location

Resource location.
serverKeyType

The server key type like 'ServiceManaged', 'AzureKeyVault'.
subregion

Subregion of the server key.
thumbprint

Thumbprint of the server key.
uri

The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' or can be 'https://YourVaultName.vault.azure.net/keys/YourKeyName'

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

autoRotationEnabled

Key auto rotation opt-in flag. Either true or false.

autoRotationEnabled?: boolean

Property Value

boolean

creationDate

The server key creation date.

creationDate?: Date

Property Value

Date

keyVersion

The version of the server key.

keyVersion?: string

Property Value

string

kind

Kind of encryption protector. This is metadata used for the Azure portal experience.

kind?: string

Property Value

string

location

Resource location.

location?: string

Property Value

string

serverKeyType

The server key type like 'ServiceManaged', 'AzureKeyVault'.

serverKeyType?: string

Property Value

string

subregion

Subregion of the server key.

subregion?: string

Property Value

string

thumbprint

Thumbprint of the server key.

thumbprint?: string

Property Value

string

uri

The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' or can be 'https://YourVaultName.vault.azure.net/keys/YourKeyName'

uri?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type