AzureSasCredentialPolicy Class

Package:

com.azure.core.http.policy

Maven Artifact:

com.azure:azure-core:1.55.2

• java.lang.Object
• • com.azure.core.http.policy.AzureSasCredentialPolicy

Implements

HttpPipelinePolicy

public final class AzureSasCredentialPolicy
implements HttpPipelinePolicy

The AzureSasCredentialPolicy class is an implementation of the HttpPipelinePolicy interface. This policy uses an AzureSasCredential to append a shared access signature (SAS) to the query string of a request.

This class is useful when you need to authorize requests with a SAS from Azure. It ensures that the requests are sent over HTTPS to prevent the SAS from being leaked.

Code sample:

In this example, an AzureSasCredentialPolicy is created with a SAS. The policy can then added to the pipeline. The request sent by the pipeline will then include the SAS appended to its query string.

Java

AzureSasCredential credential = new AzureSasCredential("my_sas");
 AzureSasCredentialPolicy policy = new AzureSasCredentialPolicy(credential);

Constructor Summary

Constructor	Description
AzureSasCredentialPolicy(AzureSasCredential credential)	Creates a policy that uses the passed AzureSasCredential to append sas to query string.
AzureSasCredentialPolicy(AzureSasCredential credential, boolean requireHttps)	Creates a policy that uses the passed AzureSasCredential to append sas to query string.

Method Summary

Modifier and Type	Method and Description
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Processes provided request context and invokes the next policy.
HttpResponse	processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) Processes provided request context and invokes the next policy synchronously.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureSasCredentialPolicy

public AzureSasCredentialPolicy(AzureSasCredential credential)

Creates a policy that uses the passed AzureSasCredential to append sas to query string.

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 shared access signature.

Parameters:

credential - The AzureSasCredential containing the shared access signature to use.

AzureSasCredentialPolicy

public AzureSasCredentialPolicy(AzureSasCredential credential, boolean requireHttps)

Creates a policy that uses the passed AzureSasCredential to append sas to query string.

Parameters:

credential - The AzureSasCredential containing the shared access signature to use.

requireHttps - A flag indicating whether HTTPS is required.

Method Details

process

public Mono process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)

Processes provided request context and invokes the next policy.

Parameters:

context

next

processSync

public HttpResponse processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)

Processes provided request context and invokes the next policy synchronously.

Parameters:

context

next

Azure SDK for Java

Latest