Share via

PipelineClient Třída

  • Reference

Základní metody klienta služby

Vytvoří klienta kanálu.

Dědičnost
azure.core.pipeline.transport._base.PipelineClientBase
PipelineClient
Generic
PipelineClient

Konstruktor

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

Parametry

base_url
str
Vyžadováno

Adresa URL požadavku

config
Configuration

Pokud tento parametr vynecháte, použije se standardní konfigurace.

pipeline
Pipeline

Pokud tento parametr vynecháte, vytvoří se a vrátí objekt kanálu.

policies
list[HTTPPolicy]

Pokud tento parametr vynecháte, použijí se standardní zásady objektu konfigurace.

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

Pokud je tato hodnota zadána, zásady se přidají do seznamu zásad před opakováním zásad.

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

Pokud je tato hodnota zadána, zásady se přidají do seznamu zásad po operaci RetryPolicy.

transport
HttpTransport

Pokud je vynechán, RequestsTransport se použije pro synchronní přenos.

Příklady

Vytvoří klienta kanálu.


   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)

Metody

close
delete

Vytvořte objekt požadavku DELETE.
format_url

Naformátujte adresu URL požadavku se základní adresou URL klienta, pokud zadaná adresa URL není již absolutní.

Všimněte si, že základní adresa URL i adresa URL šablony můžou obsahovat parametry dotazu.
get

Vytvořte objekt požadavku GET.
head

Vytvořte objekt požadavku HEAD.
merge

Vytvořte objekt žádosti MERGE.
options

Vytvořte objekt požadavku OPTIONS.
patch

Vytvořte objekt požadavku PATCH.
post

Vytvořte objekt požadavku POST.
put

Vytvořte objekt požadavku PUT.
send_request

Metoda, která spouští síťový požadavek prostřednictvím zřetězených zásad klienta.


>>> 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

Vytvořte objekt požadavku 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content
bytes nebo str nebo dict
výchozí hodnota: None

Obsah textu

form_content
dict
výchozí hodnota: None

Obsah formuláře

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

format_url

Naformátujte adresu URL požadavku se základní adresou URL klienta, pokud zadaná adresa URL není již absolutní.

Všimněte si, že základní adresa URL i adresa URL šablony můžou obsahovat parametry dotazu.

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

Parametry

url_template
str
Vyžadováno

Adresa URL požadavku, která se má v případě potřeby naformátovat.

Návraty

Formátovaná adresa URL.

Návratový typ

str

get

Vytvořte objekt požadavku 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content
bytes nebo str nebo dict
výchozí hodnota: None

Obsah textu

form_content
dict
výchozí hodnota: None

Obsah formuláře

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

head

Vytvořte objekt požadavku 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content
bytes nebo str nebo dict
výchozí hodnota: None

Obsah textu

form_content
dict
výchozí hodnota: None

Obsah formuláře

stream_content
<xref:stream> nebo <xref:generator> nebo <xref:asyncgenerator>
výchozí hodnota: None

Obsah těla jako datový proud

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

merge

Vytvořte objekt žádosti 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content
bytes nebo str nebo dict
výchozí hodnota: None

Obsah textu

form_content
dict
výchozí hodnota: None

Obsah formuláře

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

options

Vytvořte objekt požadavku 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content

Obsah textu

form_content
dict

Obsah formuláře

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

patch

Vytvořte objekt požadavku 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content
bytes nebo str nebo dict
výchozí hodnota: None

Obsah textu

form_content
dict
výchozí hodnota: None

Obsah formuláře

stream_content
<xref:stream> nebo <xref:generator> nebo <xref:asyncgenerator>
výchozí hodnota: None

Obsah těla jako datový proud

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

post

Vytvořte objekt požadavku 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content
bytes nebo str nebo dict
výchozí hodnota: None

Obsah textu

form_content
dict
výchozí hodnota: None

Obsah formuláře

stream_content
<xref:stream> nebo <xref:generator> nebo <xref:asyncgenerator>
výchozí hodnota: None

Obsah těla jako datový proud

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

put

Vytvořte objekt požadavku 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

Parametry

url
str
Vyžadováno

Adresa URL požadavku.

params
dict
výchozí hodnota: None

Parametry adresy URL požadavku.

headers
dict
výchozí hodnota: None

Hlavičky

content
bytes nebo str nebo dict
výchozí hodnota: None

Obsah textu

form_content
dict
výchozí hodnota: None

Obsah formuláře

stream_content
<xref:stream> nebo <xref:generator> nebo <xref:asyncgenerator>
výchozí hodnota: None

Obsah těla jako datový proud

Návraty

Objekt HttpRequest

Návratový typ

HttpRequest

send_request

Metoda, která spouští síťový požadavek prostřednictvím zřetězených zásad klienta.


>>> 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

Parametry

request
HttpRequest
Vyžadováno

Síťový požadavek, který chcete vytvořit. Povinná hodnota.

stream
bool

Určuje, jestli se datová část odpovědi bude streamovat. Výchozí hodnota je False.

Návraty

Odpověď síťového volání. Nezvládá zpracování chyb ve vaší odpovědi.

Návratový typ

HttpResponse