PipelineClient Klasse

Kernmethoden des Dienstclients.

Erstellt einen Pipelineclient.

Vererbung

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)

Parameter

base_url

str

Erforderlich

URL für die Anforderung.

config

Configuration

Wenn nicht angegeben, wird die Standardkonfiguration verwendet.

pipeline

Pipeline

Wenn es nicht angegeben wird, wird ein Pipelineobjekt erstellt und zurückgegeben.

policies

list[HTTPPolicy]

Wenn nicht angegeben, werden die Standardrichtlinien des Konfigurationsobjekts verwendet.

per_call_policies

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

Falls angegeben, werden die Richtlinien der Richtlinienliste vor RetryPolicy hinzugefügt.

per_retry_policies

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

Falls angegeben, werden die Richtlinien der Richtlinienliste nach RetryPolicy hinzugefügt.

transport

HttpTransport

Falls nicht angegeben, wird RequestsTransport für den synchronen Transport verwendet.

Beispiele

Erstellt den Pipelineclient.

   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	Erstellen Sie ein DELETE-Anforderungsobjekt.
format_url	Formatieren Sie die Anforderungs-URL mit der Clientbasis-URL, es sei denn, die angegebene URL ist bereits absolut. Beachten Sie, dass sowohl die Basis-URL als auch die Vorlagen-URL Abfrageparameter enthalten können.
get	Erstellen Sie ein GET-Anforderungsobjekt.
head	Erstellen Sie ein HEAD Anforderungsobjekt.
merge	Erstellen Sie ein MERGE-Anforderungsobjekt.
options	Erstellen Sie ein OPTIONS-Anforderungsobjekt.
patch	Erstellen Sie ein PATCH-Anforderungsobjekt.
post	Erstellen Sie ein POST-Anforderungsobjekt.
put	Erstellen Sie ein PUT-Anforderungsobjekt.
send_request	Methode, die die Netzwerkanforderung über die verketteten Richtlinien des Clients ausführt. >>> 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

Erstellen Sie ein DELETE-Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

bytes oder str oder dict

Standardwert: None

Der Textinhalt

form_content

dict

Standardwert: None

Formularinhalt

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

format_url

Formatieren Sie die Anforderungs-URL mit der Clientbasis-URL, es sei denn, die angegebene URL ist bereits absolut.

Beachten Sie, dass sowohl die Basis-URL als auch die Vorlagen-URL Abfrageparameter enthalten können.

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

Parameter

url_template

str

Erforderlich

Die Anforderungs-URL, die bei Bedarf formatiert werden soll.

Gibt zurück

Die formatierte URL.

Rückgabetyp

str

get

Erstellen Sie ein GET-Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

bytes oder str oder dict

Standardwert: None

Der Textinhalt

form_content

dict

Standardwert: None

Formularinhalt

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

head

Erstellen Sie ein HEAD Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

bytes oder str oder dict

Standardwert: None

Der Textinhalt

form_content

dict

Standardwert: None

Formularinhalt

stream_content

<xref:stream> oder <xref:generator> oder <xref:asyncgenerator>

Standardwert: None

Der Textinhalt als Stream

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

merge

Erstellen Sie ein MERGE-Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

bytes oder str oder dict

Standardwert: None

Der Textinhalt

form_content

dict

Standardwert: None

Formularinhalt

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

options

Erstellen Sie ein OPTIONS-Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

Der Textinhalt

form_content

dict

Formularinhalt

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

patch

Erstellen Sie ein PATCH-Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

bytes oder str oder dict

Standardwert: None

Der Textinhalt

form_content

dict

Standardwert: None

Formularinhalt

stream_content

<xref:stream> oder <xref:generator> oder <xref:asyncgenerator>

Standardwert: None

Der Textinhalt als Stream

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

post

Erstellen Sie ein POST-Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

bytes oder str oder dict

Standardwert: None

Der Textinhalt

form_content

dict

Standardwert: None

Formularinhalt

stream_content

<xref:stream> oder <xref:generator> oder <xref:asyncgenerator>

Standardwert: None

Der Textinhalt als Stream

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

put

Erstellen Sie ein PUT-Anforderungsobjekt.

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

Parameter

url

str

Erforderlich

Die Anforderungs-URL.

params

dict

Standardwert: None

Anforderungs-URL-Parameter.

headers

dict

Standardwert: None

Header

content

bytes oder str oder dict

Standardwert: None

Der Textinhalt

form_content

dict

Standardwert: None

Formularinhalt

stream_content

<xref:stream> oder <xref:generator> oder <xref:asyncgenerator>

Standardwert: None

Der Textinhalt als Stream

Gibt zurück

Ein HttpRequest-Objekt

Rückgabetyp

HttpRequest

send_request

Methode, die die Netzwerkanforderung über die verketteten Richtlinien des Clients ausführt.

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

Parameter

request

HttpRequest

Erforderlich

Die Netzwerkanforderung, die Sie stellen möchten. Erforderlich.

stream

bool

Gibt an, ob die Antwortnutzlast gestreamt wird. Der Standardwert lautet „False“.

Gibt zurück

Die Antwort Ihres Netzwerkaufrufs. Führt keine Fehlerbehandlung für Ihre Antwort durch.

Rückgabetyp

HttpResponse