PipelineClient クラス

リファレンス

サービスクライアントのコアメソッド。

パイプラインクライアントをビルドします。

継承: azure.core.pipeline.transport._base.PipelineClientBase

PipelineClient

Generic

PipelineClient

コンストラクター

PipelineClient(base_url: str, *, pipeline: Pipeline[HTTPRequestType, HTTPResponseType] | None = None, config: Configuration[HTTPRequestType, HTTPResponseType] | None = None, **kwargs: Any)

パラメーター

base_url: str

必須

要求の URL。

config: Configuration

省略すると、標準構成が使用されます。

pipeline: Pipeline

省略すると、Pipeline オブジェクトが作成され、返されます。

policies: list[HTTPPolicy]

省略すると、構成オブジェクトの標準ポリシーが使用されます。

per_call_policies: Union[HTTPPolicy, SansIOHTTPPolicy, list[HTTPPolicy], list[SansIOHTTPPolicy]]

指定した場合、ポリシーは RetryPolicy の前にポリシーリストに追加されます

per_retry_policies: Union[HTTPPolicy, SansIOHTTPPolicy, list[HTTPPolicy], list[SansIOHTTPPolicy]]

指定した場合、ポリシーは RetryPolicy の後にポリシーリストに追加されます

transport: HttpTransport

省略すると、同期トランスポートに RequestsTransport が使用されます。

例

パイプラインクライアントをビルドします。


   from azure.core import PipelineClient
   from azure.core.rest import HttpRequest
   from azure.core.pipeline.policies import RedirectPolicy, UserAgentPolicy

   # example configuration with some policies
   policies: Iterable[Union[HTTPPolicy, SansIOHTTPPolicy]] = [UserAgentPolicy("myuseragent"), RedirectPolicy()]

   client: PipelineClient[HttpRequest, HttpResponse] = PipelineClient(base_url=url, policies=policies)
   request = HttpRequest("GET", "https://bing.com")

   pipeline_response = client._pipeline.run(request)

メソッド

close
delete	DELETE 要求オブジェクトを作成します。
format_url	指定された URL が既に絶対である場合を除き、要求 URL をクライアントベース URL で書式設定します。ベース URL とテンプレート URL の両方にクエリパラメーターを含めることができることに注意してください。
get	GET 要求オブジェクトを作成します。
head	HEAD要求オブジェクトを作成します。
merge	MERGE 要求オブジェクトを作成します。
options	OPTIONS 要求オブジェクトを作成します。
patch	PATCH 要求オブジェクトを作成します。
post	POST 要求オブジェクトを作成します。
put	PUT 要求オブジェクトを作成します。
send_request	クライアントのチェーンポリシーを介してネットワーク要求を実行するメソッド。 `>>> from azure.core.rest import HttpRequest >>> request = HttpRequest('GET', 'http://www.example.com') <HttpRequest [GET], url: 'http://www.example.com'> >>> response = client.send_request(request) <HttpResponse: 200 OK>`

close

close() -> None

delete

DELETE 要求オブジェクトを作成します。

delete(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, content: Any = None, form_content: Dict[str, Any] | None = None) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content: bytes または str または dict

既定値: None

本文の内容

form_content: dict

既定値: None

フォームコンテンツ

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

format_url

指定された URL が既に絶対である場合を除き、要求 URL をクライアントベース URL で書式設定します。

ベース URL とテンプレート URL の両方にクエリパラメーターを含めることができることに注意してください。

format_url(url_template: str, **kwargs: Any) -> str

パラメーター

url_template: str

必須

必要に応じて書式設定する要求 URL。

戻り値

書式設定された URL。

の戻り値の型 :

str

get

GET 要求オブジェクトを作成します。

get(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, content: Any = None, form_content: Dict[str, Any] | None = None) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content: bytes または str または dict

既定値: None

本文の内容

form_content: dict

既定値: None

フォームコンテンツ

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

head

HEAD要求オブジェクトを作成します。

head(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, content: Any = None, form_content: Dict[str, Any] | None = None, stream_content: Any = None) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content: bytes または str または dict

既定値: None

本文の内容

form_content: dict

既定値: None

フォームコンテンツ

stream_content: <xref:stream> または <xref:generator> または <xref:asyncgenerator>

既定値: None

ストリームとしての本文の内容

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

merge

MERGE 要求オブジェクトを作成します。

merge(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, content: Any = None, form_content: Dict[str, Any] | None = None) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content: bytes または str または dict

既定値: None

本文の内容

form_content: dict

既定値: None

フォームコンテンツ

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

options

OPTIONS 要求オブジェクトを作成します。

options(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, *, content: bytes | str | Dict[Any, Any] | None = None, form_content: Dict[Any, Any] | None = None, **kwargs: Any) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content

本文の内容

form_content: dict

フォームコンテンツ

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

patch

PATCH 要求オブジェクトを作成します。

patch(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, content: Any = None, form_content: Dict[str, Any] | None = None, stream_content: Any = None) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content: bytes または str または dict

既定値: None

本文の内容

form_content: dict

既定値: None

フォームコンテンツ

stream_content: <xref:stream> または <xref:generator> または <xref:asyncgenerator>

既定値: None

ストリームとしての本文の内容

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

post

POST 要求オブジェクトを作成します。

post(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, content: Any = None, form_content: Dict[str, Any] | None = None, stream_content: Any = None) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content: bytes または str または dict

既定値: None

本文の内容

form_content: dict

既定値: None

フォームコンテンツ

stream_content: <xref:stream> または <xref:generator> または <xref:asyncgenerator>

既定値: None

ストリームとしての本文の内容

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

put

PUT 要求オブジェクトを作成します。

put(url: str, params: Dict[str, str] | None = None, headers: Dict[str, str] | None = None, content: Any = None, form_content: Dict[str, Any] | None = None, stream_content: Any = None) -> HttpRequest

パラメーター

url: str

必須

要求 URL。

params: dict

既定値: None

要求 URL パラメーター。

headers: dict

既定値: None

ヘッダー

content: bytes または str または dict

既定値: None

本文の内容

form_content: dict

既定値: None

フォームコンテンツ

stream_content: <xref:stream> または <xref:generator> または <xref:asyncgenerator>

既定値: None

ストリームとしての本文の内容

戻り値

HttpRequest オブジェクト

の戻り値の型 :

HttpRequest

send_request

クライアントのチェーンポリシーを介してネットワーク要求を実行するメソッド。


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest('GET', 'http://www.example.com')
<HttpRequest [GET], url: 'http://www.example.com'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

send_request(request: HTTPRequestType, *, stream: bool = False, **kwargs: Any) -> HTTPResponseType

パラメーター

request: HttpRequest

必須

作成するネットワーク要求。必須。

stream: bool

応答ペイロードがストリーミングされるかどうか。既定値は False です。

戻り値

ネットワーク呼び出しの応答。応答でエラー処理を行いません。

の戻り値の型 :

HttpResponse

次の方法で共有

PipelineClient クラス

コンストラクター

パラメーター

例

メソッド

close

delete

パラメーター

戻り値

の戻り値の型 :

format_url

パラメーター

戻り値

の戻り値の型 :

get

パラメーター

戻り値

の戻り値の型 :

head

パラメーター

戻り値

の戻り値の型 :

merge

パラメーター

戻り値

の戻り値の型 :

options

パラメーター

戻り値

の戻り値の型 :

patch

パラメーター

戻り値

の戻り値の型 :

post

パラメーター

戻り値

の戻り値の型 :

put

パラメーター

戻り値

の戻り値の型 :

send_request

パラメーター

戻り値

の戻り値の型 :

フィードバック

その他のリソース