vault_usages
Creates, updates, deletes, gets or lists a vault_usages resource.
Overview​
| Name | vault_usages |
| Type | Resource |
| Id | oci.kms.vault_usages |
Fields​
The following fields are returned by SELECT queries:
- get
The usage level of keys and key versions in the specified vault.
| Name | Datatype | Description |
|---|---|---|
keyCount | integer (int32) | The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a DELETED state. |
keyVersionCount | integer (int32) | The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a DELETED state. |
softwareKeyCount | integer (int32) | The number of keys in this vault that persist on the server, across all compartments, excluding keys in a DELETED state. |
softwareKeyVersionCount | integer (int32) | The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a DELETED state. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | vaultId, region | opc-request-id | Gets the count of keys and key versions in the specified vault to calculate usage against service limits.<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.
| Name | Datatype | Description |
|---|---|---|
region | string | OCI 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) |
vaultId | string | The OCID of the vault. |
opc-request-id | string | Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. |
SELECT examples​
- get
Gets the count of keys and key versions in the specified vault to calculate usage against service limits.<br />
SELECT
keyCount,
keyVersionCount,
softwareKeyCount,
softwareKeyVersionCount
FROM oci.kms.vault_usages
WHERE vaultId = '{{ vaultId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;