Microsoft Azure · Schema

onYourDataAuthenticationType

The authentication types supported with Azure OpenAI On Your Data.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1
View JSON Schema on GitHub

JSON Schema

microsoft-azure-onyourdataauthenticationtype-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/onYourDataAuthenticationType",
  "title": "onYourDataAuthenticationType",
  "type": "string",
  "description": "The authentication types supported with Azure OpenAI On Your Data.",
  "enum": [
    "api_key",
    "connection_string",
    "key_and_key_id",
    "encoded_api_key",
    "access_token",
    "system_assigned_managed_identity",
    "user_assigned_managed_identity"
  ],
  "x-ms-enum": {
    "name": "OnYourDataAuthenticationType",
    "modelAsString": true,
    "values": [
      {
        "name": "apiKey",
        "value": "api_key",
        "description": "Authentication via API key."
      },
      {
        "name": "connectionString",
        "value": "connection_string",
        "description": "Authentication via connection string."
      },
      {
        "name": "keyAndKeyId",
        "value": "key_and_key_id",
        "description": "Authentication via key and key ID pair."
      },
      {
        "name": "encodedApiKey",
        "value": "encoded_api_key",
        "description": "Authentication via encoded API key."
      },
      {
        "name": "accessToken",
        "value": "access_token",
        "description": "Authentication via access token."
      },
      {
        "name": "systemAssignedManagedIdentity",
        "value": "system_assigned_managed_identity",
        "description": "Authentication via system-assigned managed identity."
      },
      {
        "name": "userAssignedManagedIdentity",
        "value": "user_assigned_managed_identity",
        "description": "Authentication via user-assigned managed identity."
      }
    ]
  }
}