airflow.providers.microsoft.azure.operators.msgraph¶
模块内容¶
类¶
一个 Microsoft Graph API 操作符，允许你执行对 Microsoft Graph API 的 REST 调用。 |
函数¶
|
- airflow.providers.microsoft.azure.operators.msgraph.default_event_handler(context, event=None)[源代码]¶
- 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, api_version=None, pagination_function=None, result_processor=lambda context, result: ..., event_handler=None, serializer=ResponseSerializer, **kwargs)[源代码]¶
基类：
airflow.models.BaseOperator一个 Microsoft Graph API 操作符，允许你执行对 Microsoft Graph API 的 REST 调用。
https://learn.microsoft.com/zh-cn/graph/use-the-api
另请参阅
有关如何使用此操作符的更多信息，请查看指南： MSGraphAsyncOperator
- 参数
url (str) – 在 Microsoft Graph API 上执行的 URL (已模板化)。
response_type (kiota_abstractions.request_adapter.ResponseType | None) – 作为字符串的响应的预期返回类型。可能的值为：bytes、str、int、float、bool 和 datetime (默认为 None)。
method (str) – 用于执行 REST 调用的 HTTP 方法 (默认为 GET)。
conn_id (str) – 用于运行操作符的 HTTP 连接 ID (已模板化)。
key (str) – 用于存储 XCom 的键 (“return_value” 是默认值)。
timeout (float | None) – KiotaRequestAdapter 使用的 HTTP 超时 (默认为 None)。如果未指定超时或设置为 None，则每次请求都没有 HTTP 超时。
proxies (dict | None) – 用于定义要使用的 HTTP 代理的字典 (默认为 None)。
api_version (msgraph_core.APIVersion | str | None) – 要使用的 Microsoft Graph API 的 API 版本 (默认为 v1)。你可以传递一个名为 APIVersion 的枚举，它有两个可能的成员 v1 和 beta，或者你可以传递一个字符串作为 v1.0 或 beta。
result_processor (Callable[[airflow.utils.context.Context, Any], Any]) – 用于进一步处理来自 MS Graph API 的响应的函数 (默认为 lambda: context, response: response)。当 KiotaRequestAdapterHook 返回的响应是字节时，它们将被 base64 编码为字符串。
event_handler (Callable[[airflow.utils.context.Context, dict[Any, Any] | None], Any] | None) – 用于处理从 MSGraphTrigger 返回的事件的函数。默认情况下，当 MSGraphTrigger 返回的事件具有失败状态时，将引发一个 AirflowException，其中包含来自事件的消息，否则将返回来自事件负载的响应。
serializer (type[airflow.providers.microsoft.azure.triggers.msgraph.ResponseSerializer]) – 用于处理响应序列化的类 (默认为 ResponseSerializer)。字节将被 base64 编码为字符串，因此可以将其存储为 XCom。
- template_fields: collections.abc.Sequence[str] = ('url', 'response_type', 'path_parameters', 'url_template', 'query_parameters', 'headers',...[源代码]¶