Azure Native

v1.78.0 published on Wednesday, Sep 14, 2022 by Pulumi

getEnvironment

An environment, which is essentially an ARM template deployment. API Version: 2018-09-15.

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)
// Output-based functions aren't available in Java yet
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.

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.

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.

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.

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.

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.

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:

CreatedByUser string

The creator of the environment.

Id string

The identifier of the resource.

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.

Type string

The type of the resource.

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 location of the resource.

Tags Dictionary<string, string>

The tags of the resource.

CreatedByUser string

The creator of the environment.

Id string

The identifier of the resource.

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.

Type string

The type of the resource.

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 location of the resource.

Tags map[string]string

The tags of the resource.

createdByUser String

The creator of the environment.

id String

The identifier of the resource.

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.

type String

The type of the resource.

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 location of the resource.

tags Map<String,String>

The tags of the resource.

createdByUser string

The creator of the environment.

id string

The identifier of the resource.

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.

type string

The type of the resource.

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 location of the resource.

tags {[key: string]: string}

The tags of the resource.

created_by_user str

The creator of the environment.

id str

The identifier of the resource.

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.

type str

The type of the resource.

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 location of the resource.

tags Mapping[str, str]

The tags of the resource.

createdByUser String

The creator of the environment.

id String

The identifier of the resource.

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.

type String

The type of the resource.

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 location of the resource.

tags Map<String>

The tags of the resource.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0