Key interface

Package:

@azure/arm-keyvault

The key resource.

Extends

Resource

Properties

attributes	The attributes of the key.
curveName	The elliptic curve name. For valid values, see JsonWebKeyCurveName.
keyOps
keySize	The key size in bits. For example: 2048, 3072, or 4096 for RSA.
keyUri	The URI to retrieve the current version of the key. NOTE: This property will not be serialized. It can only be populated by the server.
keyUriWithVersion	The URI to retrieve the specific version of the key. NOTE: This property will not be serialized. It can only be populated by the server.
kty	The type of the key. For valid values, see JsonWebKeyType.
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

Inherited Properties

id	Fully qualified identifier of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.
location	Azure location of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.
name	Name of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Tags assigned to the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

attributes

The attributes of the key.

attributes?: KeyAttributes

Property Value

KeyAttributes

curveName

The elliptic curve name. For valid values, see JsonWebKeyCurveName.

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.

keySize?: number

Property Value

number

keyUri

The URI to retrieve the current version of the key. NOTE: This property will not be serialized. It can only be populated by the server.

keyUri?: string

Property Value

string

keyUriWithVersion

The URI to retrieve the specific version of the key. NOTE: This property will not be serialized. It can only be populated by the server.

keyUriWithVersion?: string

Property Value

string

kty

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

kty?: 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

Inherited Property Details

id

Fully qualified identifier of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Azure location of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From Resource.location

name

Name of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Tags assigned to the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type of the key vault resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type