StorageClient クラス

  • リファレンス

これは、サービス オブジェクトの基本クラスです。 サービス オブジェクトは、Storage に対するすべての要求を実行するために使用されます。 このクラスを直接インスタンス化することはできません。

継承
builtins.object
StorageClient

コンストラクター

StorageClient(connection_params)

パラメーター

connection_params
<xref:obj>
必須

クライアントの構築に使用するパラメーター。

変数

account_name
str

ストレージ アカウント名。 これは、アカウント キーで署名された要求を認証し、ストレージ エンドポイントを構築するために使用されます。 接続文字列を指定しない限り、または匿名認証でカスタム ドメインを使用する場合は必須です。

account_key
str

ストレージ アカウント キー。 これは、共有キー認証に使用されます。 アカウント キーまたは sas トークンが指定されていない場合は、匿名アクセスが使用されます。

sas_token
str

アカウント キーの代わりに要求を認証するために使用する共有アクセス署名トークン。 アカウント キーと sas トークンの両方が指定されている場合は、アカウント キーを使用して署名します。 どちらも指定しない場合は、匿名アクセスが使用されます。

primary_endpoint
str

ストレージ要求を送信するエンドポイント。

secondary_endpoint
str

ストレージ データの読み取り元のセカンダリ エンドポイント。 これは、使用されるストレージ アカウントが RA-GRS であるため、セカンダリからの読み取りが許可されている場合にのみ有効なエンドポイントになります。

retry
<xref:function>(<xref:context>)

再試行するかどうかを決定する関数。 パラメーターとして オブジェクトを RetryContext 受け取ります。 要求を再試行するまで待機する秒数を返します。再試行しないことを示す場合は None を返します。

location_mode
LocationMode

要求を行うために使用するホストの場所。 既定値は LocationMode.PRIMARY です。 他のアカウントの種類ではセカンダリからの読み取りが許可されないため、この設定は RA-GRS アカウントにのみ適用されることに注意してください。 location_modeが LocationMode.SECONDARY に設定されている場合、読み取り要求はセカンダリ エンドポイントに送信されます。 書き込み要求は引き続きプライマリに送信されます。

protocol
str

要求に使用するプロトコル。 既定値は https です。

request_session
<xref:requests.Session>

http 要求に使用するセッション オブジェクト。

request_callback
<xref:function>(<xref:request>)

各要求が送信される直前に呼び出される関数。 この関数は、要求オブジェクトをパラメーターとして受け取り、何も返しません。 カスタム ヘッダーまたはログ要求データを追加するために使用できます。

response_callback
<xref:function>()

各応答を受信した直後に呼び出される関数。 この関数は、応答オブジェクトをパラメーターとして受け取り、何も返しません。 応答データをログに記録するために使用できます。

retry_callback
<xref:function>()

再試行評価が実行された直後に 呼び出される関数。 この関数は、再試行コンテキスト オブジェクトをパラメーターとして受け取り、何も返しません。 再試行を検出し、コンテキスト情報をログに記録するために使用できます。

メソッド

extract_date_and_request_id
set_proxy

HTTP CONNECT トンネリングのプロキシ サーバーのホストとポートを設定します。

extract_date_and_request_id 

static extract_date_and_request_id(retry_context)

パラメーター

retry_context
必須

set_proxy

HTTP CONNECT トンネリングのプロキシ サーバーのホストとポートを設定します。

set_proxy(host, port, user=None, password=None)

パラメーター

host
str
必須

プロキシのアドレス。 例: '192.168.0.100'

port
int
必須

プロキシのポート。 例: 6000

user
str
既定値: None

プロキシ承認のユーザー。

password
str
既定値: None

プロキシ承認のパスワード。

属性

protocol

request_session

socket_timeout