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

參數

傳回

傳回類型

意見反應

其他資源