PipelineClient الفصل

الأساليب الأساسية لعميل الخدمة.

إنشاء عميل البنية الأساسية لبرنامج ربط العمليات التجارية.

توريث

azure.core.pipeline.transport._base.PipelineClientBase

PipelineClient

Generic

PipelineClient

الدالمنشئ

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

المعلمات

base_url

str

مطلوب

عنوان URL للطلب.

config

Configuration

إذا تم حذفه، يتم استخدام التكوين القياسي.

pipeline

Pipeline

إذا تم حذفه، يتم إنشاء كائن Pipeline وإرجاعه.

policies

list[HTTPPolicy]

إذا تم حذفها، يتم استخدام النهج القياسية لكائن التكوين.

per_call_policies

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

إذا تم تحديدها، فستتم إضافة النهج إلى قائمة النهج قبل RetryPolicy

per_retry_policies

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

إذا تم تحديدها، ستتم إضافة النهج إلى قائمة النهج بعد RetryPolicy

transport

HttpTransport

إذا تم حذفها، يتم استخدام RequestsTransport للنقل المتزامن.

أمثلة

بناء عميل البنية الأساسية لبرنامج ربط العمليات التجارية.

   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)

الأساليب

close
delete	إنشاء كائن طلب DELETE.
format_url	تنسيق عنوان URL للطلب باستخدام عنوان URL الأساسي للعميل، ما لم يكن عنوان URL المتوفر مطلقا بالفعل. لاحظ أن كل من عنوان URL الأساسي وعنوان URL للقالب يمكن أن يحتويا على معلمات الاستعلام.
get	إنشاء كائن طلب GET.
head	إنشاء كائن طلب HEAD.
merge	إنشاء كائن طلب MERGE.
options	إنشاء كائن طلب OPTIONS.
patch	إنشاء كائن طلب PATCH.
post	إنشاء كائن طلب POST.
put	إنشاء كائن طلب PUT.
send_request	الأسلوب الذي يقوم بتشغيل طلب الشبكة من خلال نهج العميل المتسلسلة. >>> 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

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

bytes أو str أو dict

القيمة الافتراضية: None

محتوى النص الأساسي

form_content

dict

القيمة الافتراضية: None

محتوى النموذج

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

format_url

تنسيق عنوان URL للطلب باستخدام عنوان URL الأساسي للعميل، ما لم يكن عنوان URL المتوفر مطلقا بالفعل.

لاحظ أن كل من عنوان URL الأساسي وعنوان URL للقالب يمكن أن يحتويا على معلمات الاستعلام.

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

المعلمات

url_template

str

مطلوب

عنوان URL للطلب الذي سيتم تنسيقه إذا لزم الأمر.

المرتجعات

عنوان URL المنسق.

نوع الإرجاع

str

get

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

bytes أو str أو dict

القيمة الافتراضية: None

محتوى النص الأساسي

form_content

dict

القيمة الافتراضية: None

محتوى النموذج

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

head

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

bytes أو str أو dict

القيمة الافتراضية: None

محتوى النص الأساسي

form_content

dict

القيمة الافتراضية: None

محتوى النموذج

stream_content

<xref:stream> أو <xref:generator> أو <xref:asyncgenerator>

القيمة الافتراضية: None

محتوى النص الأساسي كتدفق

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

merge

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

bytes أو str أو dict

القيمة الافتراضية: None

محتوى النص الأساسي

form_content

dict

القيمة الافتراضية: None

محتوى النموذج

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

options

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

محتوى النص الأساسي

form_content

dict

محتوى النموذج

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

patch

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

bytes أو str أو dict

القيمة الافتراضية: None

محتوى النص الأساسي

form_content

dict

القيمة الافتراضية: None

محتوى النموذج

stream_content

<xref:stream> أو <xref:generator> أو <xref:asyncgenerator>

القيمة الافتراضية: None

محتوى النص الأساسي كتدفق

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

post

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

bytes أو str أو dict

القيمة الافتراضية: None

محتوى النص الأساسي

form_content

dict

القيمة الافتراضية: None

محتوى النموذج

stream_content

<xref:stream> أو <xref:generator> أو <xref:asyncgenerator>

القيمة الافتراضية: None

محتوى النص الأساسي كتدفق

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

put

إنشاء كائن طلب 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

المعلمات

url

str

مطلوب

عنوان URL للطلب.

params

dict

القيمة الافتراضية: None

طلب معلمات URL.

headers

dict

القيمة الافتراضية: None

الرؤوس

content

bytes أو str أو dict

القيمة الافتراضية: None

محتوى النص الأساسي

form_content

dict

القيمة الافتراضية: None

محتوى النموذج

stream_content

<xref:stream> أو <xref:generator> أو <xref:asyncgenerator>

القيمة الافتراضية: None

محتوى النص الأساسي كتدفق

المرتجعات

كائن HttpRequest

نوع الإرجاع

HttpRequest

send_request

الأسلوب الذي يقوم بتشغيل طلب الشبكة من خلال نهج العميل المتسلسلة.

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

المعلمات

request

HttpRequest

مطلوب

طلب الشبكة الذي تريد تقديمه. مطلوب

stream

bool

ما إذا كان سيتم دفق حمولة الاستجابة. الإعدادات الافتراضية معينة على False.

المرتجعات

استجابة مكالمة الشبكة. لا يقوم بمعالجة الأخطاء في استجابتك.

نوع الإرجاع

HttpResponse