Skip to main content

configuration_source_providers

Creates, updates, deletes, gets or lists a configuration_source_providers resource.

Overview​

Nameconfiguration_source_providers
TypeResource
Idoci.resource_manager.configuration_source_providers

Fields​

The following fields are returned by SELECT queries:

The request was accepted for processing.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the configuration source provider is located.
configSourceProviderTypestringThe type of configuration source provider. The BITBUCKET_CLOUD_ACCESS_TOKEN type corresponds to Bitbucket Cloud. The BITBUCKET_SERVER_ACCESS_TOKEN type corresponds to Bitbucket Server. The GITLAB_ACCESS_TOKEN type corresponds to GitLab. The GITHUB_ACCESS_TOKEN type corresponds to GitHub. (BITBUCKET_CLOUD_ACCESS_TOKEN, BITBUCKET_SERVER_ACCESS_TOKEN, GITLAB_ACCESS_TOKEN, GITHUB_ACCESS_TOKEN)
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
descriptionstringDescription of the configuration source provider.
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
emailstringAtlassian account email used for Bitbucket Cloud API token authentication.
freeformTagsobjectFree-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isMigrationRequiredbooleanIndicates whether this configuration source provider uses legacy Bitbucket Cloud username/app-password credentials and must be migrated.
lifecycleStatestringThe current lifecycle state of the configuration source provider. For more information about configuration source provider lifecycle states in Resource Manager, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__CSPStates). (ACTIVE)
privateServerConfigDetailsobjectDetails about a private endpoint associated with the configuration source provider. (x-example: {<br /> "privateEndpointId": "ocid1.ormprivateendpoint.oc1..<var><unique_ID></var>",<br /> "sslCertificateId": "ocid1.certificate.oc1..<var><unique_ID></var>"<br />}<br />)
secretIdstringSecret ocid which is used to authorize the user.
systemTagsobjectThe system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https:​//docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: &#123;orcl-cloud: &#123;free-tier-retain: true&#125;&#125;
timeCreatedstring (date-time)The date and time when the configuration source provider was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
usernamestringUsername which is used to authorize the user.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectconfigurationSourceProviderId, regionopc-request-idGets the properties of the specified configuration source provider.<br />For more information, see<br />[Getting a Configuration Source Provider's Details](/iaas/Content/ResourceManager/Tasks/get-csp.htm).<br />
listselectregionopc-request-id, compartmentId, configurationSourceProviderId, displayName, sortBy, sortOrder, limit, page, configSourceProviderTypeLists configuration source providers according to the specified filter.<br />For more information, see<br />[Listing Configuration Source Providers](/iaas/Content/ResourceManager/Tasks/list-csp.htm).<br />- For compartmentId, lists all configuration source providers in the matching compartment.<br />- For configurationSourceProviderId, lists the matching configuration source provider.<br />
createinsertregion, configSourceProviderTypeopc-request-id, opc-retry-tokenCreates a configuration source provider in the specified compartment.<br />For more information, see<br />[Creating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/create-csp.htm).<br />
updateupdateconfigurationSourceProviderId, regionopc-request-id, if-matchUpdates the properties of the specified configuration source provider.<br />For more information, see<br />[Updating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/update-csp.htm).<br />
deletedeleteconfigurationSourceProviderId, regionopc-request-id, if-matchDeletes the specified configuration source provider.<br />For more information, see<br />[Deleting a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/delete-csp.htm).<br />
change_compartmentexecconfigurationSourceProviderId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a configuration source provider into a different compartment within the same tenancy.<br />For more information, see<br />[Moving a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/change-compartment-csp.htm).<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
configurationSourceProviderIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
compartmentIdstringA filter to return only resources that exist in the compartment, identified by [OCID](/iaas/Content/General/Concepts/identifiers.htm).
configSourceProviderTypestringA filter to return only configuration source providers of the specified type (GitHub or GitLab).
configurationSourceProviderIdstringA filter to return only configuration source providers that match the provided [OCID](/iaas/Content/General/Concepts/identifiers.htm).
displayNamestringA 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.
if-matchstringFor 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.
limitintegerThe number of items returned in a paginated List call. For information about pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
opc-request-idstringUnique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA 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.
pagestringThe value of the opc-next-page response header from the preceding List call. For information about pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBystringThe 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.
sortOrderstringThe sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

SELECT examples​

Gets the properties of the specified configuration source provider.<br />For more information, see<br />[Getting a Configuration Source Provider's Details](/iaas/Content/ResourceManager/Tasks/get-csp.htm).<br />

SELECT
id,
compartmentId,
configSourceProviderType,
definedTags,
description,
displayName,
email,
freeformTags,
isMigrationRequired,
lifecycleState,
privateServerConfigDetails,
secretId,
systemTags,
timeCreated,
username
FROM oci.resource_manager.configuration_source_providers
WHERE configurationSourceProviderId = '{{ configurationSourceProviderId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a configuration source provider in the specified compartment.<br />For more information, see<br />[Creating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/create-csp.htm).<br />

INSERT INTO oci.resource_manager.configuration_source_providers (
compartmentId,
configSourceProviderType,
definedTags,
description,
displayName,
freeformTags,
privateServerConfigDetails,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ compartmentId }}',
'{{ configSourceProviderType }}' /* required */,
'{{ definedTags }}',
'{{ description }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ privateServerConfigDetails }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
configSourceProviderType,
definedTags,
description,
displayName,
email,
freeformTags,
isMigrationRequired,
lifecycleState,
privateServerConfigDetails,
secretId,
systemTags,
timeCreated,
username
;

UPDATE examples​

Updates the properties of the specified configuration source provider.<br />For more information, see<br />[Updating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/update-csp.htm).<br />

UPDATE oci.resource_manager.configuration_source_providers
SET 
configSourceProviderType = '{{ configSourceProviderType }}',
definedTags = '{{ definedTags }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
privateServerConfigDetails = '{{ privateServerConfigDetails }}'
WHERE 
configurationSourceProviderId = '{{ configurationSourceProviderId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
configSourceProviderType,
definedTags,
description,
displayName,
email,
freeformTags,
isMigrationRequired,
lifecycleState,
privateServerConfigDetails,
secretId,
systemTags,
timeCreated,
username;

DELETE examples​

Deletes the specified configuration source provider.<br />For more information, see<br />[Deleting a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/delete-csp.htm).<br />

DELETE FROM oci.resource_manager.configuration_source_providers
WHERE configurationSourceProviderId = '{{ configurationSourceProviderId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods​

Moves a configuration source provider into a different compartment within the same tenancy.<br />For more information, see<br />[Moving a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/change-compartment-csp.htm).<br />

EXEC oci.resource_manager.configuration_source_providers.change_compartment 
@configurationSourceProviderId='{{ configurationSourceProviderId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;