Resource Manger Functions

CANCEL_JOB Function

Indicates the intention to cancel the specified job. Cancellation of the job is not immediate, and may be delayed, or may not happen at all. You can optionally choose forced cancellation by setting `isForced` to true. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources.

Syntax

FUNCTION cancel_job (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  is_forced number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_cancel_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`is_forced`	(optional) Indicates whether a forced cancellation is requested for the job while it was running. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_CONFIGURATION_SOURCE_PROVIDER_COMPARTMENT Function

Moves a configuration source provider into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_configuration_source_provider_compartment (
  configuration_source_provider_id varchar2,
  change_configuration_source_provider_compartment_details dbms_cloud_oci_resource_manager_change_configuration_source_provider_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_change_configuration_source_provider_compartment_response_t;

Parameters

Parameter	Description
`configuration_source_provider_id`	(required) The OCID of the configuration source provider.
`change_configuration_source_provider_compartment_details`	(required) Defines the properties of changeConfigurationSourceProviderCompartment operation.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PRIVATE_ENDPOINT_COMPARTMENT Function

Moves a private endpoint to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_private_endpoint_compartment (
  private_endpoint_id varchar2,
  change_private_endpoint_compartment_details dbms_cloud_oci_resource_manager_change_private_endpoint_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_change_private_endpoint_compartment_response_t;

Parameters

Parameter	Description
`private_endpoint_id`	(required) The OCID of the private endpoint.
`change_private_endpoint_compartment_details`	(required) Defines the properties of changePrivateEndpointCompartment operation.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_STACK_COMPARTMENT Function

Moves a stack (and its associated jobs) into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_stack_compartment (
  stack_id varchar2,
  change_stack_compartment_details dbms_cloud_oci_resource_manager_change_stack_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_change_stack_compartment_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`change_stack_compartment_details`	(required) Defines the properties of changeStackCompartment operation.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_TEMPLATE_COMPARTMENT Function

Moves a template into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_template_compartment (
  template_id varchar2,
  change_template_compartment_details dbms_cloud_oci_resource_manager_change_template_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_change_template_compartment_response_t;

Parameters

Parameter	Description
`template_id`	(required) The OCID of the template.
`change_template_compartment_details`	(required) The details for moving a template to a different compartment.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CONFIGURATION_SOURCE_PROVIDER Function

Creates a configuration source provider in the specified compartment. For more information, see To create a configuration source provider.

Syntax

FUNCTION create_configuration_source_provider (
  create_configuration_source_provider_details dbms_cloud_oci_resource_manager_create_configuration_source_provider_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_create_configuration_source_provider_response_t;

Parameters

Parameter	Description
`create_configuration_source_provider_details`	(required) The properties for creating a ConfigurationSourceProvider.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_JOB Function

Creates a job.

Syntax

FUNCTION create_job (
  create_job_details dbms_cloud_oci_resource_manager_create_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_create_job_response_t;

Parameters

Parameter	Description
`create_job_details`	(required) The properties for a request to create a job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PRIVATE_ENDPOINT Function

Creates a private endpoint in the specified compartment.

Syntax

FUNCTION create_private_endpoint (
  create_private_endpoint_details dbms_cloud_oci_resource_manager_create_private_endpoint_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_create_private_endpoint_response_t;

Parameters

Parameter	Description
`create_private_endpoint_details`	(required) Creation details for a private endpoint.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_STACK Function

Creates a stack in the specified compartment. You can create a stack from a Terraform configuration. The Terraform configuration can be directly uploaded or referenced from a source code control system. You can also create a stack from an existing compartment, which generates a Terraform configuration. You can also upload the Terraform configuration from an Object Storage bucket. For more information, see Creating Stacks.

Syntax

FUNCTION create_stack (
  create_stack_details dbms_cloud_oci_resource_manager_create_stack_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_create_stack_response_t;

Parameters

Parameter	Description
`create_stack_details`	(required) The properties for creating a stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TEMPLATE Function

Creates a private template in the specified compartment.

Syntax

FUNCTION create_template (
  create_template_details dbms_cloud_oci_resource_manager_create_template_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_create_template_response_t;

Parameters

Parameter	Description
`create_template_details`	(required) The configuration details for creating a template.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CONFIGURATION_SOURCE_PROVIDER Function

Deletes the specified configuration source provider.

Syntax

FUNCTION delete_configuration_source_provider (
  configuration_source_provider_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_delete_configuration_source_provider_response_t;

Parameters

Parameter	Description
`configuration_source_provider_id`	(required) The OCID of the configuration source provider.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PRIVATE_ENDPOINT Function

Deletes the specified private endpoint.

Syntax

FUNCTION delete_private_endpoint (
  private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_delete_private_endpoint_response_t;

Parameters

Parameter	Description
`private_endpoint_id`	(required) The OCID of the private endpoint.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_STACK Function

Deletes the specified stack.

Syntax

FUNCTION delete_stack (
  stack_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_delete_stack_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TEMPLATE Function

Deletes the specified template.

Syntax

FUNCTION delete_template (
  template_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_delete_template_response_t;

Parameters

Parameter	Description
`template_id`	(required) The OCID of the template.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DETECT_STACK_DRIFT Function

Checks drift status for the specified stack.

Syntax

FUNCTION detect_stack_drift (
  stack_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  detect_stack_drift_details dbms_cloud_oci_resource_manager_detect_stack_drift_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_detect_stack_drift_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`detect_stack_drift_details`	(optional) The details for detecting drift in a stack
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CONFIGURATION_SOURCE_PROVIDER Function

Gets the properties of the specified configuration source provider.

Syntax

FUNCTION get_configuration_source_provider (
  configuration_source_provider_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_configuration_source_provider_response_t;

Parameters

Parameter	Description
`configuration_source_provider_id`	(required) The OCID of the configuration source provider.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB Function

Gets the properties of the specified job.

Syntax

FUNCTION get_job (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_DETAILED_LOG_CONTENT Function

Returns the Terraform detailed log content for the specified job in plain text. Learn about Terraform detailed log.

Syntax

FUNCTION get_job_detailed_log_content (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_job_detailed_log_content_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_LOGS Function

Returns console log entries for the specified job in JSON format.

Syntax

FUNCTION get_job_logs (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  l_type dbms_cloud_oci_resource_manager_varchar2_tbl DEFAULT NULL,
  level_greater_than_or_equal_to varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  timestamp_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  timestamp_less_than_or_equal_to timestamp with time zone DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_job_logs_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`l_type`	(optional) A filter that returns only logs of a specified type.
`level_greater_than_or_equal_to`	(optional) A filter that returns only log entries that match a given severity level or greater.
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`timestamp_greater_than_or_equal_to`	(optional) Time stamp specifying the lower time limit for which logs are returned in a query. Format is defined by RFC3339. Example: `2020-01-01T12:00:00.000Z`
`timestamp_less_than_or_equal_to`	(optional) Time stamp specifying the upper time limit for which logs are returned in a query. Format is defined by RFC3339. Example: `2020-02-01T12:00:00.000Z`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_LOGS_CONTENT Function

Returns the raw log file for the specified job in text format. The file includes a maximum of 100,000 log entries.

Syntax

FUNCTION get_job_logs_content (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_job_logs_content_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_TF_CONFIG Function

Returns the Terraform configuration for the specified job in zip format. If no zip file is found, returns an error.

Syntax

FUNCTION get_job_tf_config (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_job_tf_config_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_TF_PLAN Function

Returns the output of the specified Terraform plan job in binary or JSON format. For information about running Terraform plan jobs, see Creating Plan Jobs.

Syntax

FUNCTION get_job_tf_plan (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  tf_plan_format varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_job_tf_plan_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`tf_plan_format`	(optional) The output format of the Terraform plan. Allowed values are: 'BINARY', 'JSON'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_JOB_TF_STATE Function

Returns the Terraform state for the specified job.

Syntax

FUNCTION get_job_tf_state (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_job_tf_state_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PRIVATE_ENDPOINT Function

Gets the specified private endpoint.

Syntax

FUNCTION get_private_endpoint (
  private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_private_endpoint_response_t;

Parameters

Parameter	Description
`private_endpoint_id`	(required) The OCID of the private endpoint.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REACHABLE_IP Function

Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint. Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint.

Syntax

FUNCTION get_reachable_ip (
  private_ip varchar2,
  private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_reachable_ip_response_t;

Parameters

Parameter	Description
`private_ip`	(required) The IP address of the resource in the private subnet.
`private_endpoint_id`	(required) The OCID of the private endpoint.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STACK Function

Gets the specified stack.

Syntax

FUNCTION get_stack (
  stack_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_stack_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STACK_TF_CONFIG Function

Returns the Terraform configuration file for the specified stack in zip format. Returns an error if no zip file is found.

Syntax

FUNCTION get_stack_tf_config (
  stack_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_stack_tf_config_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STACK_TF_STATE Function

Returns the Terraform state for the specified stack.

Syntax

FUNCTION get_stack_tf_state (
  stack_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_stack_tf_state_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TEMPLATE Function

Gets the specified template.

Syntax

FUNCTION get_template (
  template_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_template_response_t;

Parameters

Parameter	Description
`template_id`	(required) The OCID of the template.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TEMPLATE_LOGO Function

Returns the Terraform logo file in .logo format for the specified template. Returns an error if no logo file is found.

Syntax

FUNCTION get_template_logo (
  template_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_template_logo_response_t;

Parameters

Parameter	Description
`template_id`	(required) The OCID of the template.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TEMPLATE_TF_CONFIG Function

Returns the Terraform configuration file in zip format for the specified template. Returns an error if no zip file is found.

Syntax

FUNCTION get_template_tf_config (
  template_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_template_tf_config_response_t;

Parameters

Parameter	Description
`template_id`	(required) The OCID of the template.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Returns the specified work request.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CONFIGURATION_SOURCE_PROVIDERS Function

Lists configuration source providers according to the specified filter. - For `compartmentId`, lists all configuration source providers in the matching compartment. - For `configurationSourceProviderId`, lists the matching configuration source provider.

Syntax

FUNCTION list_configuration_source_providers (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  configuration_source_provider_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  config_source_provider_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_configuration_source_providers_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`configuration_source_provider_id`	(optional) A filter to return only configuration source providers that match the provided OCID.
`display_name`	(optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation.
`sort_by`	(optional) The field to use when sorting returned resources. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`config_source_provider_type`	(optional) A filter to return only configuration source providers of the specified type (GitHub or GitLab).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOB_ASSOCIATED_RESOURCES Function

Gets the list of resources associated with the specified job.

Syntax

FUNCTION list_job_associated_resources (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  terraform_resource_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_job_associated_resources_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`terraform_resource_type`	(optional) A filter to return only specified resource types. For more information about resource types supported for the Oracle Cloud Infrastructure OCI] provider, see [Oracle Cloud Infrastructure Provider.
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOB_OUTPUTS Function

Gets the list of outputs associated with the specified job.

Syntax

FUNCTION list_job_outputs (
  job_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_job_outputs_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_JOBS Function

Lists jobs according to the specified filter. By default, the list is ordered by time created. - To list all jobs in a stack, provide the stack OCID. - To list all jobs in a compartment, provide the compartment OCID. - To return a specific job, provide the job OCID. (Equivalent to GET_STACK Function.)

Syntax

FUNCTION list_jobs (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  stack_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_jobs_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`stack_id`	(optional) The stack OCID on which to filter.
`id`	(optional) The OCID on which to query for jobs.
`lifecycle_state`	(optional) A filter that returns all resources that match the specified lifecycle state. The state value is case-insensitive. Allowable values: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED
`display_name`	(optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation.
`sort_by`	(optional) The field to use when sorting returned resources. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PRIVATE_ENDPOINTS Function

Lists private endpoints according to the specified filter. - For `compartmentId`, lists all private endpoints in the matching compartment. - For `privateEndpointId`, lists the matching private endpoint.

Syntax

FUNCTION list_private_endpoints (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  private_endpoint_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_private_endpoints_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`private_endpoint_id`	(optional) The OCID of the private endpoint.
`display_name`	(optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation.
`vcn_id`	(optional) The OCID of the VCN.
`sort_by`	(optional) The field to use when sorting returned resources. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RESOURCE_DISCOVERY_SERVICES Function

Returns a list of supported services for Resource Discovery. For reference on service names, see the Terraform provider documentation.

Syntax

FUNCTION list_resource_discovery_services (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_resource_discovery_services_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STACK_ASSOCIATED_RESOURCES Function

Gets the list of resources associated with the specified stack.

Syntax

FUNCTION list_stack_associated_resources (
  stack_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  terraform_resource_type varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_stack_associated_resources_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`terraform_resource_type`	(optional) A filter to return only specified resource types. For more information about resource types supported for the Oracle Cloud Infrastructure OCI] provider, see [Oracle Cloud Infrastructure Provider.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STACK_RESOURCE_DRIFT_DETAILS Function

Lists drift status details for each resource defined in the specified stack. The drift status details for a given resource indicate differences, if any, between the actual state and the expected (defined) state for that resource. The drift status details correspond to the specified work request (`workRequestId`). If no work request is specified, then the drift status details correspond to the latest completed work request for the stack.

Syntax

FUNCTION list_stack_resource_drift_details (
  stack_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  work_request_id varchar2 DEFAULT NULL,
  resource_drift_status dbms_cloud_oci_resource_manager_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_stack_resource_drift_details_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`work_request_id`	(optional) The OCID of the work request.
`resource_drift_status`	(optional) A filter that returns only resources that match the given drift status. The value is case-insensitive. Allowable values - - NOT_CHECKED - MODIFIED - IN_SYNC - DELETED
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STACKS Function

Lists stacks according to the specified filter. - If called using the compartment ID, returns all stacks in the specified compartment. - If called using the stack ID, returns the specified stack. (See also GET_STACK Function.)

Syntax

FUNCTION list_stacks (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_stacks_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`id`	(optional) The OCID on which to query for a stack.
`lifecycle_state`	(optional) A filter that returns only those resources that match the specified lifecycle state. The state value is case-insensitive. For more information about stack lifecycle states, see Key Concepts. Allowable values: - CREATING - ACTIVE - DELETING - DELETED - FAILED
`display_name`	(optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation.
`sort_by`	(optional) The field to use when sorting returned resources. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TEMPLATE_CATEGORIES Function

Lists template categories.

Syntax

FUNCTION list_template_categories (
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_template_categories_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TEMPLATES Function

Lists templates according to the specified filter. The attributes `compartmentId` and `templateCategoryId` are required unless `templateId` is specified.

Syntax

FUNCTION list_templates (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  template_category_id varchar2 DEFAULT NULL,
  template_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_templates_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`template_category_id`	(optional) Unique identifier for the template category. Possible values are `0` (Quickstarts), `1` (Service), `2` (Architecture), and `3` (Private). Template category labels are displayed in the Console page listing templates. Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. Each private template (category 3) is available in the compartment where it was created.
`template_id`	(optional) The OCID of the template.
`display_name`	(optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation.
`sort_by`	(optional) The field to use when sorting returned resources. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TERRAFORM_VERSIONS Function

Returns a list of supported Terraform versions for use with stacks.

Syntax

FUNCTION list_terraform_versions (
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_terraform_versions_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Returns a paginated list of errors for the specified work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Returns a paginated list of logs for the specified work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`compartment_id`	(optional) A filter to return only resources that exist in the compartment, identified by OCID.
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`sort_order`	(optional) The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in the specified compartment or for the specified resource.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  resource_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) A filter to return only resources that exist in the compartment, identified by OCID.
`resource_id`	(optional) The OCID of the resource.
`limit`	(optional) The number of items returned in a paginated `List` call. For information about pagination, see List Pagination.
`page`	(optional) The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CONFIGURATION_SOURCE_PROVIDER Function

Updates the properties of the specified configuration source provider. For more information, see To edit a configuration source provider.

Syntax

FUNCTION update_configuration_source_provider (
  configuration_source_provider_id varchar2,
  update_configuration_source_provider_details dbms_cloud_oci_resource_manager_update_configuration_source_provider_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_update_configuration_source_provider_response_t;

Parameters

Parameter	Description
`configuration_source_provider_id`	(required) The OCID of the configuration source provider.
`update_configuration_source_provider_details`	(required) Updated information provided for the ConfigurationSourceProvider.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_JOB Function

Updates the specified job.

Syntax

FUNCTION update_job (
  job_id varchar2,
  update_job_details dbms_cloud_oci_resource_manager_update_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_update_job_response_t;

Parameters

Parameter	Description
`job_id`	(required) The OCID of the job.
`update_job_details`	(required) Updates properties for the specified job.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PRIVATE_ENDPOINT Function

Updates the specified private endpoint.

Syntax

FUNCTION update_private_endpoint (
  private_endpoint_id varchar2,
  update_private_endpoint_details dbms_cloud_oci_resource_manager_update_private_endpoint_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_update_private_endpoint_response_t;

Parameters

Parameter	Description
`private_endpoint_id`	(required) The OCID of the private endpoint.
`update_private_endpoint_details`	(required) Update details for a private endpoint.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_STACK Function

Updates the specified stack. Use `UpdateStack` when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see Updating Stacks.

Syntax

FUNCTION update_stack (
  stack_id varchar2,
  update_stack_details dbms_cloud_oci_resource_manager_update_stack_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_update_stack_response_t;

Parameters

Parameter	Description
`stack_id`	(required) The OCID of the stack.
`update_stack_details`	(required) The details for updating a stack.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TEMPLATE Function

Updates the specified template.

Syntax

FUNCTION update_template (
  template_id varchar2,
  update_template_details dbms_cloud_oci_resource_manager_update_template_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rm_resource_manager_update_template_response_t;

Parameters

Parameter	Description
`template_id`	(required) The OCID of the template.
`update_template_details`	(required) The details for updating a template.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://resourcemanager.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CANCEL_JOB Function 🔗

CHANGE_CONFIGURATION_SOURCE_PROVIDER_COMPARTMENT Function 🔗

CHANGE_PRIVATE_ENDPOINT_COMPARTMENT Function 🔗

CHANGE_STACK_COMPARTMENT Function 🔗

CHANGE_TEMPLATE_COMPARTMENT Function 🔗

CREATE_CONFIGURATION_SOURCE_PROVIDER Function 🔗

CREATE_JOB Function 🔗

CREATE_PRIVATE_ENDPOINT Function 🔗

CREATE_STACK Function 🔗

CREATE_TEMPLATE Function 🔗

DELETE_CONFIGURATION_SOURCE_PROVIDER Function 🔗

DELETE_PRIVATE_ENDPOINT Function 🔗

DELETE_STACK Function 🔗

DELETE_TEMPLATE Function 🔗

DETECT_STACK_DRIFT Function 🔗

GET_CONFIGURATION_SOURCE_PROVIDER Function 🔗

GET_JOB Function 🔗

GET_JOB_DETAILED_LOG_CONTENT Function 🔗

GET_JOB_LOGS Function 🔗

GET_JOB_LOGS_CONTENT Function 🔗

GET_JOB_TF_CONFIG Function 🔗

GET_JOB_TF_PLAN Function 🔗

GET_JOB_TF_STATE Function 🔗

GET_PRIVATE_ENDPOINT Function 🔗

GET_REACHABLE_IP Function 🔗

GET_STACK Function 🔗

GET_STACK_TF_CONFIG Function 🔗

GET_STACK_TF_STATE Function 🔗

GET_TEMPLATE Function 🔗

GET_TEMPLATE_LOGO Function 🔗

GET_TEMPLATE_TF_CONFIG Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_CONFIGURATION_SOURCE_PROVIDERS Function 🔗

LIST_JOB_ASSOCIATED_RESOURCES Function 🔗

LIST_JOB_OUTPUTS Function 🔗

LIST_JOBS Function 🔗

LIST_PRIVATE_ENDPOINTS Function 🔗

LIST_RESOURCE_DISCOVERY_SERVICES Function 🔗

LIST_STACK_ASSOCIATED_RESOURCES Function 🔗

LIST_STACK_RESOURCE_DRIFT_DETAILS Function 🔗

LIST_STACKS Function 🔗

LIST_TEMPLATE_CATEGORIES Function 🔗

LIST_TEMPLATES Function 🔗

LIST_TERRAFORM_VERSIONS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_CONFIGURATION_SOURCE_PROVIDER Function 🔗

UPDATE_JOB Function 🔗

UPDATE_PRIVATE_ENDPOINT Function 🔗

UPDATE_STACK Function 🔗

UPDATE_TEMPLATE Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CANCEL_JOB Function

CHANGE_CONFIGURATION_SOURCE_PROVIDER_COMPARTMENT Function

CHANGE_PRIVATE_ENDPOINT_COMPARTMENT Function

CHANGE_STACK_COMPARTMENT Function

CHANGE_TEMPLATE_COMPARTMENT Function

CREATE_CONFIGURATION_SOURCE_PROVIDER Function

CREATE_JOB Function

CREATE_PRIVATE_ENDPOINT Function

CREATE_STACK Function

CREATE_TEMPLATE Function

DELETE_CONFIGURATION_SOURCE_PROVIDER Function

DELETE_PRIVATE_ENDPOINT Function

DELETE_STACK Function

DELETE_TEMPLATE Function

DETECT_STACK_DRIFT Function

GET_CONFIGURATION_SOURCE_PROVIDER Function

GET_JOB Function

GET_JOB_DETAILED_LOG_CONTENT Function

GET_JOB_LOGS Function

GET_JOB_LOGS_CONTENT Function

GET_JOB_TF_CONFIG Function

GET_JOB_TF_PLAN Function

GET_JOB_TF_STATE Function

GET_PRIVATE_ENDPOINT Function

GET_REACHABLE_IP Function

GET_STACK Function

GET_STACK_TF_CONFIG Function

GET_STACK_TF_STATE Function

GET_TEMPLATE Function

GET_TEMPLATE_LOGO Function

GET_TEMPLATE_TF_CONFIG Function

GET_WORK_REQUEST Function

LIST_CONFIGURATION_SOURCE_PROVIDERS Function

LIST_JOB_ASSOCIATED_RESOURCES Function

LIST_JOB_OUTPUTS Function

LIST_JOBS Function

LIST_PRIVATE_ENDPOINTS Function

LIST_RESOURCE_DISCOVERY_SERVICES Function

LIST_STACK_ASSOCIATED_RESOURCES Function

LIST_STACK_RESOURCE_DRIFT_DETAILS Function

LIST_STACKS Function

LIST_TEMPLATE_CATEGORIES Function

LIST_TEMPLATES Function

LIST_TERRAFORM_VERSIONS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_CONFIGURATION_SOURCE_PROVIDER Function

UPDATE_JOB Function

UPDATE_PRIVATE_ENDPOINT Function

UPDATE_STACK Function

UPDATE_TEMPLATE Function