{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-cognitive-services/json-schema/microsoft-cognitive-services-encryption-scope-schema.json",
  "title": "EncryptionScope",
  "description": "Cognitive Services EncryptionScope",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-cognitive-services-encryptionscopes-api-openapi.yml#/components/schemas/EncryptionScope",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/EncryptionScopeProperties",
      "description": "Properties of Cognitive Services EncryptionScope."
    },
    "etag": {
      "type": "string",
      "description": "Resource Etag.",
      "readOnly": true
    },
    "tags": {
      "type": "object",
      "description": "Resource tags.",
      "additionalProperties": {
        "type": "string"
      },
      "x-ms-mutability": [
        "read",
        "update",
        "create"
      ]
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
    }
  ],
  "$defs": {
    "Encryption": {
      "type": "object",
      "description": "Properties to configure Encryption",
      "properties": {
        "keyVaultProperties": {
          "$ref": "#/$defs/KeyVaultProperties",
          "description": "Properties of KeyVault"
        },
        "keySource": {
          "type": "string",
          "description": "Enumerates the possible value of keySource for Encryption",
          "default": "Microsoft.KeyVault",
          "enum": [
            "Microsoft.CognitiveServices",
            "Microsoft.KeyVault"
          ],
          "x-ms-enum": {
            "name": "KeySource",
            "modelAsString": true,
            "values": [
              {
                "name": "Microsoft.CognitiveServices",
                "value": "Microsoft.CognitiveServices"
              },
              {
                "name": "Microsoft.KeyVault",
                "value": "Microsoft.KeyVault"
              }
            ]
          }
        }
      }
    },
    "EncryptionScopeProperties": {
      "type": "object",
      "description": "Properties to EncryptionScope",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/EncryptionScopeProvisioningState",
          "description": "Gets the status of the resource at the time the operation was called.",
          "readOnly": true
        },
        "state": {
          "$ref": "#/$defs/EncryptionScopeState",
          "description": "The encryptionScope state."
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/Encryption"
        }
      ]
    },
    "EncryptionScopeProvisioningState": {
      "type": "string",
      "description": "Gets the status of the resource at the time the operation was called.",
      "enum": [
        "Accepted",
        "Creating",
        "Deleting",
        "Moving",
        "Failed",
        "Succeeded",
        "Canceled"
      ],
      "x-ms-enum": {
        "name": "EncryptionScopeProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Accepted",
            "value": "Accepted"
          },
          {
            "name": "Creating",
            "value": "Creating"
          },
          {
            "name": "Deleting",
            "value": "Deleting"
          },
          {
            "name": "Moving",
            "value": "Moving"
          },
          {
            "name": "Failed",
            "value": "Failed"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Canceled",
            "value": "Canceled"
          }
        ]
      },
      "readOnly": true
    },
    "EncryptionScopeState": {
      "type": "string",
      "description": "The encryptionScope state.",
      "enum": [
        "Disabled",
        "Enabled"
      ],
      "x-ms-enum": {
        "name": "EncryptionScopeState",
        "modelAsString": true,
        "values": [
          {
            "name": "Disabled",
            "value": "Disabled"
          },
          {
            "name": "Enabled",
            "value": "Enabled"
          }
        ]
      }
    },
    "KeyVaultProperties": {
      "type": "object",
      "description": "Properties to configure keyVault Properties",
      "properties": {
        "keyName": {
          "type": "string",
          "description": "Name of the Key from KeyVault"
        },
        "keyVersion": {
          "type": "string",
          "description": "Version of the Key from KeyVault"
        },
        "keyVaultUri": {
          "type": "string",
          "description": "Uri of KeyVault"
        },
        "identityClientId": {
          "type": "string"
        }
      }
    }
  }
}