azure-native.devtestlab.getEnvironment

Azure Native v3.16.0, Mar 20 26

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

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Using getEnvironment

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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>

def get_environment(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) -> GetEnvironmentResult
def get_environment_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[GetEnvironmentResult]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

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

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:devtestlab:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

LabName string: The name of the lab.
Name string: The name of the environment.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
UserName string: The name of the user profile.
Expand string: Specify the $expand query. Example: 'properties($select=deploymentProperties)'

LabName string: The name of the lab.
Name string: The name of the environment.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
UserName string: The name of the user profile.
Expand string: Specify the $expand query. Example: 'properties($select=deploymentProperties)'

labName String: The name of the lab.
name String: The name of the environment.
resourceGroupName String: The name of the resource group. The name is case insensitive.
userName String: The name of the user profile.
expand String: Specify the $expand query. Example: 'properties($select=deploymentProperties)'

labName string: The name of the lab.
name string: The name of the environment.
resourceGroupName string: The name of the resource group. The name is case insensitive.
userName string: The name of the user profile.
expand string: Specify the $expand query. Example: 'properties($select=deploymentProperties)'

lab_name str: The name of the lab.
name str: The name of the environment.
resource_group_name str: The name of the resource group. The name is case insensitive.
user_name str: The name of the user profile.
expand str: Specify the $expand query. Example: 'properties($select=deploymentProperties)'

labName String: The name of the lab.
name String: The name of the environment.
resourceGroupName String: The name of the resource group. The name is case insensitive.
userName String: The name of the user profile.
expand String: Specify the $expand query. Example: 'properties($select=deploymentProperties)'

getEnvironment Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreatedByUser string: The creator of the environment.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status of the resource.
ResourceGroupId string: The identifier of the resource group containing the environment's resources.
SystemData Pulumi.AzureNative.DevTestLab.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
ArmTemplateDisplayName string: The display name of the Azure Resource Manager template that produced the environment.
DeploymentProperties Pulumi.AzureNative.DevTestLab.Outputs.EnvironmentDeploymentPropertiesResponse: The deployment properties of the environment.
Location string: The geo-location where the resource lives
Tags Dictionary<string, string>: Resource tags.

AzureApiVersion string: The Azure API version of the resource.
CreatedByUser string: The creator of the environment.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status of the resource.
ResourceGroupId string: The identifier of the resource group containing the environment's resources.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
ArmTemplateDisplayName string: The display name of the Azure Resource Manager template that produced the environment.
DeploymentProperties EnvironmentDeploymentPropertiesResponse: The deployment properties of the environment.
Location string: The geo-location where the resource lives
Tags map[string]string: Resource tags.

azureApiVersion String: The Azure API version of the resource.
createdByUser String: The creator of the environment.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status of the resource.
resourceGroupId String: The identifier of the resource group containing the environment's resources.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
armTemplateDisplayName String: The display name of the Azure Resource Manager template that produced the environment.
deploymentProperties EnvironmentDeploymentPropertiesResponse: The deployment properties of the environment.
location String: The geo-location where the resource lives
tags Map<String,String>: Resource tags.

azureApiVersion string: The Azure API version of the resource.
createdByUser string: The creator of the environment.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
provisioningState string: The provisioning status of the resource.
resourceGroupId string: The identifier of the resource group containing the environment's resources.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier string: The unique immutable identifier of a resource (Guid).
armTemplateDisplayName string: The display name of the Azure Resource Manager template that produced the environment.
deploymentProperties EnvironmentDeploymentPropertiesResponse: The deployment properties of the environment.
location string: The geo-location where the resource lives
tags {[key: string]: string}: Resource tags.

azure_api_version str: The Azure API version of the resource.
created_by_user str: The creator of the environment.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
provisioning_state str: The provisioning status of the resource.
resource_group_id str: The identifier of the resource group containing the environment's resources.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
unique_identifier str: The unique immutable identifier of a resource (Guid).
arm_template_display_name str: The display name of the Azure Resource Manager template that produced the environment.
deployment_properties EnvironmentDeploymentPropertiesResponse: The deployment properties of the environment.
location str: The geo-location where the resource lives
tags Mapping[str, str]: Resource tags.

azureApiVersion String: The Azure API version of the resource.
createdByUser String: The creator of the environment.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status of the resource.
resourceGroupId String: The identifier of the resource group containing the environment's resources.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
armTemplateDisplayName String: The display name of the Azure Resource Manager template that produced the environment.
deploymentProperties Property Map: The deployment properties of the environment.
location String: The geo-location where the resource lives
tags Map<String>: Resource tags.

Supporting Types

ArmTemplateParameterPropertiesResponse

Name string: The name of the template parameter.
Value string: The value of the template parameter.

Name string: The name of the template parameter.
Value string: The value of the template parameter.

name String: The name of the template parameter.
value String: The value of the template parameter.

name string: The name of the template parameter.
value string: The value of the template parameter.

name str: The name of the template parameter.
value str: The value of the template parameter.

name String: The name of the template parameter.
value String: The value of the template parameter.

EnvironmentDeploymentPropertiesResponse

ArmTemplateId string: The Azure Resource Manager template's identifier.
Parameters List<Pulumi.AzureNative.DevTestLab.Inputs.ArmTemplateParameterPropertiesResponse>: The parameters of the Azure Resource Manager template.

ArmTemplateId string: The Azure Resource Manager template's identifier.
Parameters []ArmTemplateParameterPropertiesResponse: The parameters of the Azure Resource Manager template.

armTemplateId String: The Azure Resource Manager template's identifier.
parameters List<ArmTemplateParameterPropertiesResponse>: The parameters of the Azure Resource Manager template.

armTemplateId string: The Azure Resource Manager template's identifier.
parameters ArmTemplateParameterPropertiesResponse[]: The parameters of the Azure Resource Manager template.

arm_template_id str: The Azure Resource Manager template's identifier.
parameters Sequence[ArmTemplateParameterPropertiesResponse]: The parameters of the Azure Resource Manager template.

armTemplateId String: The Azure Resource Manager template's identifier.
parameters List<Property Map>: The parameters of the Azure Resource Manager template.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.