Partager via


PipelineClient Classe

Méthodes principales du client de service.

Génère un client pipeline.

Héritage
azure.core.pipeline.transport._base.PipelineClientBase
PipelineClient
PipelineClient

Constructeur

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

Paramètres

base_url
str
Obligatoire

URL de la demande.

config
Configuration

En cas d’omission, la configuration standard est utilisée.

pipeline
Pipeline

En cas d’omission, un objet Pipeline est créé et retourné.

policies
list[HTTPPolicy]

En cas d’omission, les stratégies standard de l’objet de configuration sont utilisées.

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

Si elles sont spécifiées, les stratégies seront ajoutées à la liste des stratégies avant RetryPolicy

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

Si elles sont spécifiées, les stratégies seront ajoutées à la liste des stratégies après RetryPolicy

transport
HttpTransport

En cas d’omission, RequestsTransport est utilisé pour le transport synchrone.

Exemples

Génère le client de pipeline.


   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)

Méthodes

close
delete

Créez un objet de requête DELETE.

format_url

Mettez en forme l’URL de la demande avec l’URL de base du client, sauf si l’URL fournie est déjà absolue.

Notez que l’URL de base et l’URL du modèle peuvent contenir des paramètres de requête.

get

Créez un objet de requête GET.

head

Créez un objet de requête HEAD.

merge

Créez un objet de requête MERGE.

options

Créez un objet de requête OPTIONS.

patch

Créez un objet de requête PATCH.

post

Créez un objet de requête POST.

put

Créez un objet de requête PUT.

send_request

Méthode qui exécute la requête réseau via les stratégies chaînées du 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

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content
bytes ou str ou dict
valeur par défaut: None

Contenu du corps

form_content
dict
valeur par défaut: None

Contenu du formulaire

Retours

Objet HttpRequest

Type de retour

format_url

Mettez en forme l’URL de la demande avec l’URL de base du client, sauf si l’URL fournie est déjà absolue.

Notez que l’URL de base et l’URL du modèle peuvent contenir des paramètres de requête.

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

Paramètres

url_template
str
Obligatoire

URL de demande à mettre en forme si nécessaire.

Retours

URL mise en forme.

Type de retour

str

get

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content
bytes ou str ou dict
valeur par défaut: None

Contenu du corps

form_content
dict
valeur par défaut: None

Contenu du formulaire

Retours

Objet HttpRequest

Type de retour

head

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content
bytes ou str ou dict
valeur par défaut: None

Contenu du corps

form_content
dict
valeur par défaut: None

Contenu du formulaire

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valeur par défaut: None

Contenu du corps en tant que flux

Retours

Objet HttpRequest

Type de retour

merge

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content
bytes ou str ou dict
valeur par défaut: None

Contenu du corps

form_content
dict
valeur par défaut: None

Contenu du formulaire

Retours

Objet HttpRequest

Type de retour

options

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content

Contenu du corps

form_content
dict

Contenu du formulaire

Retours

Objet HttpRequest

Type de retour

patch

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content
bytes ou str ou dict
valeur par défaut: None

Contenu du corps

form_content
dict
valeur par défaut: None

Contenu du formulaire

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valeur par défaut: None

Contenu du corps en tant que flux

Retours

Objet HttpRequest

Type de retour

post

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content
bytes ou str ou dict
valeur par défaut: None

Contenu du corps

form_content
dict
valeur par défaut: None

Contenu du formulaire

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valeur par défaut: None

Contenu du corps en tant que flux

Retours

Objet HttpRequest

Type de retour

put

Créez un objet de requête 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

Paramètres

url
str
Obligatoire

URL de la demande.

params
dict
valeur par défaut: None

Paramètres d’URL de requête.

headers
dict
valeur par défaut: None

En-têtes

content
bytes ou str ou dict
valeur par défaut: None

Contenu du corps

form_content
dict
valeur par défaut: None

Contenu du formulaire

stream_content
<xref:stream> ou <xref:generator> ou <xref:asyncgenerator>
valeur par défaut: None

Contenu du corps en tant que flux

Retours

Objet HttpRequest

Type de retour

send_request

Méthode qui exécute la requête réseau via les stratégies chaînées du 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

Paramètres

request
HttpRequest
Obligatoire

Demande réseau que vous souhaitez effectuer. Obligatoire.

stream
bool

Indique si la charge utile de réponse sera diffusée en continu. Valeur par défaut False.

Retours

Réponse de votre appel réseau. Ne gère pas les erreurs sur votre réponse.

Type de retour