Share via

ManagedHsmKeyProperties Class

The properties of the key.

Constructor

ManagedHsmKeyProperties(*args: Any, **kwargs: Any)

Variables

Name Description
attributes
ManagedHsmKeyAttributes

The attributes of the key.
kty
str or JsonWebKeyType

The type of the key. For valid values, see JsonWebKeyType. Known values are: "EC", "EC-HSM", "RSA", and "RSA-HSM".
key_ops
list[str or JsonWebKeyOperation]
key_size
int

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.
curve_name
str or JsonWebKeyCurveName

The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256. Known values are: "P-256", "P-384", "P-521", and "P-256K".
key_uri
str

The URI to retrieve the current version of the key.
key_uri_with_version
str

The URI to retrieve the specific version of the key.
rotation_policy
ManagedHsmRotationPolicy

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

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

Attributes

attributes

The attributes of the key.

attributes: _models.ManagedHsmKeyAttributes | None

curve_name

The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256. Known values are: "P-256", "P-384", "P-521", and "P-256K".

curve_name: str | _models.JsonWebKeyCurveName | None

key_ops 

key_ops: list[typing.Union[str, ForwardRef('_models.JsonWebKeyOperation')]] | None

key_size

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.

key_size: int | None

key_uri

The URI to retrieve the current version of the key.

key_uri: str | None

key_uri_with_version

The URI to retrieve the specific version of the key.

key_uri_with_version: str | None

kty

"EC", "EC-HSM", "RSA", and "RSA-HSM".

kty: str | _models.JsonWebKeyType | None

release_policy

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

release_policy: _models.ManagedHsmKeyReleasePolicy | None

rotation_policy

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

rotation_policy: _models.ManagedHsmRotationPolicy | None