PipelineClient Classe

  • Referência

Métodos principais do cliente de serviço.

Cria um cliente pipeline.

Herança
azure.core.pipeline.transport._base.PipelineClientBase
PipelineClient
Generic
PipelineClient

Construtor

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

Parâmetros

base_url
str
Necessário

URL do pedido.

config
Configuration

Se omitido, é utilizada a configuração padrão.

pipeline
Pipeline

Se omitido, é criado e devolvido um objeto pipeline.

policies
list[HTTPPolicy]

Se omitido, são utilizadas as políticas padrão do objeto de configuração.

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

Se especificado, as políticas serão adicionadas à lista de políticas antes de RetryPolicy

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

Se especificado, as políticas serão adicionadas à lista de políticas após RetryPolicy

transport
HttpTransport

Se omitido, RequestsTransport é utilizado para o transporte síncrono.

Exemplos

Cria o cliente de pipeline.


   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

Crie um objeto de pedido DELETE.
format_url

Formate o URL do pedido com o URL base do cliente, a menos que o URL fornecido já seja absoluto.

Tenha em atenção que o URL base e o URL do modelo podem conter parâmetros de consulta.
get

Crie um objeto de pedido GET.
head

Crie um objeto de pedido HEAD.
merge

Crie um objeto de pedido MERGE.
options

Crie um objeto de pedido OPTIONS.
patch

Crie um objeto de pedido PATCH.
post

Criar um objeto de pedido POST.
put

Crie um objeto de pedido PUT.
send_request

Método que executa o pedido de rede através das políticas em cadeia do 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

Crie um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content
bytes ou str ou dict
valor predefinido: None

O conteúdo do corpo

form_content
dict
valor predefinido: None

Conteúdo do formulário

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

format_url

Formate o URL do pedido com o URL base do cliente, a menos que o URL fornecido já seja absoluto.

Tenha em atenção que o URL base e o URL do modelo podem conter parâmetros de consulta.

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

Parâmetros

url_template
str
Necessário

O URL do pedido a formatar, se necessário.

Devoluções

O URL formatado.

Tipo de retorno

str

get

Crie um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content
bytes ou str ou dict
valor predefinido: None

O conteúdo do corpo

form_content
dict
valor predefinido: None

Conteúdo do formulário

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

head

Crie um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content
bytes ou str ou dict
valor predefinido: None

O conteúdo do corpo

form_content
dict
valor predefinido: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor predefinido: None

O conteúdo do corpo como um fluxo

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

merge

Crie um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content
bytes ou str ou dict
valor predefinido: None

O conteúdo do corpo

form_content
dict
valor predefinido: None

Conteúdo do formulário

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

options

Crie um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content

O conteúdo do corpo

form_content
dict

Conteúdo do formulário

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

patch

Crie um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content
bytes ou str ou dict
valor predefinido: None

O conteúdo do corpo

form_content
dict
valor predefinido: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor predefinido: None

O conteúdo do corpo como um fluxo

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

post

Criar um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content
bytes ou str ou dict
valor predefinido: None

O conteúdo do corpo

form_content
dict
valor predefinido: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor predefinido: None

O conteúdo do corpo como um fluxo

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

put

Crie um objeto de pedido 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
Necessário

O URL do pedido.

params
dict
valor predefinido: None

Pedir parâmetros de URL.

headers
dict
valor predefinido: None

Cabeçalhos

content
bytes ou str ou dict
valor predefinido: None

O conteúdo do corpo

form_content
dict
valor predefinido: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor predefinido: None

O conteúdo do corpo como um fluxo

Devoluções

Um objeto HttpRequest

Tipo de retorno

HttpRequest

send_request

Método que executa o pedido de rede através das políticas em cadeia do 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
Necessário

O pedido de rede que pretende fazer. Obrigatório.

stream
bool

Se o payload de resposta será transmitido em fluxo. Predefinições para Falso.

Devoluções

A resposta da chamada de rede. Não efetua o processamento de erros na resposta.

Tipo de retorno

HttpResponse