Class LogAnalyticsClient
Service client instance for LogAnalytics.
Implements
Inherited Members
Namespace: Oci.LoganalyticsService
Assembly: OCI.DotNetSDK.Loganalytics.dll
Syntax
public class LogAnalyticsClient : RegionalClientBase, IDisposable
Constructors
LogAnalyticsClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public LogAnalyticsClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public LogAnalyticsPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
LogAnalyticsPaginators |
Waiters
Declaration
public LogAnalyticsWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
LogAnalyticsWaiters |
Methods
AddEntityAssociation(AddEntityAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds association between input source log analytics entity and one or more existing destination entities.
Declaration
public Task<AddEntityAssociationResponse> AddEntityAssociation(AddEntityAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddEntityAssociationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddEntityAssociationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddEntityAssociation API.
AddSourceEventTypes(AddSourceEventTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add one or more event types to a source. An event type and version can be enabled only on one source.
Declaration
public Task<AddSourceEventTypesResponse> AddSourceEventTypes(AddSourceEventTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddSourceEventTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddSourceEventTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddSourceEventTypes API.
AppendLookupData(AppendLookupDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Appends data to the lookup content. The csv file containing the content to be appended is passed in as binary data in the request.
Declaration
public Task<AppendLookupDataResponse> AppendLookupData(AppendLookupDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AppendLookupDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AppendLookupDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AppendLookupData API.
AssignEncryptionKey(AssignEncryptionKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API submits a work request to assign customer encryption key.
Declaration
public Task<AssignEncryptionKeyResponse> AssignEncryptionKey(AssignEncryptionKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AssignEncryptionKeyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AssignEncryptionKeyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AssignEncryptionKey API.
BatchGetBasicInfo(BatchGetBasicInfoRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists basic information about a specified set of labels in batch.
Declaration
public Task<BatchGetBasicInfoResponse> BatchGetBasicInfo(BatchGetBasicInfoRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchGetBasicInfoRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchGetBasicInfoResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchGetBasicInfo API.
CancelQueryWorkRequest(CancelQueryWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancel/Remove query job work request.
Declaration
public Task<CancelQueryWorkRequestResponse> CancelQueryWorkRequest(CancelQueryWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelQueryWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CancelQueryWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelQueryWorkRequest API.
ChangeIngestTimeRuleCompartment(ChangeIngestTimeRuleCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the specified ingest time rule to a different compartment.
Declaration
public Task<ChangeIngestTimeRuleCompartmentResponse> ChangeIngestTimeRuleCompartment(ChangeIngestTimeRuleCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeIngestTimeRuleCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeIngestTimeRuleCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeIngestTimeRuleCompartment API.
ChangeLogAnalyticsEmBridgeCompartment(ChangeLogAnalyticsEmBridgeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update the compartment of the log analytics enterprise manager bridge with the given id.
Declaration
public Task<ChangeLogAnalyticsEmBridgeCompartmentResponse> ChangeLogAnalyticsEmBridgeCompartment(ChangeLogAnalyticsEmBridgeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeLogAnalyticsEmBridgeCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeLogAnalyticsEmBridgeCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeLogAnalyticsEmBridgeCompartment API.
ChangeLogAnalyticsEntityCompartment(ChangeLogAnalyticsEntityCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update the compartment of the log analytics entity with the given id.
Declaration
public Task<ChangeLogAnalyticsEntityCompartmentResponse> ChangeLogAnalyticsEntityCompartment(ChangeLogAnalyticsEntityCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeLogAnalyticsEntityCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeLogAnalyticsEntityCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeLogAnalyticsEntityCompartment API.
ChangeLogAnalyticsLogGroupCompartment(ChangeLogAnalyticsLogGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the specified log group to a different compartment.
Declaration
public Task<ChangeLogAnalyticsLogGroupCompartmentResponse> ChangeLogAnalyticsLogGroupCompartment(ChangeLogAnalyticsLogGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeLogAnalyticsLogGroupCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeLogAnalyticsLogGroupCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeLogAnalyticsLogGroupCompartment API.
ChangeLogAnalyticsObjectCollectionRuleCompartment(ChangeLogAnalyticsObjectCollectionRuleCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Move the rule from it's current compartment to the given compartment.
Declaration
public Task<ChangeLogAnalyticsObjectCollectionRuleCompartmentResponse> ChangeLogAnalyticsObjectCollectionRuleCompartment(ChangeLogAnalyticsObjectCollectionRuleCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeLogAnalyticsObjectCollectionRuleCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeLogAnalyticsObjectCollectionRuleCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeLogAnalyticsObjectCollectionRuleCompartment API.
ChangeScheduledTaskCompartment(ChangeScheduledTaskCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Move the scheduled task into a different compartment within the same tenancy.
Declaration
public Task<ChangeScheduledTaskCompartmentResponse> ChangeScheduledTaskCompartment(ChangeScheduledTaskCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeScheduledTaskCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeScheduledTaskCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeScheduledTaskCompartment API.
Clean(CleanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Clean accumulated acceleration data stored for the accelerated saved search. The ScheduledTask taskType must be ACCELERATION.
Declaration
public Task<CleanResponse> Clean(CleanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CleanRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CleanResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Clean API.
CompareContent(CompareContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the difference between the two input payloads, including intraline differences.
Declaration
public Task<CompareContentResponse> CompareContent(CompareContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CompareContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CompareContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CompareContent API.
CreateIngestTimeRule(CreateIngestTimeRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new ingest time rule in the specified compartment. You may also specify optional information such as description, defined tags, and free-form tags.
Declaration
public Task<CreateIngestTimeRuleResponse> CreateIngestTimeRule(CreateIngestTimeRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateIngestTimeRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateIngestTimeRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateIngestTimeRule API.
CreateLogAnalyticsEmBridge(CreateLogAnalyticsEmBridgeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add configuration for enterprise manager bridge. Enterprise manager bridge is used to automatically add selected entities from enterprise manager cloud control. A corresponding OCI bridge configuration is required in enterprise manager.
Declaration
public Task<CreateLogAnalyticsEmBridgeResponse> CreateLogAnalyticsEmBridge(CreateLogAnalyticsEmBridgeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateLogAnalyticsEmBridgeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateLogAnalyticsEmBridgeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateLogAnalyticsEmBridge API.
CreateLogAnalyticsEntity(CreateLogAnalyticsEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new log analytics entity.
Declaration
public Task<CreateLogAnalyticsEntityResponse> CreateLogAnalyticsEntity(CreateLogAnalyticsEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateLogAnalyticsEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateLogAnalyticsEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateLogAnalyticsEntity API.
CreateLogAnalyticsEntityType(CreateLogAnalyticsEntityTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add custom log analytics entity type.
Declaration
public Task<CreateLogAnalyticsEntityTypeResponse> CreateLogAnalyticsEntityType(CreateLogAnalyticsEntityTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateLogAnalyticsEntityTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateLogAnalyticsEntityTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateLogAnalyticsEntityType API.
CreateLogAnalyticsLogGroup(CreateLogAnalyticsLogGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new log group in the specified compartment with the input display name. You may also specify optional information such as description, defined tags, and free-form tags.
Declaration
public Task<CreateLogAnalyticsLogGroupResponse> CreateLogAnalyticsLogGroup(CreateLogAnalyticsLogGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateLogAnalyticsLogGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateLogAnalyticsLogGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateLogAnalyticsLogGroup API.
CreateLogAnalyticsObjectCollectionRule(CreateLogAnalyticsObjectCollectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a rule to collect logs from an object storage bucket.
Declaration
public Task<CreateLogAnalyticsObjectCollectionRuleResponse> CreateLogAnalyticsObjectCollectionRule(CreateLogAnalyticsObjectCollectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateLogAnalyticsObjectCollectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateLogAnalyticsObjectCollectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateLogAnalyticsObjectCollectionRule API.
CreateScheduledTask(CreateScheduledTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Schedule a task as specified and return task info.
Declaration
public Task<CreateScheduledTaskResponse> CreateScheduledTask(CreateScheduledTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateScheduledTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateScheduledTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateScheduledTask API.
DeleteAssociations(DeleteAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the associations between the sources and entities specified.
Declaration
public Task<DeleteAssociationsResponse> DeleteAssociations(DeleteAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAssociations API.
DeleteField(DeleteFieldRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes field with the specified name.
Declaration
public Task<DeleteFieldResponse> DeleteField(DeleteFieldRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteFieldRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteFieldResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteField API.
DeleteIngestTimeRule(DeleteIngestTimeRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified ingest time rule.
Declaration
public Task<DeleteIngestTimeRuleResponse> DeleteIngestTimeRule(DeleteIngestTimeRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteIngestTimeRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteIngestTimeRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteIngestTimeRule API.
DeleteLabel(DeleteLabelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes label with the specified name.
Declaration
public Task<DeleteLabelResponse> DeleteLabel(DeleteLabelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLabelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLabelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLabel API.
DeleteLogAnalyticsEmBridge(DeleteLogAnalyticsEmBridgeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete log analytics enterprise manager bridge with the given id.
Declaration
public Task<DeleteLogAnalyticsEmBridgeResponse> DeleteLogAnalyticsEmBridge(DeleteLogAnalyticsEmBridgeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLogAnalyticsEmBridgeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLogAnalyticsEmBridgeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLogAnalyticsEmBridge API.
DeleteLogAnalyticsEntity(DeleteLogAnalyticsEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete log analytics entity with the given id.
Declaration
public Task<DeleteLogAnalyticsEntityResponse> DeleteLogAnalyticsEntity(DeleteLogAnalyticsEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLogAnalyticsEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLogAnalyticsEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLogAnalyticsEntity API.
DeleteLogAnalyticsEntityType(DeleteLogAnalyticsEntityTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete log analytics entity type with the given name.
Declaration
public Task<DeleteLogAnalyticsEntityTypeResponse> DeleteLogAnalyticsEntityType(DeleteLogAnalyticsEntityTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLogAnalyticsEntityTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLogAnalyticsEntityTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLogAnalyticsEntityType API.
DeleteLogAnalyticsLogGroup(DeleteLogAnalyticsLogGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified log group. The log group cannot be part of an active association or have an active upload.
Declaration
public Task<DeleteLogAnalyticsLogGroupResponse> DeleteLogAnalyticsLogGroup(DeleteLogAnalyticsLogGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLogAnalyticsLogGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLogAnalyticsLogGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLogAnalyticsLogGroup API.
DeleteLogAnalyticsObjectCollectionRule(DeleteLogAnalyticsObjectCollectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the configured object storage bucket based collection rule and stop the log collection. It will not delete the existing processed data associated with this bucket from logging analytics storage.
Declaration
public Task<DeleteLogAnalyticsObjectCollectionRuleResponse> DeleteLogAnalyticsObjectCollectionRule(DeleteLogAnalyticsObjectCollectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLogAnalyticsObjectCollectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLogAnalyticsObjectCollectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLogAnalyticsObjectCollectionRule API.
DeleteLookup(DeleteLookupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes lookup with the specified name.
Declaration
public Task<DeleteLookupResponse> DeleteLookup(DeleteLookupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLookupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteLookupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLookup API.
DeleteParser(DeleteParserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes parser with the specified name.
Declaration
public Task<DeleteParserResponse> DeleteParser(DeleteParserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteParserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteParserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteParser API.
DeleteScheduledTask(DeleteScheduledTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the scheduled task.
Declaration
public Task<DeleteScheduledTaskResponse> DeleteScheduledTask(DeleteScheduledTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteScheduledTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteScheduledTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteScheduledTask API.
DeleteSource(DeleteSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes source with the specified name.
Declaration
public Task<DeleteSourceResponse> DeleteSource(DeleteSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSource API.
DeleteUpload(DeleteUploadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes an Upload by its reference. It deletes all the logs in storage asscoiated with the upload and the corresponding upload metadata.
Declaration
public Task<DeleteUploadResponse> DeleteUpload(DeleteUploadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteUploadRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteUploadResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteUpload API.
DeleteUploadFile(DeleteUploadFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific log file inside an upload by upload file reference. It deletes all the logs from storage associated with the file and the corresponding metadata.
Declaration
public Task<DeleteUploadFileResponse> DeleteUploadFile(DeleteUploadFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteUploadFileRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteUploadFileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteUploadFile API.
DeleteUploadWarning(DeleteUploadWarningRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Suppresses a specific warning inside an upload.
Declaration
public Task<DeleteUploadWarningResponse> DeleteUploadWarning(DeleteUploadWarningRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteUploadWarningRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteUploadWarningResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteUploadWarning API.
DisableArchiving(DisableArchivingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API disables archiving.
Declaration
public Task<DisableArchivingResponse> DisableArchiving(DisableArchivingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DisableArchivingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DisableArchivingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableArchiving API.
DisableAutoAssociation(DisableAutoAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Disables auto association for a log source. In the future, this log source would not be automatically associated with any entity that becomes eligible for association. In addition, you may also optionally remove all existing associations for this log source.
Declaration
public Task<DisableAutoAssociationResponse> DisableAutoAssociation(DisableAutoAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DisableAutoAssociationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DisableAutoAssociationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableAutoAssociation API.
DisableIngestTimeRule(DisableIngestTimeRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Disables the specified ingest time rule.
Declaration
public Task<DisableIngestTimeRuleResponse> DisableIngestTimeRule(DisableIngestTimeRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DisableIngestTimeRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DisableIngestTimeRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableIngestTimeRule API.
DisableSourceEventTypes(DisableSourceEventTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Disable one or more event types in a source.
Declaration
public Task<DisableSourceEventTypesResponse> DisableSourceEventTypes(DisableSourceEventTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DisableSourceEventTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DisableSourceEventTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableSourceEventTypes API.
EnableArchiving(EnableArchivingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
THis API enables archiving.
Declaration
public Task<EnableArchivingResponse> EnableArchiving(EnableArchivingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EnableArchivingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EnableArchivingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableArchiving API.
EnableAutoAssociation(EnableAutoAssociationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Enables auto association for a log source. This would initiate immediate association of the source to any eligible entities it is not already associated with, and would also ensure the log source gets associated with entities that are added or become eligible in the future.
Declaration
public Task<EnableAutoAssociationResponse> EnableAutoAssociation(EnableAutoAssociationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EnableAutoAssociationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EnableAutoAssociationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableAutoAssociation API.
EnableIngestTimeRule(EnableIngestTimeRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Enables the specified ingest time rule.
Declaration
public Task<EnableIngestTimeRuleResponse> EnableIngestTimeRule(EnableIngestTimeRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EnableIngestTimeRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EnableIngestTimeRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableIngestTimeRule API.
EnableSourceEventTypes(EnableSourceEventTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Enable one or more event types in a source. An event type and version can be enabled only in one source.
Declaration
public Task<EnableSourceEventTypesResponse> EnableSourceEventTypes(EnableSourceEventTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EnableSourceEventTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EnableSourceEventTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableSourceEventTypes API.
EstimatePurgeDataSize(EstimatePurgeDataSizeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API estimates the size of data to be purged based based on time interval, purge query etc.
Declaration
public Task<EstimatePurgeDataSizeResponse> EstimatePurgeDataSize(EstimatePurgeDataSizeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EstimatePurgeDataSizeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EstimatePurgeDataSizeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EstimatePurgeDataSize API.
EstimateRecallDataSize(EstimateRecallDataSizeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.
Declaration
public Task<EstimateRecallDataSizeResponse> EstimateRecallDataSize(EstimateRecallDataSizeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EstimateRecallDataSizeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EstimateRecallDataSizeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EstimateRecallDataSize API.
EstimateReleaseDataSize(EstimateReleaseDataSizeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gives an active storage usage estimate for recalled data to be released and the time range of such data.
Declaration
public Task<EstimateReleaseDataSizeResponse> EstimateReleaseDataSize(EstimateReleaseDataSizeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
EstimateReleaseDataSizeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<EstimateReleaseDataSizeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EstimateReleaseDataSize API.
ExportCustomContent(ExportCustomContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Exports all custom details of the specified sources, parsers, fields and labels, in zip format.
Declaration
public Task<ExportCustomContentResponse> ExportCustomContent(ExportCustomContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExportCustomContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExportCustomContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExportCustomContent API.
ExportQueryResult(ExportQueryResultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Export data based on query. Endpoint returns a stream of data. Endpoint is synchronous. Queries must deliver first result within 60 seconds or calls are subject to timeout.
Declaration
public Task<ExportQueryResultResponse> ExportQueryResult(ExportQueryResultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExportQueryResultRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExportQueryResultResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExportQueryResult API.
ExtractStructuredLogFieldPaths(ExtractStructuredLogFieldPathsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Extracts the field paths from the example json or xml content.
Declaration
public Task<ExtractStructuredLogFieldPathsResponse> ExtractStructuredLogFieldPaths(ExtractStructuredLogFieldPathsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExtractStructuredLogFieldPathsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExtractStructuredLogFieldPathsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExtractStructuredLogFieldPaths API.
ExtractStructuredLogHeaderPaths(ExtractStructuredLogHeaderPathsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Extracts the header paths from the example json or xml content.
Declaration
public Task<ExtractStructuredLogHeaderPathsResponse> ExtractStructuredLogHeaderPaths(ExtractStructuredLogHeaderPathsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExtractStructuredLogHeaderPathsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExtractStructuredLogHeaderPathsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExtractStructuredLogHeaderPaths API.
Filter(FilterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.
Declaration
public Task<FilterResponse> Filter(FilterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
FilterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<FilterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Filter API.
GetAssociationSummary(GetAssociationSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of source associations for entities in the specified compartment.
Declaration
public Task<GetAssociationSummaryResponse> GetAssociationSummary(GetAssociationSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAssociationSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAssociationSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAssociationSummary API.
GetCategory(GetCategoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the category with the specified name.
Declaration
public Task<GetCategoryResponse> GetCategory(GetCategoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCategoryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCategoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCategory API.
GetColumnNames(GetColumnNamesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Extracts column names from the input SQL query.
Declaration
public Task<GetColumnNamesResponse> GetColumnNames(GetColumnNamesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetColumnNamesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetColumnNamesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetColumnNames API.
GetConfigWorkRequest(GetConfigWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns detailed information about the configuration work request with the specified id.
Declaration
public Task<GetConfigWorkRequestResponse> GetConfigWorkRequest(GetConfigWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetConfigWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetConfigWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetConfigWorkRequest API.
GetField(GetFieldRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the field with the specified name.
Declaration
public Task<GetFieldResponse> GetField(GetFieldRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetFieldRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetFieldResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetField API.
GetFieldsSummary(GetFieldsSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of fields. You may optionally specify isShowDetail=true to view a summary of each field data type.
Declaration
public Task<GetFieldsSummaryResponse> GetFieldsSummary(GetFieldsSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetFieldsSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetFieldsSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetFieldsSummary API.
GetIngestTimeRule(GetIngestTimeRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the specified ingest time rule such as description, defined tags, and free-form tags.
Declaration
public Task<GetIngestTimeRuleResponse> GetIngestTimeRule(GetIngestTimeRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIngestTimeRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetIngestTimeRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIngestTimeRule API.
GetLabel(GetLabelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the label with the specified name.
Declaration
public Task<GetLabelResponse> GetLabel(GetLabelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLabelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLabelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLabel API.
GetLabelSummary(GetLabelSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of labels.
Declaration
public Task<GetLabelSummaryResponse> GetLabelSummary(GetLabelSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLabelSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLabelSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLabelSummary API.
GetLogAnalyticsEmBridge(GetLogAnalyticsEmBridgeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the log analytics enterprise manager bridge with the given id.
Declaration
public Task<GetLogAnalyticsEmBridgeResponse> GetLogAnalyticsEmBridge(GetLogAnalyticsEmBridgeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsEmBridgeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsEmBridgeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsEmBridge API.
GetLogAnalyticsEmBridgeSummary(GetLogAnalyticsEmBridgeSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns log analytics enterprise manager bridges summary report.
Declaration
public Task<GetLogAnalyticsEmBridgeSummaryResponse> GetLogAnalyticsEmBridgeSummary(GetLogAnalyticsEmBridgeSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsEmBridgeSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsEmBridgeSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsEmBridgeSummary API.
GetLogAnalyticsEntitiesSummary(GetLogAnalyticsEntitiesSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns log analytics entities count summary report.
Declaration
public Task<GetLogAnalyticsEntitiesSummaryResponse> GetLogAnalyticsEntitiesSummary(GetLogAnalyticsEntitiesSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsEntitiesSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsEntitiesSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsEntitiesSummary API.
GetLogAnalyticsEntity(GetLogAnalyticsEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the log analytics entity with the given id.
Declaration
public Task<GetLogAnalyticsEntityResponse> GetLogAnalyticsEntity(GetLogAnalyticsEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsEntity API.
GetLogAnalyticsEntityType(GetLogAnalyticsEntityTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the log analytics entity type with the given name.
Declaration
public Task<GetLogAnalyticsEntityTypeResponse> GetLogAnalyticsEntityType(GetLogAnalyticsEntityTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsEntityTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsEntityTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsEntityType API.
GetLogAnalyticsLogGroup(GetLogAnalyticsLogGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.
Declaration
public Task<GetLogAnalyticsLogGroupResponse> GetLogAnalyticsLogGroup(GetLogAnalyticsLogGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsLogGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsLogGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsLogGroup API.
GetLogAnalyticsLogGroupsSummary(GetLogAnalyticsLogGroupsSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of log groups in a compartment.
Declaration
public Task<GetLogAnalyticsLogGroupsSummaryResponse> GetLogAnalyticsLogGroupsSummary(GetLogAnalyticsLogGroupsSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsLogGroupsSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsLogGroupsSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsLogGroupsSummary API.
GetLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a configured object storage based collection rule by given id
Declaration
public Task<GetLogAnalyticsObjectCollectionRuleResponse> GetLogAnalyticsObjectCollectionRule(GetLogAnalyticsObjectCollectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogAnalyticsObjectCollectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogAnalyticsObjectCollectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogAnalyticsObjectCollectionRule API.
GetLogSetsCount(GetLogSetsCountRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API returns the count of distinct log sets.
Declaration
public Task<GetLogSetsCountResponse> GetLogSetsCount(GetLogSetsCountRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLogSetsCountRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLogSetsCountResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLogSetsCount API.
GetLookup(GetLookupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the lookup with the specified name.
Declaration
public Task<GetLookupResponse> GetLookup(GetLookupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLookupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLookupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLookup API.
GetLookupSummary(GetLookupSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of user created and oracle defined lookups.
Declaration
public Task<GetLookupSummaryResponse> GetLookupSummary(GetLookupSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLookupSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetLookupSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLookupSummary API.
GetNamespace(GetNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gets the namespace details of a tenancy already onboarded in Logging Analytics Application
Declaration
public Task<GetNamespaceResponse> GetNamespace(GetNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNamespace API.
GetParser(GetParserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the parser with the specified name.
Declaration
public Task<GetParserResponse> GetParser(GetParserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetParserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetParserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetParser API.
GetParserSummary(GetParserSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of parsers.
Declaration
public Task<GetParserSummaryResponse> GetParserSummary(GetParserSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetParserSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetParserSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetParserSummary API.
GetPreferences(GetPreferencesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
Declaration
public Task<GetPreferencesResponse> GetPreferences(GetPreferencesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPreferencesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPreferencesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPreferences API.
GetQueryResult(GetQueryResultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the intermediate results for a query that was specified to run asynchronously if the query has not completed, otherwise the final query results identified by a queryWorkRequestId returned when submitting the query execute asynchronously.
Declaration
public Task<GetQueryResultResponse> GetQueryResult(GetQueryResultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetQueryResultRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetQueryResultResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetQueryResult API.
GetQueryWorkRequest(GetQueryWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve work request details by workRequestId. This endpoint can be polled for status tracking of work request. Clients should poll using the interval returned in the retry-after header.
Declaration
public Task<GetQueryWorkRequestResponse> GetQueryWorkRequest(GetQueryWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetQueryWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetQueryWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetQueryWorkRequest API.
GetRecallCount(GetRecallCountRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gets the number of recalls made and the maximum recalls that can be made
Declaration
public Task<GetRecallCountResponse> GetRecallCount(GetRecallCountRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRecallCountRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRecallCountResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRecallCount API.
GetRecalledDataSize(GetRecalledDataSizeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gets the datasize of recalls for a given timeframe
Declaration
public Task<GetRecalledDataSizeResponse> GetRecalledDataSize(GetRecalledDataSizeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRecalledDataSizeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRecalledDataSizeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRecalledDataSize API.
GetRulesSummary(GetRulesSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of detection rules in a compartment.
Declaration
public Task<GetRulesSummaryResponse> GetRulesSummary(GetRulesSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRulesSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRulesSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRulesSummary API.
GetScheduledTask(GetScheduledTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the scheduled task for the specified task identifier.
Declaration
public Task<GetScheduledTaskResponse> GetScheduledTask(GetScheduledTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetScheduledTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetScheduledTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetScheduledTask API.
GetSource(GetSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about the source with the specified name.
Declaration
public Task<GetSourceResponse> GetSource(GetSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSource API.
GetSourceSummary(GetSourceSummaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the count of sources.
Declaration
public Task<GetSourceSummaryResponse> GetSourceSummary(GetSourceSummaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSourceSummaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSourceSummaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSourceSummary API.
GetStorage(GetStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gets the storage configuration of a tenancy
Declaration
public Task<GetStorageResponse> GetStorage(GetStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetStorageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetStorageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetStorage API.
GetStorageUsage(GetStorageUsageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gets storage usage information of a tenancy. Storage usage information includes active, archived or recalled data. The unit of return data is in bytes.
Declaration
public Task<GetStorageUsageResponse> GetStorageUsage(GetStorageUsageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetStorageUsageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetStorageUsageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetStorageUsage API.
GetStorageWorkRequest(GetStorageWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API returns work request details specified by {workRequestId}. This API can be polled for status tracking of work request. Clients should poll using the interval returned in retry-after header.
Declaration
public Task<GetStorageWorkRequestResponse> GetStorageWorkRequest(GetStorageWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetStorageWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetStorageWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetStorageWorkRequest API.
GetUnprocessedDataBucket(GetUnprocessedDataBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API retrieves details of the configured bucket that stores unprocessed payloads.
Declaration
public Task<GetUnprocessedDataBucketResponse> GetUnprocessedDataBucket(GetUnprocessedDataBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetUnprocessedDataBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetUnprocessedDataBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetUnprocessedDataBucket API.
GetUpload(GetUploadRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets an On-Demand Upload info by reference.
Declaration
public Task<GetUploadResponse> GetUpload(GetUploadRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetUploadRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetUploadResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetUpload API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status of the work request with the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ImportCustomContent(ImportCustomContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Imports the specified custom content from the input in zip format.
Declaration
public Task<ImportCustomContentResponse> ImportCustomContent(ImportCustomContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportCustomContentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ImportCustomContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportCustomContent API.
ListAssociableEntities(ListAssociableEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the entities in the specified compartment which are (in)eligible for association with this source.
Declaration
public Task<ListAssociableEntitiesResponse> ListAssociableEntities(ListAssociableEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAssociableEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAssociableEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAssociableEntities API.
ListAssociatedEntities(ListAssociatedEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the association details of entities in the specified compartment that are associated with at least one source.
Declaration
public Task<ListAssociatedEntitiesResponse> ListAssociatedEntities(ListAssociatedEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAssociatedEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAssociatedEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAssociatedEntities API.
ListAutoAssociations(ListAutoAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information related to auto association for the source with the specified name.
Declaration
public Task<ListAutoAssociationsResponse> ListAutoAssociations(ListAutoAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAutoAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAutoAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAutoAssociations API.
ListCategories(ListCategoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of categories, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as category name or description.
Declaration
public Task<ListCategoriesResponse> ListCategories(ListCategoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCategoriesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCategoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCategories API.
ListConfigWorkRequests(ListConfigWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of configuration work requests such as association or lookup operations, containing detailed information about them. You may paginate or limit the number of results.
Declaration
public Task<ListConfigWorkRequestsResponse> ListConfigWorkRequests(ListConfigWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListConfigWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListConfigWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListConfigWorkRequests API.
ListEffectiveProperties(ListEffectivePropertiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of effective properties for the specified resource.
Declaration
public Task<ListEffectivePropertiesResponse> ListEffectiveProperties(ListEffectivePropertiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEffectivePropertiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEffectivePropertiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEffectiveProperties API.
ListEncryptionKeyInfo(ListEncryptionKeyInfoRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API returns the list of customer owned encryption key info.
Declaration
public Task<ListEncryptionKeyInfoResponse> ListEncryptionKeyInfo(ListEncryptionKeyInfoRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEncryptionKeyInfoRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEncryptionKeyInfoResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEncryptionKeyInfo API.
ListEntityAssociations(ListEntityAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a list of log analytics entities associated with input source log analytics entity.
Declaration
public Task<ListEntityAssociationsResponse> ListEntityAssociations(ListEntityAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEntityAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEntityAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEntityAssociations API.
ListEntitySourceAssociations(ListEntitySourceAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of source associations for the specified entity.
Declaration
public Task<ListEntitySourceAssociationsResponse> ListEntitySourceAssociations(ListEntitySourceAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEntitySourceAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEntitySourceAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEntitySourceAssociations API.
ListFields(ListFieldsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of log fields, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by specifying various options including parser and source names.
Declaration
public Task<ListFieldsResponse> ListFields(ListFieldsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListFieldsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListFieldsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListFields API.
ListIngestTimeRules(ListIngestTimeRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of ingest time rules in a compartment. You may limit the number of rules, provide sorting options, and filter the results.
Declaration
public Task<ListIngestTimeRulesResponse> ListIngestTimeRules(ListIngestTimeRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIngestTimeRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListIngestTimeRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIngestTimeRules API.
ListLabelPriorities(ListLabelPrioritiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the available problem priorities that could be associated with a label.
Declaration
public Task<ListLabelPrioritiesResponse> ListLabelPriorities(ListLabelPrioritiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLabelPrioritiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLabelPrioritiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLabelPriorities API.
ListLabelSourceDetails(ListLabelSourceDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists sources using the label, along with configuration details like base field, operator and condition.
Declaration
public Task<ListLabelSourceDetailsResponse> ListLabelSourceDetails(ListLabelSourceDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLabelSourceDetailsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLabelSourceDetailsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLabelSourceDetails API.
ListLabels(ListLabelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of labels, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as label name, display name, description and priority.
Declaration
public Task<ListLabelsResponse> ListLabels(ListLabelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLabelsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLabelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLabels API.
ListLogAnalyticsEmBridges(ListLogAnalyticsEmBridgesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a list of log analytics enterprise manager bridges.
Declaration
public Task<ListLogAnalyticsEmBridgesResponse> ListLogAnalyticsEmBridges(ListLogAnalyticsEmBridgesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLogAnalyticsEmBridgesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLogAnalyticsEmBridgesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLogAnalyticsEmBridges API.
ListLogAnalyticsEntities(ListLogAnalyticsEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a list of log analytics entities.
Declaration
public Task<ListLogAnalyticsEntitiesResponse> ListLogAnalyticsEntities(ListLogAnalyticsEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLogAnalyticsEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLogAnalyticsEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLogAnalyticsEntities API.
ListLogAnalyticsEntityTopology(ListLogAnalyticsEntityTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a log analytics entity topology collection that contains a set of log analytics entities and a set of relationships between those, for the input source entity.
Declaration
public Task<ListLogAnalyticsEntityTopologyResponse> ListLogAnalyticsEntityTopology(ListLogAnalyticsEntityTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLogAnalyticsEntityTopologyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLogAnalyticsEntityTopologyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLogAnalyticsEntityTopology API.
ListLogAnalyticsEntityTypes(ListLogAnalyticsEntityTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a list of log analytics entity types.
Declaration
public Task<ListLogAnalyticsEntityTypesResponse> ListLogAnalyticsEntityTypes(ListLogAnalyticsEntityTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLogAnalyticsEntityTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLogAnalyticsEntityTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLogAnalyticsEntityTypes API.
ListLogAnalyticsLogGroups(ListLogAnalyticsLogGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of log groups in a compartment. You may limit the number of log groups, provide sorting options, and filter the results by specifying a display name.
Declaration
public Task<ListLogAnalyticsLogGroupsResponse> ListLogAnalyticsLogGroups(ListLogAnalyticsLogGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLogAnalyticsLogGroupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLogAnalyticsLogGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLogAnalyticsLogGroups API.
ListLogAnalyticsObjectCollectionRules(ListLogAnalyticsObjectCollectionRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets list of collection rules.
Declaration
public Task<ListLogAnalyticsObjectCollectionRulesResponse> ListLogAnalyticsObjectCollectionRules(ListLogAnalyticsObjectCollectionRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLogAnalyticsObjectCollectionRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLogAnalyticsObjectCollectionRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLogAnalyticsObjectCollectionRules API.
ListLogSets(ListLogSetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API returns a list of log sets.
Declaration
public Task<ListLogSetsResponse> ListLogSets(ListLogSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLogSetsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLogSetsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLogSets API.
ListLookups(ListLookupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of lookups, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as lookup name, description and type.
Declaration
public Task<ListLookupsResponse> ListLookups(ListLookupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLookupsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListLookupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLookups API.
ListMetaSourceTypes(ListMetaSourceTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the types of log sources supported.
Declaration
public Task<ListMetaSourceTypesResponse> ListMetaSourceTypes(ListMetaSourceTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMetaSourceTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListMetaSourceTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMetaSourceTypes API.
ListNamespaces(ListNamespacesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Given a tenancy OCID, this API returns the namespace of the tenancy if it is valid and subscribed to the region. The result also indicates if the tenancy is onboarded with Logging Analytics.
Declaration
public Task<ListNamespacesResponse> ListNamespaces(ListNamespacesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNamespacesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNamespacesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNamespaces API.
ListOverlappingRecalls(ListOverlappingRecallsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API gets the list of overlapping recalls made in the given timeframe
Declaration
public Task<ListOverlappingRecallsResponse> ListOverlappingRecalls(ListOverlappingRecallsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOverlappingRecallsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOverlappingRecallsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOverlappingRecalls API.
ListParserFunctions(ListParserFunctionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the parser functions defined for the specified parser.
Declaration
public Task<ListParserFunctionsResponse> ListParserFunctions(ListParserFunctionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListParserFunctionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListParserFunctionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListParserFunctions API.
ListParserMetaPlugins(ListParserMetaPluginsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the parser meta plugins available for defining parser functions.
Declaration
public Task<ListParserMetaPluginsResponse> ListParserMetaPlugins(ListParserMetaPluginsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListParserMetaPluginsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListParserMetaPluginsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListParserMetaPlugins API.
ListParsers(ListParsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of parsers, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as parser name, type, display name and description.
Declaration
public Task<ListParsersResponse> ListParsers(ListParsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListParsersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListParsersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListParsers API.
ListPropertiesMetadata(ListPropertiesMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of properties along with their metadata.
Declaration
public Task<ListPropertiesMetadataResponse> ListPropertiesMetadata(ListPropertiesMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPropertiesMetadataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPropertiesMetadataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPropertiesMetadata API.
ListQueryWorkRequests(ListQueryWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List active asynchronous queries.
Declaration
public Task<ListQueryWorkRequestsResponse> ListQueryWorkRequests(ListQueryWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListQueryWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListQueryWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListQueryWorkRequests API.
ListRecalledData(ListRecalledDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API returns the list of recalled data of a tenancy.
Declaration
public Task<ListRecalledDataResponse> ListRecalledData(ListRecalledDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRecalledDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRecalledDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRecalledData API.
ListResourceCategories(ListResourceCategoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of resources and their category assignments. You may limit the number of results, provide sorting order, and filter by information such as resource type.
Declaration
public Task<ListResourceCategoriesResponse> ListResourceCategories(ListResourceCategoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourceCategoriesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListResourceCategoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourceCategories API.
ListRules(ListRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of ingest time rules and scheduled tasks in a compartment. You may limit the number of items returned, provide sorting options, and filter the results.
Declaration
public Task<ListRulesResponse> ListRules(ListRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRules API.
ListScheduledTasks(ListScheduledTasksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists scheduled tasks.
Declaration
public Task<ListScheduledTasksResponse> ListScheduledTasks(ListScheduledTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListScheduledTasksRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListScheduledTasksResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListScheduledTasks API.
ListSourceAssociations(ListSourceAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of entity associations in the input compartment for the specified source.
Declaration
public Task<ListSourceAssociationsResponse> ListSourceAssociations(ListSourceAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSourceAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSourceAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSourceAssociations API.
ListSourceEventTypes(ListSourceEventTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the event types mapped to the source with the specified name. The event type string could be the fully qualified name or a prefix that matches the event type.
Declaration
public Task<ListSourceEventTypesResponse> ListSourceEventTypes(ListSourceEventTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSourceEventTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSourceEventTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSourceEventTypes API.
ListSourceExtendedFieldDefinitions(ListSourceExtendedFieldDefinitionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the extended field definitions for the source with the specified name.
Declaration
public Task<ListSourceExtendedFieldDefinitionsResponse> ListSourceExtendedFieldDefinitions(ListSourceExtendedFieldDefinitionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSourceExtendedFieldDefinitionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSourceExtendedFieldDefinitionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSourceExtendedFieldDefinitions API.
ListSourceLabelOperators(ListSourceLabelOperatorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the supported conditional operators that could be used for matching log field values to generate a label. You may use patterns to specify a condition. If a log entry matches that condition, it is tagged with the corresponding label.
Declaration
public Task<ListSourceLabelOperatorsResponse> ListSourceLabelOperators(ListSourceLabelOperatorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSourceLabelOperatorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSourceLabelOperatorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSourceLabelOperators API.
ListSourceMetaFunctions(ListSourceMetaFunctionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the functions that could be used to enrich log entries based on meaningful information extracted from the log fields.
Declaration
public Task<ListSourceMetaFunctionsResponse> ListSourceMetaFunctions(ListSourceMetaFunctionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSourceMetaFunctionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSourceMetaFunctionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSourceMetaFunctions API.
ListSourcePatterns(ListSourcePatternsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the source patterns for the source with the specified name.
Declaration
public Task<ListSourcePatternsResponse> ListSourcePatterns(ListSourcePatternsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSourcePatternsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSourcePatternsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSourcePatterns API.
ListSources(ListSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of sources, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as display name, description and entity type.
Declaration
public Task<ListSourcesResponse> ListSources(ListSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSourcesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSources API.
ListStorageWorkRequestErrors(ListStorageWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API returns the list of work request errors if any.
Declaration
public Task<ListStorageWorkRequestErrorsResponse> ListStorageWorkRequestErrors(ListStorageWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListStorageWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListStorageWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListStorageWorkRequestErrors API.
ListStorageWorkRequests(ListStorageWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API lists storage work requests. Use query parameters to narrow down or sort the result list.
Declaration
public Task<ListStorageWorkRequestsResponse> ListStorageWorkRequests(ListStorageWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListStorageWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListStorageWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListStorageWorkRequests API.
ListSupportedCharEncodings(ListSupportedCharEncodingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets list of character encodings which are supported by on-demand upload.
Declaration
public Task<ListSupportedCharEncodingsResponse> ListSupportedCharEncodings(ListSupportedCharEncodingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSupportedCharEncodingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSupportedCharEncodingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSupportedCharEncodings API.
ListSupportedTimezones(ListSupportedTimezonesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets list of timezones which are supported by on-demand upload.
Declaration
public Task<ListSupportedTimezonesResponse> ListSupportedTimezones(ListSupportedTimezonesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSupportedTimezonesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSupportedTimezonesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSupportedTimezones API.
ListUploadFiles(ListUploadFilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets list of files in an upload along with its processing state.
Declaration
public Task<ListUploadFilesResponse> ListUploadFiles(ListUploadFilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListUploadFilesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListUploadFilesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListUploadFiles API.
ListUploadWarnings(ListUploadWarningsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets list of warnings in an upload caused by incorrect configuration.
Declaration
public Task<ListUploadWarningsResponse> ListUploadWarnings(ListUploadWarningsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListUploadWarningsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListUploadWarningsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListUploadWarnings API.
ListUploads(ListUploadsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all On-demand uploads. To use this and other API operations, you must be authorized in an IAM policy.
Declaration
public Task<ListUploadsResponse> ListUploads(ListUploadsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListUploadsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListUploadsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListUploads API.
ListWarnings(ListWarningsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of collection warnings, containing detailed information about them. You may limit the number of results, provide sorting order, and filter by information such as start time, end time, warning type, warning state, source name, source pattern and entity name.
Declaration
public Task<ListWarningsResponse> ListWarnings(ListWarningsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWarningsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWarningsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWarnings API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of errors for a given work request.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of logs for a given work request.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
OffboardNamespace(OffboardNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Off-boards a tenant from Logging Analytics
Declaration
public Task<OffboardNamespaceResponse> OffboardNamespace(OffboardNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
OffboardNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<OffboardNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use OffboardNamespace API.
OnboardNamespace(OnboardNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
On-boards a tenant to Logging Analytics.
Declaration
public Task<OnboardNamespaceResponse> OnboardNamespace(OnboardNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
OnboardNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<OnboardNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use OnboardNamespace API.
ParseQuery(ParseQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Describe query
Declaration
public Task<ParseQueryResponse> ParseQuery(ParseQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ParseQueryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ParseQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ParseQuery API.
PauseScheduledTask(PauseScheduledTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Pause the scheduled task specified by {scheduledTaskId}.
Declaration
public Task<PauseScheduledTaskResponse> PauseScheduledTask(PauseScheduledTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PauseScheduledTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PauseScheduledTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PauseScheduledTask API.
PurgeStorageData(PurgeStorageDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API submits a work request to purge data. Only data from log groups that the user has permission to delete will be purged. To purge all data, the user must have permission to all log groups.
Declaration
public Task<PurgeStorageDataResponse> PurgeStorageData(PurgeStorageDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PurgeStorageDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PurgeStorageDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PurgeStorageData API.
PutQueryWorkRequestBackground(PutQueryWorkRequestBackgroundRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Put the work request specified by {workRequestId} into the background. Backgrounded queries will preserve query results on query completion for up to 7 days for recall. After 7 days the results and query expire.
Declaration
public Task<PutQueryWorkRequestBackgroundResponse> PutQueryWorkRequestBackground(PutQueryWorkRequestBackgroundRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PutQueryWorkRequestBackgroundRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PutQueryWorkRequestBackgroundResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PutQueryWorkRequestBackground API.
Query(QueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Performs a log analytics search, if shouldRunAsync is false returns the query results once they become available subject to 60 second timeout. If a query is subject to exceed that time then it should be run asynchronously. Asynchronous query submissions return the queryWorkRequestId to use for execution tracking, query submission lifecycle actions and to poll for query results.
Declaration
public Task<QueryResponse> Query(QueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
QueryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<QueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Query API.
RecallArchivedData(RecallArchivedDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API submits a work request to recall archived data based on time interval and data type.
Declaration
public Task<RecallArchivedDataResponse> RecallArchivedData(RecallArchivedDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RecallArchivedDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RecallArchivedDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RecallArchivedData API.
RegisterLookup(RegisterLookupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a lookup with the specified name, type and description. The csv file containing the lookup content is passed in as binary data in the request.
Declaration
public Task<RegisterLookupResponse> RegisterLookup(RegisterLookupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RegisterLookupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RegisterLookupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RegisterLookup API.
ReleaseRecalledData(ReleaseRecalledDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API submits a work request to release recalled data based on time interval and data type.
Declaration
public Task<ReleaseRecalledDataResponse> ReleaseRecalledData(ReleaseRecalledDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ReleaseRecalledDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ReleaseRecalledDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ReleaseRecalledData API.
RemoveEntityAssociations(RemoveEntityAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete association between input source log analytics entity and destination entities.
Declaration
public Task<RemoveEntityAssociationsResponse> RemoveEntityAssociations(RemoveEntityAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveEntityAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveEntityAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveEntityAssociations API.
RemovePreferences(RemovePreferencesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
Declaration
public Task<RemovePreferencesResponse> RemovePreferences(RemovePreferencesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemovePreferencesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemovePreferencesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemovePreferences API.
RemoveResourceCategories(RemoveResourceCategoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes the category assignments of DASHBOARD and SAVEDSEARCH resources.
Declaration
public Task<RemoveResourceCategoriesResponse> RemoveResourceCategories(RemoveResourceCategoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveResourceCategoriesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveResourceCategoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveResourceCategories API.
RemoveSourceEventTypes(RemoveSourceEventTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove one or more event types from a source.
Declaration
public Task<RemoveSourceEventTypesResponse> RemoveSourceEventTypes(RemoveSourceEventTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveSourceEventTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveSourceEventTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveSourceEventTypes API.
ResumeScheduledTask(ResumeScheduledTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Resume the scheduled task specified by {scheduledTaskId}.
Declaration
public Task<ResumeScheduledTaskResponse> ResumeScheduledTask(ResumeScheduledTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ResumeScheduledTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ResumeScheduledTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ResumeScheduledTask API.
Run(RunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Execute the saved search acceleration task in the foreground. The ScheduledTask taskType must be ACCELERATION. Optionally specify time range (timeStart and timeEnd). The default is all time.
Declaration
public Task<RunResponse> Run(RunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RunRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Run API.
SetUnprocessedDataBucket(SetUnprocessedDataBucketRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API configures a bucket to store unprocessed payloads. While processing there could be reasons a payload cannot be processed (mismatched structure, corrupted archive format, etc), if configured the payload would be uploaded to the bucket for verification.
Declaration
public Task<SetUnprocessedDataBucketResponse> SetUnprocessedDataBucket(SetUnprocessedDataBucketRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SetUnprocessedDataBucketRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SetUnprocessedDataBucketResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SetUnprocessedDataBucket API.
Suggest(SuggestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a context specific list of either commands, fields, or values to append to the end of the specified query string if applicable.
Declaration
public Task<SuggestResponse> Suggest(SuggestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SuggestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SuggestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Suggest API.
SuppressWarning(SuppressWarningRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Supresses a list of warnings. Any unsuppressed warnings in the input list would be suppressed. Warnings in the input list which are already suppressed will not be modified.
Declaration
public Task<SuppressWarningResponse> SuppressWarning(SuppressWarningRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SuppressWarningRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SuppressWarningResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SuppressWarning API.
TestParser(TestParserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Tests the parser definition against the specified example content to ensure fields are successfully extracted.
Declaration
public Task<TestParserResponse> TestParser(TestParserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
TestParserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<TestParserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use TestParser API.
UnsuppressWarning(UnsuppressWarningRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Unsupresses a list of warnings. Any suppressed warnings in the input list would be unsuppressed. Warnings in the input list which are already unsuppressed will not be modified.
Declaration
public Task<UnsuppressWarningResponse> UnsuppressWarning(UnsuppressWarningRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UnsuppressWarningRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UnsuppressWarningResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UnsuppressWarning API.
UpdateIngestTimeRule(UpdateIngestTimeRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified ingest time rule's description, defined tags, and free-form tags.
Declaration
public Task<UpdateIngestTimeRuleResponse> UpdateIngestTimeRule(UpdateIngestTimeRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateIngestTimeRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateIngestTimeRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateIngestTimeRule API.
UpdateLogAnalyticsEmBridge(UpdateLogAnalyticsEmBridgeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update log analytics enterprise manager bridge with the given id.
Declaration
public Task<UpdateLogAnalyticsEmBridgeResponse> UpdateLogAnalyticsEmBridge(UpdateLogAnalyticsEmBridgeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLogAnalyticsEmBridgeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLogAnalyticsEmBridgeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLogAnalyticsEmBridge API.
UpdateLogAnalyticsEntity(UpdateLogAnalyticsEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update the log analytics entity with the given id.
Declaration
public Task<UpdateLogAnalyticsEntityResponse> UpdateLogAnalyticsEntity(UpdateLogAnalyticsEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLogAnalyticsEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLogAnalyticsEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLogAnalyticsEntity API.
UpdateLogAnalyticsEntityType(UpdateLogAnalyticsEntityTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update custom log analytics entity type. Out of box entity types cannot be udpated.
Declaration
public Task<UpdateLogAnalyticsEntityTypeResponse> UpdateLogAnalyticsEntityType(UpdateLogAnalyticsEntityTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLogAnalyticsEntityTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLogAnalyticsEntityTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLogAnalyticsEntityType API.
UpdateLogAnalyticsLogGroup(UpdateLogAnalyticsLogGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified log group's display name, description, defined tags, and free-form tags.
Declaration
public Task<UpdateLogAnalyticsLogGroupResponse> UpdateLogAnalyticsLogGroup(UpdateLogAnalyticsLogGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLogAnalyticsLogGroupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLogAnalyticsLogGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLogAnalyticsLogGroup API.
UpdateLogAnalyticsObjectCollectionRule(UpdateLogAnalyticsObjectCollectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates configuration of the object collection rule for the given id.
Declaration
public Task<UpdateLogAnalyticsObjectCollectionRuleResponse> UpdateLogAnalyticsObjectCollectionRule(UpdateLogAnalyticsObjectCollectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLogAnalyticsObjectCollectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLogAnalyticsObjectCollectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLogAnalyticsObjectCollectionRule API.
UpdateLookup(UpdateLookupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the metadata of the specified lookup, such as the lookup description.
Declaration
public Task<UpdateLookupResponse> UpdateLookup(UpdateLookupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLookupRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLookupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLookup API.
UpdateLookupData(UpdateLookupDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the lookup content. The csv file containing the content to be updated is passed in as binary data in the request.
Declaration
public Task<UpdateLookupDataResponse> UpdateLookupData(UpdateLookupDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLookupDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateLookupDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLookupData API.
UpdatePreferences(UpdatePreferencesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the tenant preferences such as DEFAULT_HOMEPAGE and collection properties.
Declaration
public Task<UpdatePreferencesResponse> UpdatePreferences(UpdatePreferencesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePreferencesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePreferencesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePreferences API.
UpdateResourceCategories(UpdateResourceCategoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the category assignments of DASHBOARD and SAVEDSEARCH resources.
Declaration
public Task<UpdateResourceCategoriesResponse> UpdateResourceCategories(UpdateResourceCategoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateResourceCategoriesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateResourceCategoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateResourceCategories API.
UpdateScheduledTask(UpdateScheduledTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update the scheduled task. Schedules may be updated only for taskType SAVED_SEARCH and PURGE.
Declaration
public Task<UpdateScheduledTaskResponse> UpdateScheduledTask(UpdateScheduledTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateScheduledTaskRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateScheduledTaskResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateScheduledTask API.
UpdateStorage(UpdateStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API updates the archiving configuration
Declaration
public Task<UpdateStorageResponse> UpdateStorage(UpdateStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateStorageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateStorageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateStorage API.
UploadDiscoveryData(UploadDiscoveryDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Accepts discovery data for processing by Logging Analytics.
Declaration
public Task<UploadDiscoveryDataResponse> UploadDiscoveryData(UploadDiscoveryDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UploadDiscoveryDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UploadDiscoveryDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UploadDiscoveryData API.
UploadLogEventsFile(UploadLogEventsFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Accepts log events for processing by Logging Analytics.
Declaration
public Task<UploadLogEventsFileResponse> UploadLogEventsFile(UploadLogEventsFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UploadLogEventsFileRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UploadLogEventsFileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UploadLogEventsFile API.
UploadLogFile(UploadLogFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Accepts log data for processing by Logging Analytics.
Declaration
public Task<UploadLogFileResponse> UploadLogFile(UploadLogFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UploadLogFileRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UploadLogFileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UploadLogFile API.
UpsertAssociations(UpsertAssociationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates or updates associations between sources and entities. All entities should belong to the specified input compartment.
Declaration
public Task<UpsertAssociationsResponse> UpsertAssociations(UpsertAssociationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpsertAssociationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpsertAssociationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpsertAssociations API.
UpsertField(UpsertFieldRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates or updates a field that could be used in parser expressions to extract and assign value. To create a field, specify its display name. A name would be generated for the field. For subsequent calls to update the field, include the name attribute.
Declaration
public Task<UpsertFieldResponse> UpsertField(UpsertFieldRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpsertFieldRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpsertFieldResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpsertField API.
UpsertLabel(UpsertLabelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates or updates a label that could be used to tag a log entry. You may optionally designate the label as a problem, and assign it a priority. You may also provide its related terms (aliases). To create a label, specify its display name. A name would be generated for the label. For subsequent calls to update the label, include the name attribute.
Declaration
public Task<UpsertLabelResponse> UpsertLabel(UpsertLabelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpsertLabelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpsertLabelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpsertLabel API.
UpsertParser(UpsertParserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates or updates a parser, which defines how fields are extracted from a log entry.
Declaration
public Task<UpsertParserResponse> UpsertParser(UpsertParserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpsertParserRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpsertParserResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpsertParser API.
UpsertSource(UpsertSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates or updates a log source. You may also specify parsers, labels, extended fields etc., for the source.
Declaration
public Task<UpsertSourceResponse> UpsertSource(UpsertSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpsertSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpsertSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpsertSource API.
ValidateAssociationParameters(ValidateAssociationParametersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Checks if the passed in entities could be associated with the specified sources. The validation is performed to ensure that the entities have the relevant property values that are used in the corresponding source patterns.
Declaration
public Task<ValidateAssociationParametersResponse> ValidateAssociationParameters(ValidateAssociationParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateAssociationParametersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateAssociationParametersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateAssociationParameters API.
ValidateEndpoint(ValidateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validates the REST endpoint configuration.
Declaration
public Task<ValidateEndpointResponse> ValidateEndpoint(ValidateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateEndpoint API.
ValidateFile(ValidateFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validates a log file to check whether it is eligible to be uploaded or not.
Declaration
public Task<ValidateFileResponse> ValidateFile(ValidateFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateFileRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateFileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateFile API.
ValidateLabelCondition(ValidateLabelConditionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validates specified condition for a source label. If both conditionString and conditionBlocks are specified, they would be validated to ensure they represent identical conditions. If one of them is input, the response would include the validated representation of the other structure too. Additionally, if field values are passed, the condition specification would be evaluated against them.
Declaration
public Task<ValidateLabelConditionResponse> ValidateLabelCondition(ValidateLabelConditionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateLabelConditionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateLabelConditionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateLabelCondition API.
ValidateSource(ValidateSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Checks if the specified input is a valid log source definition.
Declaration
public Task<ValidateSourceResponse> ValidateSource(ValidateSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateSourceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateSource API.
ValidateSourceExtendedFieldDetails(ValidateSourceExtendedFieldDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Checks if the specified input contains valid extended field definitions against the provided example content.
Declaration
public Task<ValidateSourceExtendedFieldDetailsResponse> ValidateSourceExtendedFieldDetails(ValidateSourceExtendedFieldDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateSourceExtendedFieldDetailsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateSourceExtendedFieldDetailsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateSourceExtendedFieldDetails API.
ValidateSourceMapping(ValidateSourceMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validates the source mapping for a given file and provides match status and the parsed representation of log data.
Declaration
public Task<ValidateSourceMappingResponse> ValidateSourceMapping(ValidateSourceMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateSourceMappingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateSourceMappingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateSourceMapping API.
Verify(VerifyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Verify the accelerated saved search task specified by {scheduledTaskId}. For internal use only. Optionally specify whether to return accelerated search results; the default is false. The ScheduledTask taskType must be ACCELERATION.
Declaration
public Task<VerifyResponse> Verify(VerifyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
VerifyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<VerifyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Verify API.