Secret

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-cdn/json-schema/microsoft-azure-cdn-secret-schema.json",
  "title": "Secret",
  "description": "Friendly Secret name mapping to the any Secret or secret related information.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-cdn-secrets-api-openapi.yml#/components/schemas/Secret",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/SecretProperties",
      "description": "The JSON object that contains the properties of the Secret to create.",
      "x-ms-client-flatten": true
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource"
    }
  ],
  "$defs": {
    "AFDStateProperties": {
      "type": "object",
      "description": "The tracking states for afd resources.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/AfdProvisioningState",
          "description": "Provisioning status",
          "readOnly": true
        },
        "deploymentStatus": {
          "$ref": "#/$defs/DeploymentStatus",
          "readOnly": true
        }
      }
    },
    "AfdProvisioningState": {
      "type": "string",
      "description": "Provisioning status",
      "enum": [
        "Succeeded",
        "Failed",
        "Updating",
        "Deleting",
        "Creating"
      ],
      "x-ms-enum": {
        "name": "AfdProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Failed",
            "value": "Failed"
          },
          {
            "name": "Updating",
            "value": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting"
          },
          {
            "name": "Creating",
            "value": "Creating"
          }
        ]
      }
    },
    "DeploymentStatus": {
      "type": "string",
      "enum": [
        "NotStarted",
        "InProgress",
        "Succeeded",
        "Failed"
      ],
      "x-ms-enum": {
        "name": "DeploymentStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "NotStarted",
            "value": "NotStarted"
          },
          {
            "name": "InProgress",
            "value": "InProgress"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Failed",
            "value": "Failed"
          }
        ]
      }
    },
    "SecretParameters": {
      "type": "object",
      "description": "The json object containing secret parameters",
      "properties": {
        "type": {
          "$ref": "#/$defs/SecretType",
          "description": "The type of the secret resource."
        }
      },
      "required": [
        "type"
      ]
    },
    "SecretProperties": {
      "type": "object",
      "description": "The JSON object that contains the properties of the Secret to create.",
      "properties": {
        "profileName": {
          "type": "string",
          "description": "The name of the profile which holds the secret.",
          "readOnly": true
        },
        "parameters": {
          "$ref": "#/$defs/SecretParameters",
          "description": "object which contains secret parameters"
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/AFDStateProperties"
        }
      ]
    },
    "SecretType": {
      "type": "string",
      "description": "The type of the secret resource.",
      "enum": [
        "UrlSigningKey",
        "CustomerCertificate",
        "ManagedCertificate",
        "AzureFirstPartyManagedCertificate",
        "MtlsCertificateChain"
      ],
      "x-ms-enum": {
        "name": "SecretType",
        "modelAsString": true,
        "values": [
          {
            "name": "UrlSigningKey",
            "value": "UrlSigningKey"
          },
          {
            "name": "CustomerCertificate",
            "value": "CustomerCertificate"
          },
          {
            "name": "ManagedCertificate",
            "value": "ManagedCertificate"
          },
          {
            "name": "AzureFirstPartyManagedCertificate",
            "value": "AzureFirstPartyManagedCertificate"
          },
          {
            "name": "MtlsCertificateChain",
            "value": "MtlsCertificateChain"
          }
        ]
      }
    }
  }
}