azure.core package

class azure.core.AsyncPipelineClient(base_url, **kwargs)[source]

Service client core methods.

Builds an AsyncPipeline client.

Parameters

base_url (str) – URL for the request.

Keyword Arguments

  • config (Configuration) – If omitted, the standard configuration is used.

  • pipeline (Pipeline) – If omitted, a Pipeline object is created and returned.

  • policies (list[AsyncHTTPPolicy]) – If omitted, the standard policies of the configuration object is used.

  • per_call_policies (Union[AsyncHTTPPolicy, SansIOHTTPPolicy, list[AsyncHTTPPolicy], list[SansIOHTTPPolicy]]) – If specified, the policies will be added into the policy list before RetryPolicy

  • per_retry_policies (Union[AsyncHTTPPolicy, SansIOHTTPPolicy, list[AsyncHTTPPolicy], list[SansIOHTTPPolicy]]) – If specified, the policies will be added into the policy list after RetryPolicy

  • transport (AsyncHttpTransport) – If omitted, AioHttpTransport is used for asynchronous transport.

Returns

An async pipeline object.

Return type

AsyncPipeline

Example:

async close()[source]
delete(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a DELETE request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

format_url(url_template: str, **kwargs: Any) → str

Format request URL with the client base URL, unless the supplied URL is already absolute.

Parameters

url_template (str) – The request URL to be formatted if necessary.

get(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a GET request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

head(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a HEAD request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

merge(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a MERGE request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

options(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.core.pipeline.transport._base.HttpRequest

Create a OPTIONS request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

Keyword Arguments

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

patch(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a PATCH request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

post(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a POST request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

put(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a PUT request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

send_request(request: HTTPRequestType, *, stream: bool = False, **kwargs: Any) → Awaitable[AsyncHTTPResponseType][source]

Provisional method that runs the network request through the client’s chained policies.

This method is marked as provisional, meaning it may be changed in a future release.

>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest('GET', 'http://www.example.com')
<HttpRequest [GET], url: 'http://www.example.com'>
>>> response = await client.send_request(request)
<AsyncHttpResponse: 200 OK>
Parameters

request (HttpRequest) – The network request you want to make. Required.

Keyword Arguments

stream (bool) – Whether the response payload will be streamed. Defaults to False.

Returns

The response of your network call. Does not do error handling on your response.

Return type

AsyncHttpResponse

class azure.core.CaseInsensitiveEnumMeta(cls, bases, classdict)[source]

Enum metaclass to allow for interoperability with case-insensitive strings.

Consuming this metaclass in an SDK should be done in the following manner:

from enum import Enum
from six import with_metaclass
from azure.core import CaseInsensitiveEnumMeta

class MyCustomEnum(with_metaclass(CaseInsensitiveEnumMeta, str, Enum)):
    FOO = 'foo'
    BAR = 'bar'
mro() → list

return a type’s method resolution order

class azure.core.MatchConditions(value)[source]

An enum to describe match conditions.

IfMissing = 5
IfModified = 3
IfNotModified = 2
IfPresent = 4
Unconditionally = 1
class azure.core.PipelineClient(base_url, **kwargs)[source]

Service client core methods.

Builds a Pipeline client.

Parameters

base_url (str) – URL for the request.

Keyword Arguments

  • config (Configuration) – If omitted, the standard configuration is used.

  • pipeline (Pipeline) – If omitted, a Pipeline object is created and returned.

  • policies (list[HTTPPolicy]) – If omitted, the standard policies of the configuration object is used.

  • per_call_policies (Union[HTTPPolicy, SansIOHTTPPolicy, list[HTTPPolicy], list[SansIOHTTPPolicy]]) – If specified, the policies will be added into the policy list before RetryPolicy

  • per_retry_policies (Union[HTTPPolicy, SansIOHTTPPolicy, list[HTTPPolicy], list[SansIOHTTPPolicy]]) – If specified, the policies will be added into the policy list after RetryPolicy

  • transport (HttpTransport) – If omitted, RequestsTransport is used for synchronous transport.

Returns

A pipeline object.

Return type

Pipeline

Example:

close()[source]
delete(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a DELETE request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

format_url(url_template: str, **kwargs: Any) → str

Format request URL with the client base URL, unless the supplied URL is already absolute.

Parameters

url_template (str) – The request URL to be formatted if necessary.

get(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a GET request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

head(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a HEAD request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

merge(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a MERGE request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

options(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, **kwargs: Any) → azure.core.pipeline.transport._base.HttpRequest

Create a OPTIONS request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

Keyword Arguments

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

patch(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a PATCH request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

post(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a POST request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

put(url: str, params: Optional[Dict[str, str]] = None, headers: Optional[Dict[str, str]] = None, content: Optional[Any] = None, form_content: Optional[Dict[str, Any]] = None, stream_content: Optional[Any] = None) → azure.core.pipeline.transport._base.HttpRequest

Create a PUT request object.

Parameters

  • url (str) – The request URL.

  • params (dict) – Request URL parameters.

  • headers (dict) – Headers

  • content – The body content

  • form_content (dict) – Form content

Returns

An HttpRequest object

Return type

HttpRequest

send_request(request: HTTPRequestType, **kwargs: Any) → HTTPResponseType[source]

Provisional method that runs the network request through the client’s chained policies.

This method is marked as provisional, meaning it may be changed in a future release.

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

request (HttpRequest) – The network request you want to make. Required.

Keyword Arguments

stream (bool) – Whether the response payload will be streamed. Defaults to False.

Returns

The response of your network call. Does not do error handling on your response.

Return type

HttpResponse

#