Skip to main content

app_catalog_subscriptions

Creates, updates, deletes, gets or lists an app_catalog_subscriptions resource.

Overview​

Nameapp_catalog_subscriptions
TypeResource
Idoci.compute.app_catalog_subscriptions

Fields​

The following fields are returned by SELECT queries:

a subscription summary for a listing resource version.

NameDatatypeDescription
compartmentIdstringThe compartmentID of the subscription.
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
listingIdstringThe ocid of the listing resource.
listingResourceIdstringListing resource id.
listingResourceVersionstringListing resource version.
publisherNamestringName of the publisher who published this listing.
summarystringThe short summary to the listing.
timeCreatedstring (date-time)Date and time at which the subscription was created, in [RFC3339](https:​//tools.ietf.org/html/rfc3339) format. Example: 2018-03-20T12:32:53.532Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectcompartmentId, regionlimit, page, sortBy, sortOrder, listingIdLists subscriptions for a compartment.
createinsertregion, compartmentId, listingId, listingResourceVersion, oracleTermsOfUseLink, timeRetrieved, signatureopc-retry-tokenCreate a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.<br />
deletedeletelistingId, compartmentId, resourceVersion, regionDelete a subscription for a listing resource version for a compartment.

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
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
listingIdstringThe OCID of the listing.
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)
resourceVersionstringListing Resource Version.
limitintegerFor list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
listingIdstringA filter to return only the listings that matches the given listing 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 executing that same action again. 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).
pagestringFor list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples​

Lists subscriptions for a compartment.

SELECT
compartmentId,
displayName,
listingId,
listingResourceId,
listingResourceVersion,
publisherName,
summary,
timeCreated
FROM oci.compute.app_catalog_subscriptions
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND listingId = '{{ listingId }}'
;

INSERT examples​

Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.<br />

INSERT INTO oci.compute.app_catalog_subscriptions (
compartmentId,
eulaLink,
listingId,
listingResourceVersion,
oracleTermsOfUseLink,
signature,
timeRetrieved,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ eulaLink }}',
'{{ listingId }}' /* required */,
'{{ listingResourceVersion }}' /* required */,
'{{ oracleTermsOfUseLink }}' /* required */,
'{{ signature }}' /* required */,
'{{ timeRetrieved }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
compartmentId,
displayName,
listingId,
listingResourceId,
listingResourceVersion,
publisherName,
summary,
timeCreated
;

DELETE examples​

Delete a subscription for a listing resource version for a compartment.

DELETE FROM oci.compute.app_catalog_subscriptions
WHERE listingId = '{{ listingId }}' --required
AND compartmentId = '{{ compartmentId }}' --required
AND resourceVersion = '{{ resourceVersion }}' --required
AND region = '{{ region }}' --required
;