airflow.providers.microsoft.azure.operators.msgraph¶
類¶
一個 Microsoft Graph API operator，允許您執行到 Microsoft Graph API 的 REST 呼叫。 |
函式¶
|
|
|
模組內容¶
- airflow.providers.microsoft.azure.operators.msgraph.default_event_handler(event=None, **context)[原始碼]¶
- airflow.providers.microsoft.azure.operators.msgraph.execute_callable(func, value, context, message)[原始碼]¶
- class airflow.providers.microsoft.azure.operators.msgraph.MSGraphAsyncOperator(*, url, response_type=None, path_parameters=None, url_template=None, method='GET', query_parameters=None, headers=None, data=None, conn_id=KiotaRequestAdapterHook.default_conn_name, key=XCOM_RETURN_KEY, timeout=None, proxies=None, scopes=None, api_version=None, pagination_function=None, result_processor=lambda result, **context: ..., event_handler=None, serializer=ResponseSerializer, **kwargs)[原始碼]¶
基類:
airflow.models.BaseOperator一個 Microsoft Graph API operator，允許您執行到 Microsoft Graph API 的 REST 呼叫。
https://learn.microsoft.com/en-us/graph/use-the-api
另請參閱
有關如何使用此 operator 的更多資訊，請參閱指南：MSGraphAsyncOperator
- 引數:
url (str) – 在 Microsoft Graph API 上執行的 url（使用模板）。
response_type (str | None) – 預期的響應返回型別字串。可能的值包括：bytes, str, int, float, bool 和 datetime（預設為 None）。
method (str) – 用於執行 REST 呼叫的 HTTP 方法（預設為 GET）。
conn_id (str) – 用於執行此 operator 的 HTTP 連線 ID（使用模板）。
key (str) – 用於儲存 XCom’s 的鍵（預設為 “return_value”）。
timeout (float | None) – KiotaRequestAdapter 使用的 HTTP 超時（預設為 None）。未指定超時或設定為 None 時，每個請求沒有 HTTP 超時。
proxies (dict | None) – 定義要使用的 HTTP 代理的字典（預設為 None）。
scopes (str | list[str] | None) – 要使用的 scopes（預設為 ["https://graph.microsoft.com/.default"]）。
api_version (msgraph_core.APIVersion | str | None) – 要使用的 Microsoft Graph API 的 API 版本（預設為 v1）。您可以傳遞一個名為 APIVersion 的列舉，它有兩個可能的成員 v1 和 beta，或者您可以傳遞一個字串，如 v1.0 或 beta。
result_processor (Callable[[Any, airflow.utils.context.Context], Any]) – 用於進一步處理 MS Graph API 響應的函式（預設為 lambda: response, context: response）。當 KiotaRequestAdapterHook 返回的響應是 bytes 時，它們將被 base64 編碼為字串。
event_handler (Callable[[dict[Any, Any] | None, airflow.utils.context.Context], Any] | None) – 用於處理從 MSGraphTrigger 返回的事件的函式。預設情況下，當 MSGraphTrigger 返回的事件狀態為 failed 時，會丟擲包含事件訊息的 AirflowException，否則返回事件 payload 中的響應。
serializer (type[airflow.providers.microsoft.azure.triggers.msgraph.ResponseSerializer]) – 處理響應序列化的類（預設為 ResponseSerializer）。Bytes 將被 base64 編碼為字串，以便可以儲存為 XCom。
- template_fields: collections.abc.Sequence[str] = ('url', 'response_type', 'path_parameters', 'url_template', 'query_parameters', 'headers',...[原始碼]¶
- execute(context)[原始碼]¶
建立 operator 時繼承此類。
Context 與渲染 jinja 模板時使用的字典相同。
有關更多 context，請參閱 get_template_context。