Share via

Key Class

  • Reference

The key resource.

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

Inheritance
azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.Resource
Key

Constructor

Key(*, attributes: _models.KeyAttributes | 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.RotationPolicy | None = None, release_policy: _models.KeyReleasePolicy | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
attributes
KeyAttributes

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
RotationPolicy

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

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

Variables

Name Description
id
str

Fully qualified identifier of the key vault resource.
name
str

Name of the key vault resource.
type
str

Resource type of the key vault resource.
location
str

Azure location of the key vault resource.
tags
dict[str, str]

Tags assigned to the key vault resource.
attributes
KeyAttributes

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
RotationPolicy

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

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