Class CloudGuardClient
Service client instance for CloudGuard.
Implements
Inherited Members
Namespace: Oci.CloudguardService
Assembly: OCI.DotNetSDK.Cloudguard.dll
Syntax
public class CloudGuardClient : RegionalClientBase, IDisposable
Constructors
CloudGuardClient(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 CloudGuardClient(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 CloudGuardPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
CloudGuardPaginators |
Waiters
Declaration
public CloudGuardWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
CloudGuardWaiters |
Methods
AddCompartment(AddCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a compartment to an existing security zone (SecurityZone resource), identified by securityZoneId. Specify parameters in an AddCompartmentDetails resource that you pass. If you previously removed a subcompartment from a security zone, you can add it back to the same security zone. The security zone ensures that resources in the subcompartment comply with the security zone's policies.
Declaration
public Task<AddCompartmentResponse> AddCompartment(AddCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddCompartmentRequest | 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<AddCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddCompartment API.
CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels a work request identified by workRequestId.
Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelWorkRequestRequest | 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<CancelWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelWorkRequest API.
ChangeDataSourceCompartment(ChangeDataSourceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a data source (DataSource resource), identified by parameters passed in a ChangeDataSourceCompartmentDetails resource, from the current compartment to another.
Declaration
public Task<ChangeDataSourceCompartmentResponse> ChangeDataSourceCompartment(ChangeDataSourceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDataSourceCompartmentRequest | 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<ChangeDataSourceCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDataSourceCompartment API.
ChangeDetectorRecipeCompartment(ChangeDetectorRecipeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the detector recipe (DetectorRecipe resource), identified by detectorRecipeId, from the current compartment to another compartment. When provided, If-Match is checked against etag values of the resource.
Declaration
public Task<ChangeDetectorRecipeCompartmentResponse> ChangeDetectorRecipeCompartment(ChangeDetectorRecipeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDetectorRecipeCompartmentRequest | 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<ChangeDetectorRecipeCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDetectorRecipeCompartment API.
ChangeManagedListCompartment(ChangeManagedListCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the managed list (ManagedList resource), identified by managedListId, from the current compartment to another compartment.
Declaration
public Task<ChangeManagedListCompartmentResponse> ChangeManagedListCompartment(ChangeManagedListCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeManagedListCompartmentRequest | 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<ChangeManagedListCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeManagedListCompartment API.
ChangeResponderRecipeCompartment(ChangeResponderRecipeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the responder recipe (ResponderRecipe resource), identified by responderRecipeId in a ChangeResponderRecipeCompartmentDetails resource, from the current compartment to another compartment. When provided, if-match is checked against etag values of the resource.
Declaration
public Task<ChangeResponderRecipeCompartmentResponse> ChangeResponderRecipeCompartment(ChangeResponderRecipeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeResponderRecipeCompartmentRequest | 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<ChangeResponderRecipeCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeResponderRecipeCompartment API.
ChangeSavedQueryCompartment(ChangeSavedQueryCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the SavedQuery resource into a different compartment. When provided, If-Match is checked against etag values of the resource.
Declaration
public Task<ChangeSavedQueryCompartmentResponse> ChangeSavedQueryCompartment(ChangeSavedQueryCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSavedQueryCompartmentRequest | 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<ChangeSavedQueryCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSavedQueryCompartment API.
ChangeSecurityRecipeCompartment(ChangeSecurityRecipeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the security recipe (SecurityRecipe resource), identified by securityRecipeId,
from the current compartment to another compartment. When provided, if-match
is checked
against etag
values of the resource.
Declaration
public Task<ChangeSecurityRecipeCompartmentResponse> ChangeSecurityRecipeCompartment(ChangeSecurityRecipeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSecurityRecipeCompartmentRequest | 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<ChangeSecurityRecipeCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSecurityRecipeCompartment API.
ChangeSecurityZoneCompartment(ChangeSecurityZoneCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a security zone, identified by securityZoneId, to a different compartment.
Pass parameters through a ChangeSecurityZoneCompartmentDetails resource.
When provided, if-match
is checked against etag
values of the resource.
Declaration
public Task<ChangeSecurityZoneCompartmentResponse> ChangeSecurityZoneCompartment(ChangeSecurityZoneCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSecurityZoneCompartmentRequest | 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<ChangeSecurityZoneCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSecurityZoneCompartment API.
CreateAdhocQuery(CreateAdhocQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a AdhocQuery resource.
Declaration
public Task<CreateAdhocQueryResponse> CreateAdhocQuery(CreateAdhocQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAdhocQueryRequest | 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<CreateAdhocQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAdhocQuery API.
CreateDataMaskRule(CreateDataMaskRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new DataMaskRule resource definition.
Declaration
public Task<CreateDataMaskRuleResponse> CreateDataMaskRule(CreateDataMaskRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDataMaskRuleRequest | 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<CreateDataMaskRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDataMaskRule API.
CreateDataSource(CreateDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a data source (DataSource resource), using parameters passed through a CreateDataSourceDetails resource.
Declaration
public Task<CreateDataSourceResponse> CreateDataSource(CreateDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDataSourceRequest | 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<CreateDataSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDataSource API.
CreateDetectorRecipe(CreateDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new DetectorRecipe resource.
Declaration
public Task<CreateDetectorRecipeResponse> CreateDetectorRecipe(CreateDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDetectorRecipeRequest | 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<CreateDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDetectorRecipe API.
CreateDetectorRecipeDetectorRule(CreateDetectorRecipeDetectorRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a detector rule.
Declaration
public Task<CreateDetectorRecipeDetectorRuleResponse> CreateDetectorRecipeDetectorRule(CreateDetectorRecipeDetectorRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDetectorRecipeDetectorRuleRequest | 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<CreateDetectorRecipeDetectorRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDetectorRecipeDetectorRule API.
CreateManagedList(CreateManagedListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new ManagedList resource.
Declaration
public Task<CreateManagedListResponse> CreateManagedList(CreateManagedListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateManagedListRequest | 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<CreateManagedListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateManagedList API.
CreateResponderRecipe(CreateResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a responder recipe (ResponderRecipe resource), from values passed in a CreateResponderRecipeDetails resource.
Declaration
public Task<CreateResponderRecipeResponse> CreateResponderRecipe(CreateResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateResponderRecipeRequest | 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<CreateResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateResponderRecipe API.
CreateSavedQuery(CreateSavedQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a SavedQuery resource.
Declaration
public Task<CreateSavedQueryResponse> CreateSavedQuery(CreateSavedQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSavedQueryRequest | 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<CreateSavedQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSavedQuery API.
CreateSecurityRecipe(CreateSecurityRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a security zone recipe (SecurityRecipe resource), using parameters passed in a CreateSecurityRecipeDetails resource.
Declaration
public Task<CreateSecurityRecipeResponse> CreateSecurityRecipe(CreateSecurityRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSecurityRecipeRequest | 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<CreateSecurityRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSecurityRecipe API.
CreateSecurityZone(CreateSecurityZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a security zone (SecurityZone resource) for a compartment. Pass parameters through a CreateSecurityZoneDetails resource.
Declaration
public Task<CreateSecurityZoneResponse> CreateSecurityZone(CreateSecurityZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSecurityZoneRequest | 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<CreateSecurityZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSecurityZone API.
CreateTarget(CreateTargetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a target (Target resource), using parameters passed in a CreateTargetDetails resource.
Declaration
public Task<CreateTargetResponse> CreateTarget(CreateTargetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTargetRequest | 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<CreateTargetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTarget API.
CreateTargetDetectorRecipe(CreateTargetDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Attaches a DetectorRecipe to a target (Target resource) identified by targetId, using parameters passed in a TargetAttachTargetDetectorRecipeDetails resource. Attach a DetectorRecipe with the Target
Declaration
public Task<CreateTargetDetectorRecipeResponse> CreateTargetDetectorRecipe(CreateTargetDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTargetDetectorRecipeRequest | 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<CreateTargetDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTargetDetectorRecipe API.
CreateTargetResponderRecipe(CreateTargetResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Attaches a responder recipe to a target.
Declaration
public Task<CreateTargetResponderRecipeResponse> CreateTargetResponderRecipe(CreateTargetResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTargetResponderRecipeRequest | 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<CreateTargetResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTargetResponderRecipe API.
CreateWlpAgent(CreateWlpAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates and registers a WLP agent for an on-premise resource.
Declaration
public Task<CreateWlpAgentResponse> CreateWlpAgent(CreateWlpAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateWlpAgentRequest | 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<CreateWlpAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateWlpAgent API.
DeleteAdhocQuery(DeleteAdhocQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a AdhocQuery resource identified by adhocQueryId.
Declaration
public Task<DeleteAdhocQueryResponse> DeleteAdhocQuery(DeleteAdhocQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAdhocQueryRequest | 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<DeleteAdhocQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAdhocQuery API.
DeleteDataMaskRule(DeleteDataMaskRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a DataMaskRule resource, identified by dataMaskRuleId.
Declaration
public Task<DeleteDataMaskRuleResponse> DeleteDataMaskRule(DeleteDataMaskRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDataMaskRuleRequest | 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<DeleteDataMaskRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDataMaskRule API.
DeleteDataSource(DeleteDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a data source (DataSource resource) identified by dataSourceId.
Declaration
public Task<DeleteDataSourceResponse> DeleteDataSource(DeleteDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDataSourceRequest | 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<DeleteDataSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDataSource API.
DeleteDetectorRecipe(DeleteDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
Declaration
public Task<DeleteDetectorRecipeResponse> DeleteDetectorRecipe(DeleteDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDetectorRecipeRequest | 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<DeleteDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDetectorRecipe API.
DeleteDetectorRecipeDetectorRule(DeleteDetectorRecipeDetectorRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the DetectorRecipeDetectorRule resource identified by detectorRuleId.
Declaration
public Task<DeleteDetectorRecipeDetectorRuleResponse> DeleteDetectorRecipeDetectorRule(DeleteDetectorRecipeDetectorRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDetectorRecipeDetectorRuleRequest | 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<DeleteDetectorRecipeDetectorRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDetectorRecipeDetectorRule API.
DeleteDetectorRecipeDetectorRuleDataSource(DeleteDetectorRecipeDetectorRuleDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the DetectorRecipeDetectorRuleDataSource resource by identifier.
Declaration
public Task<DeleteDetectorRecipeDetectorRuleDataSourceResponse> DeleteDetectorRecipeDetectorRuleDataSource(DeleteDetectorRecipeDetectorRuleDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDetectorRecipeDetectorRuleDataSourceRequest | 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<DeleteDetectorRecipeDetectorRuleDataSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDetectorRecipeDetectorRuleDataSource API.
DeleteManagedList(DeleteManagedListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a managed list identified by managedListId.
Declaration
public Task<DeleteManagedListResponse> DeleteManagedList(DeleteManagedListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteManagedListRequest | 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<DeleteManagedListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteManagedList API.
DeleteResponderRecipe(DeleteResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
Declaration
public Task<DeleteResponderRecipeResponse> DeleteResponderRecipe(DeleteResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteResponderRecipeRequest | 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<DeleteResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteResponderRecipe API.
DeleteSavedQuery(DeleteSavedQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a SavedQuery resource identified by savedQueryId.
Declaration
public Task<DeleteSavedQueryResponse> DeleteSavedQuery(DeleteSavedQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSavedQueryRequest | 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<DeleteSavedQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSavedQuery API.
DeleteSecurityRecipe(DeleteSecurityRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a security zone recipe, identified by securityRecipeId. The recipe can't be associated with an existing security zone.
Declaration
public Task<DeleteSecurityRecipeResponse> DeleteSecurityRecipe(DeleteSecurityRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSecurityRecipeRequest | 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<DeleteSecurityRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSecurityRecipe API.
DeleteSecurityZone(DeleteSecurityZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a security zone, identified by securityZoneId.
Declaration
public Task<DeleteSecurityZoneResponse> DeleteSecurityZone(DeleteSecurityZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSecurityZoneRequest | 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<DeleteSecurityZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSecurityZone API.
DeleteTarget(DeleteTargetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a target (Target resource) identified by targetId.
Declaration
public Task<DeleteTargetResponse> DeleteTarget(DeleteTargetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTargetRequest | 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<DeleteTargetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTarget API.
DeleteTargetDetectorRecipe(DeleteTargetDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId, from a target (Target resource) identified by targetId.
Declaration
public Task<DeleteTargetDetectorRecipeResponse> DeleteTargetDetectorRecipe(DeleteTargetDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTargetDetectorRecipeRequest | 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<DeleteTargetDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTargetDetectorRecipe API.
DeleteTargetResponderRecipe(DeleteTargetResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Detaches a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, from a target (Target resource) identified by targetId.
Declaration
public Task<DeleteTargetResponderRecipeResponse> DeleteTargetResponderRecipe(DeleteTargetResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTargetResponderRecipeRequest | 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<DeleteTargetResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTargetResponderRecipe API.
DeleteWlpAgent(DeleteWlpAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes and unregisters the WLP agent for an on-premise resource. x-obmcs-splat: routing: strategy: route-to-any-ad serviceList: [ 'cloudguard-cp-SPLAT_ENV' ] resources: wlpAgent: serviceResourceName: WlpAgent targetCompartmentId: downstream.getOr404('cloudguard-cp-SPLAT_ENV', 'GetWlpAgent', request.resourceId).compartmentId actionKind: delete resourceOcid: request.resourceId reconciliationCanStartAfterSecs: 30 permissions: [ "WLP_AGENT_DELETE" ] authorization: mode: automated check: resources['wlpAgent'].grantedPermissions.contains('WLP_AGENT_DELETE') allowCrossTenancy: true tagStore: mode: automated maximumAttemptCount: 3 throttling: perUserLimit: rpsLimit: 15 perTenantLimit: rpsLimit: 30 quotas: mode: automated search: mode: backfilling operationResourceName: wlpAgent lock: mode: test operationResourceName: wlpAgent
Declaration
public Task<DeleteWlpAgentResponse> DeleteWlpAgent(DeleteWlpAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteWlpAgentRequest | 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<DeleteWlpAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteWlpAgent API.
ExecuteResponderExecution(ExecuteResponderExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Executes the responder execution. When provided, if-match is checked against etag values of the resource.
Declaration
public Task<ExecuteResponderExecutionResponse> ExecuteResponderExecution(ExecuteResponderExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExecuteResponderExecutionRequest | 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<ExecuteResponderExecutionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExecuteResponderExecution API.
GetAdhocQuery(GetAdhocQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns an adhoc query identified by adhocQueryId.
Declaration
public Task<GetAdhocQueryResponse> GetAdhocQuery(GetAdhocQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAdhocQueryRequest | 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<GetAdhocQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAdhocQuery API.
GetAdhocQueryResultContent(GetAdhocQueryResultContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Downloads the results for a given adhoc ID (from includes results from all monitoring regions).
Declaration
public Task<GetAdhocQueryResultContentResponse> GetAdhocQueryResultContent(GetAdhocQueryResultContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAdhocQueryResultContentRequest | 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<GetAdhocQueryResultContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAdhocQueryResultContent API.
GetConditionMetadataType(GetConditionMetadataTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a ConditionMetatDataType resource with its details.
Declaration
public Task<GetConditionMetadataTypeResponse> GetConditionMetadataType(GetConditionMetadataTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetConditionMetadataTypeRequest | 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<GetConditionMetadataTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetConditionMetadataType API.
GetConfiguration(GetConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the configuration details for a Cloud Guard tenancy, identified by root compartment OCID.
Declaration
public Task<GetConfigurationResponse> GetConfiguration(GetConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetConfigurationRequest | 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<GetConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetConfiguration API.
GetDataMaskRule(GetDataMaskRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a DataMaskRule resource, identified by dataMaskRuleId.
Declaration
public Task<GetDataMaskRuleResponse> GetDataMaskRule(GetDataMaskRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDataMaskRuleRequest | 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<GetDataMaskRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDataMaskRule API.
GetDataSource(GetDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a data source (DataSource resource) identified by dataSourceId.
Declaration
public Task<GetDataSourceResponse> GetDataSource(GetDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDataSourceRequest | 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<GetDataSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDataSource API.
GetDetector(GetDetectorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a Detector resource, identified by detectorId.
Declaration
public Task<GetDetectorResponse> GetDetector(GetDetectorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDetectorRequest | 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<GetDetectorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDetector API.
GetDetectorRecipe(GetDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
Declaration
public Task<GetDetectorRecipeResponse> GetDetectorRecipe(GetDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDetectorRecipeRequest | 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<GetDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDetectorRecipe API.
GetDetectorRecipeDetectorRule(GetDetectorRecipeDetectorRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
Declaration
public Task<GetDetectorRecipeDetectorRuleResponse> GetDetectorRecipeDetectorRule(GetDetectorRecipeDetectorRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDetectorRecipeDetectorRuleRequest | 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<GetDetectorRecipeDetectorRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDetectorRecipeDetectorRule API.
GetDetectorRule(GetDetectorRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a detector rule (DetectorRule resource) identified by detectorRuleId.
Declaration
public Task<GetDetectorRuleResponse> GetDetectorRule(GetDetectorRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDetectorRuleRequest | 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<GetDetectorRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDetectorRule API.
GetManagedList(GetManagedListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a managed list identified by managedListId.
Declaration
public Task<GetManagedListResponse> GetManagedList(GetManagedListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetManagedListRequest | 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<GetManagedListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetManagedList API.
GetProblem(GetProblemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the Problem resource identified by problemId.
Declaration
public Task<GetProblemResponse> GetProblem(GetProblemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetProblemRequest | 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<GetProblemResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetProblem API.
GetResource(GetResourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a resource identified by resourceId
Declaration
public Task<GetResourceResponse> GetResource(GetResourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResourceRequest | 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<GetResourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResource API.
GetResourceProfile(GetResourceProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns details for a resource profile, identified by resourceProfileId.
Declaration
public Task<GetResourceProfileResponse> GetResourceProfile(GetResourceProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResourceProfileRequest | 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<GetResourceProfileResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResourceProfile API.
GetResourceVulnerability(GetResourceVulnerabilityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the vulnerability details associated with the cveId where resource is an instance
Declaration
public Task<GetResourceVulnerabilityResponse> GetResourceVulnerability(GetResourceVulnerabilityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResourceVulnerabilityRequest | 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<GetResourceVulnerabilityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResourceVulnerability API.
GetResponderExecution(GetResponderExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a responder execution identified by responderExecutionId.
Declaration
public Task<GetResponderExecutionResponse> GetResponderExecution(GetResponderExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResponderExecutionRequest | 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<GetResponderExecutionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResponderExecution API.
GetResponderRecipe(GetResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a responder recipe (ResponderRecipe resource) identified by responderRecipeId.
Declaration
public Task<GetResponderRecipeResponse> GetResponderRecipe(GetResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResponderRecipeRequest | 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<GetResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResponderRecipe API.
GetResponderRecipeResponderRule(GetResponderRecipeResponderRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a responder rule (ResponderRule resource) identified by responderRuleId.
Declaration
public Task<GetResponderRecipeResponderRuleResponse> GetResponderRecipeResponderRule(GetResponderRecipeResponderRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResponderRecipeResponderRuleRequest | 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<GetResponderRecipeResponderRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResponderRecipeResponderRule API.
GetResponderRule(GetResponderRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a responder rule (ResponderRule resource) identified by resonderRuleId.
Declaration
public Task<GetResponderRuleResponse> GetResponderRule(GetResponderRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResponderRuleRequest | 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<GetResponderRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResponderRule API.
GetSavedQuery(GetSavedQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a SavedQuery resource identified by savedQueryId.
Declaration
public Task<GetSavedQueryResponse> GetSavedQuery(GetSavedQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSavedQueryRequest | 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<GetSavedQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSavedQuery API.
GetSecurityPolicy(GetSecurityPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a security zone policy (SecurityPolicy resource), identified by its unique ID (securityPolicyId). When a policy is enabled in a security zone, then any action in the zone that attempts to violate that policy is blocked.
Declaration
public Task<GetSecurityPolicyResponse> GetSecurityPolicy(GetSecurityPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSecurityPolicyRequest | 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<GetSecurityPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSecurityPolicy API.
GetSecurityRecipe(GetSecurityRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a security zone recipe (SecurityRecipe resource) identified by securityRecipeId.
Declaration
public Task<GetSecurityRecipeResponse> GetSecurityRecipe(GetSecurityRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSecurityRecipeRequest | 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<GetSecurityRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSecurityRecipe API.
GetSecurityZone(GetSecurityZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a security zone (SecurityZone resource) identified by securityZoneId.
Declaration
public Task<GetSecurityZoneResponse> GetSecurityZone(GetSecurityZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSecurityZoneRequest | 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<GetSecurityZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSecurityZone API.
GetSighting(GetSightingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a single sighting (Sighting resource) identified by sightingId.
Declaration
public Task<GetSightingResponse> GetSighting(GetSightingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSightingRequest | 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<GetSightingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSighting API.
GetTarget(GetTargetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a target (Target resource) identified by targetId.
Declaration
public Task<GetTargetResponse> GetTarget(GetTargetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTargetRequest | 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<GetTargetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTarget API.
GetTargetDetectorRecipe(GetTargetDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a target detector recipe (TargetDetectorRecipe resource) identified by targetDetectorRecipeId.
Declaration
public Task<GetTargetDetectorRecipeResponse> GetTargetDetectorRecipe(GetTargetDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTargetDetectorRecipeRequest | 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<GetTargetDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTargetDetectorRecipe API.
GetTargetDetectorRecipeDetectorRule(GetTargetDetectorRecipeDetectorRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns DetectorRule resource by identified by targetDetectorRecipeId.
Declaration
public Task<GetTargetDetectorRecipeDetectorRuleResponse> GetTargetDetectorRecipeDetectorRule(GetTargetDetectorRecipeDetectorRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTargetDetectorRecipeDetectorRuleRequest | 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<GetTargetDetectorRecipeDetectorRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTargetDetectorRecipeDetectorRule API.
GetTargetResponderRecipe(GetTargetResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a target responder recipe (TargetResponderRecipe) identified by targetResponderRecipeId for a target (Target resource) identified by targetId.
Declaration
public Task<GetTargetResponderRecipeResponse> GetTargetResponderRecipe(GetTargetResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTargetResponderRecipeRequest | 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<GetTargetResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTargetResponderRecipe API.
GetTargetResponderRecipeResponderRule(GetTargetResponderRecipeResponderRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a responder rule (ResponderRule resource) identified by responderRuleId, from a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target (Target resource) identified by targetId.
Declaration
public Task<GetTargetResponderRecipeResponderRuleResponse> GetTargetResponderRecipeResponderRule(GetTargetResponderRecipeResponderRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTargetResponderRecipeResponderRuleRequest | 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<GetTargetResponderRecipeResponderRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTargetResponderRecipeResponderRule API.
GetWlpAgent(GetWlpAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a WlpAgent resource for an on-premise resource identified by wlpAgentId.
Declaration
public Task<GetWlpAgentResponse> GetWlpAgent(GetWlpAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWlpAgentRequest | 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<GetWlpAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWlpAgent API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns details for a work request (WorkRequest resource) identified by workRequestId.
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.
ListAdhocQueries(ListAdhocQueriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all adhoc queries (AdhocQuery resources) for a compartment
identified by compartmentId. List is returned in a AdhocQueryCollection resource
with page of AdhocQuerySummary resources.
<br/>
The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed.
The list does not include any subcompartments of the compartmentId passed.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListAdhocQueries on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListAdhocQueriesResponse> ListAdhocQueries(ListAdhocQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAdhocQueriesRequest | 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<ListAdhocQueriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAdhocQueries API.
ListAdhocQueryResults(ListAdhocQueryResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the results for a given adhoc ID (from includes results from all monitoring regions).
Declaration
public Task<ListAdhocQueryResultsResponse> ListAdhocQueryResults(ListAdhocQueryResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAdhocQueryResultsRequest | 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<ListAdhocQueryResultsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAdhocQueryResults API.
ListConditionMetadataTypes(ListConditionMetadataTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of ConditionMetadataType resources.
Declaration
public Task<ListConditionMetadataTypesResponse> ListConditionMetadataTypes(ListConditionMetadataTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListConditionMetadataTypesRequest | 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<ListConditionMetadataTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListConditionMetadataTypes API.
ListDataMaskRules(ListDataMaskRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all DataMaskRule resources in the specified compartmentId (OCID) and its subcompartments.
Declaration
public Task<ListDataMaskRulesResponse> ListDataMaskRules(ListDataMaskRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDataMaskRulesRequest | 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<ListDataMaskRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDataMaskRules API.
ListDataSourceEvents(ListDataSourceEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of data source events (DataSourceEventCollection resource) from the data source (DataSource resource) identified by dataSourceId.
Declaration
public Task<ListDataSourceEventsResponse> ListDataSourceEvents(ListDataSourceEventsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDataSourceEventsRequest | 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<ListDataSourceEventsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDataSourceEvents API.
ListDataSources(ListDataSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all data sources (DataSource resources) for a compartment
identified by compartmentId. List is returned in a DataSourceCollection resource
with page of DataSourceSummary resources.
<br/>
The ListAdhocQueries operation returns only the adhoc queries in 'compartmentId' passed.
The list does not include any subcompartments of the compartmentId passed.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListAdhocQueries on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListDataSourcesResponse> ListDataSources(ListDataSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDataSourcesRequest | 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<ListDataSourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDataSources API.
ListDetectorRecipeDetectorRules(ListDetectorRecipeDetectorRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of detector rules (DetectorRule resources) for a detector recipe (DetectorRecipe resource), identified by detectorRecipeId.
Declaration
public Task<ListDetectorRecipeDetectorRulesResponse> ListDetectorRecipeDetectorRules(ListDetectorRecipeDetectorRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDetectorRecipeDetectorRulesRequest | 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<ListDetectorRecipeDetectorRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDetectorRecipeDetectorRules API.
ListDetectorRecipes(ListDetectorRecipesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all detector recipes (DetectorRecipe resources) in a compartment, identified by compartmentId.
<br/>
The ListDetectorRecipes operation returns only the detector recipes in compartmentId
passed.
The list does not include any subcompartments of the compartmentId passed.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListDetectorRecipes on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListDetectorRecipesResponse> ListDetectorRecipes(ListDetectorRecipesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDetectorRecipesRequest | 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<ListDetectorRecipesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDetectorRecipes API.
ListDetectorRules(ListDetectorRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of detector rules for the DetectorRecipe resource identified by detectorId.
Declaration
public Task<ListDetectorRulesResponse> ListDetectorRules(ListDetectorRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDetectorRulesRequest | 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<ListDetectorRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDetectorRules API.
ListDetectors(ListDetectorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a detector catalog (DetectorCollection resource) with a list of DetectorSummary resources.
Declaration
public Task<ListDetectorsResponse> ListDetectors(ListDetectorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDetectorsRequest | 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<ListDetectorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDetectors API.
ListImpactedResources(ListImpactedResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of impacted resources for a problem identified by problemId.
Declaration
public Task<ListImpactedResourcesResponse> ListImpactedResources(ListImpactedResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListImpactedResourcesRequest | 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<ListImpactedResourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListImpactedResources API.
ListManagedListTypes(ListManagedListTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns all managed list types (listType parameter) that Cloud Guard supports.
Declaration
public Task<ListManagedListTypesResponse> ListManagedListTypes(ListManagedListTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListManagedListTypesRequest | 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<ListManagedListTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListManagedListTypes API.
ListManagedLists(ListManagedListsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all ManagedList resources in a compartment, identified by compartmentId.
The ListManagedLists operation returns only the managed lists in compartmentId
passed.
The list does not include any subcompartments of the compartmentId passed.
<br/>
The parameter accessLevel
specifies whether to return ManagedLists in only
those compartments for which the requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListManagedLists on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListManagedListsResponse> ListManagedLists(ListManagedListsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListManagedListsRequest | 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<ListManagedListsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListManagedLists API.
ListPolicies(ListPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of global policy statements (policy attributes) needed to fully enable Cloud Guard.
Declaration
public Task<ListPoliciesResponse> ListPolicies(ListPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPoliciesRequest | 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<ListPoliciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPolicies API.
ListProblemEndpoints(ListProblemEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of endpoints associated with a problem, identified by problemId.
Declaration
public Task<ListProblemEndpointsResponse> ListProblemEndpoints(ListProblemEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProblemEndpointsRequest | 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<ListProblemEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProblemEndpoints API.
ListProblemEntities(ListProblemEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of entities for a problem.
Declaration
public Task<ListProblemEntitiesResponse> ListProblemEntities(ListProblemEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProblemEntitiesRequest | 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<ListProblemEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProblemEntities API.
ListProblemHistories(ListProblemHistoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of actions taken on a problem.
Declaration
public Task<ListProblemHistoriesResponse> ListProblemHistories(ListProblemHistoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProblemHistoriesRequest | 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<ListProblemHistoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProblemHistories API.
ListProblems(ListProblemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all Problems identified by Cloud Guard which are currently in the database and meet the filtering criteria.
<br/>
The ListProblems operation returns only the problems in compartmentId
passed.
The list does not include any subcompartments of the compartmentId passed.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListProblems on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListProblemsResponse> ListProblems(ListProblemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProblemsRequest | 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<ListProblemsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProblems API.
ListRecommendations(ListRecommendationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of recommendations (RecommendationSummaryCollection resource with a page of RecommendationSummary resources) for a specified compartment OCID.
Declaration
public Task<ListRecommendationsResponse> ListRecommendations(ListRecommendationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRecommendationsRequest | 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<ListRecommendationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRecommendations API.
ListResourcePorts(ListResourcePortsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of open ports associated with the resourceId where resource is an instance
Declaration
public Task<ListResourcePortsResponse> ListResourcePorts(ListResourcePortsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourcePortsRequest | 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<ListResourcePortsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourcePorts API.
ListResourceProfileEndpoints(ListResourceProfileEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of endpoints (ResourceProfileEndpointCollection resource with a page of ResourceProfileEndpointSummary resources) for a resource profile identified by resourceProfileId.
Declaration
public Task<ListResourceProfileEndpointsResponse> ListResourceProfileEndpoints(ListResourceProfileEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourceProfileEndpointsRequest | 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<ListResourceProfileEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourceProfileEndpoints API.
ListResourceProfileImpactedResources(ListResourceProfileImpactedResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of impacted resources (ResourceProfileImpactedResourceCollection resource with a page of ResourceProfileImpactedResourceSummary resources) for a resource profile identified by resourceProfileId.
Declaration
public Task<ListResourceProfileImpactedResourcesResponse> ListResourceProfileImpactedResources(ListResourceProfileImpactedResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourceProfileImpactedResourcesRequest | 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<ListResourceProfileImpactedResourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourceProfileImpactedResources API.
ListResourceProfiles(ListResourceProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all resource profile summaries (ResourceProfileCollection resource with a page of
ResourceProfileSummary resources) for a compartment, identified by compartmentId and filtered as specified.
<br/>
The ListResourceProfiles operation returns only the resource profiles in compartmentId
passed.
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListResourceProfiles on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListResourceProfilesResponse> ListResourceProfiles(ListResourceProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourceProfilesRequest | 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<ListResourceProfilesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourceProfiles API.
ListResourceTypes(ListResourceTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a single ResourceTypeCollection resource, containing a list of resource types, identified by parameters specified.
Declaration
public Task<ListResourceTypesResponse> ListResourceTypes(ListResourceTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourceTypesRequest | 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<ListResourceTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourceTypes API.
ListResourceVulnerabilities(ListResourceVulnerabilitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of vulnerabilities associated with the resourceId where resource is an instance
Declaration
public Task<ListResourceVulnerabilitiesResponse> ListResourceVulnerabilities(ListResourceVulnerabilitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourceVulnerabilitiesRequest | 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<ListResourceVulnerabilitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourceVulnerabilities API.
ListResources(ListResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all resources in a compartment
<br/>
The ListResources operation returns only the resources in compartmentId
passed.
The list does not include any subcompartments of the compartmentId passed.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListResources on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListResourcesResponse> ListResources(ListResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourcesRequest | 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<ListResourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResources API.
ListResponderActivities(ListResponderActivitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of responder activities for a problem, identified by problemId, in a ResponderActivityCollection resource, with a page of ResponderActivitySummary resources.
Declaration
public Task<ListResponderActivitiesResponse> ListResponderActivities(ListResponderActivitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResponderActivitiesRequest | 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<ListResponderActivitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResponderActivities API.
ListResponderExecutions(ListResponderExecutionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of responder executions. A responder execution is an entity that tracks the collective execution of multiple responder rule executions for a given problem.
Declaration
public Task<ListResponderExecutionsResponse> ListResponderExecutions(ListResponderExecutionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResponderExecutionsRequest | 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<ListResponderExecutionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResponderExecutions API.
ListResponderRecipeResponderRules(ListResponderRecipeResponderRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of responder rules (ResponderRule resources in a responderRecipeResponderRuleCollection resource, with page of ResponderRuleSummary resources), for a responder recipe (ResponderRecipe resource), identified by responderRecipeId.
Declaration
public Task<ListResponderRecipeResponderRulesResponse> ListResponderRecipeResponderRules(ListResponderRecipeResponderRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResponderRecipeResponderRulesRequest | 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<ListResponderRecipeResponderRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResponderRecipeResponderRules API.
ListResponderRecipes(ListResponderRecipesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list (ResponderRecipeCollection resource, with a page of ResponderRecipeSummary resources)
of all responder recipes (RespponderRecipe resources) in a compartment, identified by compartmentId.
The ListResponderRecipe operation returns only the targets in compartmentId
passed.
The list does not include any subcompartments of the compartmentId passed.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListResponderRecipe on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListResponderRecipesResponse> ListResponderRecipes(ListResponderRecipesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResponderRecipesRequest | 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<ListResponderRecipesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResponderRecipes API.
ListResponderRules(ListResponderRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of responder rules for the ResponderRecipe resource identified by responderId. The list is contained in a ResponderRuleCollection resource with a page of ResponderRuleSummary resources.
Declaration
public Task<ListResponderRulesResponse> ListResponderRules(ListResponderRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResponderRulesRequest | 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<ListResponderRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResponderRules API.
ListSavedQueries(ListSavedQueriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of saved queries run in a tenancy.
Declaration
public Task<ListSavedQueriesResponse> ListSavedQueries(ListSavedQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSavedQueriesRequest | 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<ListSavedQueriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSavedQueries API.
ListSecurityPolicies(ListSecurityPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of security zone policies (SecurityPolicySummary resources), identified by compartmentId.
Declaration
public Task<ListSecurityPoliciesResponse> ListSecurityPolicies(ListSecurityPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSecurityPoliciesRequest | 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<ListSecurityPoliciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSecurityPolicies API.
ListSecurityRecipes(ListSecurityRecipesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of security zone recipes (SecurityRecipeSummary resources) in a compartment, identified by compartmentId.
Declaration
public Task<ListSecurityRecipesResponse> ListSecurityRecipes(ListSecurityRecipesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSecurityRecipesRequest | 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<ListSecurityRecipesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSecurityRecipes API.
ListSecurityZones(ListSecurityZonesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of security zones (SecurityZone resources) in a compartment identified by compartmentId. List is contained in a page of SecurityZoneSummary resources.
Declaration
public Task<ListSecurityZonesResponse> ListSecurityZones(ListSecurityZonesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSecurityZonesRequest | 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<ListSecurityZonesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSecurityZones API.
ListSightingEndpoints(ListSightingEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns sighting endpoints details in a SightingEndpointsCollection resource with a page of SightingEndpointSummary resources.
Declaration
public Task<ListSightingEndpointsResponse> ListSightingEndpoints(ListSightingEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSightingEndpointsRequest | 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<ListSightingEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSightingEndpoints API.
ListSightingImpactedResources(ListSightingImpactedResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of impacted resources for a sighting, identified by sightingId, in a SightingImpactedResourceCollection resource with a page of SightingImpactedResourceSummary resources.
Declaration
public Task<ListSightingImpactedResourcesResponse> ListSightingImpactedResources(ListSightingImpactedResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSightingImpactedResourcesRequest | 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<ListSightingImpactedResourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSightingImpactedResources API.
ListSightings(ListSightingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
For the parameters passed, returns a list of sightings
(SightingCollection resource) with a page of SightingSummary resources.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListSightings on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListSightingsResponse> ListSightings(ListSightingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSightingsRequest | 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<ListSightingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSightings API.
ListTactics(ListTacticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of TacticSummary resources for a compartment, identified by compartmentId.
Declaration
public Task<ListTacticsResponse> ListTactics(ListTacticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTacticsRequest | 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<ListTacticsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTactics API.
ListTargetDetectorRecipeDetectorRules(ListTargetDetectorRecipeDetectorRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of DetectorRule associated with DetectorRecipe within a Target.
Declaration
public Task<ListTargetDetectorRecipeDetectorRulesResponse> ListTargetDetectorRecipeDetectorRules(ListTargetDetectorRecipeDetectorRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTargetDetectorRecipeDetectorRulesRequest | 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<ListTargetDetectorRecipeDetectorRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTargetDetectorRecipeDetectorRules API.
ListTargetDetectorRecipes(ListTargetDetectorRecipesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all target detector recipes (TargetDetectorRecipe resources) associated with a target (Target resource), identified by targetId. The list is contained in a TargetDetectorRecipeCollection resource with page of TargetDetectorRecipeSummary resources.
Declaration
public Task<ListTargetDetectorRecipesResponse> ListTargetDetectorRecipes(ListTargetDetectorRecipesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTargetDetectorRecipesRequest | 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<ListTargetDetectorRecipesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTargetDetectorRecipes API.
ListTargetResponderRecipeResponderRules(ListTargetResponderRecipeResponderRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of responder rules (ResponderRule resources) associated with a responder recipe (ResponderRecipe resource) attached to a Target. List is returned in a TargetResponderRecipeResponderRuleCollection resource with page of TargetResponderRecipeResponderRuleSummary resources.
Declaration
public Task<ListTargetResponderRecipeResponderRulesResponse> ListTargetResponderRecipeResponderRules(ListTargetResponderRecipeResponderRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTargetResponderRecipeResponderRulesRequest | 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<ListTargetResponderRecipeResponderRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTargetResponderRecipeResponderRules API.
ListTargetResponderRecipes(ListTargetResponderRecipesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of summary information for all responder recipes (TargetResponderRecipeCollection resource, with a page of TargetResponderRecipeSummary resources) attached to a target identified by targetId, located in a compartment identified by compartmentId.
Declaration
public Task<ListTargetResponderRecipesResponse> ListTargetResponderRecipes(ListTargetResponderRecipesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTargetResponderRecipesRequest | 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<ListTargetResponderRecipesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTargetResponderRecipes API.
ListTargets(ListTargetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of targets (TargetCollection resource with page of TargetSummary
resources) for the target identified by compartmentId. By default, only the target
associated with the compartment is returned. Setting compartmentIdInSubtree to true
returns the entire hierarchy of targets in subcompartments.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform ListTargets on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all targets in compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<ListTargetsResponse> ListTargets(ListTargetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTargetsRequest | 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<ListTargetsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTargets API.
ListTechniques(ListTechniquesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of techniques associated with detector rules.
Declaration
public Task<ListTechniquesResponse> ListTechniques(ListTechniquesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTechniquesRequest | 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<ListTechniquesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTechniques API.
ListWlpAgents(ListWlpAgentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of WLP agents in a compartment.
Declaration
public Task<ListWlpAgentsResponse> ListWlpAgents(ListWlpAgentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWlpAgentsRequest | 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<ListWlpAgentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWlpAgents API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of errors for a work request identified by workRequestId.
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)
Returns a paginated list (WorkRequestLogEntryCollection resource) of log entries for a request, identified by workRequestId.
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)
Returns a list of work requests (WorkRequestSummaryCollection resource), in a compartment identified by compartmentId.
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.
RemoveCompartment(RemoveCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a compartment from a security zone (SecurityZone resource), identified by securityZoneId. Pass compartmentId of compartment to remove through a RemoveCompartmentDetails resource. When you remove a subcompartment from a security zone, it no longer enforces security zone policies on the resources in the subcompartment. You can't remove the primary compartment that was used to create the security zone.
Declaration
public Task<RemoveCompartmentResponse> RemoveCompartment(RemoveCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveCompartmentRequest | 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<RemoveCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveCompartment API.
RequestRiskScores(RequestRiskScoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of RiskScoreAggregation resources for a compartment, identified by compartmentId.
Declaration
public Task<RequestRiskScoresResponse> RequestRiskScores(RequestRiskScoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestRiskScoresRequest | 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<RequestRiskScoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestRiskScores API.
RequestSecurityScoreSummarizedTrend(RequestSecurityScoreSummarizedTrendRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of SecurityScoreTrendAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected.
Declaration
public Task<RequestSecurityScoreSummarizedTrendResponse> RequestSecurityScoreSummarizedTrend(RequestSecurityScoreSummarizedTrendRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSecurityScoreSummarizedTrendRequest | 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<RequestSecurityScoreSummarizedTrendResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSecurityScoreSummarizedTrend API.
RequestSecurityScores(RequestSecurityScoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of SecurityScoreAggregation resources. These measure the number of resources examined across all regions and compare it with the number of problems detected.
Declaration
public Task<RequestSecurityScoresResponse> RequestSecurityScores(RequestSecurityScoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSecurityScoresRequest | 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<RequestSecurityScoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSecurityScores API.
RequestSummarizedActivityProblems(RequestSummarizedActivityProblemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the summary of problems generated by OCI Activity Detector rules, identified by parameters specified.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform summarize API on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
<br/>
The compartmentId to be passed with accessLevel
and compartmentIdInSubtree
params has to be the root
compartment id (tenant-id) only.
Declaration
public Task<RequestSummarizedActivityProblemsResponse> RequestSummarizedActivityProblems(RequestSummarizedActivityProblemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedActivityProblemsRequest | 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<RequestSummarizedActivityProblemsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedActivityProblems API.
RequestSummarizedProblems(RequestSummarizedProblemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the number of problems matching the key-value pairs in dimensionMap.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform summarize API on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<RequestSummarizedProblemsResponse> RequestSummarizedProblems(RequestSummarizedProblemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedProblemsRequest | 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<RequestSummarizedProblemsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedProblems API.
RequestSummarizedResponderExecutions(RequestSummarizedResponderExecutionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the number of responder executions, identified by parameters specified, in a page of ResponderExecutionAggregation resources. <br/> Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201CNot Authorized\u201D is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true. <br/> Setting accessLevel to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions, directly or indirectly (permissions can be on a resource in a subcompartment). \u201CNot Authorized\u201D is returned if user doesn't have access to at least one of the child compartments. When accessLevel is set to RESTRICTED, permissions are checked and no partial results are displayed. This is valid only when compartmentIdInSubtree is set to true.
Declaration
public Task<RequestSummarizedResponderExecutionsResponse> RequestSummarizedResponderExecutions(RequestSummarizedResponderExecutionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedResponderExecutionsRequest | 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<RequestSummarizedResponderExecutionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedResponderExecutions API.
RequestSummarizedRiskScores(RequestSummarizedRiskScoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
DEPRECATED
Declaration
public Task<RequestSummarizedRiskScoresResponse> RequestSummarizedRiskScores(RequestSummarizedRiskScoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedRiskScoresRequest | 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<RequestSummarizedRiskScoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedRiskScores API.
RequestSummarizedSecurityScores(RequestSummarizedSecurityScoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
DEPRECATED
Declaration
public Task<RequestSummarizedSecurityScoresResponse> RequestSummarizedSecurityScores(RequestSummarizedSecurityScoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedSecurityScoresRequest | 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<RequestSummarizedSecurityScoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedSecurityScores API.
RequestSummarizedTopTrendResourceProfileRiskScores(RequestSummarizedTopTrendResourceProfileRiskScoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of resource profile risk score aggregation summaries (ResourceProfileRiskScoreAggregationSummaryCollection resource with a page of ResourceProfileRiskScoreAggregationSummary resources) for a specified compartment.
Declaration
public Task<RequestSummarizedTopTrendResourceProfileRiskScoresResponse> RequestSummarizedTopTrendResourceProfileRiskScores(RequestSummarizedTopTrendResourceProfileRiskScoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedTopTrendResourceProfileRiskScoresRequest | 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<RequestSummarizedTopTrendResourceProfileRiskScoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedTopTrendResourceProfileRiskScores API.
RequestSummarizedTrendProblems(RequestSummarizedTrendProblemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a ProblemTrendAggregationCollection resource for a compartment, identified by compartmentId, for the specified time period. The ProblemTrendAggregationCollection resource contains a list of ProblemTrendAggregation resources.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform summarize API on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<RequestSummarizedTrendProblemsResponse> RequestSummarizedTrendProblems(RequestSummarizedTrendProblemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedTrendProblemsRequest | 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<RequestSummarizedTrendProblemsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedTrendProblems API.
RequestSummarizedTrendResourceRiskScores(RequestSummarizedTrendResourceRiskScoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a summary of risk score trends in a ResourceRiskScoreAggregationCollection resource, with a page of ResourceRiskScoreAggregation resources, filtered by parameters that you specify in a RequestSummarizedTrendResourceRiskScoresDetailsresource.
Declaration
public Task<RequestSummarizedTrendResourceRiskScoresResponse> RequestSummarizedTrendResourceRiskScores(RequestSummarizedTrendResourceRiskScoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedTrendResourceRiskScoresRequest | 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<RequestSummarizedTrendResourceRiskScoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedTrendResourceRiskScores API.
RequestSummarizedTrendResponderExecutions(RequestSummarizedTrendResponderExecutionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the number of remediations performed by Responders, for a given time period.
<br/>
The parameter accessLevel
specifies whether to return only those compartments for which the
requestor has INSPECT permissions on at least one resource directly
or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if
Principal doesn't have access to even one of the child compartments. This is valid only when
compartmentIdInSubtree
is set to true
.
<br/>
The parameter compartmentIdInSubtree
applies when you perform summarize API on the
compartmentId
passed and when it is set to true, the entire hierarchy of compartments can be returned.
To get a full list of all compartments and subcompartments in the tenancy (root compartment),
set the parameter compartmentIdInSubtree
to true and accessLevel
to ACCESSIBLE.
Declaration
public Task<RequestSummarizedTrendResponderExecutionsResponse> RequestSummarizedTrendResponderExecutions(RequestSummarizedTrendResponderExecutionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedTrendResponderExecutionsRequest | 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<RequestSummarizedTrendResponderExecutionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedTrendResponderExecutions API.
RequestSummarizedTrendSecurityScores(RequestSummarizedTrendSecurityScoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
DEPRECATED
Declaration
public Task<RequestSummarizedTrendSecurityScoresResponse> RequestSummarizedTrendSecurityScores(RequestSummarizedTrendSecurityScoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestSummarizedTrendSecurityScoresRequest | 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<RequestSummarizedTrendSecurityScoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestSummarizedTrendSecurityScores API.
SkipBulkResponderExecution(SkipBulkResponderExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Skips the execution for a bulk of responder executions.
Declaration
public Task<SkipBulkResponderExecutionResponse> SkipBulkResponderExecution(SkipBulkResponderExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SkipBulkResponderExecutionRequest | 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<SkipBulkResponderExecutionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SkipBulkResponderExecution API.
SkipResponderExecution(SkipResponderExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Skips the execution of the responder execution. When provided, If-Match is checked against etag values of the resource.
Declaration
public Task<SkipResponderExecutionResponse> SkipResponderExecution(SkipResponderExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SkipResponderExecutionRequest | 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<SkipResponderExecutionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SkipResponderExecution API.
TriggerResponder(TriggerResponderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Sends the problem identified by problemId to the responder engine, to be processed by rule that\u2019s identified by responderRuleId, in the TriggerResponderDetails resource that\u2019s passed.
Declaration
public Task<TriggerResponderResponse> TriggerResponder(TriggerResponderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
TriggerResponderRequest | 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<TriggerResponderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use TriggerResponder API.
UpdateBulkProblemStatus(UpdateBulkProblemStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Changes the status for all problems listed in the problemIds array, passed through the UpdateBulkProblemStatusDetails resource, from the current status to the status set in UpdateBulkProblemStatusDetails.
Declaration
public Task<UpdateBulkProblemStatusResponse> UpdateBulkProblemStatus(UpdateBulkProblemStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateBulkProblemStatusRequest | 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<UpdateBulkProblemStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateBulkProblemStatus API.
UpdateConfiguration(UpdateConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates configuration details for a Cloud Guard tenancy, identified by root compartment OCID. The reporting region cannot be updated once created.
Declaration
public Task<UpdateConfigurationResponse> UpdateConfiguration(UpdateConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateConfigurationRequest | 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<UpdateConfigurationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateConfiguration API.
UpdateDataMaskRule(UpdateDataMaskRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a data mask rule (DataMaskRule resource) identified by dataMaskRuleId.
Declaration
public Task<UpdateDataMaskRuleResponse> UpdateDataMaskRule(UpdateDataMaskRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDataMaskRuleRequest | 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<UpdateDataMaskRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDataMaskRule API.
UpdateDataSource(UpdateDataSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a data source (DataSource resource) identified by dataSourceId, using values passed in an UpdateDataSourceDetails resource.
Declaration
public Task<UpdateDataSourceResponse> UpdateDataSource(UpdateDataSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDataSourceRequest | 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<UpdateDataSourceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDataSource API.
UpdateDetectorRecipe(UpdateDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a detector recipe (DetectorRecipe resource) identified by detectorRecipeId.
Declaration
public Task<UpdateDetectorRecipeResponse> UpdateDetectorRecipe(UpdateDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDetectorRecipeRequest | 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<UpdateDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDetectorRecipe API.
UpdateDetectorRecipeDetectorRule(UpdateDetectorRecipeDetectorRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a detector rule (DetectorRule resource) identified by detectorRuleId.
Declaration
public Task<UpdateDetectorRecipeDetectorRuleResponse> UpdateDetectorRecipeDetectorRule(UpdateDetectorRecipeDetectorRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDetectorRecipeDetectorRuleRequest | 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<UpdateDetectorRecipeDetectorRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDetectorRecipeDetectorRule API.
UpdateManagedList(UpdateManagedListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a ManagedList resource, identified by managedList.
Declaration
public Task<UpdateManagedListResponse> UpdateManagedList(UpdateManagedListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateManagedListRequest | 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<UpdateManagedListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateManagedList API.
UpdateProblemStatus(UpdateProblemStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Changes the current status of the problem, identified by problemId, to the status specified in the UpdateProblemStatusDetails resource that you pass.
Declaration
public Task<UpdateProblemStatusResponse> UpdateProblemStatus(UpdateProblemStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateProblemStatusRequest | 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<UpdateProblemStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateProblemStatus API.
UpdateResponderRecipe(UpdateResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a responder recipe (ResponderRecipe resource) identified by responderRecipeId, passed in an UpdateResponderRecipeDetails resource.
Declaration
public Task<UpdateResponderRecipeResponse> UpdateResponderRecipe(UpdateResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateResponderRecipeRequest | 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<UpdateResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateResponderRecipe API.
UpdateResponderRecipeResponderRule(UpdateResponderRecipeResponderRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a responder rule (ResponderRule resource) identified by responderRuleId, passed in a UpdateResponderRecipeResponderRuleDetails resource.
Declaration
public Task<UpdateResponderRecipeResponderRuleResponse> UpdateResponderRecipeResponderRule(UpdateResponderRecipeResponderRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateResponderRecipeResponderRuleRequest | 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<UpdateResponderRecipeResponderRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateResponderRecipeResponderRule API.
UpdateSavedQuery(UpdateSavedQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a saved query identified by savedQueryId.
Declaration
public Task<UpdateSavedQueryResponse> UpdateSavedQuery(UpdateSavedQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSavedQueryRequest | 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<UpdateSavedQueryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSavedQuery API.
UpdateSecurityRecipe(UpdateSecurityRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a security zone recipe (SecurityRecipe resource), identified by securityRecipeId, using parameters passed in an UpdateSecurityRecipeDetails resource.
Declaration
public Task<UpdateSecurityRecipeResponse> UpdateSecurityRecipe(UpdateSecurityRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSecurityRecipeRequest | 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<UpdateSecurityRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSecurityRecipe API.
UpdateSecurityZone(UpdateSecurityZoneRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a security zone (SecurityZone resource) identified by securityZoneId. Pass parameters through an UpdateSecurityZoneDetails resource.
Declaration
public Task<UpdateSecurityZoneResponse> UpdateSecurityZone(UpdateSecurityZoneRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSecurityZoneRequest | 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<UpdateSecurityZoneResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSecurityZone API.
UpdateTarget(UpdateTargetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a target (Target resource) identified by targetId, using parameters passed in an UpdateTargetDetails resource.
Declaration
public Task<UpdateTargetResponse> UpdateTarget(UpdateTargetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTargetRequest | 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<UpdateTargetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTarget API.
UpdateTargetDetectorRecipe(UpdateTargetDetectorRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a target detector recipe (TargtetDetectorRecipe resource) identified by targetDetectorRecipeId, using parameters passed in an UpdateTargetDetectorRecipeDetails resource.
Declaration
public Task<UpdateTargetDetectorRecipeResponse> UpdateTargetDetectorRecipe(UpdateTargetDetectorRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTargetDetectorRecipeRequest | 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<UpdateTargetDetectorRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTargetDetectorRecipe API.
UpdateTargetDetectorRecipeDetectorRule(UpdateTargetDetectorRecipeDetectorRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the DetectorRule resource identified by targetDetectorRecipeId
Declaration
public Task<UpdateTargetDetectorRecipeDetectorRuleResponse> UpdateTargetDetectorRecipeDetectorRule(UpdateTargetDetectorRecipeDetectorRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTargetDetectorRecipeDetectorRuleRequest | 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<UpdateTargetDetectorRecipeDetectorRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTargetDetectorRecipeDetectorRule API.
UpdateTargetResponderRecipe(UpdateTargetResponderRecipeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, attached to a target identified by targetId. Pass parameters for the update through an UpdateTargetResponderRecipeDetails resource.
Declaration
public Task<UpdateTargetResponderRecipeResponse> UpdateTargetResponderRecipe(UpdateTargetResponderRecipeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTargetResponderRecipeRequest | 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<UpdateTargetResponderRecipeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTargetResponderRecipe API.
UpdateTargetResponderRecipeResponderRule(UpdateTargetResponderRecipeResponderRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a responder rule (ResponderRule resource) identified by responderRuleId, for a target responder recipe (TargetResponderRecipe resource) identified by targetResponderRecipeId, for a target (Target resource) identified by targetId. Parameters for the update are passed through an UpdateTargetResponderRecipeResponderRuleDetails resource.
Declaration
public Task<UpdateTargetResponderRecipeResponderRuleResponse> UpdateTargetResponderRecipeResponderRule(UpdateTargetResponderRecipeResponderRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTargetResponderRecipeResponderRuleRequest | 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<UpdateTargetResponderRecipeResponderRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTargetResponderRecipeResponderRule API.
UpdateWlpAgent(UpdateWlpAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates and renews the certificate for an on-premise WLP agent identified by wlpAgentId.
Declaration
public Task<UpdateWlpAgentResponse> UpdateWlpAgent(UpdateWlpAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateWlpAgentRequest | 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<UpdateWlpAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateWlpAgent API.