Class GovernanceRuleClient
Service client instance for GovernanceRule.
Implements
Inherited Members
Namespace: Oci.GovernancerulescontrolplaneService
Assembly: OCI.DotNetSDK.Governancerulescontrolplane.dll
Syntax
public class GovernanceRuleClient : RegionalClientBase, IDisposable
Constructors
GovernanceRuleClient(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 GovernanceRuleClient(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 GovernanceRulePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
GovernanceRulePaginators |
Waiters
Declaration
public GovernanceRuleWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
GovernanceRuleWaiters |
Methods
CreateGovernanceRule(CreateGovernanceRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create governance rule in the root compartment only. Either relatedResourceId or template must be supplied.
Declaration
public Task<CreateGovernanceRuleResponse> CreateGovernanceRule(CreateGovernanceRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateGovernanceRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateGovernanceRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateGovernanceRule API.
CreateInclusionCriterion(CreateInclusionCriterionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create inclusion criterion of type tenancy or tag for the governance rule.
Declaration
public Task<CreateInclusionCriterionResponse> CreateInclusionCriterion(CreateInclusionCriterionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateInclusionCriterionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateInclusionCriterionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateInclusionCriterion API.
DeleteGovernanceRule(DeleteGovernanceRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified governance rule.
Declaration
public Task<DeleteGovernanceRuleResponse> DeleteGovernanceRule(DeleteGovernanceRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteGovernanceRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteGovernanceRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteGovernanceRule API.
DeleteInclusionCriterion(DeleteInclusionCriterionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified inclusion criterion.
Declaration
public Task<DeleteInclusionCriterionResponse> DeleteInclusionCriterion(DeleteInclusionCriterionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteInclusionCriterionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteInclusionCriterionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteInclusionCriterion API.
GetEnforcedGovernanceRule(GetEnforcedGovernanceRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified enforced governance rule's information.
Declaration
public Task<GetEnforcedGovernanceRuleResponse> GetEnforcedGovernanceRule(GetEnforcedGovernanceRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetEnforcedGovernanceRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetEnforcedGovernanceRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetEnforcedGovernanceRule API.
GetGovernanceRule(GetGovernanceRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified governance rule's information.
Declaration
public Task<GetGovernanceRuleResponse> GetGovernanceRule(GetGovernanceRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetGovernanceRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetGovernanceRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetGovernanceRule API.
GetInclusionCriterion(GetInclusionCriterionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified inclusion criterion's information.
Declaration
public Task<GetInclusionCriterionResponse> GetInclusionCriterion(GetInclusionCriterionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetInclusionCriterionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetInclusionCriterionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetInclusionCriterion API.
GetTenancyAttachment(GetTenancyAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the specified tenancy attachment's information.
Declaration
public Task<GetTenancyAttachmentResponse> GetTenancyAttachment(GetTenancyAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTenancyAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTenancyAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTenancyAttachment API.
ListEnforcedGovernanceRules(ListEnforcedGovernanceRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List enforced governance rules. Either compartment id or enforced governance rule id must be supplied. An optional governance rule type or a display name can also be supplied.
Declaration
public Task<ListEnforcedGovernanceRulesResponse> ListEnforcedGovernanceRules(ListEnforcedGovernanceRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEnforcedGovernanceRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEnforcedGovernanceRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEnforcedGovernanceRules API.
ListGovernanceRules(ListGovernanceRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List governance rules. Either compartment id or governance rule id must be supplied. An optional lifecycle state, display name or a governance rule type can also be supplied.
Declaration
public Task<ListGovernanceRulesResponse> ListGovernanceRules(ListGovernanceRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListGovernanceRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListGovernanceRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListGovernanceRules API.
ListInclusionCriteria(ListInclusionCriteriaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List inclusion criteria associated with a governance rule. Governance rule id must be supplied. An optional inclusion criterion id or a lifecycle state can also be supplied.
Declaration
public Task<ListInclusionCriteriaResponse> ListInclusionCriteria(ListInclusionCriteriaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListInclusionCriteriaRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListInclusionCriteriaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListInclusionCriteria API.
ListTenancyAttachments(ListTenancyAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List tenancy attachments. Either compartment id, governance rule id or tenancy attachment id must be supplied. An optional lifecycle state or a child tenancy id can also be supplied.
Declaration
public Task<ListTenancyAttachmentsResponse> ListTenancyAttachments(ListTenancyAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTenancyAttachmentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTenancyAttachmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTenancyAttachments API.
RetryGovernanceRule(RetryGovernanceRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retry the creation of the specified governance rule. Used by the tenancy admins when all the workflow retries have exhausted. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<RetryGovernanceRuleResponse> RetryGovernanceRule(RetryGovernanceRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RetryGovernanceRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RetryGovernanceRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RetryGovernanceRule API.
RetryTenancyAttachment(RetryTenancyAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retry governance rule application for the specified tenancy attachment id. Used by the tenancy admins when all the workflow retries have exhausted.
Declaration
public Task<RetryTenancyAttachmentResponse> RetryTenancyAttachment(RetryTenancyAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RetryTenancyAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RetryTenancyAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RetryTenancyAttachment API.
UpdateGovernanceRule(UpdateGovernanceRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update the specified governance rule.
Declaration
public Task<UpdateGovernanceRuleResponse> UpdateGovernanceRule(UpdateGovernanceRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateGovernanceRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateGovernanceRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateGovernanceRule API.