Share via

ManagedHsmKey Class

  • Reference

The key resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.keyvault.v2023_02_01.models._models_py3.ProxyResourceWithoutSystemData
ManagedHsmKey

Constructor

ManagedHsmKey(*, tags: Dict[str, str] | None = None, attributes: _models.ManagedHsmKeyAttributes | None = None, kty: str | _models.JsonWebKeyType | None = None, key_ops: List[str | _models.JsonWebKeyOperation] | None = None, key_size: int | None = None, curve_name: str | _models.JsonWebKeyCurveName | None = None, rotation_policy: _models.ManagedHsmRotationPolicy | None = None, release_policy: _models.ManagedHsmKeyReleasePolicy | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags
dict[str, str]

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

The elliptic curve name. For valid values, see JsonWebKeyCurveName. Known values are: "P-256", "P-384", "P-521", and "P-256K".
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.

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
tags
dict[str, str]

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

The elliptic curve name. For valid values, see JsonWebKeyCurveName. 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.