azure.monitor.ingestion package¶
-
class
azure.monitor.ingestion.
LogsIngestionClient
(endpoint: str, credential: TokenCredential, **kwargs: Any)[source]¶ Azure Monitor Data Collection Python Client.
- Parameters
endpoint (str) – The Data Collection Endpoint for the Data Collection Rule, for example https://dce-name.eastus-2.ingest.monitor.azure.com.
credential (TokenCredential) – Credential needed for the client to connect to Azure.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. Note that overriding this default value may result in unsupported behavior.
-
send_request
(request: azure.core.rest._rest_py3.HttpRequest, **kwargs: Any) → azure.core.rest._rest_py3.HttpResponse¶ Runs the network request through the client’s chained policies.
>>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = client.send_request(request) <HttpResponse: 200 OK>
For more information on this code flow, see https://aka.ms/azsdk/python/protocol/quickstart
- 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
-
upload
(rule_id: str, stream_name: str, logs: List[Any], *, max_concurrency: Optional[int] = None, **kwargs: Any) → azure.monitor.ingestion._models.UploadLogsResult¶ Ingestion API used to directly ingest data using Data Collection Rules.
See error response code and error response message for more detail.
- Parameters
- Keyword Arguments
max_concurrency (int) – Number of parallel threads to use when logs size is > 1mb.
- Returns
UploadLogsResult
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
class
azure.monitor.ingestion.
MonitorIngestionClient
(endpoint: str, credential: TokenCredential, **kwargs: Any)[source]¶ Azure Monitor Data Collection Python Client.
- Parameters
endpoint (str) – The Data Collection Endpoint for the Data Collection Rule, for example https://dce-name.eastus-2.ingest.monitor.azure.com. Required.
credential (TokenCredential) – Credential needed for the client to connect to Azure. Required.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. Note that overriding this default value may result in unsupported behavior.
-
send_request
(request: azure.core.rest._rest_py3.HttpRequest, **kwargs: Any) → azure.core.rest._rest_py3.HttpResponse[source]¶ Runs the network request through the client’s chained policies.
>>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = client.send_request(request) <HttpResponse: 200 OK>
For more information on this code flow, see https://aka.ms/azsdk/python/protocol/quickstart
- 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
-
upload
(rule_id: str, stream_name: str, logs: List[Any], *, max_concurrency: Optional[int] = None, **kwargs: Any) → azure.monitor.ingestion._models.UploadLogsResult¶ Ingestion API used to directly ingest data using Data Collection Rules.
See error response code and error response message for more detail.
- Parameters
- Keyword Arguments
max_concurrency (int) – Number of parallel threads to use when logs size is > 1mb.
- Returns
UploadLogsResult
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
class
azure.monitor.ingestion.
UploadLogsResult
(**kwargs)[source]¶ The response for send_logs API.
- Variables
status (UploadLogsStatus) – Inditcates if the result is a success or a partial failure.
failed_logs (list) – If there is a failure, returns the request.
-
class
azure.monitor.ingestion.
UploadLogsStatus
(value)[source]¶ An enumeration.
-
PARTIAL_FAILURE
= 'PartialFailure'¶
-
SUCCESS
= 'Success'¶
-