Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. devtestlab
  5. getSecret
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.devtestlab.getSecret

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get secret. Azure REST API version: 2018-09-15.

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>
Copy
def get_secret(expand: Optional[str] = None,
               lab_name: Optional[str] = None,
               name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               user_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSecretResult
def get_secret_output(expand: Optional[pulumi.Input[str]] = None,
               lab_name: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               user_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSecretResult]
Copy
func LookupSecret(ctx *Context, args *LookupSecretArgs, opts ...InvokeOption) (*LookupSecretResult, error)
func LookupSecretOutput(ctx *Context, args *LookupSecretOutputArgs, opts ...InvokeOption) LookupSecretResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)
public static Output<GetSecretResult> getSecret(GetSecretArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devtestlab:getSecret
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the secret.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
UserName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
Expand string
Specify the $expand query. Example: 'properties($select=value)'
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the secret.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
UserName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
Expand string
Specify the $expand query. Example: 'properties($select=value)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the secret.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
userName
This property is required.
Changes to this property will trigger replacement.
String
The name of the user profile.
expand String
Specify the $expand query. Example: 'properties($select=value)'
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the secret.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
userName
This property is required.
Changes to this property will trigger replacement.
string
The name of the user profile.
expand string
Specify the $expand query. Example: 'properties($select=value)'
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the secret.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
user_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the user profile.
expand str
Specify the $expand query. Example: 'properties($select=value)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the secret.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
userName
This property is required.
Changes to this property will trigger replacement.
String
The name of the user profile.
expand String
Specify the $expand query. Example: 'properties($select=value)'

getSecret Result

The following output properties are available:

Id string
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
Location string
The location of the resource.
Tags Dictionary<string, string>
The tags of the resource.
Value string
The value of the secret for secret creation.
Id string
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
UniqueIdentifier string
The unique immutable identifier of a resource (Guid).
Location string
The location of the resource.
Tags map[string]string
The tags of the resource.
Value string
The value of the secret for secret creation.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
location String
The location of the resource.
tags Map<String,String>
The tags of the resource.
value String
The value of the secret for secret creation.
id string
The identifier of the resource.
name string
The name of the resource.
provisioningState string
The provisioning status of the resource.
type string
The type of the resource.
uniqueIdentifier string
The unique immutable identifier of a resource (Guid).
location string
The location of the resource.
tags {[key: string]: string}
The tags of the resource.
value string
The value of the secret for secret creation.
id str
The identifier of the resource.
name str
The name of the resource.
provisioning_state str
The provisioning status of the resource.
type str
The type of the resource.
unique_identifier str
The unique immutable identifier of a resource (Guid).
location str
The location of the resource.
tags Mapping[str, str]
The tags of the resource.
value str
The value of the secret for secret creation.
id String
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
uniqueIdentifier String
The unique immutable identifier of a resource (Guid).
location String
The location of the resource.
tags Map<String>
The tags of the resource.
value String
The value of the secret for secret creation.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native