PipelineClient Osztály

Referencia

Szolgáltatásügyfél alapvető metódusai.

Folyamatügyfél létrehozása.

Öröklődés: 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)

Paraméterek

base_url: str

Kötelező

A kérelem URL-címe.

config: Configuration

Ha nincs megadva, a rendszer a standard konfigurációt használja.

pipeline: Pipeline

Ha nincs megadva, a rendszer létrehoz és visszaad egy Folyamat objektumot.

policies: list[HTTPPolicy]

Ha nincs megadva, a rendszer a konfigurációs objektum standard szabályzatait használja.

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

Ha meg van adva, a szabályzatok a RetryPolicy előtt bekerülnek a szabályzatok listájába

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

Ha meg van adva, a szabályzatok a RetryPolicy után bekerülnek a szabályzatok listájába

transport: HttpTransport

Ha nincs megadva, a RequestsTransport a szinkron átvitelhez használatos.

Példák

Létrehozza a folyamatügyfélt.


   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)

Metódusok

close
delete	Hozzon létre egy DELETE kérelemobjektumot.
format_url	Formázza a kérelem URL-címét az ügyfél alap URL-címével, kivéve, ha a megadott URL-cím már abszolút. Vegye figyelembe, hogy az alap URL-cím és a sablon URL-címe is tartalmazhat lekérdezési paramétereket.
get	Hozzon létre egy GET kérelemobjektumot.
head	Hozzon létre egy HEAD-kérelemobjektumot.
merge	Hozzon létre egy MERGE kérelemobjektumot.
options	Hozzon létre egy OPTIONS kérelemobjektumot.
patch	Hozzon létre egy PATCH kérésobjektumot.
post	Hozzon létre egy POST kérelemobjektumot.
put	Hozzon létre egy PUT kérelemobjektumot.
send_request	A hálózati kérést az ügyfél láncolt szabályzatain keresztül futtató metódus. `>>> 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

Hozzon létre egy DELETE kérelemobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content: bytes vagy str vagy dict

alapértelmezett érték: None

A törzs tartalma

form_content: dict

alapértelmezett érték: None

Űrlap tartalma

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

format_url

Formázza a kérelem URL-címét az ügyfél alap URL-címével, kivéve, ha a megadott URL-cím már abszolút.

Vegye figyelembe, hogy az alap URL-cím és a sablon URL-címe is tartalmazhat lekérdezési paramétereket.

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

Paraméterek

url_template: str

Kötelező

A kérelem URL-címe, amelyet szükség esetén formázni kell.

Válaszok

A formázott URL-cím.

Visszatérési típus

str

get

Hozzon létre egy GET kérelemobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content: bytes vagy str vagy dict

alapértelmezett érték: None

A törzs tartalma

form_content: dict

alapértelmezett érték: None

Űrlap tartalma

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

head

Hozzon létre egy HEAD-kérelemobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content: bytes vagy str vagy dict

alapértelmezett érték: None

A törzs tartalma

form_content: dict

alapértelmezett érték: None

Űrlap tartalma

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

alapértelmezett érték: None

A törzs tartalma adatfolyamként

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

merge

Hozzon létre egy MERGE kérelemobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content: bytes vagy str vagy dict

alapértelmezett érték: None

A törzs tartalma

form_content: dict

alapértelmezett érték: None

Űrlap tartalma

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

options

Hozzon létre egy OPTIONS kérelemobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content

A törzs tartalma

form_content: dict

Űrlap tartalma

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

patch

Hozzon létre egy PATCH kérésobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content: bytes vagy str vagy dict

alapértelmezett érték: None

A törzs tartalma

form_content: dict

alapértelmezett érték: None

Űrlap tartalma

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

alapértelmezett érték: None

A törzs tartalma adatfolyamként

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

post

Hozzon létre egy POST kérelemobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content: bytes vagy str vagy dict

alapértelmezett érték: None

A törzs tartalma

form_content: dict

alapértelmezett érték: None

Űrlap tartalma

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

alapértelmezett érték: None

A törzs tartalma adatfolyamként

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

put

Hozzon létre egy PUT kérelemobjektumot.

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

Paraméterek

url: str

Kötelező

A kérelem URL-címe.

params: dict

alapértelmezett érték: None

Kérelem URL-paraméterei.

headers: dict

alapértelmezett érték: None

Fejlécek

content: bytes vagy str vagy dict

alapértelmezett érték: None

A törzs tartalma

form_content: dict

alapértelmezett érték: None

Űrlap tartalma

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

alapértelmezett érték: None

A törzs tartalma adatfolyamként

Válaszok

HttpRequest objektum

Visszatérési típus

HttpRequest

send_request

A hálózati kérést az ügyfél láncolt szabályzatain keresztül futtató metódus.


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

Paraméterek

request: HttpRequest

Kötelező

A létrehozni kívánt hálózati kérelem. Kötelező.

stream: bool

A válasz hasznos adatainak streamelése. Alapértelmezés szerint Hamis.

Válaszok

A hálózati hívás válasza. Nem végez hibakezelést a válaszon.

Visszatérési típus

HttpResponse

Megosztás a következőn keresztül:

PipelineClient Osztály

Konstruktor

Paraméterek

Példák

Metódusok

close

delete

Paraméterek

Válaszok

Visszatérési típus

format_url

Paraméterek

Válaszok

Visszatérési típus

get

Paraméterek

Válaszok

Visszatérési típus

head

Paraméterek

Válaszok

Visszatérési típus

merge

Paraméterek

Válaszok

Visszatérési típus

options

Paraméterek

Válaszok

Visszatérési típus

patch

Paraméterek

Válaszok

Visszatérési típus

post

Paraméterek

Válaszok

Visszatérési típus

put

Paraméterek

Válaszok

Visszatérési típus

send_request

Paraméterek

Válaszok

Visszatérési típus

További források