Configuration

configobjectrequired
Hide Child Parameters
azure_api_versionstring

Sets the ?api-version URL parameter, used for defining the Azure Content Services interchange format.

Default:2023-10-01

>= 1 characters

azure_client_idstring

If azure_use_managed_identity is true, set the client ID if required.

azure_client_secretstring

If azure_use_managed_identity is true, set the client secret if required.

azure_tenant_idstring

If azure_use_managed_identity is true, set the tenant ID if required.

azure_use_managed_identityboolean

If checked, uses (if set) azure_client_id, azure_client_secret, and/or azure_tenant_id for Azure authentication, via Managed or User-assigned identity

Default:false

blocklist_namesarray[string]

Use these configured blocklists (in Azure Content Services) when inspecting content.

categoriesarray[object]

Array of categories, and their thresholds, to measure on.

Hide Child Parameters
namestringrequired
rejection_levelintegerrequired
content_safety_keystring

If azure_use_managed_identity is true, set the API key to call Content Safety.
This field is encrypted.
This field is referenceable.

content_safety_urlstringrequired

Full URL, inc protocol, of the Azure Content Safety instance.
This field is referenceable.

halt_on_blocklist_hitboolean

Tells Azure to reject the request if any blocklist filter is hit.

Default:true

output_typestring

Allowed values:EightSeverityLevelsFourSeverityLevels

Default:FourSeverityLevels

reveal_failure_reasonboolean

Set true to tell the caller why their request was rejected, if so.

Default:true

text_sourcestring

Select where to pick the ‘text’ for the Azure Content Services request.

Allowed values:concatenate_all_contentconcatenate_user_content

Default:concatenate_all_content

protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

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.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

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.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!