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.47.1 published on Monday, Jun 24, 2024 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.47.1 published on Monday, Jun 24, 2024 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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:cdn:getSecret
arguments:
# arguments dictionary
The following arguments are supported:
- Profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- Secret
Name string - Name of the Secret under the profile.
- Profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- Secret
Name string - Name of the Secret under the profile.
- profile
Name String - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
- secret
Name String - Name of the Secret under the profile.
- profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resource
Group stringName - Name of the Resource group within the Azure subscription.
- secret
Name 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.
- profile
Name String - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
- secret
Name String - Name of the Secret under the profile.
getSecret Result
The following output properties are available:
- Deployment
Status string - Id string
- Resource ID.
- Name string
- Resource name.
- Profile
Name string - The name of the profile which holds the secret.
- Provisioning
State string - Provisioning status
- System
Data 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
- Deployment
Status string - Id string
- Resource ID.
- Name string
- Resource name.
- Profile
Name string - The name of the profile which holds the secret.
- Provisioning
State string - Provisioning status
- System
Data SystemData Response - Read only system data
- Type string
- Resource type.
- Parameters
Azure
First | CustomerParty Managed Certificate Parameters Response Certificate | ManagedParameters Response Certificate | UrlParameters Response Signing Key Parameters Response - object which contains secret parameters
- deployment
Status String - id String
- Resource ID.
- name String
- Resource name.
- profile
Name String - The name of the profile which holds the secret.
- provisioning
State String - Provisioning status
- system
Data SystemData Response - Read only system data
- type String
- Resource type.
- parameters
Azure
First | CustomerParty Managed Certificate Parameters Response Certificate | ManagedParameters Response Certificate | UrlParameters Response Signing Key Parameters Response - object which contains secret parameters
- deployment
Status string - id string
- Resource ID.
- name string
- Resource name.
- profile
Name string - The name of the profile which holds the secret.
- provisioning
State string - Provisioning status
- system
Data SystemData Response - Read only system data
- type string
- Resource type.
- parameters
Azure
First | 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
Azure
First | CustomerParty Managed Certificate Parameters Response Certificate | ManagedParameters Response Certificate | UrlParameters Response Signing Key Parameters Response - object which contains secret parameters
- deployment
Status String - id String
- Resource ID.
- name String
- Resource name.
- profile
Name String - The name of the profile which holds the secret.
- provisioning
State String - Provisioning status
- system
Data 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.
- Expiration
Date string - Certificate expiration date.
- Secret
Source 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.
- Subject
Alternative List<string>Names - The list of SANs.
- string
- Certificate issuing authority.
- Expiration
Date string - 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 string
- Subject name in the certificate.
- Thumbprint string
- Certificate thumbprint.
- Subject
Alternative []stringNames - The list of SANs.
- String
- Certificate issuing authority.
- expiration
Date String - 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 String
- Subject name in the certificate.
- thumbprint String
- Certificate thumbprint.
- subject
Alternative List<String>Names - The list of SANs.
- string
- Certificate issuing authority.
- expiration
Date string - 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 string
- Subject name in the certificate.
- thumbprint string
- Certificate thumbprint.
- subject
Alternative 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.
- expiration
Date String - Certificate expiration date.
- secret
Source 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.
- subject
Alternative List<String>Names - The list of SANs.
CustomerCertificateParametersResponse
- string
- Certificate issuing authority.
- Expiration
Date string - Certificate expiration date.
- Secret
Source 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.
- Secret
Version string - Version of the secret to be used
- Subject
Alternative List<string>Names - The list of SANs.
- Use
Latest boolVersion - Whether to use the latest version for the certificate
- string
- Certificate issuing authority.
- Expiration
Date string - 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 string
- Subject name in the certificate.
- Thumbprint string
- Certificate thumbprint.
- Secret
Version string - Version of the secret to be used
- Subject
Alternative []stringNames - The list of SANs.
- Use
Latest boolVersion - Whether to use the latest version for the certificate
- String
- Certificate issuing authority.
- expiration
Date String - 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 String
- Subject name in the certificate.
- thumbprint String
- Certificate thumbprint.
- secret
Version String - Version of the secret to be used
- subject
Alternative List<String>Names - The list of SANs.
- use
Latest BooleanVersion - Whether to use the latest version for the certificate
- string
- Certificate issuing authority.
- expiration
Date string - 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 string
- Subject name in the certificate.
- thumbprint string
- Certificate thumbprint.
- secret
Version string - Version of the secret to be used
- subject
Alternative string[]Names - The list of SANs.
- use
Latest 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.
- expiration
Date String - Certificate expiration date.
- secret
Source 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.
- secret
Version String - Version of the secret to be used
- subject
Alternative List<String>Names - The list of SANs.
- use
Latest BooleanVersion - Whether to use the latest version for the certificate
ManagedCertificateParametersResponse
- Expiration
Date string - Certificate expiration date.
- Subject string
- Subject name in the certificate.
- Expiration
Date string - Certificate expiration date.
- Subject string
- Subject name in the certificate.
- expiration
Date String - Certificate expiration date.
- subject String
- Subject name in the certificate.
- expiration
Date string - Certificate expiration date.
- subject string
- Subject name in the certificate.
- expiration_
date str - Certificate expiration date.
- subject str
- Subject name in the certificate.
- expiration
Date 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
- Created
At string - The timestamp of resource creation (UTC)
- Created
By string - An identifier for the identity that created the resource
- Created
By stringType - The type of identity that created the resource
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - An identifier for the identity that last modified the resource
- Last
Modified stringBy Type - The type of identity that last modified the resource
- Created
At string - The timestamp of resource creation (UTC)
- Created
By string - An identifier for the identity that created the resource
- Created
By stringType - The type of identity that created the resource
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - An identifier for the identity that last modified the resource
- Last
Modified stringBy Type - The type of identity that last modified the resource
- created
At String - The timestamp of resource creation (UTC)
- created
By String - An identifier for the identity that created the resource
- created
By StringType - The type of identity that created the resource
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - An identifier for the identity that last modified the resource
- last
Modified StringBy Type - The type of identity that last modified the resource
- created
At string - The timestamp of resource creation (UTC)
- created
By string - An identifier for the identity that created the resource
- created
By stringType - The type of identity that created the resource
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - An identifier for the identity that last modified the resource
- last
Modified 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
- created
At String - The timestamp of resource creation (UTC)
- created
By String - An identifier for the identity that created the resource
- created
By StringType - The type of identity that created the resource
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - An identifier for the identity that last modified the resource
- last
Modified StringBy Type - The type of identity that last modified the resource
UrlSigningKeyParametersResponse
- Key
Id string - 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 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}
- Secret
Version string - Version of the secret to be used
- Key
Id string - 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 string - Version of the secret to be used
- key
Id String - 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 String - Version of the secret to be used
- key
Id string - 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 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
- key
Id String - 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 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}
- secret
Version 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.47.1 published on Monday, Jun 24, 2024 by Pulumi