Oracle Cloud Infrastructure v2.29.0, Apr 9 25

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Kms.getVaults

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testVaults = oci.Kms.getVaults({
    compartmentId: compartmentId,
});

import pulumi
import pulumi_oci as oci

test_vaults = oci.Kms.get_vaults(compartment_id=compartment_id)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/kms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.GetVaults(ctx, &kms.GetVaultsArgs{
			CompartmentId: compartmentId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testVaults = Oci.Kms.GetVaults.Invoke(new()
    {
        CompartmentId = compartmentId,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Kms.KmsFunctions;
import com.pulumi.oci.Kms.inputs.GetVaultsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testVaults = KmsFunctions.getVaults(GetVaultsArgs.builder()
            .compartmentId(compartmentId)
            .build());

    }
}

variables:
  testVaults:
    fn::invoke:
      function: oci:Kms:getVaults
      arguments:
        compartmentId: ${compartmentId}

Using getVaults

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getVaults(args: GetVaultsArgs, opts?: InvokeOptions): Promise<GetVaultsResult>
function getVaultsOutput(args: GetVaultsOutputArgs, opts?: InvokeOptions): Output<GetVaultsResult>

def get_vaults(compartment_id: Optional[str] = None,
               filters: Optional[Sequence[_kms.GetVaultsFilter]] = None,
               opts: Optional[InvokeOptions] = None) -> GetVaultsResult
def get_vaults_output(compartment_id: Optional[pulumi.Input[str]] = None,
               filters: Optional[pulumi.Input[Sequence[pulumi.Input[_kms.GetVaultsFilterArgs]]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVaultsResult]

func GetVaults(ctx *Context, args *GetVaultsArgs, opts ...InvokeOption) (*GetVaultsResult, error)
func GetVaultsOutput(ctx *Context, args *GetVaultsOutputArgs, opts ...InvokeOption) GetVaultsResultOutput

> Note: This function is named GetVaults in the Go SDK.

public static class GetVaults 
{
    public static Task<GetVaultsResult> InvokeAsync(GetVaultsArgs args, InvokeOptions? opts = null)
    public static Output<GetVaultsResult> Invoke(GetVaultsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVaultsResult> getVaults(GetVaultsArgs args, InvokeOptions options)
public static Output<GetVaultsResult> getVaults(GetVaultsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Kms/getVaults:getVaults
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
Filters List<GetVaultsFilter>

CompartmentId string: The OCID of the compartment.
Filters []GetVaultsFilter

compartmentId String: The OCID of the compartment.
filters List<GetVaultsFilter>

compartmentId string: The OCID of the compartment.
filters GetVaultsFilter[]

compartment_id str: The OCID of the compartment.
filters Sequence[kms.GetVaultsFilter]

compartmentId String: The OCID of the compartment.
filters List<Property Map>

getVaults Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains a particular vault.
Id string: The provider-assigned unique ID for this managed resource.
Vaults List<GetVaultsVault>: The list of vaults.
Filters List<GetVaultsFilter>

CompartmentId string: The OCID of the compartment that contains a particular vault.
Id string: The provider-assigned unique ID for this managed resource.
Vaults []GetVaultsVault: The list of vaults.
Filters []GetVaultsFilter

compartmentId String: The OCID of the compartment that contains a particular vault.
id String: The provider-assigned unique ID for this managed resource.
vaults List<GetVaultsVault>: The list of vaults.
filters List<GetVaultsFilter>

compartmentId string: The OCID of the compartment that contains a particular vault.
id string: The provider-assigned unique ID for this managed resource.
vaults GetVaultsVault[]: The list of vaults.
filters GetVaultsFilter[]

compartment_id str: The OCID of the compartment that contains a particular vault.
id str: The provider-assigned unique ID for this managed resource.
vaults Sequence[kms.GetVaultsVault]: The list of vaults.
filters Sequence[kms.GetVaultsFilter]

compartmentId String: The OCID of the compartment that contains a particular vault.
id String: The provider-assigned unique ID for this managed resource.
vaults List<Property Map>: The list of vaults.
filters List<Property Map>

Supporting Types

GetVaultsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetVaultsVault

CompartmentId string: The OCID of the compartment.
CryptoEndpoint string: The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
ExternalKeyManagerMetadataSummaries List<GetVaultsVaultExternalKeyManagerMetadataSummary>: Summary about metadata of external key manager to be returned to the customer as a response.
ExternalKeyManagerMetadatas List<GetVaultsVaultExternalKeyManagerMetadata>
FreeformTags Dictionary<string, string>: Free-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. Example: {"Department": "Finance"}
Id string: The OCID of the vault.
IsPrimary bool: A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
IsVaultReplicable bool: A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.
ManagementEndpoint string: The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
ReplicaDetails List<GetVaultsVaultReplicaDetail>: Vault replica details
RestoreFromFiles List<GetVaultsVaultRestoreFromFile>
RestoreFromObjectStores List<GetVaultsVaultRestoreFromObjectStore>
RestoreTrigger bool
RestoredFromVaultId string: The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.
State string: The vault's current lifecycle state. Example: DELETED
TimeCreated string: The date and time this vault was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeOfDeletion string: An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
VaultType string: The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

CompartmentId string: The OCID of the compartment.
CryptoEndpoint string: The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
ExternalKeyManagerMetadataSummaries []GetVaultsVaultExternalKeyManagerMetadataSummary: Summary about metadata of external key manager to be returned to the customer as a response.
ExternalKeyManagerMetadatas []GetVaultsVaultExternalKeyManagerMetadata
FreeformTags map[string]string: Free-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. Example: {"Department": "Finance"}
Id string: The OCID of the vault.
IsPrimary bool: A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
IsVaultReplicable bool: A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.
ManagementEndpoint string: The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
ReplicaDetails []GetVaultsVaultReplicaDetail: Vault replica details
RestoreFromFiles []GetVaultsVaultRestoreFromFile
RestoreFromObjectStores []GetVaultsVaultRestoreFromObjectStore
RestoreTrigger bool
RestoredFromVaultId string: The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.
State string: The vault's current lifecycle state. Example: DELETED
TimeCreated string: The date and time this vault was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeOfDeletion string: An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
VaultType string: The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

compartmentId String: The OCID of the compartment.
cryptoEndpoint String: The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
externalKeyManagerMetadataSummaries List<GetVaultsVaultExternalKeyManagerMetadataSummary>: Summary about metadata of external key manager to be returned to the customer as a response.
externalKeyManagerMetadatas List<GetVaultsVaultExternalKeyManagerMetadata>
freeformTags Map<String,String>: Free-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. Example: {"Department": "Finance"}
id String: The OCID of the vault.
isPrimary Boolean: A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
isVaultReplicable Boolean: A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.
managementEndpoint String: The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
replicaDetails List<GetVaultsVaultReplicaDetail>: Vault replica details
restoreFromFiles List<GetVaultsVaultRestoreFromFile>
restoreFromObjectStores List<GetVaultsVaultRestoreFromObjectStore>
restoreTrigger Boolean
restoredFromVaultId String: The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.
state String: The vault's current lifecycle state. Example: DELETED
timeCreated String: The date and time this vault was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeOfDeletion String: An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vaultType String: The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

compartmentId string: The OCID of the compartment.
cryptoEndpoint string: The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
externalKeyManagerMetadataSummaries GetVaultsVaultExternalKeyManagerMetadataSummary[]: Summary about metadata of external key manager to be returned to the customer as a response.
externalKeyManagerMetadatas GetVaultsVaultExternalKeyManagerMetadata[]
freeformTags {[key: string]: string}: Free-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. Example: {"Department": "Finance"}
id string: The OCID of the vault.
isPrimary boolean: A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
isVaultReplicable boolean: A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.
managementEndpoint string: The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
replicaDetails GetVaultsVaultReplicaDetail[]: Vault replica details
restoreFromFiles GetVaultsVaultRestoreFromFile[]
restoreFromObjectStores GetVaultsVaultRestoreFromObjectStore[]
restoreTrigger boolean
restoredFromVaultId string: The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.
state string: The vault's current lifecycle state. Example: DELETED
timeCreated string: The date and time this vault was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeOfDeletion string: An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vaultType string: The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

compartment_id str: The OCID of the compartment.
crypto_endpoint str: The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
external_key_manager_metadata_summaries Sequence[kms.GetVaultsVaultExternalKeyManagerMetadataSummary]: Summary about metadata of external key manager to be returned to the customer as a response.
external_key_manager_metadatas Sequence[kms.GetVaultsVaultExternalKeyManagerMetadata]
freeform_tags Mapping[str, str]: Free-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. Example: {"Department": "Finance"}
id str: The OCID of the vault.
is_primary bool: A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
is_vault_replicable bool: A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.
management_endpoint str: The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
replica_details Sequence[kms.GetVaultsVaultReplicaDetail]: Vault replica details
restore_from_files Sequence[kms.GetVaultsVaultRestoreFromFile]
restore_from_object_stores Sequence[kms.GetVaultsVaultRestoreFromObjectStore]
restore_trigger bool
restored_from_vault_id str: The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.
state str: The vault's current lifecycle state. Example: DELETED
time_created str: The date and time this vault was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
time_of_deletion str: An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vault_type str: The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

compartmentId String: The OCID of the compartment.
cryptoEndpoint String: The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
externalKeyManagerMetadataSummaries List<Property Map>: Summary about metadata of external key manager to be returned to the customer as a response.
externalKeyManagerMetadatas List<Property Map>
freeformTags Map<String>: Free-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. Example: {"Department": "Finance"}
id String: The OCID of the vault.
isPrimary Boolean: A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
isVaultReplicable Boolean: A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.
managementEndpoint String: The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
replicaDetails List<Property Map>: Vault replica details
restoreFromFiles List<Property Map>
restoreFromObjectStores List<Property Map>
restoreTrigger Boolean
restoredFromVaultId String: The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.
state String: The vault's current lifecycle state. Example: DELETED
timeCreated String: The date and time this vault was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeOfDeletion String: An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vaultType String: The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

GetVaultsVaultExternalKeyManagerMetadata

ExternalVaultEndpointUrl string: URL of the vault on external key manager.
OauthMetadatas List<GetVaultsVaultExternalKeyManagerMetadataOauthMetadata>
PrivateEndpointId string: OCID of the private endpoint.

ExternalVaultEndpointUrl string: URL of the vault on external key manager.
OauthMetadatas []GetVaultsVaultExternalKeyManagerMetadataOauthMetadata
PrivateEndpointId string: OCID of the private endpoint.

externalVaultEndpointUrl String: URL of the vault on external key manager.
oauthMetadatas List<GetVaultsVaultExternalKeyManagerMetadataOauthMetadata>
privateEndpointId String: OCID of the private endpoint.

externalVaultEndpointUrl string: URL of the vault on external key manager.
oauthMetadatas GetVaultsVaultExternalKeyManagerMetadataOauthMetadata[]
privateEndpointId string: OCID of the private endpoint.

external_vault_endpoint_url str: URL of the vault on external key manager.
oauth_metadatas Sequence[kms.GetVaultsVaultExternalKeyManagerMetadataOauthMetadata]
private_endpoint_id str: OCID of the private endpoint.

externalVaultEndpointUrl String: URL of the vault on external key manager.
oauthMetadatas List<Property Map>
privateEndpointId String: OCID of the private endpoint.

GetVaultsVaultExternalKeyManagerMetadataOauthMetadata

ClientAppId string: ID of the client app created in IDP.
ClientAppSecret string
IdcsAccountNameUrl string: Base URL of the IDCS account where confidential client app is created.

ClientAppId string: ID of the client app created in IDP.
ClientAppSecret string
IdcsAccountNameUrl string: Base URL of the IDCS account where confidential client app is created.

clientAppId String: ID of the client app created in IDP.
clientAppSecret String
idcsAccountNameUrl String: Base URL of the IDCS account where confidential client app is created.

clientAppId string: ID of the client app created in IDP.
clientAppSecret string
idcsAccountNameUrl string: Base URL of the IDCS account where confidential client app is created.

client_app_id str: ID of the client app created in IDP.
client_app_secret str
idcs_account_name_url str: Base URL of the IDCS account where confidential client app is created.

clientAppId String: ID of the client app created in IDP.
clientAppSecret String
idcsAccountNameUrl String: Base URL of the IDCS account where confidential client app is created.

GetVaultsVaultExternalKeyManagerMetadataSummary

ExternalVaultEndpointUrl string: URL of the vault on external key manager.
OauthMetadataSummaries List<GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary>: Summary about authorization to be returned to the customer as a response.
PrivateEndpointId string: OCID of the private endpoint.
Vendor string: Vendor of the external key manager.

ExternalVaultEndpointUrl string: URL of the vault on external key manager.
OauthMetadataSummaries []GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary: Summary about authorization to be returned to the customer as a response.
PrivateEndpointId string: OCID of the private endpoint.
Vendor string: Vendor of the external key manager.

externalVaultEndpointUrl String: URL of the vault on external key manager.
oauthMetadataSummaries List<GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary>: Summary about authorization to be returned to the customer as a response.
privateEndpointId String: OCID of the private endpoint.
vendor String: Vendor of the external key manager.

externalVaultEndpointUrl string: URL of the vault on external key manager.
oauthMetadataSummaries GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary[]: Summary about authorization to be returned to the customer as a response.
privateEndpointId string: OCID of the private endpoint.
vendor string: Vendor of the external key manager.

external_vault_endpoint_url str: URL of the vault on external key manager.
oauth_metadata_summaries Sequence[kms.GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary]: Summary about authorization to be returned to the customer as a response.
private_endpoint_id str: OCID of the private endpoint.
vendor str: Vendor of the external key manager.

externalVaultEndpointUrl String: URL of the vault on external key manager.
oauthMetadataSummaries List<Property Map>: Summary about authorization to be returned to the customer as a response.
privateEndpointId String: OCID of the private endpoint.
vendor String: Vendor of the external key manager.

GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary

ClientAppId string: ID of the client app created in IDP.
IdcsAccountNameUrl string: Base URL of the IDCS account where confidential client app is created.

ClientAppId string: ID of the client app created in IDP.
IdcsAccountNameUrl string: Base URL of the IDCS account where confidential client app is created.

clientAppId String: ID of the client app created in IDP.
idcsAccountNameUrl String: Base URL of the IDCS account where confidential client app is created.

clientAppId string: ID of the client app created in IDP.
idcsAccountNameUrl string: Base URL of the IDCS account where confidential client app is created.

client_app_id str: ID of the client app created in IDP.
idcs_account_name_url str: Base URL of the IDCS account where confidential client app is created.

clientAppId String: ID of the client app created in IDP.
idcsAccountNameUrl String: Base URL of the IDCS account where confidential client app is created.