Dela via

PipelineClient Klass

  • Referens

Kärnmetoder för tjänstklienten.

Skapar en Pipeline-klient.

Arv
azure.core.pipeline.transport._base.PipelineClientBase
PipelineClient
Generic
PipelineClient

Konstruktor

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

Parametrar

base_url
str
Obligatorisk

URL för begäran.

config
Configuration

Om den utelämnas används standardkonfigurationen.

pipeline
Pipeline

Om det utelämnas skapas och returneras ett Pipeline-objekt.

policies
list[HTTPPolicy]

Om det utelämnas används standardprinciperna för konfigurationsobjektet.

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

Om de anges läggs principerna till i principlistan före RetryPolicy

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

Om de anges läggs principerna till i principlistan efter RetryPolicy

transport
HttpTransport

Om det utelämnas används RequestsTransport för synkron transport.

Exempel

Skapar pipelineklienten.


   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)

Metoder

close
delete

Skapa ett DELETE-begärandeobjekt.
format_url

Formatera begärande-URL med klientens bas-URL, såvida inte den angivna URL:en redan är absolut.

Observera att både bas-URL:en och mall-URL:en kan innehålla frågeparametrar.
get

Skapa ett GET-begärandeobjekt.
head

Skapa ett HEAD-begärandeobjekt.
merge

Skapa ett MERGE-begärandeobjekt.
options

Skapa ett OPTIONS-begärandeobjekt.
patch

Skapa ett PATCH-begärandeobjekt.
post

Skapa ett POST-begärandeobjekt.
put

Skapa ett PUT-begärandeobjekt.
send_request

Metod som kör nätverksbegäran via klientens länkade principer.


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

Skapa ett DELETE-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content
bytes eller str eller dict
standardvärde: None

Brödtextinnehållet

form_content
dict
standardvärde: None

Formulärinnehåll

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

format_url

Formatera begärande-URL med klientens bas-URL, såvida inte den angivna URL:en redan är absolut.

Observera att både bas-URL:en och mall-URL:en kan innehålla frågeparametrar.

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

Parametrar

url_template
str
Obligatorisk

Begärande-URL:en ska formateras om det behövs.

Returer

Den formaterade URL:en.

Returtyp

str

get

Skapa ett GET-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content
bytes eller str eller dict
standardvärde: None

Brödtextinnehållet

form_content
dict
standardvärde: None

Formulärinnehåll

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

head

Skapa ett HEAD-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content
bytes eller str eller dict
standardvärde: None

Brödtextinnehållet

form_content
dict
standardvärde: None

Formulärinnehåll

stream_content
<xref:stream> eller <xref:generator> eller <xref:asyncgenerator>
standardvärde: None

Brödtextinnehållet som en ström

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

merge

Skapa ett MERGE-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content
bytes eller str eller dict
standardvärde: None

Brödtextinnehållet

form_content
dict
standardvärde: None

Formulärinnehåll

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

options

Skapa ett OPTIONS-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content

Brödtextinnehållet

form_content
dict

Formulärinnehåll

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

patch

Skapa ett PATCH-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content
bytes eller str eller dict
standardvärde: None

Brödtextinnehållet

form_content
dict
standardvärde: None

Formulärinnehåll

stream_content
<xref:stream> eller <xref:generator> eller <xref:asyncgenerator>
standardvärde: None

Brödtextinnehållet som en ström

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

post

Skapa ett POST-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content
bytes eller str eller dict
standardvärde: None

Brödtextinnehållet

form_content
dict
standardvärde: None

Formulärinnehåll

stream_content
<xref:stream> eller <xref:generator> eller <xref:asyncgenerator>
standardvärde: None

Brödtextinnehållet som en ström

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

put

Skapa ett PUT-begärandeobjekt.

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

Parametrar

url
str
Obligatorisk

Begärande-URL:en.

params
dict
standardvärde: None

Begär URL-parametrar.

headers
dict
standardvärde: None

Sidhuvuden

content
bytes eller str eller dict
standardvärde: None

Brödtextinnehållet

form_content
dict
standardvärde: None

Formulärinnehåll

stream_content
<xref:stream> eller <xref:generator> eller <xref:asyncgenerator>
standardvärde: None

Brödtextinnehållet som en ström

Returer

Ett HttpRequest-objekt

Returtyp

HttpRequest

send_request

Metod som kör nätverksbegäran via klientens länkade principer.


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

Parametrar

request
HttpRequest
Obligatorisk

Den nätverksbegäran som du vill göra. Krävs.

stream
bool

Om svarsnyttolasten kommer att strömmas. Standardvärdet är False.

Returer

Svaret på ditt nätverksanrop. Felhantering sker inte för ditt svar.

Returtyp

HttpResponse