PipelineClient Clase

Métodos principales del cliente de servicio.

Compila un cliente de canalización.

Herencia

azure.core.pipeline.transport._base.PipelineClientBase

PipelineClient

Generic

PipelineClient

Constructor

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

Parámetros

base_url

str

Requerido

Dirección URL de la solicitud.

config

Configuration

Si se omite, se usa la configuración estándar.

pipeline

Pipeline

Si se omite, se crea y devuelve un objeto Pipeline.

policies

list[HTTPPolicy]

Si se omite, se usan las directivas estándar del objeto de configuración.

per_call_policies

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

Si se especifica, las directivas se agregarán a la lista de directivas antes de RetryPolicy.

per_retry_policies

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

Si se especifica, las directivas se agregarán a la lista de directivas después de RetryPolicy.

transport

HttpTransport

Si se omite, RequestsTransport se usa para el transporte sincrónico.

Ejemplos

Compila el cliente de canalización.

   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)

Métodos

close
delete	Cree un objeto de solicitud DELETE.
format_url	Dar formato a la dirección URL de solicitud con la dirección URL base del cliente, a menos que la dirección URL proporcionada ya sea absoluta. Tenga en cuenta que tanto la dirección URL base como la dirección URL de plantilla pueden contener parámetros de consulta.
get	Cree un objeto de solicitud GET.
head	Cree un objeto de solicitud HEAD.
merge	Cree un objeto de solicitud MERGE.
options	Cree un objeto de solicitud OPTIONS.
patch	Cree un objeto de solicitud PATCH.
post	Cree un objeto de solicitud POST.
put	Cree un objeto de solicitud PUT.
send_request	Método que ejecuta la solicitud de red a través de las directivas encadenadas del cliente. >>> 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

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

bytes o str o dict

valor predeterminado: None

El contenido del cuerpo

form_content

dict

valor predeterminado: None

Contenido del formulario

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

format_url

Dar formato a la dirección URL de solicitud con la dirección URL base del cliente, a menos que la dirección URL proporcionada ya sea absoluta.

Tenga en cuenta que tanto la dirección URL base como la dirección URL de plantilla pueden contener parámetros de consulta.

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

Parámetros

url_template

str

Requerido

Dirección URL de la solicitud a la que se va a dar formato si es necesario.

Devoluciones

Dirección URL con formato.

Tipo de valor devuelto

str

get

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

bytes o str o dict

valor predeterminado: None

El contenido del cuerpo

form_content

dict

valor predeterminado: None

Contenido del formulario

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

head

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

bytes o str o dict

valor predeterminado: None

El contenido del cuerpo

form_content

dict

valor predeterminado: None

Contenido del formulario

stream_content

<xref:stream> o <xref:generator> o <xref:asyncgenerator>

valor predeterminado: None

El contenido del cuerpo como una secuencia

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

merge

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

bytes o str o dict

valor predeterminado: None

El contenido del cuerpo

form_content

dict

valor predeterminado: None

Contenido del formulario

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

options

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

El contenido del cuerpo

form_content

dict

Contenido del formulario

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

patch

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

bytes o str o dict

valor predeterminado: None

El contenido del cuerpo

form_content

dict

valor predeterminado: None

Contenido del formulario

stream_content

<xref:stream> o <xref:generator> o <xref:asyncgenerator>

valor predeterminado: None

El contenido del cuerpo como una secuencia

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

post

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

bytes o str o dict

valor predeterminado: None

El contenido del cuerpo

form_content

dict

valor predeterminado: None

Contenido del formulario

stream_content

<xref:stream> o <xref:generator> o <xref:asyncgenerator>

valor predeterminado: None

El contenido del cuerpo como una secuencia

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

put

Cree un objeto de solicitud 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

Parámetros

url

str

Requerido

Dirección URL de la solicitud.

params

dict

valor predeterminado: None

Parámetros de dirección URL de solicitud.

headers

dict

valor predeterminado: None

Encabezados

content

bytes o str o dict

valor predeterminado: None

El contenido del cuerpo

form_content

dict

valor predeterminado: None

Contenido del formulario

stream_content

<xref:stream> o <xref:generator> o <xref:asyncgenerator>

valor predeterminado: None

El contenido del cuerpo como una secuencia

Devoluciones

Un objeto HttpRequest

Tipo de valor devuelto

HttpRequest

send_request

Método que ejecuta la solicitud de red a través de las directivas encadenadas del cliente.

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

Parámetros

request

HttpRequest

Requerido

La solicitud de red que desea realizar. Necesario.

stream

bool

Indica si se transmitirá la carga de respuesta. El valor predeterminado es False.

Devoluciones

Respuesta de la llamada de red. No realiza el control de errores en la respuesta.

Tipo de valor devuelto

HttpResponse