Azure Native v3.1.0, Apr 8 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.cdn.getSecret

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Using getSecret

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 getSecret(args: GetSecretArgs, opts?: InvokeOptions): Promise<GetSecretResult>
function getSecretOutput(args: GetSecretOutputArgs, opts?: InvokeOptions): Output<GetSecretResult>

def get_secret(profile_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               secret_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSecretResult
def get_secret_output(profile_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               secret_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSecretResult]

func LookupSecret(ctx *Context, args *LookupSecretArgs, opts ...InvokeOption) (*LookupSecretResult, error)
func LookupSecretOutput(ctx *Context, args *LookupSecretOutputArgs, opts ...InvokeOption) LookupSecretResultOutput

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

public static class GetSecret 
{
    public static Task<GetSecretResult> InvokeAsync(GetSecretArgs args, InvokeOptions? opts = null)
    public static Output<GetSecretResult> Invoke(GetSecretInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)
public static Output<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:cdn:getSecret
  arguments:
    # arguments dictionary

The following arguments are supported:

ProfileName string: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
SecretName string: Name of the Secret under the profile.

ProfileName string: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
SecretName string: Name of the Secret under the profile.

profileName String: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.
secretName String: Name of the Secret under the profile.

profileName string: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName string: Name of the Resource group within the Azure subscription.
secretName string: Name of the Secret under the profile.

profile_name str: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resource_group_name str: Name of the Resource group within the Azure subscription.
secret_name str: Name of the Secret under the profile.

profileName String: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.
secretName String: Name of the Secret under the profile.

getSecret Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
DeploymentStatus string
Id string: Resource ID.
Name string: Resource name.
ProfileName string: The name of the profile which holds the secret.
ProvisioningState string: Provisioning status
SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse: Read only system data
Type string: Resource type.
Parameters Pulumi.AzureNative.Cdn.Outputs.AzureFirstPartyManagedCertificateParametersResponse | Pulumi.AzureNative.Cdn.Outputs.CustomerCertificateParametersResponse | Pulumi.AzureNative.Cdn.Outputs.ManagedCertificateParametersResponse | Pulumi.AzureNative.Cdn.Outputs.UrlSigningKeyParametersResponse: object which contains secret parameters

AzureApiVersion string: The Azure API version of the resource.
DeploymentStatus string
Id string: Resource ID.
Name string: Resource name.
ProfileName string: The name of the profile which holds the secret.
ProvisioningState string: Provisioning status
SystemData SystemDataResponse: Read only system data
Type string: Resource type.
Parameters AzureFirstPartyManagedCertificateParametersResponse | CustomerCertificateParametersResponse | ManagedCertificateParametersResponse | UrlSigningKeyParametersResponse: object which contains secret parameters

azureApiVersion String: The Azure API version of the resource.
deploymentStatus String
id String: Resource ID.
name String: Resource name.
profileName String: The name of the profile which holds the secret.
provisioningState String: Provisioning status
systemData SystemDataResponse: Read only system data
type String: Resource type.
parameters AzureFirstPartyManagedCertificateParametersResponse | CustomerCertificateParametersResponse | ManagedCertificateParametersResponse | UrlSigningKeyParametersResponse: object which contains secret parameters

azureApiVersion string: The Azure API version of the resource.
deploymentStatus string
id string: Resource ID.
name string: Resource name.
profileName string: The name of the profile which holds the secret.
provisioningState string: Provisioning status
systemData SystemDataResponse: Read only system data
type string: Resource type.
parameters AzureFirstPartyManagedCertificateParametersResponse | CustomerCertificateParametersResponse | ManagedCertificateParametersResponse | UrlSigningKeyParametersResponse: object which contains secret parameters

azure_api_version str: The Azure API version of the resource.
deployment_status str
id str: Resource ID.
name str: Resource name.
profile_name str: The name of the profile which holds the secret.
provisioning_state str: Provisioning status
system_data SystemDataResponse: Read only system data
type str: Resource type.
parameters AzureFirstPartyManagedCertificateParametersResponse | CustomerCertificateParametersResponse | ManagedCertificateParametersResponse | UrlSigningKeyParametersResponse: object which contains secret parameters

azureApiVersion String: The Azure API version of the resource.
deploymentStatus String
id String: Resource ID.
name String: Resource name.
profileName String: The name of the profile which holds the secret.
provisioningState String: Provisioning status
systemData Property Map: Read only system data
type String: Resource type.
parameters Property Map | Property Map | Property Map | Property Map: object which contains secret parameters

Supporting Types

AzureFirstPartyManagedCertificateParametersResponse

CertificateAuthority string: Certificate issuing authority.
ExpirationDate string: Certificate expiration date.
SecretSource Pulumi.AzureNative.Cdn.Inputs.ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
Subject string: Subject name in the certificate.
Thumbprint string: Certificate thumbprint.
SubjectAlternativeNames List<string>: The list of SANs.

CertificateAuthority string: Certificate issuing authority.
ExpirationDate string: Certificate expiration date.
SecretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
Subject string: Subject name in the certificate.
Thumbprint string: Certificate thumbprint.
SubjectAlternativeNames []string: The list of SANs.

certificateAuthority String: Certificate issuing authority.
expirationDate String: Certificate expiration date.
secretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject String: Subject name in the certificate.
thumbprint String: Certificate thumbprint.
subjectAlternativeNames List<String>: The list of SANs.

certificateAuthority string: Certificate issuing authority.
expirationDate string: Certificate expiration date.
secretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject string: Subject name in the certificate.
thumbprint string: Certificate thumbprint.
subjectAlternativeNames string[]: The list of SANs.

certificate_authority str: Certificate issuing authority.
expiration_date str: Certificate expiration date.
secret_source ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject str: Subject name in the certificate.
thumbprint str: Certificate thumbprint.
subject_alternative_names Sequence[str]: The list of SANs.

certificateAuthority String: Certificate issuing authority.
expirationDate String: Certificate expiration date.
secretSource Property Map: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject String: Subject name in the certificate.
thumbprint String: Certificate thumbprint.
subjectAlternativeNames List<String>: The list of SANs.

CustomerCertificateParametersResponse

CertificateAuthority string: Certificate issuing authority.
ExpirationDate string: Certificate expiration date.
SecretSource Pulumi.AzureNative.Cdn.Inputs.ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
Subject string: Subject name in the certificate.
Thumbprint string: Certificate thumbprint.
SecretVersion string: Version of the secret to be used
SubjectAlternativeNames List<string>: The list of SANs.
UseLatestVersion bool: Whether to use the latest version for the certificate

CertificateAuthority string: Certificate issuing authority.
ExpirationDate string: Certificate expiration date.
SecretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
Subject string: Subject name in the certificate.
Thumbprint string: Certificate thumbprint.
SecretVersion string: Version of the secret to be used
SubjectAlternativeNames []string: The list of SANs.
UseLatestVersion bool: Whether to use the latest version for the certificate

certificateAuthority String: Certificate issuing authority.
expirationDate String: Certificate expiration date.
secretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject String: Subject name in the certificate.
thumbprint String: Certificate thumbprint.
secretVersion String: Version of the secret to be used
subjectAlternativeNames List<String>: The list of SANs.
useLatestVersion Boolean: Whether to use the latest version for the certificate

certificateAuthority string: Certificate issuing authority.
expirationDate string: Certificate expiration date.
secretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject string: Subject name in the certificate.
thumbprint string: Certificate thumbprint.
secretVersion string: Version of the secret to be used
subjectAlternativeNames string[]: The list of SANs.
useLatestVersion boolean: Whether to use the latest version for the certificate

certificate_authority str: Certificate issuing authority.
expiration_date str: Certificate expiration date.
secret_source ResourceReferenceResponse: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject str: Subject name in the certificate.
thumbprint str: Certificate thumbprint.
secret_version str: Version of the secret to be used
subject_alternative_names Sequence[str]: The list of SANs.
use_latest_version bool: Whether to use the latest version for the certificate

certificateAuthority String: Certificate issuing authority.
expirationDate String: Certificate expiration date.
secretSource Property Map: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject String: Subject name in the certificate.
thumbprint String: Certificate thumbprint.
secretVersion String: Version of the secret to be used
subjectAlternativeNames List<String>: The list of SANs.
useLatestVersion Boolean: Whether to use the latest version for the certificate

ManagedCertificateParametersResponse

ExpirationDate string: Certificate expiration date.
Subject string: Subject name in the certificate.

ExpirationDate string: Certificate expiration date.
Subject string: Subject name in the certificate.

expirationDate String: Certificate expiration date.
subject String: Subject name in the certificate.

expirationDate string: Certificate expiration date.
subject string: Subject name in the certificate.

expiration_date str: Certificate expiration date.
subject str: Subject name in the certificate.

expirationDate String: Certificate expiration date.
subject String: Subject name in the certificate.

ResourceReferenceResponse

Id string: Resource ID.

Id string: Resource ID.

id String: Resource ID.

id string: Resource ID.

id str: Resource ID.

id String: Resource ID.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC)
CreatedBy string: An identifier for the identity that created the resource
CreatedByType string: The type of identity that created the resource
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: An identifier for the identity that last modified the resource
LastModifiedByType string: The type of identity that last modified the resource

CreatedAt string: The timestamp of resource creation (UTC)
CreatedBy string: An identifier for the identity that created the resource
CreatedByType string: The type of identity that created the resource
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: An identifier for the identity that last modified the resource
LastModifiedByType string: The type of identity that last modified the resource

createdAt String: The timestamp of resource creation (UTC)
createdBy String: An identifier for the identity that created the resource
createdByType String: The type of identity that created the resource
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: An identifier for the identity that last modified the resource
lastModifiedByType String: The type of identity that last modified the resource

createdAt string: The timestamp of resource creation (UTC)
createdBy string: An identifier for the identity that created the resource
createdByType string: The type of identity that created the resource
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: An identifier for the identity that last modified the resource
lastModifiedByType string: The type of identity that last modified the resource

created_at str: The timestamp of resource creation (UTC)
created_by str: An identifier for the identity that created the resource
created_by_type str: The type of identity that created the resource
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: An identifier for the identity that last modified the resource
last_modified_by_type str: The type of identity that last modified the resource

createdAt String: The timestamp of resource creation (UTC)
createdBy String: An identifier for the identity that created the resource
createdByType String: The type of identity that created the resource
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: An identifier for the identity that last modified the resource
lastModifiedByType String: The type of identity that last modified the resource

UrlSigningKeyParametersResponse

KeyId string: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
SecretSource Pulumi.AzureNative.Cdn.Inputs.ResourceReferenceResponse: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
SecretVersion string: Version of the secret to be used

KeyId string: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
SecretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
SecretVersion string: Version of the secret to be used

keyId String: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
secretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretVersion String: Version of the secret to be used

keyId string: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
secretSource ResourceReferenceResponse: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretVersion string: Version of the secret to be used

key_id str: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
secret_source ResourceReferenceResponse: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secret_version str: Version of the secret to be used

keyId String: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
secretSource Property Map: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretVersion String: Version of the secret to be used

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.cdn.getSecret

On this page

On this page

Using getSecret

getSecret Result

Supporting Types

AzureFirstPartyManagedCertificateParametersResponse

CustomerCertificateParametersResponse

ManagedCertificateParametersResponse

ResourceReferenceResponse

SystemDataResponse

UrlSigningKeyParametersResponse

Package Details

On this page

On this page