{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-functions/json-schema/microsoft-azure-functions-certificate-collection-schema.json",
  "title": "CertificateCollection",
  "description": "Collection of certificates.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-functions-certificates-api-openapi.yml#/components/schemas/CertificateCollection",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The Certificate items on this page",
      "items": {
        "$ref": "#/$defs/Certificate"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "Certificate": {
      "type": "object",
      "description": "SSL certificate for an app.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/CertificateProperties",
          "description": "Certificate resource specific properties",
          "x-ms-client-flatten": true
        },
        "kind": {
          "type": "string",
          "description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
        }
      ]
    },
    "CertificateProperties": {
      "type": "object",
      "description": "Certificate resource specific properties",
      "properties": {
        "password": {
          "type": "string",
          "description": "Certificate password."
        },
        "friendlyName": {
          "type": "string",
          "description": "Friendly name of the certificate.",
          "readOnly": true
        },
        "subjectName": {
          "type": "string",
          "description": "Subject name of the certificate.",
          "readOnly": true
        },
        "hostNames": {
          "type": "array",
          "description": "Host names the certificate applies to.",
          "items": {
            "type": "string"
          }
        },
        "pfxBlob": {
          "type": "string",
          "format": "byte",
          "description": "Pfx blob."
        },
        "siteName": {
          "type": "string",
          "description": "App name.",
          "readOnly": true
        },
        "selfLink": {
          "type": "string",
          "description": "Self link.",
          "readOnly": true
        },
        "issuer": {
          "type": "string",
          "description": "Certificate issuer.",
          "readOnly": true
        },
        "issueDate": {
          "type": "string",
          "format": "date-time",
          "description": "Certificate issue Date.",
          "readOnly": true
        },
        "expirationDate": {
          "type": "string",
          "format": "date-time",
          "description": "Certificate expiration date.",
          "readOnly": true
        },
        "thumbprint": {
          "type": "string",
          "description": "Certificate thumbprint.",
          "readOnly": true
        },
        "valid": {
          "type": "boolean",
          "description": "Is the certificate valid?.",
          "readOnly": true
        },
        "cerBlob": {
          "type": "string",
          "format": "byte",
          "description": "Raw bytes of .cer file",
          "readOnly": true
        },
        "publicKeyHash": {
          "type": "string",
          "description": "Public key hash.",
          "readOnly": true
        },
        "hostingEnvironmentProfile": {
          "$ref": "#/$defs/HostingEnvironmentProfile",
          "description": "Specification for the App Service Environment to use for the certificate.",
          "readOnly": true
        },
        "keyVaultId": {
          "type": "string",
          "format": "arm-id",
          "description": "Azure Key Vault Csm resource Id.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.KeyVault/vaults"
              }
            ]
          }
        },
        "keyVaultSecretName": {
          "type": "string",
          "description": "Azure Key Vault secret name."
        },
        "keyVaultSecretStatus": {
          "$ref": "#/$defs/KeyVaultSecretStatus",
          "description": "Status of the Key Vault secret.",
          "readOnly": true
        },
        "serverFarmId": {
          "type": "string",
          "format": "arm-id",
          "description": "Resource ID of the associated App Service plan.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.Web/serverfarms"
              }
            ]
          }
        },
        "canonicalName": {
          "type": "string",
          "description": "CNAME of the certificate to be issued via free certificate"
        },
        "domainValidationMethod": {
          "type": "string",
          "description": "Method of domain validation for free cert"
        }
      }
    },
    "HostingEnvironmentProfile": {
      "type": "object",
      "description": "Specification for an App Service Environment to use for this resource.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Resource ID of the App Service Environment."
        },
        "name": {
          "type": "string",
          "description": "Name of the App Service Environment.",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "Resource type of the App Service Environment.",
          "readOnly": true
        }
      }
    },
    "KeyVaultSecretStatus": {
      "type": "string",
      "description": "Status of the Key Vault secret.",
      "enum": [
        "Initialized",
        "WaitingOnCertificateOrder",
        "Succeeded",
        "CertificateOrderFailed",
        "OperationNotPermittedOnKeyVault",
        "AzureServiceUnauthorizedToAccessKeyVault",
        "KeyVaultDoesNotExist",
        "KeyVaultSecretDoesNotExist",
        "UnknownError",
        "ExternalPrivateKey",
        "Unknown"
      ],
      "x-ms-enum": {
        "name": "KeyVaultSecretStatus",
        "modelAsString": false
      }
    }
  }
}