AzureFunctionsPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AzureFunctionsPluginConfig",
  "title": "AzureFunctionsPluginConfig",
  "x-speakeasy-entity": "PluginAzureFunctions",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "apikey": {
          "description": "The apikey to access the Azure resources. If provided, it is injected as the `x-functions-key` header.",
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "appname": {
          "description": "The Azure app name.",
          "type": "string"
        },
        "clientid": {
          "description": "The `clientid` to access the Azure resources. If provided, it is injected as the `x-functions-clientid` header.",
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "functionname": {
          "description": "Name of the Azure function to invoke.",
          "type": "string"
        },
        "hostdomain": {
          "description": "The domain where the function resides.",
          "type": "string",
          "default": "azurewebsites.net"
        },
        "https": {
          "description": "Use of HTTPS to connect with the Azure Functions server.",
          "type": "boolean",
          "default": true
        },
        "https_verify": {
          "description": "Set to `true` to authenticate the Azure Functions server.",
          "type": "boolean",
          "default": true
        },
        "keepalive": {
          "description": "Time in milliseconds during which an idle connection to the Azure Functions server lives before being closed.",
          "type": "number",
          "default": 60000
        },
        "routeprefix": {
          "description": "Route prefix to use.",
          "type": "string",
          "default": "api"
        },
        "timeout": {
          "description": "Timeout in milliseconds before closing a connection to the Azure Functions server.",
          "type": "number",
          "default": 600000
        }
      },
      "required": [
        "appname",
        "functionname"
      ]
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "azure-functions"
    },
    "protocols": {
      "description": "A set of strings representing protocols.",
      "type": "array",
      "items": {
        "description": "A string representing a protocol, such as HTTP or HTTPS.",
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https",
          "tcp",
          "tls",
          "tls_passthrough",
          "udp",
          "ws",
          "wss"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "config"
  ]
}