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。