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