Package version:

Interface ManagedHsmKeyProperties

The properties of the key.

interface ManagedHsmKeyProperties {
    attributes?: ManagedHsmKeyAttributes;
    curveName?: string;
    keyOps?: string[];
    keySize?: number;
    keyUri?: string;
    keyUriWithVersion?: string;
    kty?: string;
    releasePolicy?: ManagedHsmKeyReleasePolicy;
    rotationPolicy?: ManagedHsmRotationPolicy;
}

Properties

attributes? curveName? keyOps? keySize? keyUri? keyUriWithVersion? kty? releasePolicy? rotationPolicy?

Properties

Optionalattributes

attributes?: ManagedHsmKeyAttributes

The attributes of the key.

OptionalcurveName

curveName?: string

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

OptionalkeyOps

keyOps?: string[]

OptionalkeySize

keySize?: number

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.

Optional ReadonlykeyUri

keyUri?: string

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.

Optional ReadonlykeyUriWithVersion

keyUriWithVersion?: string

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.

Optionalkty

kty?: string

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

OptionalreleasePolicy

releasePolicy?: ManagedHsmKeyReleasePolicy

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

OptionalrotationPolicy

rotationPolicy?: ManagedHsmRotationPolicy

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

Settings

Member Visibility