Delen via

PipelineClient Klas

  • Referentie

Kernmethoden van de serviceclient.

Hiermee wordt een pijplijnclient gemaakt.

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

Parameters

base_url
str
Vereist

URL voor de aanvraag.

config
Configuration

Als u dit weglaat, wordt de standaardconfiguratie gebruikt.

pipeline
Pipeline

Als u dit weglaat, wordt een pijplijnobject gemaakt en geretourneerd.

policies
list[HTTPPolicy]

Als u dit weglaat, wordt het standaardbeleid van het configuratieobject gebruikt.

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

Indien opgegeven, worden de beleidsregels toegevoegd aan de beleidslijst vóór RetryPolicy

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

Indien opgegeven, worden de beleidsregels toegevoegd aan de beleidslijst na RetryPolicy

transport
HttpTransport

Als u dit weglaat, wordt RequestsTransport gebruikt voor synchroon transport.

Voorbeelden

Hiermee bouwt u de pijplijnclient.


   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)

Methoden

close
delete

Maak een DELETE-aanvraagobject.
format_url

Formatteer de aanvraag-URL met de clientbasis-URL, tenzij de opgegeven URL al absoluut is.

Houd er rekening mee dat zowel de basis-URL als de sjabloon-URL queryparameters kunnen bevatten.
get

Maak een GET-aanvraagobject.
head

Maak een HEAD-aanvraagobject.
merge

Maak een MERGE-aanvraagobject.
options

Maak een OPTIONS-aanvraagobject.
patch

Maak een PATCH-aanvraagobject.
post

Maak een POST-aanvraagobject.
put

Maak een PUT-aanvraagobject.
send_request

Methode waarmee de netwerkaanvraag wordt uitgevoerd via het gekoppelde beleid van de 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

Maak een DELETE-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content
bytes of str of dict
standaardwaarde: None

De inhoud van de hoofdtekst

form_content
dict
standaardwaarde: None

Formulierinhoud

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

format_url

Formatteer de aanvraag-URL met de clientbasis-URL, tenzij de opgegeven URL al absoluut is.

Houd er rekening mee dat zowel de basis-URL als de sjabloon-URL queryparameters kunnen bevatten.

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

Parameters

url_template
str
Vereist

De aanvraag-URL die indien nodig moet worden opgemaakt.

Retouren

De opgemaakte URL.

Retourtype

str

get

Maak een GET-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content
bytes of str of dict
standaardwaarde: None

De inhoud van de hoofdtekst

form_content
dict
standaardwaarde: None

Formulierinhoud

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

head

Maak een HEAD-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content
bytes of str of dict
standaardwaarde: None

De inhoud van de hoofdtekst

form_content
dict
standaardwaarde: None

Formulierinhoud

stream_content
<xref:stream> of <xref:generator> of <xref:asyncgenerator>
standaardwaarde: None

De inhoud van de hoofdtekst als een stroom

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

merge

Maak een MERGE-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content
bytes of str of dict
standaardwaarde: None

De inhoud van de hoofdtekst

form_content
dict
standaardwaarde: None

Formulierinhoud

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

options

Maak een OPTIONS-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content

De inhoud van de hoofdtekst

form_content
dict

Formulierinhoud

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

patch

Maak een PATCH-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content
bytes of str of dict
standaardwaarde: None

De inhoud van de hoofdtekst

form_content
dict
standaardwaarde: None

Formulierinhoud

stream_content
<xref:stream> of <xref:generator> of <xref:asyncgenerator>
standaardwaarde: None

De inhoud van de hoofdtekst als een stroom

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

post

Maak een POST-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content
bytes of str of dict
standaardwaarde: None

De inhoud van de hoofdtekst

form_content
dict
standaardwaarde: None

Formulierinhoud

stream_content
<xref:stream> of <xref:generator> of <xref:asyncgenerator>
standaardwaarde: None

De inhoud van de hoofdtekst als een stroom

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

put

Maak een PUT-aanvraagobject.

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

Parameters

url
str
Vereist

De aanvraag-URL.

params
dict
standaardwaarde: None

Url-parameters aanvragen.

headers
dict
standaardwaarde: None

Kopteksten

content
bytes of str of dict
standaardwaarde: None

De inhoud van de hoofdtekst

form_content
dict
standaardwaarde: None

Formulierinhoud

stream_content
<xref:stream> of <xref:generator> of <xref:asyncgenerator>
standaardwaarde: None

De inhoud van de hoofdtekst als een stroom

Retouren

Een HttpRequest-object

Retourtype

HttpRequest

send_request

Methode waarmee de netwerkaanvraag wordt uitgevoerd via het gekoppelde beleid van de 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

Parameters

request
HttpRequest
Vereist

De netwerkaanvraag die u wilt maken. Vereist.

stream
bool

Of de nettolading van het antwoord wordt gestreamd. Standaard ingesteld op False.

Retouren

Het antwoord van uw netwerkoproep. Er wordt geen foutafhandeling uitgevoerd voor uw antwoord.

Retourtype

HttpResponse