Package com.azure.core.http.policy

Class AzureKeyCredentialPolicy

java.lang.Object

com.azure.core.http.policy.KeyCredentialPolicy

com.azure.core.http.policy.AzureKeyCredentialPolicy

All Implemented Interfaces:

HttpPipelinePolicy

public final class AzureKeyCredentialPolicy
extends KeyCredentialPolicy

The AzureKeyCredentialPolicy class is an implementation of the KeyCredentialPolicy interface. This policy uses an AzureKeyCredential to set the authorization key for a request.

This class is useful when you need to authorize requests with a key from Azure.

Requests sent with this pipeline policy are required to use HTTPS. If the request isn't using HTTPS an exception will be thrown to prevent leaking the key.

Code sample:

In this example, an AzureKeyCredentialPolicy is created with a key and a header name. The policy can be added to a pipeline. The requests sent by the pipeline will then include the specified header with the key as its value.

 AzureKeyCredential credential = new AzureKeyCredential("my_key");
 AzureKeyCredentialPolicy policy = new AzureKeyCredentialPolicy("my_header", credential);
 

See Also:

• com.azure.core.http.policy
• KeyCredentialPolicy
• AzureKeyCredential
• HttpPipeline
• HttpRequest
• HttpResponse

Constructor Summary

Constructors

Constructor	Description
AzureKeyCredentialPolicy(String name, AzureKeyCredential credential)	Creates a policy that uses the passed AzureKeyCredential to set the specified header name.
AzureKeyCredentialPolicy(String name, AzureKeyCredential credential, String prefix)	Creates a policy that uses the passed AzureKeyCredential to set the specified header name.

Method Summary

Methods inherited from class com.azure.core.http.policy.KeyCredentialPolicy

process, processSync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.core.http.policy.HttpPipelinePolicy

getPipelinePosition

Constructor Details

AzureKeyCredentialPolicy

public AzureKeyCredentialPolicy(String name,
 AzureKeyCredential credential)

Creates a policy that uses the passed AzureKeyCredential to set the specified header name.

Parameters:

name - The name of the key header that will be set to KeyCredential.getKey().

credential - The AzureKeyCredential containing the authorization key to use.

Throws:

NullPointerException - If name or credential is null.

IllegalArgumentException - If name is empty.

AzureKeyCredentialPolicy

public AzureKeyCredentialPolicy(String name,
 AzureKeyCredential credential,
 String prefix)

Creates a policy that uses the passed AzureKeyCredential to set the specified header name.

The prefix will be applied before the KeyCredential.getKey() when setting the header. A space will be inserted between prefix and credential.

Parameters:

name - The name of the key header that will be set to KeyCredential.getKey().

credential - The AzureKeyCredential containing the authorization key to use.

prefix - The prefix to apply before the credential, for example "SharedAccessKey credential".

Throws:

NullPointerException - If name or credential is null.

IllegalArgumentException - If name is empty.