Azure Classic v5.38.0, Mar 21 23

azure.keyvault.getCertificates

Use this data source to retrieve a list of certificate names from an existing Key Vault.

Using getCertificates

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.

function getCertificates(args: GetCertificatesArgs, opts?: InvokeOptions): Promise<GetCertificatesResult>
function getCertificatesOutput(args: GetCertificatesOutputArgs, opts?: InvokeOptions): Output<GetCertificatesResult>

def get_certificates(include_pending: Optional[bool] = None,
                     key_vault_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCertificatesResult
def get_certificates_output(include_pending: Optional[pulumi.Input[bool]] = None,
                     key_vault_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCertificatesResult]

func GetCertificates(ctx *Context, args *GetCertificatesArgs, opts ...InvokeOption) (*GetCertificatesResult, error)
func GetCertificatesOutput(ctx *Context, args *GetCertificatesOutputArgs, opts ...InvokeOption) GetCertificatesResultOutput

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

public static class GetCertificates 
{
    public static Task<GetCertificatesResult> InvokeAsync(GetCertificatesArgs args, InvokeOptions? opts = null)
    public static Output<GetCertificatesResult> Invoke(GetCertificatesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCertificatesResult> getCertificates(GetCertificatesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:keyvault/getCertificates:getCertificates
  arguments:
    # arguments dictionary

The following arguments are supported:

KeyVaultId string: Specifies the ID of the Key Vault instance to fetch certificate names from, available on the azure.keyvault.KeyVault Data Source / Resource.
IncludePending bool: Specifies whether to include certificates which are not completely provisioned. Defaults to true.

KeyVaultId string: Specifies the ID of the Key Vault instance to fetch certificate names from, available on the azure.keyvault.KeyVault Data Source / Resource.
IncludePending bool: Specifies whether to include certificates which are not completely provisioned. Defaults to true.

keyVaultId String: Specifies the ID of the Key Vault instance to fetch certificate names from, available on the azure.keyvault.KeyVault Data Source / Resource.
includePending Boolean: Specifies whether to include certificates which are not completely provisioned. Defaults to true.

keyVaultId string: Specifies the ID of the Key Vault instance to fetch certificate names from, available on the azure.keyvault.KeyVault Data Source / Resource.
includePending boolean: Specifies whether to include certificates which are not completely provisioned. Defaults to true.

key_vault_id str: Specifies the ID of the Key Vault instance to fetch certificate names from, available on the azure.keyvault.KeyVault Data Source / Resource.
include_pending bool: Specifies whether to include certificates which are not completely provisioned. Defaults to true.

keyVaultId String: Specifies the ID of the Key Vault instance to fetch certificate names from, available on the azure.keyvault.KeyVault Data Source / Resource.
includePending Boolean: Specifies whether to include certificates which are not completely provisioned. Defaults to true.

getCertificates Result

The following output properties are available:

Certificates List<GetCertificatesCertificate>: One or more certificates blocks as defined below.
Id string: The provider-assigned unique ID for this managed resource.
KeyVaultId string: The Key Vault ID.
Names List<string>: List containing names of certificates that exist in this Key Vault.
IncludePending bool

Certificates []GetCertificatesCertificate: One or more certificates blocks as defined below.
Id string: The provider-assigned unique ID for this managed resource.
KeyVaultId string: The Key Vault ID.
Names []string: List containing names of certificates that exist in this Key Vault.
IncludePending bool

certificates List<GetCertificatesCertificate>: One or more certificates blocks as defined below.
id String: The provider-assigned unique ID for this managed resource.
keyVaultId String: The Key Vault ID.
names List<String>: List containing names of certificates that exist in this Key Vault.
includePending Boolean

certificates GetCertificatesCertificate[]: One or more certificates blocks as defined below.
id string: The provider-assigned unique ID for this managed resource.
keyVaultId string: The Key Vault ID.
names string[]: List containing names of certificates that exist in this Key Vault.
includePending boolean

certificates Sequence[GetCertificatesCertificate]: One or more certificates blocks as defined below.
id str: The provider-assigned unique ID for this managed resource.
key_vault_id str: The Key Vault ID.
names Sequence[str]: List containing names of certificates that exist in this Key Vault.
include_pending bool

certificates List<Property Map>: One or more certificates blocks as defined below.
id String: The provider-assigned unique ID for this managed resource.
keyVaultId String: The Key Vault ID.
names List<String>: List containing names of certificates that exist in this Key Vault.
includePending Boolean

Supporting Types

GetCertificatesCertificate

Enabled bool: Whether this secret is enabled.
Id string
Name string: The name of secret.

Enabled bool: Whether this secret is enabled.
Id string
Name string: The name of secret.

enabled Boolean: Whether this secret is enabled.
id String
name String: The name of secret.

enabled boolean: Whether this secret is enabled.
id string
name string: The name of secret.

enabled bool: Whether this secret is enabled.
id str
name str: The name of secret.

enabled Boolean: Whether this secret is enabled.
id String
name String: The name of secret.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.