PipelineClient Klasa

Metody podstawowe klienta usługi.

Tworzy klienta potoku.

Dziedziczenie

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

Wymagane

Adres URL żądania.

config

Configuration

W przypadku pominięcia zostanie użyta standardowa konfiguracja.

pipeline

Pipeline

Jeśli zostanie pominięty, zostanie utworzony i zwrócony obiekt Pipeline.

policies

list[HTTPPolicy]

W przypadku pominięcia używane są standardowe zasady obiektu konfiguracji.

per_call_policies

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

Jeśli zostanie określony, zasady zostaną dodane do listy zasad przed zasadami RetryPolicy

per_retry_policies

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

Jeśli zostanie określony, zasady zostaną dodane do listy zasad po retryPolicy

transport

HttpTransport

W przypadku pominięcia funkcja RequestsTransport jest używana do transportu synchronicznego.

Przykłady

Tworzy klienta potoku.

   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	Utwórz obiekt żądania DELETE.
format_url	Sformatuj adres URL żądania przy użyciu podstawowego adresu URL klienta, chyba że podany adres URL jest już bezwzględny. Należy pamiętać, że zarówno podstawowy adres URL, jak i adres URL szablonu mogą zawierać parametry zapytania.
get	Utwórz obiekt żądania GET.
head	Utwórz obiekt żądania HEAD.
merge	Utwórz obiekt żądania MERGE.
options	Utwórz obiekt żądania OPTIONS.
patch	Utwórz obiekt żądania PATCH.
post	Utwórz obiekt żądania POST.
put	Utwórz obiekt żądania PUT.
send_request	Metoda, która uruchamia żądanie sieciowe za pośrednictwem zasad sieciowych 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

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

bytes lub str lub dict

wartość domyślna: None

Zawartość treści

form_content

dict

wartość domyślna: None

Zawartość formularza

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

format_url

Sformatuj adres URL żądania przy użyciu podstawowego adresu URL klienta, chyba że podany adres URL jest już bezwzględny.

Należy pamiętać, że zarówno podstawowy adres URL, jak i adres URL szablonu mogą zawierać parametry zapytania.

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

Parametry

url_template

str

Wymagane

Adres URL żądania, który ma zostać sformatowany w razie potrzeby.

Zwraca

Sformatowany adres URL.

Typ zwracany

str

get

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

bytes lub str lub dict

wartość domyślna: None

Zawartość treści

form_content

dict

wartość domyślna: None

Zawartość formularza

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

head

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

bytes lub str lub dict

wartość domyślna: None

Zawartość treści

form_content

dict

wartość domyślna: None

Zawartość formularza

stream_content

<xref:stream> lub <xref:generator> lub <xref:asyncgenerator>

wartość domyślna: None

Zawartość treści jako strumień

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

merge

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

bytes lub str lub dict

wartość domyślna: None

Zawartość treści

form_content

dict

wartość domyślna: None

Zawartość formularza

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

options

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

Zawartość treści

form_content

dict

Zawartość formularza

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

patch

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

bytes lub str lub dict

wartość domyślna: None

Zawartość treści

form_content

dict

wartość domyślna: None

Zawartość formularza

stream_content

<xref:stream> lub <xref:generator> lub <xref:asyncgenerator>

wartość domyślna: None

Zawartość treści jako strumień

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

post

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

bytes lub str lub dict

wartość domyślna: None

Zawartość treści

form_content

dict

wartość domyślna: None

Zawartość formularza

stream_content

<xref:stream> lub <xref:generator> lub <xref:asyncgenerator>

wartość domyślna: None

Zawartość treści jako strumień

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

put

Utwórz obiekt żądania 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

Wymagane

Adres URL żądania.

params

dict

wartość domyślna: None

Parametry adresu URL żądania.

headers

dict

wartość domyślna: None

Nagłówki

content

bytes lub str lub dict

wartość domyślna: None

Zawartość treści

form_content

dict

wartość domyślna: None

Zawartość formularza

stream_content

<xref:stream> lub <xref:generator> lub <xref:asyncgenerator>

wartość domyślna: None

Zawartość treści jako strumień

Zwraca

Obiekt HttpRequest

Typ zwracany

HttpRequest

send_request

Metoda, która uruchamia żądanie sieciowe za pośrednictwem zasad sieciowych 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

Wymagane

Żądanie sieciowe, które chcesz utworzyć. Wymagane.

stream

bool

Określa, czy ładunek odpowiedzi będzie przesyłany strumieniowo. Wartość domyślna to False.

Zwraca

Odpowiedź połączenia sieciowego. Nie obsługuje błędów w odpowiedzi.

Typ zwracany

HttpResponse