Azure Function Apps · JSON Structure

Azure Function Apps Api Kv Reference Structure

Description of site key vault references.

Type: object Properties: 9
AzureComputeFaaSFunctionsServerless

ApiKVReference is a JSON Structure definition published by Azure Function Apps, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

details identityType location reference secretName secretVersion source status vaultName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azure-function-apps/refs/heads/main/json-structure/azure-function-apps-api-kv-reference-structure.json",
  "description": "Description of site key vault references.",
  "type": "object",
  "properties": {
    "details": {
      "type": "string"
    },
    "identityType": {
      "enum": [
        "None",
        "SystemAssigned",
        "UserAssigned"
      ],
      "type": "string",
      "x-ms-enum": {
        "modelAsString": false,
        "name": "ManagedServiceIdentityType"
      }
    },
    "location": {
      "enum": [
        "ApplicationSetting"
      ],
      "type": "string",
      "x-ms-enum": {
        "modelAsString": false,
        "name": "ConfigReferenceLocation"
      }
    },
    "reference": {
      "type": "string"
    },
    "secretName": {
      "type": "string"
    },
    "secretVersion": {
      "type": "string"
    },
    "source": {
      "enum": [
        "KeyVault"
      ],
      "type": "string",
      "x-ms-enum": {
        "modelAsString": false,
        "name": "ConfigReferenceSource"
      }
    },
    "status": {
      "enum": [
        "Initialized",
        "Resolved",
        "InvalidSyntax",
        "MSINotEnabled",
        "VaultNotFound",
        "SecretNotFound",
        "SecretVersionNotFound",
        "AccessToKeyVaultDenied",
        "OtherReasons"
      ],
      "type": "string",
      "x-ms-enum": {
        "modelAsString": false,
        "name": "ResolveStatus"
      }
    },
    "vaultName": {
      "type": "string"
    }
  },
  "name": "ApiKVReference"
}