AzureKeyCredentialPolicy (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.core.http.policy.AzureKeyCredentialPolicy

All Implemented Interfaces:

HttpPipelinePolicy
```
public final class AzureKeyCredentialPolicy
extends Object
implements HttpPipelinePolicy
```
Pipeline policy that uses an AzureKeyCredential to set the authorization key for a request.
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.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Mono<HttpResponse>`	`process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)`	Processes provided request context and invokes the next policy.

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 Detail
  - 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 AzureKeyCredential.getKey().
    
    credential - The AzureKeyCredential containing the authorization key to use.
    
    Throws:
    
    NullPointerException - If name or credential is null.
    
    IllegalArgumentException - If name is empty.
- Method Detail
  - process
```
public Mono<HttpResponse> process(HttpPipelineCallContext context,
                                  HttpPipelineNextPolicy next)
```
    Description copied from interface: HttpPipelinePolicy
    
    Processes provided request context and invokes the next policy.
    
    Specified by:
    
    process in interface HttpPipelinePolicy
    
    Parameters:
    
    context - The request context.
    
    next - The next policy to invoke.
    
    Returns:
    
    A publisher that initiates the request upon subscription and emits a response on completion.