Skip to main content

compute_image_capability_schemas

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

Overview​

Namecompute_image_capability_schemas
TypeResource
Idoci.compute.compute_image_capability_schemas

Fields​

The following fields are returned by SELECT queries:

The compute image capability schema retrieved.

NameDatatypeDescription
idstringThe id of the compute global image capability schema version
compartmentIdstringThe OCID of the compartment that contains the resource.
computeGlobalImageCapabilitySchemaIdstringThe ocid of the compute global image capability schema
computeGlobalImageCapabilitySchemaVersionNamestringThe name of the compute global image capability schema version
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"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple 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"}
imageIdstringThe OCID of the image associated with this compute image capability schema
lifecycleStatestringThe ComputeImageCapabilitySchema current lifecycle state. (CREATING, ACTIVE, DELETED)
schemaDataobjectThe map of each capability name to its ImageCapabilityDescriptor.
timeCreatedstring (date-time)The date and time the compute image capability schema was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcomputeImageCapabilitySchemaId, regionisMergeEnabledGets the specified Compute Image Capability Schema<br />
listselectregioncompartmentId, imageId, displayName, limit, page, sortBy, sortOrderLists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.<br />
createinsertregion, compartmentId, computeGlobalImageCapabilitySchemaVersionName, imageId, schemaDataopc-retry-tokenCreates compute image capability schema.<br />
updateupdatecomputeImageCapabilitySchemaId, regionif-matchUpdates the specified Compute Image Capability Schema<br />
deletedeletecomputeImageCapabilitySchemaId, regionif-matchDeletes the specified Compute Image Capability Schema<br />
change_compartmentexeccomputeImageCapabilitySchemaId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a compute image capability schema into a different compartment within the same tenancy.<br />For information about moving resources between compartments, see<br /> [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<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
computeImageCapabilitySchemaIdstringThe id of the compute image capability schema or the image ocid
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 match the given compartment OCID exactly.
displayNamestringA filter to return only resources that match the given display name exactly.
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.
imageIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image.
isMergeEnabledbooleanMerge the image capability schema with the global image capability schema
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
opc-request-idstringUnique 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 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​

Gets the specified Compute Image Capability Schema<br />

SELECT
id,
compartmentId,
computeGlobalImageCapabilitySchemaId,
computeGlobalImageCapabilitySchemaVersionName,
definedTags,
displayName,
freeformTags,
imageId,
lifecycleState,
schemaData,
timeCreated
FROM oci.compute.compute_image_capability_schemas
WHERE computeImageCapabilitySchemaId = '{{ computeImageCapabilitySchemaId }}' -- required
AND region = '{{ region }}' -- required
AND isMergeEnabled = '{{ isMergeEnabled }}'
;

INSERT examples​

Creates compute image capability schema.<br />

INSERT INTO oci.compute.compute_image_capability_schemas (
compartmentId,
computeGlobalImageCapabilitySchemaVersionName,
definedTags,
displayName,
freeformTags,
imageId,
schemaData,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ computeGlobalImageCapabilitySchemaVersionName }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ imageId }}' /* required */,
'{{ schemaData }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
computeGlobalImageCapabilitySchemaId,
computeGlobalImageCapabilitySchemaVersionName,
definedTags,
displayName,
freeformTags,
imageId,
lifecycleState,
schemaData,
timeCreated
;

UPDATE examples​

Updates the specified Compute Image Capability Schema<br />

UPDATE oci.compute.compute_image_capability_schemas
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
schemaData = '{{ schemaData }}'
WHERE 
computeImageCapabilitySchemaId = '{{ computeImageCapabilitySchemaId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
computeGlobalImageCapabilitySchemaId,
computeGlobalImageCapabilitySchemaVersionName,
definedTags,
displayName,
freeformTags,
imageId,
lifecycleState,
schemaData,
timeCreated;

DELETE examples​

Deletes the specified Compute Image Capability Schema<br />

DELETE FROM oci.compute.compute_image_capability_schemas
WHERE computeImageCapabilitySchemaId = '{{ computeImageCapabilitySchemaId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods​

Moves a compute image capability schema into a different compartment within the same tenancy.<br />For information about moving resources between compartments, see<br /> [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

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