PipelineClient Classe

Riferimento

Metodi di base del client del servizio.

Compila un client pipeline.

Ereditarietà: azure.core.pipeline.transport._base.PipelineClientBase

PipelineClient

Generic

PipelineClient

Costruttore

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

Parametri

base_url: str

Necessario

URL della richiesta.

config: Configuration

Se omesso, viene usata la configurazione standard.

pipeline: Pipeline

Se omesso, viene creato e restituito un oggetto Pipeline.

policies: list[HTTPPolicy]

Se omesso, vengono usati i criteri standard dell'oggetto di configurazione.

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

Se specificato, i criteri verranno aggiunti all'elenco dei criteri prima di RetryPolicy

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

Se specificato, i criteri verranno aggiunti all'elenco dei criteri dopo RetryPolicy

transport: HttpTransport

Se omesso, RequestsTransport viene usato per il trasporto sincrono.

Esempio

Compila il client della 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)

Metodi

close
delete	Creare un oggetto richiesta DELETE.
format_url	Formattare l'URL della richiesta con l'URL di base del client, a meno che l'URL specificato non sia già assoluto. Si noti che sia l'URL di base che l'URL del modello possono contenere parametri di query.
get	Creare un oggetto richiesta GET.
head	Creare un oggetto richiesta HEAD.
merge	Creare un oggetto richiesta MERGE.
options	Creare un oggetto richiesta OPTIONS.
patch	Creare un oggetto richiesta PATCH.
post	Creare un oggetto richiesta POST.
put	Creare un oggetto richiesta PUT.
send_request	Metodo che esegue la richiesta di rete tramite i criteri concatenati del client. `>>> 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

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content: bytes oppure str oppure dict

valore predefinito: None

Contenuto del corpo

form_content: dict

valore predefinito: None

Contenuto del modulo

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

format_url

Formattare l'URL della richiesta con l'URL di base del client, a meno che l'URL specificato non sia già assoluto.

Si noti che sia l'URL di base che l'URL del modello possono contenere parametri di query.

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

Parametri

url_template: str

Necessario

URL della richiesta da formattare, se necessario.

Restituisce

URL formattato.

Tipo restituito

str

get

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content: bytes oppure str oppure dict

valore predefinito: None

Contenuto del corpo

form_content: dict

valore predefinito: None

Contenuto del modulo

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

head

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content: bytes oppure str oppure dict

valore predefinito: None

Contenuto del corpo

form_content: dict

valore predefinito: None

Contenuto del modulo

stream_content: <xref:stream> oppure <xref:generator> oppure <xref:asyncgenerator>

valore predefinito: None

Contenuto del corpo come flusso

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

merge

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content: bytes oppure str oppure dict

valore predefinito: None

Contenuto del corpo

form_content: dict

valore predefinito: None

Contenuto del modulo

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

options

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content

Contenuto del corpo

form_content: dict

Contenuto del modulo

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

patch

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content: bytes oppure str oppure dict

valore predefinito: None

Contenuto del corpo

form_content: dict

valore predefinito: None

Contenuto del modulo

stream_content: <xref:stream> oppure <xref:generator> oppure <xref:asyncgenerator>

valore predefinito: None

Contenuto del corpo come flusso

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

post

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content: bytes oppure str oppure dict

valore predefinito: None

Contenuto del corpo

form_content: dict

valore predefinito: None

Contenuto del modulo

stream_content: <xref:stream> oppure <xref:generator> oppure <xref:asyncgenerator>

valore predefinito: None

Contenuto del corpo come flusso

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

put

Creare un oggetto richiesta 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

Parametri

url: str

Necessario

URL della richiesta.

params: dict

valore predefinito: None

Parametri dell'URL della richiesta.

headers: dict

valore predefinito: None

Intestazioni

content: bytes oppure str oppure dict

valore predefinito: None

Contenuto del corpo

form_content: dict

valore predefinito: None

Contenuto del modulo

stream_content: <xref:stream> oppure <xref:generator> oppure <xref:asyncgenerator>

valore predefinito: None

Contenuto del corpo come flusso

Restituisce

Oggetto HttpRequest

Tipo restituito

HttpRequest

send_request

Metodo che esegue la richiesta di rete tramite i criteri concatenati del client.


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

Parametri

request: HttpRequest

Necessario

Richiesta di rete da effettuare. Obbligatorio.

stream: bool

Indica se il payload della risposta verrà trasmesso. Il valore predefinito è False.

Restituisce

Risposta della chiamata di rete. Non esegue la gestione degli errori nella risposta.

Tipo restituito

HttpResponse

Condividi tramite

PipelineClient Classe

Costruttore

Parametri

Esempio

Metodi

close

delete

Parametri

Restituisce

Tipo restituito

format_url

Parametri

Restituisce

Tipo restituito

get

Parametri

Restituisce

Tipo restituito

head

Parametri

Restituisce

Tipo restituito

merge

Parametri

Restituisce

Tipo restituito

options

Parametri

Restituisce

Tipo restituito

patch

Parametri

Restituisce

Tipo restituito

post

Parametri

Restituisce

Tipo restituito

put

Parametri

Restituisce

Tipo restituito

send_request

Parametri

Restituisce

Tipo restituito

Risorse aggiuntive