Edit

Share via

Get-AzDevCenterUserEnvironmentDefinition

  • Reference
Module:
Az.DevCenter

Get an environment definition from a catalog.

Syntax

Get-AzDevCenterUserEnvironmentDefinition
   -Endpoint <String>
   -ProjectName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserEnvironmentDefinition
   -Endpoint <String>
   -ProjectName <String>
   -CatalogName <String>
   -DefinitionName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserEnvironmentDefinition
   -Endpoint <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserEnvironmentDefinition
   -Endpoint <String>
   -ProjectName <String>
   -CatalogName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserEnvironmentDefinition
   -DevCenterName <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserEnvironmentDefinition
   -DevCenterName <String>
   -ProjectName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserEnvironmentDefinition
   -DevCenterName <String>
   -ProjectName <String>
   -CatalogName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserEnvironmentDefinition
   -DevCenterName <String>
   -ProjectName <String>
   -CatalogName <String>
   -DefinitionName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get an environment definition from a catalog.

Examples

Example 1: List environment definitions by endpoint and project



Get-AzDevCenterUserEnvironmentDefinition -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject

This command lists environment definitions under the project "DevProject".

Example 2: List environment definitions by dev center and project

Get-AzDevCenterUserEnvironmentDefinition -DevCenterName Contoso -ProjectName DevProject

This command lists environment definitions under the project "DevProject".

Example 3: List environment definitions by endpoint, catalog, and project

Get-AzDevCenterUserEnvironmentDefinition -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -CatalogName CentralCatalog

This command lists environment definitions under the project "DevProject" and the catalog "CentralCatalog".

Example 4: List environment definitions by dev center, catalog, and project

Get-AzDevCenterUserEnvironmentDefinition -DevCenterName Contoso -ProjectName DevProject -CatalogName CentralCatalog

This command lists environment definitions under the project "DevProject" and the catalog "CentralCatalog".

Example 5: Get an environment definition by endpoint

Get-AzDevCenterUserEnvironmentDefinition -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -CatalogName CentralCatalog  -DefinitionName Sandbox

This command gets the environment definition "Sandbox" under the project "DevProject" and the catalog "CentralCatalog".

Example 6: Get an environment definition by dev center

Get-AzDevCenterUserEnvironmentDefinition -DevCenterName Contoso -ProjectName DevProject -CatalogName CentralCatalog -DefinitionName Sandbox

This command gets the environment definition "Sandbox" under the project "DevProject" and the catalog "CentralCatalog".

Example 7: Get an environment definition by endpoint and InputObject

$envInput = @{"CatalogName" = "CentralCatalog"; "ProjectName" = "DevProject"; "DefinitionName" = "Sandbox" }
Get-AzDevCenterUserEnvironmentDefinition -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $envInput

This command gets the environment definition "Sandbox" under the project "DevProject" and the catalog "CentralCatalog".

Example 8: Get an environment definition by dev center and InputObject

$envInput = @{"CatalogName" = "CentralCatalog"; "ProjectName" = "DevProject"; "DefinitionName" = "Sandbox" }
Get-AzDevCenterUserEnvironmentDefinition -DevCenterName Contoso -InputObject $envInput

This command gets the environment definition "Sandbox" under the project "DevProject" and the catalog "CentralCatalog".

Parameters

-CatalogName

Name of the catalog.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefinitionName

Name of the environment definition.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DevCenterName

The DevCenter upon which to execute operations.

Type:String
Aliases:DevCenter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Endpoint

The DevCenter-specific URI to operate on.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IDevCenterdataIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProjectName

Name of the project.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IDevCenterdataIdentity

Outputs

IEnvironmentDefinition