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
Obrigatório

URL da solicitação.

config
Configuration

Se omitido, a configuração padrão será usada.

pipeline
Pipeline

Se omitido, um objeto Pipeline será criado e retornado.

policies
list[HTTPPolicy]

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

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 será usado para transporte síncrono.

Exemplos

Compila 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 solicitação DELETE.
format_url

Formate a URL de solicitação com a URL base do cliente, a menos que a URL fornecida já seja absoluta.

Observe que a URL base e a URL do modelo podem conter parâmetros de consulta.
get

Crie um objeto de solicitação GET.
head

Crie um objeto de solicitação HEAD.
merge

Crie um objeto de solicitação MERGE.
options

Crie um objeto de solicitação OPTIONS.
patch

Crie um objeto de solicitação PATCH.
post

Crie um objeto de solicitação POST.
put

Crie um objeto de solicitação PUT.
send_request

Método que executa a solicitação de rede por meio das políticas encadeadas 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 solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content
bytes ou str ou dict
valor padrão: None

O conteúdo do corpo

form_content
dict
valor padrão: None

Conteúdo do formulário

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

format_url

Formate a URL de solicitação com a URL base do cliente, a menos que a URL fornecida já seja absoluta.

Observe que a URL base e a URL do modelo podem conter parâmetros de consulta.

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

Parâmetros

url_template
str
Obrigatório

A URL de solicitação a ser formatada, se necessário.

Retornos

A URL formatada.

Tipo de retorno

str

get

Crie um objeto de solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content
bytes ou str ou dict
valor padrão: None

O conteúdo do corpo

form_content
dict
valor padrão: None

Conteúdo do formulário

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

head

Crie um objeto de solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content
bytes ou str ou dict
valor padrão: None

O conteúdo do corpo

form_content
dict
valor padrão: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor padrão: None

O conteúdo do corpo como um fluxo

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

merge

Crie um objeto de solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content
bytes ou str ou dict
valor padrão: None

O conteúdo do corpo

form_content
dict
valor padrão: None

Conteúdo do formulário

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

options

Crie um objeto de solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content

O conteúdo do corpo

form_content
dict

Conteúdo do formulário

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

patch

Crie um objeto de solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content
bytes ou str ou dict
valor padrão: None

O conteúdo do corpo

form_content
dict
valor padrão: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor padrão: None

O conteúdo do corpo como um fluxo

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

post

Crie um objeto de solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content
bytes ou str ou dict
valor padrão: None

O conteúdo do corpo

form_content
dict
valor padrão: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor padrão: None

O conteúdo do corpo como um fluxo

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

put

Crie um objeto de solicitação 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
Obrigatório

A URL da solicitação.

params
dict
valor padrão: None

Parâmetros de URL de solicitação.

headers
dict
valor padrão: None

Cabeçalhos

content
bytes ou str ou dict
valor padrão: None

O conteúdo do corpo

form_content
dict
valor padrão: None

Conteúdo do formulário

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valor padrão: None

O conteúdo do corpo como um fluxo

Retornos

Um objeto HttpRequest

Tipo de retorno

HttpRequest

send_request

Método que executa a solicitação de rede por meio das políticas encadeadas 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
Obrigatório

A solicitação de rede que você deseja fazer. Obrigatórios.

stream
bool

Se o conteúdo da resposta será transmitido. Usa False como padrão.

Retornos

A resposta da chamada de rede. Não faz tratamento de erros em sua resposta.

Tipo de retorno

HttpResponse