Key interface

Package:

@azure/arm-keyvault

The key resource.

Extends

ProxyResource

Properties

attributes	The attributes of the key.
curveName	The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
keyOps
keySize	The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
keyUri	The URI to retrieve the current version of the key.
keyUriWithVersion	The URI to retrieve the specific version of the key.
kty	The type of the key. For valid values, see JsonWebKeyType.
location	The supported Azure location where the managed HSM Pool should be created.
releasePolicy	Key release policy in response. It will be used for both output and input. Omitted if empty
rotationPolicy	Key rotation policy in response. It will be used for both output and input. Omitted if empty
tags	Resource tags

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

attributes

The attributes of the key.

attributes?: KeyAttributes

Property Value

KeyAttributes

curveName

The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256

curveName?: string

Property Value

string

keyOps

keyOps?: string[]

Property Value

string[]

keySize

The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.

keySize?: number

Property Value

number

keyUri

The URI to retrieve the current version of the key.

keyUri?: string

Property Value

string

keyUriWithVersion

The URI to retrieve the specific version of the key.

keyUriWithVersion?: string

Property Value

string

kty

The type of the key. For valid values, see JsonWebKeyType.

kty?: string

Property Value

string

location

The supported Azure location where the managed HSM Pool should be created.

location?: string

Property Value

string

releasePolicy

Key release policy in response. It will be used for both output and input. Omitted if empty

releasePolicy?: KeyReleasePolicy

Property Value

KeyReleasePolicy

rotationPolicy

Key rotation policy in response. It will be used for both output and input. Omitted if empty

rotationPolicy?: RotationPolicy

Property Value

RotationPolicy

tags

Resource tags

tags?: Record<string, string>

Property Value

Record<string, 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