你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
PipelineClient 类
服务客户端核心方法。
生成管道客户端。
- 继承
-
azure.core.pipeline.transport._base.PipelineClientBasePipelineClientPipelineClient
构造函数
PipelineClient(base_url: str, *, pipeline: Pipeline[HTTPRequestType, HTTPResponseType] | None = None, config: Configuration[HTTPRequestType, HTTPResponseType] | None = None, **kwargs: Any)参数
- 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 和模板 URL 都可以包含查询参数。 |
| get |
创建 GET 请求对象。 |
| head |
创建HEAD请求对象。 |
| merge |
创建 MERGE 请求对象。 |
| options |
创建 OPTIONS 请求对象。 |
| patch |
创建 PATCH 请求对象。 |
| post |
创建 POST 请求对象。 |
| put |
创建 PUT 请求对象。 |
| send_request |
通过客户端的链式策略运行网络请求的方法。 |
close
close() -> Nonedelete
创建 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参数
返回
HttpRequest 对象
返回类型
format_url
使用客户端基 URL 设置请求 URL 的格式，除非提供的 URL 已是绝对 URL。
请注意，基 URL 和模板 URL 都可以包含查询参数。
format_url(url_template: str, **kwargs: Any) -> str参数
返回
带有格式的 URL。
返回类型
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参数
返回
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参数
- stream_content
- <xref:stream> 或 <xref:generator> 或 <xref:asyncgenerator>
默认值: None
正文内容作为流
返回
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参数
返回
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参数
- content
正文内容
- form_content
- dict
表单内容
返回
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参数
- stream_content
- <xref:stream> 或 <xref:generator> 或 <xref:asyncgenerator>
默认值: None
正文内容作为流
返回
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参数
- stream_content
- <xref:stream> 或 <xref:generator> 或 <xref:asyncgenerator>
默认值: None
正文内容作为流
返回
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参数
- stream_content
- <xref:stream> 或 <xref:generator> 或 <xref:asyncgenerator>
默认值: None
正文内容作为流
返回
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参数
- stream
- bool
是否对响应有效负载进行流式处理。 默认为 False。
返回
网络呼叫的响应。 不对响应执行错误处理。
