AzureSasCredential クラス

  • リファレンス
パッケージ:
com.azure.core.credential
Maven 成果物:
com.azure:azure-core:1.46.0
  • java.lang.Object
    • com.azure.core.credential.AzureSasCredential

public final class AzureSasCredential

共有アクセス署名を使用して Azure サービスに対する認証を行う資格情報を表します。 これは、共有アクセス署名を使用して Azure サービスへのアクセスを認証および承認するために使用されます。

共有アクセス署名は文字列ベースのトークンであり、Azure サービス内の特定のリソースに対する制限付きアクセス許可とアクセス権を、指定された期間付与します。 これにより、アカウント キーやその他の機密性の高い資格情報を共有することなく、リソースへの時間制限付きアクセスを提供できます。

AzureSasCredentialでは、共有アクセス署名をサポートする Azure サービスを認証してアクセスできます。 クラスの AzureSasCredential インスタンスを作成し、SAS トークンをパラメーターとして指定することで、この資格情報を使用して Azure サービスへの要求を認証できます。

資格情報を使用するには、通常、インスタンス化中に適切な Azure クライアントまたはサービス クライアント ビルダーに渡します。 ライブラリは認証プロセスを内部的に処理し、Azure サービスに対して行われた HTTP 要求に SAS トークンを含めます。これにより、SAS トークンで指定されたリソースにアクセスできます。

AzureSasCredentialは、アカウント キーを公開せずに、Azure Storage コンテナー、BLOB、キュー、ファイルなどの特定のリソースへの一時的かつ制限されたアクセス権を付与する必要がある場合に特に便利です。

の可用性と使用は、特定の AzureSasCredential Azure サービスと共有アクセス署名のサポートによって異なることがあります。 さらに、SAS トークンの形式と内容は、対象とするサービスとリソースによって異なる場合があります。

サンプル: Azure SAS 認証

次のコード サンプルは、sas トークンを使用して 構成する の作成 AzureSasCredentialを示しています。

AzureSasCredential azureSasCredential =
     new AzureSasCredential("AZURE-SERVICE-SAS-KEY");

コンストラクターの概要

コンストラクター 説明
AzureSasCredential(String signature)

指定された共有アクセス署名を使用して要求を承認する資格情報を作成します。
AzureSasCredential(String signature, Function<String,String> signatureEncoder)

指定された共有アクセス署名内で要求を承認する資格情報を作成します。

メソッドの概要

修飾子と型 メソッドと説明
String getSignature()

この資格情報に関連付けられている共有アクセス署名を取得します。
AzureSasCredential update(String signature)

この資格情報に関連付けられている共有アクセス署名をローテーションします。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

AzureSasCredential

public AzureSasCredential(String signature)

指定された共有アクセス署名を使用して要求を承認する資格情報を作成します。

渡された は signature エンコードされているものと見なされます。 このコンストラクターは、 の呼び出し AzureSasCredential(String signature, Function<String,String> signatureEncoder)と実質的に同じです。

Parameters:

signature - 要求の承認に使用される共有アクセス署名。

AzureSasCredential

public AzureSasCredential(String signature, Function signatureEncoder)

指定された共有アクセス署名内で要求を承認する資格情報を作成します。

が null 以外の場合 signatureEncoder 、 関数を signature使用して、およびすべての updated signaturesがエンコードされます。 signatureEncoder は、二重エンコード エラーの可能性を減らすために、可能な限りべき等である必要があります。

Parameters:

signature - 要求の承認に使用される共有アクセス署名。
signatureEncoder - をエンコードする省略可能な signature関数。

メソッドの詳細

getSignature

public String getSignature()

この資格情報に関連付けられている共有アクセス署名を取得します。

Returns:

要求の承認に使用されている共有アクセス署名。

update

public AzureSasCredential update(String signature)

この資格情報に関連付けられている共有アクセス署名をローテーションします。

Parameters:

signature - この資格情報に関連付ける新しい共有アクセス署名。

Returns:

更新後の AzureSasCredential オブジェクト。

適用対象