ManagedHsmKey interface

Package:

@azure/arm-keyvault

The key resource.

Extends

ProxyResourceWithoutSystemData

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 resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

attributes

The attributes of the key.

attributes?: ManagedHsmKeyAttributes

Property Value

ManagedHsmKeyAttributes

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

Property Value

ManagedHsmKeyReleasePolicy

rotationPolicy

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

rotationPolicy?: ManagedHsmRotationPolicy

Property Value

ManagedHsmRotationPolicy

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResourceWithoutSystemData.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResourceWithoutSystemData.name

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From ProxyResourceWithoutSystemData.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResourceWithoutSystemData.type