QueueGetUserDelegationKeyOptions Class

Package:
com.azure.storage.queue.models
Maven Artifact:
com.azure:azure-storage-queue:12.30.0
  • java.lang.Object
    • com.azure.storage.queue.models.QueueGetUserDelegationKeyOptions

public class QueueGetUserDelegationKeyOptions

Extended options that may be passed when getting a user delegation key for a storage account.

Constructor Summary

Constructor Description
QueueGetUserDelegationKeyOptions(OffsetDateTime expiresOn)

Creates a new instance of QueueGetUserDelegationKeyOptions.

Method Summary

Modifier and Type Method and Description
String getDelegatedUserTenantId()

Gets the tenant ID of the user to whom the delegation key is issued in Azure AD.
OffsetDateTime getExpiresOn()

Gets the expiration of the key's validity.
OffsetDateTime getStartsOn()

Gets the start time of the key's validity.
QueueGetUserDelegationKeyOptions setDelegatedUserTenantId(String delegatedUserTenantId)

Optional.
QueueGetUserDelegationKeyOptions setStartsOn(OffsetDateTime startsOn)

Optional.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

QueueGetUserDelegationKeyOptions

public QueueGetUserDelegationKeyOptions(OffsetDateTime expiresOn)

Creates a new instance of QueueGetUserDelegationKeyOptions.

Parameters:

expiresOn - Expiration of the key's validity. The time should be specified in UTC.

Method Details

getDelegatedUserTenantId

public String getDelegatedUserTenantId()

Gets the tenant ID of the user to whom the delegation key is issued in Azure AD.

Returns:

The tenant ID.

getExpiresOn

public OffsetDateTime getExpiresOn()

Gets the expiration of the key's validity.

Returns:

The expiration time in UTC.

getStartsOn

public OffsetDateTime getStartsOn()

Gets the start time of the key's validity.

Returns:

The start time in UTC.

setDelegatedUserTenantId

public QueueGetUserDelegationKeyOptions setDelegatedUserTenantId(String delegatedUserTenantId)

Optional. Sets the tenant ID of the user to whom the delegation key is issued in Azure AD.

Parameters:

delegatedUserTenantId - The tenant ID.

Returns:

setStartsOn

public QueueGetUserDelegationKeyOptions setStartsOn(OffsetDateTime startsOn)

Optional. Sets the start time of the key's validity. Null indicates the key is valid immediately.

If you set the start time to the current time, failures might occur intermittently for the first few minutes. This is due to different machines having slightly different current times, known as clock skew.

Parameters:

startsOn - The start time in UTC.

Returns:

Applies to