FieldMappingFunction.Base64Decode Method

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Overloads

Base64Decode()	Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed to a URL-safe Base64-encoded string.
Base64Decode(Boolean)	Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed to a URL-safe Base64-encoded string.

Base64Decode()

Source:

FieldMappingFunction.Customization.cs

Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed to a URL-safe Base64-encoded string.

public static Microsoft.Azure.Search.Models.FieldMappingFunction Base64Decode ();

static member Base64Decode : unit -> Microsoft.Azure.Search.Models.FieldMappingFunction

Public Shared Function Base64Decode () As FieldMappingFunction

Returns

FieldMappingFunction

A new field mapping function.

Remarks

Sample use case: Blob custom metadata values must be ASCII-encoded. You can use Base64 encoding to represent arbitrary Unicode strings in blob custom metadata. However, to make search meaningful, you can use this function to turn the encoded data back into "regular" strings when populating your search index.

For details on the decoding used, see https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding. Calling this method is the same as calling with useHttpServerUtilityUrlTokenDecode set to true.

Base64Decode(Boolean)

Source:

FieldMappingFunction.Customization.cs

Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed to a URL-safe Base64-encoded string.

public static Microsoft.Azure.Search.Models.FieldMappingFunction Base64Decode (bool useHttpServerUtilityUrlTokenDecode);

static member Base64Decode : bool -> Microsoft.Azure.Search.Models.FieldMappingFunction

Public Shared Function Base64Decode (useHttpServerUtilityUrlTokenDecode As Boolean) As FieldMappingFunction

Parameters

useHttpServerUtilityUrlTokenDecode

Boolean

Determines how Base64 decoding is performed. See https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding for details.

Returns

FieldMappingFunction

A new field mapping function.

Remarks

Sample use case: Blob custom metadata values must be ASCII-encoded. You can use Base64 encoding to represent arbitrary Unicode strings in blob custom metadata. However, to make search meaningful, you can use this function to turn the encoded data back into "regular" strings when populating your search index.