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

Параметры

Возвращаемое значение

Возвращаемый тип

Дополнительные ресурсы