Package com.commercetools.api.models.extension

Interface AzureFunctionsAuthentication

All Superinterfaces:

HttpDestinationAuthentication

All Known Subinterfaces:

ExtensionAzureFunctionsAuthentication

public interface AzureFunctionsAuthentication
extends HttpDestinationAuthentication

To protect your Azure Function, set its authLevel to function and provide the function's key to be used inside the x-functions-key header. For more information, see the Azure Functions documentation.

To protect the secret key from being exposed, remove the code parameter and secret key from the URL. For example, use https://foo.azurewebsites.net/api/bar instead of https://foo.azurewebsites.net/api/bar?code=secret.

Example to create an instance using the builder pattern

     AzureFunctionsAuthentication azureFunctionsAuthentication = AzureFunctionsAuthentication.builder()
             .key("{key}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AZURE_FUNCTIONS	discriminator value for AzureFunctionsAuthentication

Method Summary

Modifier and Type	Method	Description
static AzureFunctionsAuthenticationBuilder	builder()	builder factory method for AzureFunctionsAuthentication
static AzureFunctionsAuthenticationBuilder	builder(AzureFunctionsAuthentication template)	create builder for AzureFunctionsAuthentication instance
static AzureFunctionsAuthentication	deepCopy(AzureFunctionsAuthentication template)	factory method to create a deep copy of AzureFunctionsAuthentication
@NotNull String	getKey()	Partially hidden on retrieval for security reasons.
static AzureFunctionsAuthentication	of()	factory method
static AzureFunctionsAuthentication	of(AzureFunctionsAuthentication template)	factory method to create a shallow copy AzureFunctionsAuthentication
void	setKey(String key)	Partially hidden on retrieval for security reasons.
static com.fasterxml.jackson.core.type.TypeReference<AzureFunctionsAuthentication>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAzureFunctionsAuthentication(Function<AzureFunctionsAuthentication,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.extension.HttpDestinationAuthentication

getType, withHttpDestinationAuthentication

Field Details

AZURE_FUNCTIONS

static final String AZURE_FUNCTIONS

discriminator value for AzureFunctionsAuthentication

See Also:

• Constant Field Values

Method Details

getKey

@NotNull
@NotNull String getKey()

Partially hidden on retrieval for security reasons.

Returns:

key

setKey

void setKey(String key)

Partially hidden on retrieval for security reasons.

Parameters:

key - value to be set

of

static AzureFunctionsAuthentication of()

factory method

Returns:

instance of AzureFunctionsAuthentication

of

static AzureFunctionsAuthentication of(AzureFunctionsAuthentication template)

factory method to create a shallow copy AzureFunctionsAuthentication

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AzureFunctionsAuthentication deepCopy(@Nullable
 AzureFunctionsAuthentication template)

factory method to create a deep copy of AzureFunctionsAuthentication

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AzureFunctionsAuthenticationBuilder builder()

builder factory method for AzureFunctionsAuthentication

Returns:

builder

builder

static AzureFunctionsAuthenticationBuilder builder(AzureFunctionsAuthentication template)

create builder for AzureFunctionsAuthentication instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAzureFunctionsAuthentication

default <T> T withAzureFunctionsAuthentication(Function<AzureFunctionsAuthentication,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<AzureFunctionsAuthentication> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference