This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.cdn.getSecret
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Gets an existing Secret within a profile. Azure REST API version: 2023-05-01.
Other available API versions: 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-09-01.
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.
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 dictionaryThe 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.
- ResourceGroup stringName 
- 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.
- ResourceGroup stringName 
- 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.
- resourceGroup StringName 
- 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.
- resourceGroup stringName 
- 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_ strname 
- 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.
- resourceGroup StringName 
- 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:
- 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.Azure Native. Cdn. Outputs. System Data Response 
- Read only system data
- Type string
- Resource type.
- Parameters
Pulumi.Azure | Pulumi.Native. Cdn. Outputs. Azure First Party Managed Certificate Parameters Response Azure | Pulumi.Native. Cdn. Outputs. Customer Certificate Parameters Response Azure | Pulumi.Native. Cdn. Outputs. Managed Certificate Parameters Response Azure Native. Cdn. Outputs. Url Signing Key Parameters Response 
- object which contains secret parameters
- 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 SystemData Response 
- Read only system data
- Type string
- Resource type.
- Parameters
AzureFirst | CustomerParty Managed Certificate Parameters Response Certificate | ManagedParameters Response Certificate | UrlParameters Response Signing Key Parameters Response 
- object which contains secret parameters
- 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 SystemData Response 
- Read only system data
- type String
- Resource type.
- parameters
AzureFirst | CustomerParty Managed Certificate Parameters Response Certificate | ManagedParameters Response Certificate | UrlParameters Response Signing Key Parameters Response 
- object which contains secret parameters
- 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 SystemData Response 
- Read only system data
- type string
- Resource type.
- parameters
AzureFirst | CustomerParty Managed Certificate Parameters Response Certificate | ManagedParameters Response Certificate | UrlParameters Response Signing Key Parameters Response 
- object which contains secret parameters
- 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 SystemData Response 
- Read only system data
- type str
- Resource type.
- parameters
AzureFirst | CustomerParty Managed Certificate Parameters Response Certificate | ManagedParameters Response Certificate | UrlParameters Response Signing Key Parameters Response 
- object which contains secret parameters
- 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      
- string
- Certificate issuing authority.
- ExpirationDate string
- Certificate expiration date.
- SecretSource Pulumi.Azure Native. Cdn. Inputs. Resource Reference Response 
- 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.
- SubjectAlternative List<string>Names 
- The list of SANs.
- string
- Certificate issuing authority.
- ExpirationDate string
- Certificate expiration date.
- SecretSource ResourceReference Response 
- 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.
- SubjectAlternative []stringNames 
- The list of SANs.
- String
- Certificate issuing authority.
- expirationDate String
- Certificate expiration date.
- secretSource ResourceReference Response 
- 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.
- subjectAlternative List<String>Names 
- The list of SANs.
- string
- Certificate issuing authority.
- expirationDate string
- Certificate expiration date.
- secretSource ResourceReference Response 
- 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.
- subjectAlternative string[]Names 
- The list of SANs.
- str
- Certificate issuing authority.
- expiration_date str
- Certificate expiration date.
- secret_source ResourceReference Response 
- 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_ Sequence[str]names 
- The list of SANs.
- 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.
- subjectAlternative List<String>Names 
- The list of SANs.
CustomerCertificateParametersResponse   
- string
- Certificate issuing authority.
- ExpirationDate string
- Certificate expiration date.
- SecretSource Pulumi.Azure Native. Cdn. Inputs. Resource Reference Response 
- 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
- SubjectAlternative List<string>Names 
- The list of SANs.
- UseLatest boolVersion 
- Whether to use the latest version for the certificate
- string
- Certificate issuing authority.
- ExpirationDate string
- Certificate expiration date.
- SecretSource ResourceReference Response 
- 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
- SubjectAlternative []stringNames 
- The list of SANs.
- UseLatest boolVersion 
- Whether to use the latest version for the certificate
- String
- Certificate issuing authority.
- expirationDate String
- Certificate expiration date.
- secretSource ResourceReference Response 
- 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
- subjectAlternative List<String>Names 
- The list of SANs.
- useLatest BooleanVersion 
- Whether to use the latest version for the certificate
- string
- Certificate issuing authority.
- expirationDate string
- Certificate expiration date.
- secretSource ResourceReference Response 
- 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
- subjectAlternative string[]Names 
- The list of SANs.
- useLatest booleanVersion 
- Whether to use the latest version for the certificate
- str
- Certificate issuing authority.
- expiration_date str
- Certificate expiration date.
- secret_source ResourceReference Response 
- 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_ Sequence[str]names 
- The list of SANs.
- use_latest_ boolversion 
- Whether to use the latest version for the certificate
- 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
- subjectAlternative List<String>Names 
- The list of SANs.
- useLatest BooleanVersion 
- 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
- CreatedBy stringType 
- The type of identity that created the resource
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- An identifier for the identity that last modified the resource
- LastModified stringBy Type 
- 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
- CreatedBy stringType 
- The type of identity that created the resource
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- An identifier for the identity that last modified the resource
- LastModified stringBy Type 
- 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
- createdBy StringType 
- The type of identity that created the resource
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- An identifier for the identity that last modified the resource
- lastModified StringBy Type 
- 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
- createdBy stringType 
- The type of identity that created the resource
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- An identifier for the identity that last modified the resource
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- An identifier for the identity that last modified the resource
- last_modified_ strby_ type 
- 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
- createdBy StringType 
- The type of identity that created the resource
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- An identifier for the identity that last modified the resource
- lastModified StringBy Type 
- 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.Azure Native. Cdn. Inputs. Resource Reference Response 
- 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 ResourceReference Response 
- 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 ResourceReference Response 
- 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 ResourceReference Response 
- 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 ResourceReference Response 
- 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi