Azure Key Vault · Schema

KeyItem

The key item containing key metadata.

CertificatesCloud SecurityCryptographyKey ManagementSecrets ManagementSecurity

Properties

Name Type Description
kid string Key identifier.
attributes object
tags object Application specific metadata in the form of key-value pairs.
managed boolean True if the key's lifetime is managed by key vault.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-key-vault-keyitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyItem",
  "title": "KeyItem",
  "type": "object",
  "description": "The key item containing key metadata.",
  "properties": {
    "kid": {
      "type": "string",
      "description": "Key identifier.",
      "example": "500123"
    },
    "attributes": {
      "$ref": "#/components/schemas/KeyAttributes"
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Application specific metadata in the form of key-value pairs.",
      "example": "example_value"
    },
    "managed": {
      "type": "boolean",
      "description": "True if the key's lifetime is managed by key vault.",
      "readOnly": true,
      "example": true
    }
  }
}