SecretBundle

A secret consisting of a value, id, and attributes.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
value	string	The secret value.
id	string	The secret identifier.
contentType	string	The content type of the secret.
attributes	object
tags	object	Application-specific metadata.
kid	string	If the secret is backing a KV certificate, then this field specifies the corresponding key backing the certificate.
managed	boolean	Whether the secret's lifetime is managed by Key Vault.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SecretBundle",
  "title": "SecretBundle",
  "type": "object",
  "description": "A secret consisting of a value, id, and attributes.",
  "properties": {
    "value": {
      "type": "string",
      "description": "The secret value.",
      "example": "example_value"
    },
    "id": {
      "type": "string",
      "description": "The secret identifier.",
      "example": "abc123"
    },
    "contentType": {
      "type": "string",
      "description": "The content type of the secret.",
      "example": "example_value"
    },
    "attributes": {
      "$ref": "#/components/schemas/SecretAttributes"
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Application-specific metadata.",
      "example": "example_value"
    },
    "kid": {
      "type": "string",
      "readOnly": true,
      "description": "If the secret is backing a KV certificate, then this field specifies the corresponding key backing the certificate.",
      "example": "500123"
    },
    "managed": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether the secret's lifetime is managed by Key Vault.",
      "example": true
    }
  }
}