diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Az.DevCenter.md b/src/DevCenter/DevCenter.AutoRest/help/help/Az.DevCenter.md deleted file mode 100644 index d7235b33119f..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Az.DevCenter.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -Module Name: Az.DevCenter -Module Guid: 24d861ed-547c-4787-81d0-d5e222ff4d0d -Download Help Link: https://learn.microsoft.com/powershell/module/az.devcenter -Help Version: 1.0.0.0 -Locale: en-US ---- - -# Az.DevCenter Module -## Description -Microsoft Azure PowerShell: DevCenter cmdlets - -## Az.DevCenter Cmdlets -### [Get-AzDevCenterAdminAttachedNetwork](Get-AzDevCenterAdminAttachedNetwork.md) -Gets an attached NetworkConnection. - -### [Get-AzDevCenterAdminCatalog](Get-AzDevCenterAdminCatalog.md) -Gets a catalog - -### [Get-AzDevCenterAdminDevBoxDefinition](Get-AzDevCenterAdminDevBoxDefinition.md) -Gets a Dev Box definition - -### [Get-AzDevCenterAdminDevCenter](Get-AzDevCenterAdminDevCenter.md) -Gets a devcenter. - -### [Get-AzDevCenterAdminEnvironmentType](Get-AzDevCenterAdminEnvironmentType.md) -Gets an environment type. - -### [Get-AzDevCenterAdminGallery](Get-AzDevCenterAdminGallery.md) -Gets a gallery - -### [Get-AzDevCenterAdminImage](Get-AzDevCenterAdminImage.md) -Gets a gallery image. - -### [Get-AzDevCenterAdminImageVersion](Get-AzDevCenterAdminImageVersion.md) -Gets an image version. - -### [Get-AzDevCenterAdminNetworkConnection](Get-AzDevCenterAdminNetworkConnection.md) -Gets a network connection resource - -### [Get-AzDevCenterAdminNetworkConnectionHealthDetail](Get-AzDevCenterAdminNetworkConnectionHealthDetail.md) -Gets health check status details. - -### [Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint](Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint.md) -Lists the endpoints that agents may call as part of Dev Box service administration. -These FQDNs should be allowed for outbound access in order for the Dev Box service to function. - -### [Get-AzDevCenterAdminOperationStatus](Get-AzDevCenterAdminOperationStatus.md) -Gets the current status of an async operation. - -### [Get-AzDevCenterAdminPool](Get-AzDevCenterAdminPool.md) -Gets a machine pool - -### [Get-AzDevCenterAdminProject](Get-AzDevCenterAdminProject.md) -Gets a specific project. - -### [Get-AzDevCenterAdminProjectAllowedEnvironmentType](Get-AzDevCenterAdminProjectAllowedEnvironmentType.md) -Gets an allowed environment type. - -### [Get-AzDevCenterAdminProjectEnvironmentType](Get-AzDevCenterAdminProjectEnvironmentType.md) -Gets a project environment type. - -### [Get-AzDevCenterAdminSchedule](Get-AzDevCenterAdminSchedule.md) -Gets a schedule resource. - -### [Get-AzDevCenterAdminSku](Get-AzDevCenterAdminSku.md) -Lists the Microsoft.DevCenter SKUs available in a subscription - -### [Get-AzDevCenterAdminUsage](Get-AzDevCenterAdminUsage.md) -Lists the current usages and limits in this location for the provided subscription. - -### [Invoke-AzDevCenterAdminExecuteCheckNameAvailability](Invoke-AzDevCenterAdminExecuteCheckNameAvailability.md) -Check the availability of name for resource - -### [New-AzDevCenterAdminAttachedNetwork](New-AzDevCenterAdminAttachedNetwork.md) -Creates or updates an attached NetworkConnection. - -### [New-AzDevCenterAdminCatalog](New-AzDevCenterAdminCatalog.md) -Creates or updates a catalog. - -### [New-AzDevCenterAdminDevBoxDefinition](New-AzDevCenterAdminDevBoxDefinition.md) -Creates or updates a Dev Box definition. - -### [New-AzDevCenterAdminDevCenter](New-AzDevCenterAdminDevCenter.md) -Creates or updates a devcenter resource - -### [New-AzDevCenterAdminEnvironmentType](New-AzDevCenterAdminEnvironmentType.md) -Creates or updates an environment type. - -### [New-AzDevCenterAdminGallery](New-AzDevCenterAdminGallery.md) -Creates or updates a gallery. - -### [New-AzDevCenterAdminNetworkConnection](New-AzDevCenterAdminNetworkConnection.md) -Creates or updates a Network Connections resource - -### [New-AzDevCenterAdminPool](New-AzDevCenterAdminPool.md) -Creates or updates a machine pool - -### [New-AzDevCenterAdminProject](New-AzDevCenterAdminProject.md) -Creates or updates a project. - -### [New-AzDevCenterAdminProjectEnvironmentType](New-AzDevCenterAdminProjectEnvironmentType.md) -Creates or updates a project environment type. - -### [New-AzDevCenterAdminSchedule](New-AzDevCenterAdminSchedule.md) -Creates or updates a Schedule. - -### [Remove-AzDevCenterAdminAttachedNetwork](Remove-AzDevCenterAdminAttachedNetwork.md) -Un-attach a NetworkConnection. - -### [Remove-AzDevCenterAdminCatalog](Remove-AzDevCenterAdminCatalog.md) -Deletes a catalog resource. - -### [Remove-AzDevCenterAdminDevBoxDefinition](Remove-AzDevCenterAdminDevBoxDefinition.md) -Deletes a Dev Box definition - -### [Remove-AzDevCenterAdminDevCenter](Remove-AzDevCenterAdminDevCenter.md) -Deletes a devcenter - -### [Remove-AzDevCenterAdminEnvironmentType](Remove-AzDevCenterAdminEnvironmentType.md) -Deletes an environment type. - -### [Remove-AzDevCenterAdminGallery](Remove-AzDevCenterAdminGallery.md) -Deletes a gallery resource. - -### [Remove-AzDevCenterAdminNetworkConnection](Remove-AzDevCenterAdminNetworkConnection.md) -Deletes a Network Connections resource - -### [Remove-AzDevCenterAdminPool](Remove-AzDevCenterAdminPool.md) -Deletes a machine pool - -### [Remove-AzDevCenterAdminProject](Remove-AzDevCenterAdminProject.md) -Deletes a project resource. - -### [Remove-AzDevCenterAdminProjectEnvironmentType](Remove-AzDevCenterAdminProjectEnvironmentType.md) -Deletes a project environment type. - -### [Remove-AzDevCenterAdminSchedule](Remove-AzDevCenterAdminSchedule.md) -Deletes a Scheduled. - -### [Start-AzDevCenterAdminNetworkConnectionHealthCheck](Start-AzDevCenterAdminNetworkConnectionHealthCheck.md) -Triggers a new health check run. -The execution and health check result can be tracked via the network Connection health check details - -### [Sync-AzDevCenterAdminCatalog](Sync-AzDevCenterAdminCatalog.md) -Syncs templates for a template source. - -### [Update-AzDevCenterAdminCatalog](Update-AzDevCenterAdminCatalog.md) -Partially updates a catalog. - -### [Update-AzDevCenterAdminDevBoxDefinition](Update-AzDevCenterAdminDevBoxDefinition.md) -Partially updates a Dev Box definition. - -### [Update-AzDevCenterAdminDevCenter](Update-AzDevCenterAdminDevCenter.md) -Partially updates a devcenter. - -### [Update-AzDevCenterAdminEnvironmentType](Update-AzDevCenterAdminEnvironmentType.md) -Partially updates an environment type. - -### [Update-AzDevCenterAdminNetworkConnection](Update-AzDevCenterAdminNetworkConnection.md) -Partially updates a Network Connection - -### [Update-AzDevCenterAdminPool](Update-AzDevCenterAdminPool.md) -Partially updates a machine pool - -### [Update-AzDevCenterAdminProject](Update-AzDevCenterAdminProject.md) -Partially updates a project. - -### [Update-AzDevCenterAdminProjectEnvironmentType](Update-AzDevCenterAdminProjectEnvironmentType.md) -Partially updates a project environment type. - -### [Update-AzDevCenterAdminSchedule](Update-AzDevCenterAdminSchedule.md) -Partially updates a Scheduled. - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminAttachedNetwork.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminAttachedNetwork.md deleted file mode 100644 index f4a4591ba140..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminAttachedNetwork.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminattachednetwork -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminAttachedNetwork - -## SYNOPSIS -Gets an attached NetworkConnection. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminAttachedNetwork -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminAttachedNetwork -ConnectionName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get1 -``` -Get-AzDevCenterAdminAttachedNetwork -ConnectionName -DevCenterName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminAttachedNetwork -InputObject [-DefaultProfile ] - [] -``` - -### List1 -``` -Get-AzDevCenterAdminAttachedNetwork -DevCenterName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets an attached NetworkConnection. - -## EXAMPLES - -### Example 1: List attached networks in a dev center -```powershell -Get-AzDevCenterAdminAttachedNetwork -ResourceGroupName testRg -DevCenterName Contoso -``` - -This command lists the attached networks in the dev center "Contoso" under the resource group "testRg". - -### Example 2: List attached networks in a project -```powershell -Get-AzDevCenterAdminAttachedNetwork -ProjectName DevProject -ResourceGroupName testRg -``` - -This command lists the attached networks in the project "DevProject" under the resource group "testRg". - -### Example 3: Get a dev center attached network -```powershell - Get-AzDevCenterAdminAttachedNetwork -ConnectionName network-uswest3 -ResourceGroupName testRg -DevCenterName Contoso -``` - -This command gets the attached network named "network-uswest3" in the dev center "Contoso" under the resource group "testRg". - -### Example 4: Get a project attached network -```powershell - Get-AzDevCenterAdminAttachedNetwork -ConnectionName network-uswest3 -ProjectName DevProject -ResourceGroupName testRg -``` - -This command gets the attached network named "network-uswest3" in the project "DevProject" under the resource group "testRg". - -## PARAMETERS - -### -ConnectionName -The name of the attached NetworkConnection. - -```yaml -Type: System.String -Parameter Sets: Get, Get1 -Aliases: AttachedNetworkConnectionName - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get1, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, Get1, List, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, Get1, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IAttachedNetworkConnection - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminCatalog.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminCatalog.md deleted file mode 100644 index 50acd947aad3..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminCatalog.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradmincatalog -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminCatalog - -## SYNOPSIS -Gets a catalog - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminCatalog -DevCenterName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminCatalog -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminCatalog -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a catalog - -## EXAMPLES - -### Example 1: List catalogs in a dev center -```powershell -Get-AzDevCenterAdminCatalog -DevCenterName Contoso -ResourceGroupName testRg -``` - -This command lists the catalogs in the dev center "Contoso" under the resource group "testRg". - -### Example 2: Get a catalog -```powershell -Get-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg -``` - -This command gets the catalog named "CentralCatalog" in the dev center "Contoso" under the resource group "testRg". - -### Example 3: Get a catalog using InputObject -```powershell -$catalog = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "CatalogName" = "CentralCatalog"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -$catalog = Get-AzDevCenterAdminCatalog -InputObject $catalog -``` - -This command gets the catalog named "CentralCatalog" in the dev center "Contoso" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Catalog. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: CatalogName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.ICatalog - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminDevBoxDefinition.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminDevBoxDefinition.md deleted file mode 100644 index df1d837678db..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminDevBoxDefinition.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradmindevboxdefinition -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminDevBoxDefinition - -## SYNOPSIS -Gets a Dev Box definition - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminDevBoxDefinition -DevCenterName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminDevBoxDefinition -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get1 -``` -Get-AzDevCenterAdminDevBoxDefinition -Name -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminDevBoxDefinition -InputObject [-DefaultProfile ] - [] -``` - -### List1 -``` -Get-AzDevCenterAdminDevBoxDefinition -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a Dev Box definition - -## EXAMPLES - -### Example 1: List dev box definitions in a dev center -```powershell -Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -DevCenterName Contoso -``` - -This command lists the dev box definitions in the dev center "Contoso" under the resource group "testRg". - -### Example 2: List dev box definitions in a project -```powershell -Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -ProjectName DevProject -``` - -This command lists the dev box definitions in the project "DevProject" under the resource group "testRg". - -### Example 3: Get a dev center dev box definition -```powershell -Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -DevCenterName Contoso -Name WebDevBoxDef -``` - -This command gets the dev box definition "WebDevBoxDef" in the dev center "Contoso" under the resource group "testRg". - -### Example 4: Get a project dev box definition -```powershell -Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -ProjectName DevProject -Name WebDevBoxDef -``` - -This command gets the dev box definition "WebDevBoxDef" in the project "DevProject" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Dev Box definition. - -```yaml -Type: System.String -Parameter Sets: Get, Get1 -Aliases: DevBoxDefinitionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Get1, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, Get1, List, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, Get1, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IDevBoxDefinition - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminDevCenter.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminDevCenter.md deleted file mode 100644 index 9092c2279cf8..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminDevCenter.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradmindevcenter -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminDevCenter - -## SYNOPSIS -Gets a devcenter. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminDevCenter [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminDevCenter -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminDevCenter -InputObject [-DefaultProfile ] - [] -``` - -### List1 -``` -Get-AzDevCenterAdminDevCenter -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a devcenter. - -## EXAMPLES - -### Example 1: List dev centers in a subscription -```powershell -Get-AzDevCenterAdminDevCenter -``` - -This command lists the dev centers in the current subscription. - -### Example 2: List dev centers in a resource group -```powershell -Get-AzDevCenterAdminDevCenter -ResourceGroupName testRg -``` - -This command lists the dev centers under the resource group "testRg". - -### Example 3: Get a dev center -```powershell -Get-AzDevCenterAdminDevCenter -ResourceGroupName testRg -Name Contoso -``` - -This command gets the dev center named "Contoso" under the resource group "testRg". - -### Example 4: Get a dev center using InputObject -```powershell -$devCenter = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminDevCenter -InputObject $devCenter -``` - -This command gets the dev center named "Contoso" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: DevCenterName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IDevCenter - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminEnvironmentType.md deleted file mode 100644 index f142d2026b53..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminEnvironmentType.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminenvironmenttype -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminEnvironmentType - -## SYNOPSIS -Gets an environment type. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminEnvironmentType -DevCenterName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminEnvironmentType -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminEnvironmentType -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets an environment type. - -## EXAMPLES - -### Example 1: List environment types in a dev center -```powershell -Get-AzDevCenterAdminEnvironmentType -ResourceGroupName testRg -DevCenterName Contoso -``` - -This command lists the environment types in the dev center "Contoso" under the resource group "testRg". - -### Example 2: Get a dev center environment type -```powershell - -``` - -```powershell - Get-AzDevCenterAdminEnvironmentType -ResourceGroupName testRg -DevCenterName Contoso -Name DevTest - ``` -This command gets the environment type named "DevTest" in the dev center "Contoso" under the resource group "testRg". - -### Example 3: Get a dev center environment type using InputObject -```powershell - -``` - -```powershell -$envType = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "EnvironmentTypeName" = "DevTest"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminEnvironmentType -InputObject $envType - ``` -This command gets the environment type named "DevTest" in the dev center "Contoso" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: EnvironmentTypeName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IEnvironmentType - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminGallery.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminGallery.md deleted file mode 100644 index 362ca8306fc1..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminGallery.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradmingallery -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminGallery - -## SYNOPSIS -Gets a gallery - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminGallery -DevCenterName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminGallery -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminGallery -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a gallery - -## EXAMPLES - -### Example 1: List galleries in a dev center -```powershell -Get-AzDevCenterAdminGallery -ResourceGroupName testRg -DevCenterName Contoso -``` - -This command lists the galleries in the dev center "Contoso" under the resource group "testRg". - -### Example 2: Get a gallery -```powershell -Get-AzDevCenterAdminGallery -ResourceGroupName testRg -DevCenterName Contoso -Name StandardGallery -``` - -This command gets the gallery named "StandardGallery" in the dev center "Contoso" under the resource group "testRg". - -### Example 3: Get a gallery using InputObject -```powershell -$gallery = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "GalleryName" = "StandardGallery"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminGallery -InputObject $gallery -``` - -This command gets the gallery named "StandardGallery" in the dev center "Contoso" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: GalleryName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IGallery - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminImage.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminImage.md deleted file mode 100644 index a4179855c541..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminImage.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminimage -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminImage - -## SYNOPSIS -Gets a gallery image. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminImage -DevCenterName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminImage -DevCenterName -GalleryName -Name - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminImage -InputObject [-DefaultProfile ] [] -``` - -### List1 -``` -Get-AzDevCenterAdminImage -DevCenterName -GalleryName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a gallery image. - -## EXAMPLES - -### Example 1: List iamges in a dev center -```powershell -Get-AzDevCenterAdminImage -ResourceGroupName testRg -DevCenterName Contoso -``` - -This command lists the images in the dev center "Contoso" under the resource group "testRg". - -### Example 2: List images in a gallery under a dev center -```powershell -Get-AzDevCenterAdminImage -ResourceGroupName testRg -DevCenterName Contoso -GalleryName StandardGallery -``` - -This command lists the images in the gallery "StandardGallery" under the dev center "Contoso". - -### Example 3: Get an image -```powershell -Get-AzDevCenterAdminImage -ResourceGroupName testRg -DevCenterName Contoso -GalleryName StandardGallery -Name ContosoBaseImage -``` - -This command gets the image named "ContosoBaseImage" in the gallery "StandardGallery" under the dev center "Contoso". - -### Example 4: Get an image using InputObject -```powershell -$image = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "GalleryName" = "StandardGallery"; "ImageName" = "ContosoBaseImage"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminImage -InputObject $image -``` - -This command gets the image named "ContosoBaseImage" in the gallery "StandardGallery" under the dev center "Contoso". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get, List, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: Get, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the image. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: ImageName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IImage - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminImageVersion.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminImageVersion.md deleted file mode 100644 index 324b25cba629..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminImageVersion.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminimageversion -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminImageVersion - -## SYNOPSIS -Gets an image version. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminImageVersion -DevCenterName -GalleryName -ImageName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminImageVersion -DevCenterName -GalleryName -ImageName - -ResourceGroupName -VersionName [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminImageVersion -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets an image version. - -## EXAMPLES - -### Example 1: List image versions for an image -```powershell -Get-AzDevCenterAdminImageVersion -ResourceGroupName testRg -DevCenterName Contoso -ImageName ContosoBaseImage -GalleryName StandardGallery -``` - -This command lists the image verions for the image "ContosoBaseImage" under the gallery "StandardGallery". - -### Example 2: Get an image version -```powershell -Get-AzDevCenterAdminImageVersion -ResourceGroupName testRg -DevCenterName Contoso -ImageName ContosoBaseImage -VersionName 1.0.0 -GalleryName StandardGallery -``` - -This command gets the image version "1.0.0" for the image "ContosoBaseImage" in the gallery "StandardGallery". - -### Example 3: Get an image version using InputObject -```powershell -$imageVersion = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "GalleryName" = "StandardGallery"; "ImageName" = "ContosoBaseImage"; "VersionName" = "1.0.0"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminImageVersion -InputObject $imageVersion -``` - -This command gets the image version "1.0.0" for the image "ContosoBaseImage" in the gallery "StandardGallery". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryName -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageName -The name of the image. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionName -The version of the image. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IImageVersion - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnection.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnection.md deleted file mode 100644 index d9b06fbe1825..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnection.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminnetworkconnection -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminNetworkConnection - -## SYNOPSIS -Gets a network connection resource - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminNetworkConnection [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### Get -``` -Get-AzDevCenterAdminNetworkConnection -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminNetworkConnection -InputObject [-DefaultProfile ] - [] -``` - -### List1 -``` -Get-AzDevCenterAdminNetworkConnection -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a network connection resource - -## EXAMPLES - -### Example 1: List network connections in a subscription -```powershell -Get-AzDevCenterAdminNetworkConnection -``` - -This command lists network connections in the current subscription. - -### Example 2: List network connections in a resource group -```powershell -Get-AzDevCenterAdminNetworkConnection -ResourceGroupName testRg -``` - -This command lists the network connections under the resource group "testRg". - -### Example 3: Get a network connection -```powershell -Get-AzDevCenterAdminNetworkConnection -ResourceGroupName testRg -Name eastusNetwork -``` - -This command gets the network connection named "eastusNetwork" under the resource group "testRg". - -### Example 4: Get a network connection using InputObject -```powershell -$networkConnection = @{"ResourceGroupName" = "testRg"; "NetworkConnectionName" = "eastusNetwork"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminNetworkConnection -InputObject $networkConnection -``` - -This command gets the network connection named "eastusNetwork" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Network Connection that can be applied to a Pool. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: NetworkConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.INetworkConnection - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnectionHealthDetail.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnectionHealthDetail.md deleted file mode 100644 index d72dbef47dca..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnectionHealthDetail.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminnetworkconnectionhealthdetail -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminNetworkConnectionHealthDetail - -## SYNOPSIS -Gets health check status details. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminNetworkConnectionHealthDetail -NetworkConnectionName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminNetworkConnectionHealthDetail -InputObject - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets health check status details. - -## EXAMPLES - -### Example 1: List the health check details of a network connection -```powershell -Get-AzDevCenterAdminNetworkConnectionHealthDetail -NetworkConnectionName eastusNetwork -ResourceGroupName testRg -``` - -This command lists the health check details of the network connection "eastusNetwork" under the resource group "testRg". - -### Example 2: List the health check details of a network connection using InputObject -```powershell -$networkConnection = @{"ResourceGroupName" = "testRg"; "NetworkConnectionName" = "eastusNetwork"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminNetworkConnectionHealthDetail -InputObject $networkConnection -``` - -This command lists the health check details of the network connection "eastusNetwork" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkConnectionName -Name of the Network Connection that can be applied to a Pool. - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IHealthCheckStatusDetails - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint.md deleted file mode 100644 index 6ff5574c62f9..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminnetworkconnectionoutboundnetworkdependencyendpoint -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint - -## SYNOPSIS -Lists the endpoints that agents may call as part of Dev Box service administration. -These FQDNs should be allowed for outbound access in order for the Dev Box service to function. - -## SYNTAX - -``` -Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint -NetworkConnectionName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Lists the endpoints that agents may call as part of Dev Box service administration. -These FQDNs should be allowed for outbound access in order for the Dev Box service to function. - -## EXAMPLES - -### Example 1: List the outbound network dependency endpoints of a network connection -```powershell -Get-AzDevCenterAdminNetworkConnectionOutboundNetworkDependencyEndpoint -ResourceGroupName testRg -NetworkConnectionName eastusNetwork -``` - -This command lists the outbound network dependency endpoints of the network connection "eastusNetwork" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkConnectionName -Name of the Network Connection that can be applied to a Pool. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IOutboundEnvironmentEndpoint - -## NOTES - -ALIASES - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminOperationStatus.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminOperationStatus.md deleted file mode 100644 index 6b757eb8f473..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminOperationStatus.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminoperationstatus -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminOperationStatus - -## SYNOPSIS -Gets the current status of an async operation. - -## SYNTAX - -### Get (Default) -``` -Get-AzDevCenterAdminOperationStatus -Location -OperationId [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminOperationStatus -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets the current status of an async operation. - -## EXAMPLES - -### Example 1: Get an operation -```powershell -Get-AzDevCenterAdminOperationStatus -Location "eastus" -OperationId "7e9e1394-dad0-4414-8160-21c592e880ef*4699EE32265F9FA5BF00FA169E7D9CF51755378796E32F2D1A198E080CC84614" -``` - -This command gets the operation. - -### Example 2: Get an operatio using InputObject -```powershell -$operation = @{"Location" = "eastus"; "OperationId" = "7e9e1394-dad0-4414-8160-21c592e880ef*4699EE32265F9FA5BF00FA169E7D9CF51755378796E32F2D1A198E080CC84614"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminOperationStatus -InputObject $operation -``` - -This command gets the operation. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The Azure region - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationId -The ID of an ongoing async operation - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IOperationStatus - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminPool.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminPool.md deleted file mode 100644 index bc155b42b292..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminPool.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminpool -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminPool - -## SYNOPSIS -Gets a machine pool - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminPool -ProjectName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminPool -Name -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminPool -InputObject [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a machine pool - -## EXAMPLES - -### Example 1: List pools in a project -```powershell -Get-AzDevCenterAdminPool -ResourceGroupName testRg -ProjectName DevProject -``` - -This command lists the pools in the project "DevProject" under the resource group "testRg". - -### Example 2: Get a pool -```powershell -Get-AzDevCenterAdminPool -ResourceGroupName testRg -Name DevPool -ProjectName DevProject -``` - -This command gets the pool named "DevPool" in the project "DevProject" under the resource group "testRg". - -### Example 3: Get a pool using InputObject -```powershell -$pool = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "PoolName" = "DevPool"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminPool -InputObject $pool -``` - -This command gets the pool named "DevPool" in the project "DevProject" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: PoolName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IPool - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProject.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProject.md deleted file mode 100644 index f17eadc2df01..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProject.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminproject -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminProject - -## SYNOPSIS -Gets a specific project. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminProject [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminProject -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminProject -InputObject [-DefaultProfile ] - [] -``` - -### List1 -``` -Get-AzDevCenterAdminProject -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a specific project. - -## EXAMPLES - -### Example 1: List projects in a subscription -```powershell - -``` - -```powershell -Get-AzDevCenterAdminProject - ``` -This command lists the projects in the current subscription. - -### Example 2: List projects in a resource group -```powershell -Get-AzDevCenterAdminProject -ResourceGroupName testRg -``` - -This command lists the projects under the resource group "testRg". - -### Example 3: Get a project -```powershell -Get-AzDevCenterAdminProject -ResourceGroupName testRg -Name DevProject -``` - -This command gets the project named "DevProject" under the resource group "testRg". - -### Example 4: Get a project using InputObject -```powershell -$project = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminProject -InputObject $project -``` - -This command gets the project named "DevProject" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: ProjectName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List, List1 -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IProject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProjectAllowedEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProjectAllowedEnvironmentType.md deleted file mode 100644 index cf2d81f05b81..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProjectAllowedEnvironmentType.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminprojectallowedenvironmenttype -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminProjectAllowedEnvironmentType - -## SYNOPSIS -Gets an allowed environment type. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminProjectAllowedEnvironmentType -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminProjectAllowedEnvironmentType -EnvironmentTypeName -ProjectName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminProjectAllowedEnvironmentType -InputObject - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets an allowed environment type. - -## EXAMPLES - -### Example 1: List project allowed environment types -```powershell -Get-AzDevCenterAdminProjectAllowedEnvironmentType -ProjectName DevProject -ResourceGroupName testRg -``` - -This command lists the allowed environment types in the project "DevProject" under the resource group "testRg". - -### Example 2: Get a project allowed environment type -```powershell -Get-AzDevCenterAdminProjectAllowedEnvironmentType -ProjectName DevProject -ResourceGroupName testRg -EnvironmentTypeName DevTest -``` - -This command gets the allowed environment type named "DevTest" in the project "DevProject" under the resource group "testRg". - -### Example 3: Get a project allowed environment type using InputObject -```powershell -$envType = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "EnvironmentTypeName" = "DevTest"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminProjectAllowedEnvironmentType -InputObject $envType -``` - -This command gets the allowed environment type named "DevTest" in the project "DevProject" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentTypeName -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IAllowedEnvironmentType - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProjectEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProjectEnvironmentType.md deleted file mode 100644 index 9aac84211269..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminProjectEnvironmentType.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminprojectenvironmenttype -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminProjectEnvironmentType - -## SYNOPSIS -Gets a project environment type. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterAdminProjectEnvironmentType -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterAdminProjectEnvironmentType -EnvironmentTypeName -ProjectName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminProjectEnvironmentType -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a project environment type. - -## EXAMPLES - -### Example 1: List project environment types -```powershell -Get-AzDevCenterAdminProjectEnvironmentType -ProjectName DevProject -ResourceGroupName testRg -``` - -This command lists the environment types in the project "DevProject" under the resource group "testRg". - -### Example 2: Get a project environment type -```powershell -Get-AzDevCenterAdminProjectEnvironmentType -ProjectName DevProject -ResourceGroupName testRg -EnvironmentTypeName DevTest -``` - -This command gets the environment type named "DevTest" in the project "DevProject" under the resource group "testRg". - -### Example 3: Get a project environment type using InputObject -```powershell -$envType = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "EnvironmentTypeName" = "DevTest"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminProjectEnvironmentType -InputObject $envType -``` - -This command gets the environment type named "DevTest" in the project "DevProject" under the resource group "testRg". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentTypeName -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Get, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: Get, List -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IProjectEnvironmentType - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminSchedule.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminSchedule.md deleted file mode 100644 index a4c60ba96236..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminSchedule.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminschedule -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminSchedule - -## SYNOPSIS -Gets a schedule resource. - -## SYNTAX - -### GetWithDefault (Default) -``` -Get-AzDevCenterAdminSchedule -PoolName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterAdminSchedule -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a schedule resource. - -## EXAMPLES - -### Example 1: Get a schedule in a pool -```powershell -Get-AzDevCenterAdminSchedule -PoolName DevPool -ProjectName DevProject -ResourceGroupName testRg -``` - -This command gets a schedule in a pool "DevPool" under the project "DevProject. - -### Example 2: Get a schedule in a pool using InputObject -```powershell -$schedule = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "PoolName" = "DevPool"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Get-AzDevCenterAdminSchedule -InputObject $schedule -``` - -This command gets a schedule in a pool "DevPool" under the project "DevProject. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PoolName -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: GetWithDefault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: GetWithDefault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: GetWithDefault -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: GetWithDefault -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.ISchedule - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminSku.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminSku.md deleted file mode 100644 index 6aa283273729..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminSku.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminsku -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminSku - -## SYNOPSIS -Lists the Microsoft.DevCenter SKUs available in a subscription - -## SYNTAX - -``` -Get-AzDevCenterAdminSku [-SubscriptionId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Lists the Microsoft.DevCenter SKUs available in a subscription - -## EXAMPLES - -### Example 1: List skus in a subscription -```powershell -Get-AzDevCenterAdminSku -``` - -This command lists skus in the current subscription. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IDevCenterSku - -## NOTES - -ALIASES - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminUsage.md b/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminUsage.md deleted file mode 100644 index ddd6413ef37d..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Get-AzDevCenterAdminUsage.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteradminusage -schema: 2.0.0 ---- - -# Get-AzDevCenterAdminUsage - -## SYNOPSIS -Lists the current usages and limits in this location for the provided subscription. - -## SYNTAX - -``` -Get-AzDevCenterAdminUsage -Location [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Lists the current usages and limits in this location for the provided subscription. - -## EXAMPLES - -### Example 1: List usage -```powershell -Get-AzDevCenterAdminUsage -Location "westus3" -``` - -This command lists usages in the location "westus3" for the current subscription. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The Azure region - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IUsage - -## NOTES - -ALIASES - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Invoke-AzDevCenterAdminExecuteCheckNameAvailability.md b/src/DevCenter/DevCenter.AutoRest/help/help/Invoke-AzDevCenterAdminExecuteCheckNameAvailability.md deleted file mode 100644 index 437c75febbd2..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Invoke-AzDevCenterAdminExecuteCheckNameAvailability.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/invoke-azdevcenteradminexecutechecknameavailability -schema: 2.0.0 ---- - -# Invoke-AzDevCenterAdminExecuteCheckNameAvailability - -## SYNOPSIS -Check the availability of name for resource - -## SYNTAX - -### ExecuteExpanded (Default) -``` -Invoke-AzDevCenterAdminExecuteCheckNameAvailability [-SubscriptionId ] [-Name ] - [-Type ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### ExecuteViaIdentityExpanded -``` -Invoke-AzDevCenterAdminExecuteCheckNameAvailability -InputObject [-Name ] - [-Type ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Check the availability of name for resource - -## EXAMPLES - -### Example 1: Check name availability -```powershell -Invoke-AzDevCenterAdminExecuteCheckNameAvailability -Name "Contoso" -Type "Microsoft.Devcenter/devcenters" -``` - -This command checks the name availability of "Contoso" with a resource type of "Microsoft.Devcenter/devcenters" - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: ExecuteViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the resource for which availability needs to be checked. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: ExecuteExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The resource type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api30.ICheckNameAvailabilityResponse - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminAttachedNetwork.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminAttachedNetwork.md deleted file mode 100644 index 5044d184e2d2..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminAttachedNetwork.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradminattachednetwork -schema: 2.0.0 ---- - -# New-AzDevCenterAdminAttachedNetwork - -## SYNOPSIS -Creates or updates an attached NetworkConnection. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminAttachedNetwork -ConnectionName -DevCenterName - -ResourceGroupName -NetworkConnectionId [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminAttachedNetwork -InputObject -NetworkConnectionId - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates an attached NetworkConnection. - -## EXAMPLES - -### Example 1: Create an attached network -```powershell -New-AzDevCenterAdminAttachedNetwork -ConnectionName network-uswest3 -DevCenterName Contoso -ResourceGroupName testRg -NetworkConnectionId /subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3 -``` - -This command creates an attached network named "network-uswest3" in the dev center "Contoso". - -### Example 2: Create an attached network using InputObject -```powershell -$attachedNetwork = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "AttachedNetworkConnectionName" = "network-uswest3"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminAttachedNetwork -InputObject $attachedNetwork -NetworkConnectionId /subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3 -``` - -This command creates an attached network named "network-uswest3" in the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionName -The name of the attached NetworkConnection. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: AttachedNetworkConnectionName - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkConnectionId -The resource ID of the NetworkConnection you want to attach. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IAttachedNetworkConnection - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminCatalog.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminCatalog.md deleted file mode 100644 index ba2ff53f8afe..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminCatalog.md +++ /dev/null @@ -1,396 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradmincatalog -schema: 2.0.0 ---- - -# New-AzDevCenterAdminCatalog - -## SYNOPSIS -Creates or updates a catalog. - -## SYNTAX - -### CreateExpandedAdo (Default) -``` -New-AzDevCenterAdminCatalog -DevCenterName -Name -ResourceGroupName - -AdoGitSecretIdentifier -AdoGitUri [-SubscriptionId ] [-AdoGitBranch ] - [-AdoGitPath ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -### CreateExpandedGitHub -``` -New-AzDevCenterAdminCatalog -DevCenterName -Name -ResourceGroupName - -GitHubSecretIdentifier -GitHubUri [-SubscriptionId ] [-GitHubBranch ] - [-GitHubPath ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -### CreateViaIdentityExpandedAdo -``` -New-AzDevCenterAdminCatalog -InputObject -AdoGitSecretIdentifier - -AdoGitUri [-AdoGitBranch ] [-AdoGitPath ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpandedGitHub -``` -New-AzDevCenterAdminCatalog -InputObject -GitHubSecretIdentifier - -GitHubUri [-GitHubBranch ] [-GitHubPath ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates a catalog. - -## EXAMPLES - -### Example 1: Create an Azure Dev Ops catalog -```powershell -New-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg -AdoGitBranch main -AdoGitPath "/templates" -AdoGitSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat" -AdoGitUri "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso" -``` - -Create an Azure Dev Ops catalog named "CentralCatalog" in the dev center "Contoso". - -### Example 2: Create a GitHub catalog -```powershell -New-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg -GitHubBranch main -GitHubPath "/templates" -GitHubSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat" -GitHubUri "https://github.com/Contoso/centralrepo-fake.git" -``` - -This command creates a GitHub catalog named "CentralCatalog" in the dev center "Contoso". - -### Example 3: Create an Azure Dev Ops catalog using InputObject -```powershell -$catalog = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "CatalogName" = "CentralCatalog"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminCatalog -InputObject $catalog -AdoGitBranch main -AdoGitPath "/templates" -AdoGitSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat" -AdoGitUri "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso" -``` - -This command creates an Azure Dev Ops catalog named "CentralCatalog" in the dev center "Contoso". - -### Example 4: Create a Github catalog using InputObject -```powershell -$catalog = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "CatalogName" = "CentralCatalog"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminCatalog -InputObject $catalog -GitHubBranch main -GitHubPath "/templates" -GitHubSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat" -GitHubUri "https://github.com/Contoso/centralrepo-fake.git" -``` - -This command creates a GitHub catalog named "CentralCatalog" in the dev center "Contoso". - -## PARAMETERS - -### -AdoGitBranch -Git branch. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateViaIdentityExpandedAdo -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdoGitPath -The folder where the catalog items can be found inside the repository. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateViaIdentityExpandedAdo -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdoGitSecretIdentifier -A reference to the Key Vault secret containing a security token to authenticate to a Git repository. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateViaIdentityExpandedAdo -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdoGitUri -Git URI. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateViaIdentityExpandedAdo -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateExpandedGitHub -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubBranch -Git branch. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedGitHub, CreateViaIdentityExpandedGitHub -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubPath -The folder where the catalog items can be found inside the repository. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedGitHub, CreateViaIdentityExpandedGitHub -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubSecretIdentifier -A reference to the Key Vault secret containing a security token to authenticate to a Git repository. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedGitHub, CreateViaIdentityExpandedGitHub -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubUri -Git URI. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedGitHub, CreateViaIdentityExpandedGitHub -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpandedAdo, CreateViaIdentityExpandedGitHub -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Catalog. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateExpandedGitHub -Aliases: CatalogName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateExpandedGitHub -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedAdo, CreateExpandedGitHub -Aliases: - -Required: True -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.ICatalog - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminDevBoxDefinition.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminDevBoxDefinition.md deleted file mode 100644 index 407f67c5d5ce..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminDevBoxDefinition.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradmindevboxdefinition -schema: 2.0.0 ---- - -# New-AzDevCenterAdminDevBoxDefinition - -## SYNOPSIS -Creates or updates a Dev Box definition. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminDevBoxDefinition -DevCenterName -Name -ResourceGroupName - -ImageReferenceId -Location -OSStorageType -SkuName - [-SubscriptionId ] [-HibernateSupport ] [-SkuCapacity ] - [-SkuFamily ] [-SkuSize ] [-SkuTier ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminDevBoxDefinition -InputObject -ImageReferenceId - -Location -OSStorageType -SkuName [-HibernateSupport ] - [-SkuCapacity ] [-SkuFamily ] [-SkuSize ] [-SkuTier ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates a Dev Box definition. - -## EXAMPLES - -### Example 1: Create a dev box definition -```powershell -New-AzDevCenterAdminDevBoxDefinition -Name "WebDevBox" -DevCenterName Contoso -ResourceGroupName testRg -Location "westus3" -HibernateSupport "Enabled" -ImageReferenceId "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" -OSStorageType "ssd_1024gb" -SkuName "general_a_8c32gb_v1" -``` - -This command creates a dev box definition named "WebDevBox" in the dev center "Contoso". - -### Example 2: Create a dev box definition using InputObject -```powershell -$devBoxDefinition = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "DevBoxDefinitionName" = "WebDevBox"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminDevBoxDefinition -InputObject $devBoxDefinition -Location "westus3" -HibernateSupport "Enabled" -ImageReferenceId "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" -OSStorageType "ssd_1024gb" -SkuName "general_a_8c32gb_v1" -``` - -This command creates a dev box definition named "WebDevBox" in the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HibernateSupport -Indicates whether Dev Boxes created with this definition are capable of hibernation. -Not all images are capable of supporting hibernation. -To find out more see https://aka.ms/devbox/hibernate - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.HibernateSupport -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceId -Image ID, or Image version ID. -When Image ID is provided, its latest version will be used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The geo-location where the resource lives - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the Dev Box definition. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: DevBoxDefinitionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSStorageType -The storage type used for the Operating System disk of Dev Boxes created using this definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuCapacity -If the SKU supports scale out/in then the capacity integer should be included. -If scale out/in is not possible for the resource this may be omitted. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuFamily -If the service has different generations of hardware, for the same SKU, then that can be captured here. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -The name of the SKU. -Ex - P3. -It is typically a letter+number code - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuSize -The SKU size. -When the name field is the combination of tier and some other value, this would be the standalone code. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuTier -This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.SkuTier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IDevBoxDefinition - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminDevCenter.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminDevCenter.md deleted file mode 100644 index 23c1c5a9b62d..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminDevCenter.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradmindevcenter -schema: 2.0.0 ---- - -# New-AzDevCenterAdminDevCenter - -## SYNOPSIS -Creates or updates a devcenter resource - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminDevCenter -Name -ResourceGroupName -Location - [-SubscriptionId ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-Tag ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminDevCenter -InputObject -Location - [-IdentityType ] [-IdentityUserAssignedIdentity ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates a devcenter resource - -## EXAMPLES - -### Example 1: Create a dev center -```powershell -New-AzDevCenterAdminDevCenter -Name Contoso -ResourceGroupName testRg -Location eastus -``` - -This command creates a dev center named "Contoso" in the resource group "testRg". - -### Example 2: Create dev center with user assigned identity -```powershell -$identity = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" = @{} } -New-AzDevCenterAdminDevCenter -Name Contoso -ResourceGroupName testRg -Location eastus -IdentityType "UserAssigned" -IdentityUserAssignedIdentity $identity -``` - -This command creates a dev center named "Contoso" with a user assigned identity. - -### Example 3: Create a dev center using InputObject -```powershell -$devCenter = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminDevCenter -InputObject $devCenter -Location eastus -``` - -This command creates a dev center named "Contoso" in the resource group "testRg". - -### Example 4: Create a devcenter with a system assigned identity using InputObject -```powershell -$devCenter = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminDevCenter -InputObject $devCenter -Location eastus -IdentityType "SystemAssigned" -``` - -This command creates a dev center named "Contoso" with a system assigned identity. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.ManagedServiceIdentityType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The geo-location where the resource lives - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: DevCenterName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IDevCenter - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminEnvironmentType.md deleted file mode 100644 index 2eba40be7001..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminEnvironmentType.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradminenvironmenttype -schema: 2.0.0 ---- - -# New-AzDevCenterAdminEnvironmentType - -## SYNOPSIS -Creates or updates an environment type. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminEnvironmentType -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminEnvironmentType -InputObject [-Tag ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates an environment type. - -## EXAMPLES - -### Example 1: Create an environment type -```powershell -$tags = @{"dev" ="test"} -New-AzDevCenterAdminEnvironmentType -DevCenterName Contoso -Name DevTest -ResourceGroupName testRg -Tag $tags -``` - -This command creates an environment type named "DevTest" in the dev center "Contoso". - -### Example 2: Create an environment type using InputObject -```powershell -$tags = @{"dev" ="test"} -$envType = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "EnvironmentTypeName" = "DevTest"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminEnvironmentType -InputObject $envType -Tag $tags -``` - -This command creates an environment type named "DevTest" in the dev center "Contoso". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: EnvironmentTypeName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IEnvironmentType - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminGallery.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminGallery.md deleted file mode 100644 index c44e0ed760d1..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminGallery.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradmingallery -schema: 2.0.0 ---- - -# New-AzDevCenterAdminGallery - -## SYNOPSIS -Creates or updates a gallery. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminGallery -DevCenterName -Name -ResourceGroupName - -GalleryResourceId [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminGallery -InputObject -GalleryResourceId - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates a gallery. - -## EXAMPLES - -### Example 1: Create a gallery -```powershell -New-AzDevCenterAdminGallery -DevCenterName Contoso -Name StandardGallery -ResourceGroupName testRg -GalleryResourceId "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery" -``` - -This command create a gallery named "StandardGallery" in the dev center "Contoso". - -### Example 2: Create a gallery using InputObject -```powershell -$gallery = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "GalleryName" = "StandardGallery"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminGallery -InputObject $gallery -GalleryResourceId "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery" -``` - -This command create a gallery named "StandardGallery" in the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GalleryResourceId -The resource ID of the backing Azure Compute Gallery. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: GalleryName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IGallery - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminNetworkConnection.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminNetworkConnection.md deleted file mode 100644 index 0659672f55f8..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminNetworkConnection.md +++ /dev/null @@ -1,385 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradminnetworkconnection -schema: 2.0.0 ---- - -# New-AzDevCenterAdminNetworkConnection - -## SYNOPSIS -Creates or updates a Network Connections resource - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminNetworkConnection -Name -ResourceGroupName - -DomainJoinType -Location -SubnetId [-SubscriptionId ] - [-DomainName ] [-DomainPassword ] [-DomainUsername ] - [-NetworkingResourceGroupName ] [-OrganizationUnit ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminNetworkConnection -InputObject -DomainJoinType - -Location -SubnetId [-DomainName ] [-DomainPassword ] - [-DomainUsername ] [-NetworkingResourceGroupName ] [-OrganizationUnit ] - [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates a Network Connections resource - -## EXAMPLES - -### Example 1: Create an Azure AD joined network connection -```powershell -New-AzDevCenterAdminNetworkConnection -Name eastusNetwork -ResourceGroupName testRg -Location westus3 -DomainJoinType AzureADJoin -NetworkingResourceGroupName NetworkInterfaces -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" - -``` - -This command creates an Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -### Example 2: Create a hybid Azure AD joined network connection -```powershell -New-AzDevCenterAdminNetworkConnection -Name eastusNetwork -ResourceGroupName testRg -Location westus3 -DomainJoinType HybridAzureADJoin -DomainName mydomaincontroller.local -DomainPassword passw0rd123 -DomainUsername testuser@mydomaincontroller.local -NetworkingResourceGroupName NetworkInterfaces -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" -``` - -This command creates a hybid Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -### Example 3: Create an Azure AD joined network connection using InputObject -```powershell -$networkConnection = @{"ResourceGroupName" = "testRg"; "NetworkConnectionName" = "eastusNetwork"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminNetworkConnection -InputObject $networkConnection -Location westus3 -DomainJoinType AzureADJoin -NetworkingResourceGroupName NetworkInterfaces -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" -``` - -This command creates an Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -### Example 4: Create a hybid Azure AD joined network connection using InputObject -```powershell -$networkConnection = @{"ResourceGroupName" = "testRg"; "NetworkConnectionName" = "eastusNetwork"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminNetworkConnection -InputObject $networkConnection -Location westus3 -DomainJoinType HybridAzureADJoin -DomainName mydomaincontroller.local -DomainPassword passw0rd123 -DomainUsername testuser@mydomaincontroller.local -NetworkingResourceGroupName NetworkInterfaces -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" -``` - -This command creates a hybid Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainJoinType -AAD Join type. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.DomainJoinType -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Active Directory domain name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainPassword -The password for the account used to join domain - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainUsername -The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. -Required format: admin@contoso.com. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The geo-location where the resource lives - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the Network Connection that can be applied to a Pool. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: NetworkConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkingResourceGroupName -The name for resource group where NICs will be placed. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationUnit -Active Directory domain Organization Unit (OU) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -The subnet to attach Virtual Machines to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.INetworkConnection - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminPool.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminPool.md deleted file mode 100644 index cb93b2cfb05d..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminPool.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradminpool -schema: 2.0.0 ---- - -# New-AzDevCenterAdminPool - -## SYNOPSIS -Creates or updates a machine pool - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminPool -Name -ProjectName -ResourceGroupName - -DevBoxDefinitionName -LocalAdministrator -Location - -NetworkConnectionName [-SubscriptionId ] [-Tag ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminPool -InputObject -DevBoxDefinitionName - -LocalAdministrator -Location -NetworkConnectionName [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates a machine pool - -## EXAMPLES - -### Example 1: Create a pool -```powershell -New-AzDevCenterAdminPool -Name DevPool -ProjectName DevProject -ResourceGroupName testRg -Location westus2 -DevBoxDefinitionName WebDevBox -LocalAdministrator "Enabled" -NetworkConnectionName Network1westus2 -``` - -This command creates a pool named "DevPool" in the project "DevProject". - -### Example 2: Create a pool using InputObject -```powershell -$pool = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "PoolName" = "DevPool"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminPool -InputObject $pool -Location westus2 -DevBoxDefinitionName WebDevBox -LocalAdministrator "Enabled" -NetworkConnectionName Network1westus2 -``` - -This command creates a pool named "DevPool" in the project "DevProject". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevBoxDefinitionName -Name of a Dev Box definition in parent Project of this Pool - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LocalAdministrator -Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.LocalAdminStatus -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -The geo-location where the resource lives - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: PoolName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkConnectionName -Name of a Network Connection in parent Project of this Pool - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IPool - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminProject.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminProject.md deleted file mode 100644 index e61a28a2eac1..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminProject.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradminproject -schema: 2.0.0 ---- - -# New-AzDevCenterAdminProject - -## SYNOPSIS -Creates or updates a project. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminProject -Name -ResourceGroupName -DevCenterId - -Location [-SubscriptionId ] [-Description ] [-MaxDevBoxesPerUser ] - [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminProject -InputObject -DevCenterId -Location - [-Description ] [-MaxDevBoxesPerUser ] [-Tag ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates a project. - -## EXAMPLES - -### Example 1: Create a project -```powershell -New-AzDevCenterAdminProject -Name DevProject -ResourceGroupName testRg -Location eastus -DevCenterId "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso" -MaxDevBoxesPerUser 3 -``` - -This command creates a project name "DevProject" in the resource group "testRg". - -### Example 2: Create a project using InputObject -```powershell -$project = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminProject -InputObject $project -Location eastus -DevCenterId "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso" -MaxDevBoxesPerUser 3 -``` - -This command creates a project name "DevProject" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of the project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterId -Resource Id of an associated DevCenter - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The geo-location where the resource lives - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxDevBoxesPerUser -When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. -This will have no effect on existing Dev Boxes when reduced. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the project. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: ProjectName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IProject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminProjectEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminProjectEnvironmentType.md deleted file mode 100644 index 58327a8c9029..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminProjectEnvironmentType.md +++ /dev/null @@ -1,366 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradminprojectenvironmenttype -schema: 2.0.0 ---- - -# New-AzDevCenterAdminProjectEnvironmentType - -## SYNOPSIS -Creates or updates a project environment type. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminProjectEnvironmentType -EnvironmentTypeName -ProjectName - -ResourceGroupName -DeploymentTargetId -Status - [-SubscriptionId ] [-CreatorRoleAssignmentRole ] - [-IdentityType ] [-IdentityUserAssignedIdentity ] [-Location ] - [-Tag ] [-UserRoleAssignment ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminProjectEnvironmentType -InputObject -DeploymentTargetId - -Status [-CreatorRoleAssignmentRole ] - [-IdentityType ] [-IdentityUserAssignedIdentity ] [-Location ] - [-Tag ] [-UserRoleAssignment ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Creates or updates a project environment type. - -## EXAMPLES - -### Example 1: Create a project environment type -```powershell -$identity = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" = @{} } -$deploymentTargetId = '/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff' -$creatorRoleAssignmentRole = @{"8e3af657-a8ff-443c-a75c-2fe8c4bcb635" = @{} } -$userRoleAssignment = @{ - "e45e3m7c-176e-416a-b466-0c5ec8298f8a" = @{ - "roles" = @{ - "4cbf0b6c-e750-441c-98a7-10da8387e4d6" = @{} - } - } -} - -New-AzDevCenterAdminProjectEnvironmentType -EnvironmentTypeName DevTest -ProjectName DevProject -ResourceGroupName testRg -CreatorRoleAssignmentRole $creatorRoleAssignmentRole -DeploymentTargetId $deploymentTargetId -IdentityType "SystemAssigned,UserAssigned" -IdentityUserAssignedIdentity $identity -Location "westus3" -Status "Enabled" -UserRoleAssignment $userRoleAssignment -``` - -This command creates a project environment type named "DevTest" in the project "DevProject". - -### Example 2: Create a project environment type using InputObject -```powershell -$identity = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" = @{} } -$deploymentTargetId = '/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff' -$creatorRoleAssignmentRole = @{"8e3af657-a8ff-443c-a75c-2fe8c4bcb635" = @{} } -$userRoleAssignment = @{ - "e45e3m7c-176e-416a-b466-0c5ec8298f8a" = @{ - "roles" = @{ - "4cbf0b6c-e750-441c-98a7-10da8387e4d6" = @{} - } - } -} - -$envType = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "EnvironmentTypeName" = "DevTest"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminProjectEnvironmentType -InputObject $envType -CreatorRoleAssignmentRole $creatorRoleAssignmentRole -DeploymentTargetId $deploymentTargetId -IdentityType "SystemAssigned,UserAssigned" -IdentityUserAssignedIdentity $identity -Location "westus3" -Status "Enabled" -UserRoleAssignment $userRoleAssignment -``` - -This command creates a project environment type named "DevTest" in the project "DevProject". - -## PARAMETERS - -### -CreatorRoleAssignmentRole -A map of roles to assign to the environment creator. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentTargetId -Id of a subscription that the environment type will be mapped to. -The environment's resources will be deployed into this subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentTypeName -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.ManagedServiceIdentityType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Location -The geo-location for the environment type - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Defines whether this Environment Type can be used in this Project. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.EnvironmentTypeEnableStatus -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRoleAssignment -Role Assignments created on environment backing resources. -This is a mapping from a user object ID to an object of role definition IDs. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IProjectEnvironmentType - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminSchedule.md b/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminSchedule.md deleted file mode 100644 index 1d7ca7433829..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/New-AzDevCenterAdminSchedule.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteradminschedule -schema: 2.0.0 ---- - -# New-AzDevCenterAdminSchedule - -## SYNOPSIS -Creates or updates a Schedule. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterAdminSchedule -PoolName -ProjectName -ResourceGroupName - -Time -TimeZone [-SubscriptionId ] [-State ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterAdminSchedule -InputObject -Time -TimeZone - [-State ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Creates or updates a Schedule. - -## EXAMPLES - -### Example 1: Create a schedule -```powershell -New-AzDevCenterAdminSchedule -PoolName DevPool -ProjectName DevProject -ResourceGroupName testRg -State "Enabled" -Time "18:30" -TimeZone "America/Los_Angeles" -``` - -This command creates a schedule in the pool "DevPool". - -### Example 2: Create a schedule using InputObject -```powershell -$schedule = @{"ResourceGroupName" = "testRg"; "ProjectName" = "DevProject"; "PoolName" = "DevPool"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -New-AzDevCenterAdminSchedule -InputObject $schedule -``` - -This command creates a schedule in the pool "DevPool". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolName -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -Indicates whether or not this scheduled task is enabled. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.ScheduleEnableStatus -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -The target time to trigger the action. -The format is HH:MM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -The IANA timezone id at which the schedule should execute. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.ISchedule - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/README.md b/src/DevCenter/DevCenter.AutoRest/help/help/README.md deleted file mode 100644 index 6a07bc330e7b..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Docs -This directory contains the documentation of the cmdlets for the `Az.DevCenter` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `..\examples` folder. - -## Info -- Modifiable: no -- Generated: all -- Committed: yes -- Packaged: yes - -## Details -The process of documentation generation loads `Az.DevCenter` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminAttachedNetwork.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminAttachedNetwork.md deleted file mode 100644 index 53ca33d199af..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminAttachedNetwork.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradminattachednetwork -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminAttachedNetwork - -## SYNOPSIS -Un-attach a NetworkConnection. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminAttachedNetwork -ConnectionName -DevCenterName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminAttachedNetwork -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Un-attach a NetworkConnection. - -## EXAMPLES - -### Example 1: Delete an attached network -```powershell -Remove-AzDevCenterAdminAttachedNetwork -ConnectionName network-uswest3 -DevCenterName Contoso -ResourceGroupName testRg -``` - -This command deletes the attached network "network-uswest32" in the dev center "Contoso". - -### Example 2: Delete an attached network -```powershell -$id = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest32" - -$attachedNetwork = @{"Id" = $id} -Remove-AzDevCenterAdminAttachedNetwork -InputObject $attachedNetwork -``` - -This command deletes the attached network "network-uswest32" in the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionName -The name of the attached NetworkConnection. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: AttachedNetworkConnectionName - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminCatalog.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminCatalog.md deleted file mode 100644 index b170715b41bb..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminCatalog.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradmincatalog -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminCatalog - -## SYNOPSIS -Deletes a catalog resource. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminCatalog -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminCatalog -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a catalog resource. - -## EXAMPLES - -### Example 1: Remove a catalog -```powershell -Remove-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg -``` - -This command deletes the catalog named "CentralCatalog" in the dev center "Contoso". - -### Example 2: Remove a catalog using InputObject -```powershell -$catalog = Get-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg -Remove-AzDevCenterAdminCatalog -InputObject $catalog -``` - -This command deletes the catalog named "CentralCatalog" in the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Catalog. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: CatalogName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminDevBoxDefinition.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminDevBoxDefinition.md deleted file mode 100644 index 39fc8bab9f32..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminDevBoxDefinition.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradmindevboxdefinition -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminDevBoxDefinition - -## SYNOPSIS -Deletes a Dev Box definition - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminDevBoxDefinition -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminDevBoxDefinition -InputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a Dev Box definition - -## EXAMPLES - -### Example 1: Delete a dev box definition -```powershell -Remove-AzDevCenterAdminDevBoxDefinition -DevCenterName Contoso -Name WebDevBox -ResourceGroupName testRg -``` - -This command deletes the dev box definition "WebDevBox" in the dev center "Contoso". - -### Example 2: Delete a dev box definition using InputObject -```powershell -$id = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox" - -$devBoxDefinitionId = @{"Id" = $id } -Remove-AzDevCenterAdminDevBoxDefinition -InputObject $devBoxDefinitionId -``` - -This command deletes the dev box definition "WebDevBox" in the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Dev Box definition. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: DevBoxDefinitionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminDevCenter.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminDevCenter.md deleted file mode 100644 index e22ca39b66ca..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminDevCenter.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradmindevcenter -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminDevCenter - -## SYNOPSIS -Deletes a devcenter - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminDevCenter -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminDevCenter -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a devcenter - -## EXAMPLES - -### Example 1: Delete a dev center -```powershell -Remove-AzDevCenterAdminDevCenter -Name Contoso -ResourceGroupName DevProject -``` - -This command deletes the dev center "Contoso" in the resource group "testRg". - -### Example 2: Delete a dev center using InputObject -```powershell -$devCenter = Get-AzDevCenterAdminDevCenter -ResourceGroupName DevProject -Name Contoso - -Remove-AzDevCenterAdminDevCenter -InputObject $devCenter -``` - -This command deletes the dev center "Contoso" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: DevCenterName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminEnvironmentType.md deleted file mode 100644 index e4b5d7bdeae1..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminEnvironmentType.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradminenvironmenttype -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminEnvironmentType - -## SYNOPSIS -Deletes an environment type. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminEnvironmentType -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminEnvironmentType -InputObject [-DefaultProfile ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes an environment type. - -## EXAMPLES - -### Example 1: Deletes an environment type -```powershell -Remove-AzDevCenterAdminEnvironmentType -ResourceGroupName testRg -DevCenterName Contoso -Name DevTest -``` - -This command deletes the environment type "WebDevBox" in the dev center "Contoso". - -### Example 2: Deletes an environment type using InputObject -```powershell -$envType = Get-AzDevCenterAdminEnvironmentType -ResourceGroupName testRg -DevCenterName Contoso -Name DevTest -Remove-AzDevCenterAdminEnvironmentType -InputObject $envType -``` - -This command deletes the environment type "WebDevBox" in the dev center "Contoso". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: EnvironmentTypeName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminGallery.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminGallery.md deleted file mode 100644 index 07caea9142dc..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminGallery.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradmingallery -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminGallery - -## SYNOPSIS -Deletes a gallery resource. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminGallery -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminGallery -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a gallery resource. - -## EXAMPLES - -### Example 1: Delete a gallery -```powershell -Remove-AzDevCenterAdminGallery -ResourceGroupName testRg -DevCenterName Contoso -Name StandardGallery -``` - -This command deletes a gallery named "StandardGallery" from the dev center "Contoso". - -### Example 2: Delete a gallery using InputObject -```powershell -$gallery = Get-AzDevCenterAdminGallery -ResourceGroupName testRg -DevCenterName Contoso -Name StandardGallery -Remove-AzDevCenterAdminGallery -InputObject $gallery -``` - -This command deletes a gallery named "StandardGallery" from the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the gallery. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: GalleryName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminNetworkConnection.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminNetworkConnection.md deleted file mode 100644 index 6758c2234135..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminNetworkConnection.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradminnetworkconnection -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminNetworkConnection - -## SYNOPSIS -Deletes a Network Connections resource - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminNetworkConnection -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminNetworkConnection -InputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a Network Connections resource - -## EXAMPLES - -### Example 1: Delete a network connection -```powershell -Remove-AzDevCenterAdminNetworkConnection -Name networkEastUs -ResourceGroupName testRg -``` - -This command deletes a network connection named "networkEastUs" in the resource group "testRg". - -### Example 2: Delete a network connection using InputObject -```powershell -$networkConnection = Get-AzDevCenterAdminNetworkConnection -ResourceGroupName testRg -Name networkEastUs -Remove-AzDevCenterAdminNetworkConnection -InputObject $networkConnection -``` - -This command deletes a network connection named "networkEastUs" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Network Connection that can be applied to a Pool. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: NetworkConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminPool.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminPool.md deleted file mode 100644 index 9e314e4735e8..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminPool.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradminpool -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminPool - -## SYNOPSIS -Deletes a machine pool - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminPool -Name -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminPool -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a machine pool - -## EXAMPLES - -### Example 1: Delete a pool -```powershell -Remove-AzDevCenterAdminPool -ResourceGroupName testRg -Name DevPool -ProjectName DevProject -``` - -This command deletes a pool named "DevPool" in the project "DevProject". - -### Example 2: Delete a pool using InputObject -```powershell -$pool = Get-AzDevCenterAdminPool -ResourceGroupName testRg -Name DevPool -ProjectName DevProject -Remove-AzDevCenterAdminPool -InputObject $pool -``` - -This command deletes a pool named "DevPool" in the project "DevProject". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: PoolName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminProject.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminProject.md deleted file mode 100644 index 6950d766792f..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminProject.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradminproject -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminProject - -## SYNOPSIS -Deletes a project resource. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminProject -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminProject -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a project resource. - -## EXAMPLES - -### Example 1: Delete a project -```powershell -Remove-AzDevCenterAdminProject -ResourceGroupName testRg -Name DevProject -``` - -This command deletes the project named "DevProject" in the resource group "testRg". - -### Example 2: Delete a project using InputObject -```powershell -$project = Get-AzDevCenterAdminProject -ResourceGroupName testRg -Name DevProject -Remove-AzDevCenterAdminProject -InputObject $project -``` - -This command deletes the project named "DevProject" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: ProjectName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminProjectEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminProjectEnvironmentType.md deleted file mode 100644 index bfb897c9919a..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminProjectEnvironmentType.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradminprojectenvironmenttype -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminProjectEnvironmentType - -## SYNOPSIS -Deletes a project environment type. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminProjectEnvironmentType -EnvironmentTypeName -ProjectName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] - [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminProjectEnvironmentType -InputObject [-DefaultProfile ] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a project environment type. - -## EXAMPLES - -### Example 1: Delete a project environment type -```powershell -Remove-AzDevCenterAdminProjectEnvironmentType -ProjectName DevProject -ResourceGroupName testRg -EnvironmentTypeName DevTest -``` - -This command deletes a project environment type named "DevTest" in the project "DevProject". - -### Example 2: Delete a project environment type using InputObject -```powershell -$projEnvType = Get-AzDevCenterAdminProjectEnvironmentType -ProjectName DevProject -ResourceGroupName testRg -EnvironmentTypeName DevTest -Remove-AzDevCenterAdminProjectEnvironmentType -InputObject $projEnvType -``` - -This command deletes a project environment type named "DevTest" in the project "DevProject". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentTypeName -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminSchedule.md b/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminSchedule.md deleted file mode 100644 index f9b594d01c2c..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Remove-AzDevCenterAdminSchedule.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteradminschedule -schema: 2.0.0 ---- - -# Remove-AzDevCenterAdminSchedule - -## SYNOPSIS -Deletes a Scheduled. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterAdminSchedule -PoolName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterAdminSchedule -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a Scheduled. - -## EXAMPLES - -### Example 1: Delete a schedule -```powershell -Remove-AzDevCenterAdminSchedule -PoolName DevPool -ProjectName DevProject -ResourceGroupName testRg -``` - -This command deletes the schedule for the pool "DevPool" in the project "DevProject. - -### Example 2: Delete a schedule using InputObject -```powershell -$schedule = Get-AzDevCenterAdminSchedule -PoolName DevPool -ProjectName DevProject -ResourceGroupName testRg -Remove-AzDevCenterAdminSchedule -InputObject $schedule -``` - -This command deletes the schedule for the pool "DevPool" in the project "DevProject. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolName -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Start-AzDevCenterAdminNetworkConnectionHealthCheck.md b/src/DevCenter/DevCenter.AutoRest/help/help/Start-AzDevCenterAdminNetworkConnectionHealthCheck.md deleted file mode 100644 index 48721c8539d5..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Start-AzDevCenterAdminNetworkConnectionHealthCheck.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/start-azdevcenteradminnetworkconnectionhealthcheck -schema: 2.0.0 ---- - -# Start-AzDevCenterAdminNetworkConnectionHealthCheck - -## SYNOPSIS -Triggers a new health check run. -The execution and health check result can be tracked via the network Connection health check details - -## SYNTAX - -### Run (Default) -``` -Start-AzDevCenterAdminNetworkConnectionHealthCheck -NetworkConnectionName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### RunViaIdentity -``` -Start-AzDevCenterAdminNetworkConnectionHealthCheck -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Triggers a new health check run. -The execution and health check result can be tracked via the network Connection health check details - -## EXAMPLES - -### Example 1: Start health checks for a network connection -```powershell -Start-AzDevCenterAdminNetworkConnectionHealthCheck -NetworkConnectionName eastusNetwork -ResourceGroupName testRg -``` - -This command starts the health checks for the network connection "eastusNetwork". - -### Example 2: Start health checks for a network connection using InputObject -```powershell -$networkConnection = @{"ResourceGroupName" = "testRg"; "NetworkConnectionName" = "eastusNetwork"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Start-AzDevCenterAdminNetworkConnectionHealthCheck -InputObject $networkConnection -``` - -This command starts the health checks for the network connection "eastusNetwork". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: RunViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetworkConnectionName -Name of the Network Connection that can be applied to a Pool. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Run -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Sync-AzDevCenterAdminCatalog.md b/src/DevCenter/DevCenter.AutoRest/help/help/Sync-AzDevCenterAdminCatalog.md deleted file mode 100644 index 5dd864a38277..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Sync-AzDevCenterAdminCatalog.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/sync-azdevcenteradmincatalog -schema: 2.0.0 ---- - -# Sync-AzDevCenterAdminCatalog - -## SYNOPSIS -Syncs templates for a template source. - -## SYNTAX - -### Sync (Default) -``` -Sync-AzDevCenterAdminCatalog -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### SyncViaIdentity -``` -Sync-AzDevCenterAdminCatalog -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Syncs templates for a template source. - -## EXAMPLES - -### Example 1: Sync a catalog -```powershell -Sync-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg -``` - -This command syncs the catalog named "CentralCatalog". - -### Example 2: Sync a catalog using InputObject -```powershell -$catalog = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "CatalogName" = "CentralCatalog"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -Sync-AzDevCenterAdminCatalog -InputObject $catalog -``` - -This command syncs the catalog named "CentralCatalog". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: Sync -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: SyncViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Catalog. - -```yaml -Type: System.String -Parameter Sets: Sync -Aliases: CatalogName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: Sync -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: Sync -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminCatalog.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminCatalog.md deleted file mode 100644 index a685accb9411..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminCatalog.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradmincatalog -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminCatalog - -## SYNOPSIS -Partially updates a catalog. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminCatalog -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-AdoGitBranch ] [-AdoGitPath ] [-AdoGitSecretIdentifier ] - [-AdoGitUri ] [-GitHubBranch ] [-GitHubPath ] [-GitHubSecretIdentifier ] - [-GitHubUri ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminCatalog -InputObject [-AdoGitBranch ] - [-AdoGitPath ] [-AdoGitSecretIdentifier ] [-AdoGitUri ] [-GitHubBranch ] - [-GitHubPath ] [-GitHubSecretIdentifier ] [-GitHubUri ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a catalog. - -## EXAMPLES - -### Example 1: Update a catalog -```powershell -Update-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg -GitHubPath "testpath" -GitHubSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat" -``` - -This command updates a catalog named "CentralCatalog" in the dev center "Contoso". - -### Example 2: Update a catalog using InputObject -```powershell -$catalogInput = Get-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg - -Update-AzDevCenterAdminCatalog -InputObject $catalogInput -GitHubPath "testpath" -GitHubSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat" -``` - -This command updates a catalog named "CentralCatalog" in the dev center "Contoso". - -## PARAMETERS - -### -AdoGitBranch -Git branch. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdoGitPath -The folder where the catalog items can be found inside the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdoGitSecretIdentifier -A reference to the Key Vault secret containing a security token to authenticate to a Git repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdoGitUri -Git URI. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubBranch -Git branch. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubPath -The folder where the catalog items can be found inside the repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubSecretIdentifier -A reference to the Key Vault secret containing a security token to authenticate to a Git repository. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GitHubUri -Git URI. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Catalog. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: CatalogName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.ICatalog - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminDevBoxDefinition.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminDevBoxDefinition.md deleted file mode 100644 index 7f980eacafde..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminDevBoxDefinition.md +++ /dev/null @@ -1,398 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradmindevboxdefinition -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminDevBoxDefinition - -## SYNOPSIS -Partially updates a Dev Box definition. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminDevBoxDefinition -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-HibernateSupport ] [-ImageReferenceId ] - [-OSStorageType ] [-SkuCapacity ] [-SkuFamily ] [-SkuName ] - [-SkuSize ] [-SkuTier ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminDevBoxDefinition -InputObject - [-HibernateSupport ] [-ImageReferenceId ] [-OSStorageType ] - [-SkuCapacity ] [-SkuFamily ] [-SkuName ] [-SkuSize ] [-SkuTier ] - [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a Dev Box definition. - -## EXAMPLES - -### Example 1: Update a dev box definition -```powershell -$vsImage = "microsoftvisualstudio_visualstudioplustools_vs-2022-pro-general-win10-m365-gen2" -$vsImageReferenceId = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/Default/images/" + $vsImage - -$devBoxDefinition = Update-AzDevCenterAdminDevBoxDefinition -Name "WebDevBox" -DevCenterName Contoso -ResourceGroupName testRg -HibernateSupport "Disabled" -ImageReferenceId $vsImageReferenceId -``` - -This command updates a dev box definition named "WebDevBox" in the dev center "Contoso". - -### Example 2: Update a dev box definition using InputObject -```powershell -$id = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox" -$devBoxDefinitionId = @{"Id" = $id } - -$vsImage = "microsoftvisualstudio_visualstudioplustools_vs-2022-pro-general-win10-m365-gen2" -$vsImageReferenceId = "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/testRg/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/Default/images/" + $vsImage - -Update-AzDevCenterAdminDevBoxDefinition -InputObject $devBoxDefinitionId -HibernateSupport "Disabled" -ImageReferenceId $vsImageReferenceId -``` - -This command updates a dev box definition named "WebDevBox" in the dev center "Contoso". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HibernateSupport -Indicates whether Dev Boxes created with this definition are capable of hibernation. -Not all images are capable of supporting hibernation. -To find out more see https://aka.ms/devbox/hibernate - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.HibernateSupport -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImageReferenceId -Image ID, or Image version ID. -When Image ID is provided, its latest version will be used. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the Dev Box definition. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: DevBoxDefinitionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSStorageType -The storage type used for the Operating System disk of Dev Boxes created using this definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuCapacity -If the SKU supports scale out/in then the capacity integer should be included. -If scale out/in is not possible for the resource this may be omitted. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuFamily -If the service has different generations of hardware, for the same SKU, then that can be captured here. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuName -The name of the SKU. -Ex - P3. -It is typically a letter+number code - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuSize -The SKU size. -When the name field is the combination of tier and some other value, this would be the standalone code. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkuTier -This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.SkuTier -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IDevBoxDefinition - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminDevCenter.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminDevCenter.md deleted file mode 100644 index 4eda6cc2ff8b..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminDevCenter.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradmindevcenter -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminDevCenter - -## SYNOPSIS -Partially updates a devcenter. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminDevCenter -Name -ResourceGroupName [-SubscriptionId ] - [-IdentityType ] [-IdentityUserAssignedIdentity ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminDevCenter -InputObject - [-IdentityType ] [-IdentityUserAssignedIdentity ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a devcenter. - -## EXAMPLES - -### Example 1: Update a dev center -```powershell -Update-AzDevCenterAdminDevCenter -Name Contoso -ResourceGroupName testRg -IdentityType "SystemAssigned" -``` - -This command updates a dev center named "Contoso" in the resource group "testRg". - -### Example 2: Update a dev center using InputObject -```powershell -$devCenterInput = Get-AzDevCenterAdminDevCenter -Name Contoso -ResourceGroupName testRg - -Update-AzDevCenterAdminDevCenter -InputObject $devCenterInput -IdentityType "SystemAssigned" -``` - -This command updates a dev center named "Contoso" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.ManagedServiceIdentityType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: DevCenterName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IDevCenter - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminEnvironmentType.md deleted file mode 100644 index ca53267beba3..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminEnvironmentType.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradminenvironmenttype -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminEnvironmentType - -## SYNOPSIS -Partially updates an environment type. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminEnvironmentType -DevCenterName -Name -ResourceGroupName - [-SubscriptionId ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminEnvironmentType -InputObject [-Tag ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates an environment type. - -## EXAMPLES - -### Example 1: Update an environment type -```powershell -$tags = @{"dev" = "test" } - -Update-AzDevCenterAdminEnvironmentType -DevCenterName Contoso -Name DevTest -ResourceGroupName testRg -Tag $tags -``` - -This command updates an environment type named "DevTest" in the dev center "Contoso". - -### Example 2: Update an environment type using InputObject -```powershell -$envType = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "EnvironmentTypeName" = "DevTest"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"} -$tags = @{"dev" = "test" } - -Update-AzDevCenterAdminEnvironmentType -InputObject $envType -Tag $tags -``` - -This command updates an environment type named "DevTest" in the dev center "Contoso". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenterName -The name of the devcenter. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: EnvironmentTypeName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IEnvironmentType - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminNetworkConnection.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminNetworkConnection.md deleted file mode 100644 index c2e05333c3c9..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminNetworkConnection.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradminnetworkconnection -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminNetworkConnection - -## SYNOPSIS -Partially updates a Network Connection - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminNetworkConnection -Name -ResourceGroupName [-SubscriptionId ] - [-DomainName ] [-DomainPassword ] [-DomainUsername ] [-OrganizationUnit ] - [-SubnetId ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminNetworkConnection -InputObject [-DomainName ] - [-DomainPassword ] [-DomainUsername ] [-OrganizationUnit ] [-SubnetId ] - [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a Network Connection - -## EXAMPLES - -### Example 1: Update an Azure AD joined network connection -```powershell -Update-AzDevCenterAdminNetworkConnection -Name eastusNetwork -ResourceGroupName testRg -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" -DomainPassword $null -``` - -This command updates an Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -### Example 2: Update a hybid Azure AD joined network connection -```powershell -Update-AzDevCenterAdminNetworkConnection -Name eastusNetwork -ResourceGroupName testRg -DomainName mydomaincontroller.local -DomainUsername testuser@mydomaincontroller.local -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" -``` - -This command updates a hybid Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -### Example 3: Update an Azure AD joined network connection -```powershell -$networkConnectionInput = Get-AzDevCenterAdminNetworkConnection -ResourceGroupName testRg -Name eastusNetwork -Update-AzDevCenterAdminNetworkConnection -InputObject $networkConnectionInput -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" -DomainPassword $null -``` - -This command updates an Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -### Example 4: Update a hybid Azure AD joined network connection -```powershell -$hybridNetworkConnectionInput = Get-AzDevCenterAdminNetworkConnection -ResourceGroupName testRg -Name eastusNetwork -Update-AzDevCenterAdminNetworkConnection -InputObject $hybridNetworkConnectionInput -DomainName mydomaincontroller.local -DomainUsername testuser@mydomaincontroller.local -SubnetId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" -``` - -This command updates a hybid Azure AD joined network connection named "eastusNetwork" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Active Directory domain name - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainPassword -The password for the account used to join domain - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainUsername -The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. -Required format: admin@contoso.com. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Name of the Network Connection that can be applied to a Pool. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: NetworkConnectionName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationUnit -Active Directory domain Organization Unit (OU) - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubnetId -The subnet to attach Virtual Machines to - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.INetworkConnection - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminPool.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminPool.md deleted file mode 100644 index 0f3985010039..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminPool.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradminpool -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminPool - -## SYNOPSIS -Partially updates a machine pool - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminPool -Name -ProjectName -ResourceGroupName - [-SubscriptionId ] [-DevBoxDefinitionName ] [-LocalAdministrator ] - [-NetworkConnectionName ] [-StopOnDisconnectGracePeriodMinute ] - [-StopOnDisconnectStatus ] [-Tag ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminPool -InputObject [-DevBoxDefinitionName ] - [-LocalAdministrator ] [-NetworkConnectionName ] - [-StopOnDisconnectGracePeriodMinute ] [-StopOnDisconnectStatus ] - [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a machine pool - -## EXAMPLES - -### Example 1: Update a pool -```powershell -Update-AzDevCenterAdminPool -Name DevPool -ProjectName DevProject -ResourceGroupName testRg -DevBoxDefinitionName WebDevBox -LocalAdministrator "Disabled" -NetworkConnectionName Network1westus2 -``` - -This command updates a pool named "DevPool" in the project "DevProject". - -### Example 2: Update a pool using InputObject -```powershell -Get-AzDevCenterAdminPool -ResourceGroupName testRg -Name DevPool -ProjectName DevProject -Update-AzDevCenterAdminPool -InputObject $poolInput -DevBoxDefinitionName WebDevBox -LocalAdministrator "Disabled" -NetworkConnectionName Network1westus2 - -``` - -This command updates a pool named "DevPool" in the project "DevProject". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevBoxDefinitionName -Name of a Dev Box definition in parent Project of this Pool - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LocalAdministrator -Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.LocalAdminStatus -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: PoolName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkConnectionName -Name of a Network Connection in parent Project of this Pool - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopOnDisconnectGracePeriodMinute -The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopOnDisconnectStatus -Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.StopOnDisconnectEnableStatus -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IPool - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminProject.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminProject.md deleted file mode 100644 index a283e4843b57..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminProject.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradminproject -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminProject - -## SYNOPSIS -Partially updates a project. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminProject -Name -ResourceGroupName [-SubscriptionId ] - [-Description ] [-MaxDevBoxesPerUser ] [-Tag ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminProject -InputObject [-Description ] - [-MaxDevBoxesPerUser ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a project. - -## EXAMPLES - -### Example 1: Update a project -```powershell -Update-AzDevCenterAdminProject -Name DevProject -ResourceGroupName testRg -MaxDevBoxesPerUser 5 -``` - -This command updates a project name "DevProject" in the resource group "testRg". - -### Example 2: Update a project using InputObject -```powershell -$projectInput = Get-AzDevCenterAdminProject -ResourceGroupName testRg -Name DevProject - -Update-AzDevCenterAdminProject -InputObject $projectInput -MaxDevBoxesPerUser 5 -``` - -This command updates a project name "DevProject" in the resource group "testRg". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Description of the project. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MaxDevBoxesPerUser -When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. -This will have no effect on existing Dev Boxes when reduced. - -```yaml -Type: System.Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of the project. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: ProjectName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IProject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminProjectEnvironmentType.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminProjectEnvironmentType.md deleted file mode 100644 index f1df98ac6bce..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminProjectEnvironmentType.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradminprojectenvironmenttype -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminProjectEnvironmentType - -## SYNOPSIS -Partially updates a project environment type. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminProjectEnvironmentType -EnvironmentTypeName -ProjectName - -ResourceGroupName [-SubscriptionId ] [-CreatorRoleAssignmentRole ] - [-DeploymentTargetId ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-Status ] [-Tag ] - [-UserRoleAssignment ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminProjectEnvironmentType -InputObject - [-CreatorRoleAssignmentRole ] [-DeploymentTargetId ] - [-IdentityType ] [-IdentityUserAssignedIdentity ] - [-Status ] [-Tag ] [-UserRoleAssignment ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a project environment type. - -## EXAMPLES - -### Example 1: Update a project environment type -```powershell -$deploymentTargetId = '/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff' -$creatorRoleAssignmentRole = @{"b24988ac-6180-42a0-ab88-20f7382dd24c" = @{} } -$userRoleAssignment = @{ - $env.identityPrincipalId = @{ - "roles" = @{ - "b24988ac-6180-42a0-ab88-20f7382dd24c" = @{} - } - } -} - -Update-AzDevCenterAdminProjectEnvironmentType -EnvironmentTypeName DevTest -ProjectName DevProject -ResourceGroupName testRg -CreatorRoleAssignmentRole $creatorRoleAssignmentRole -IdentityType "SystemAssigned" -Status "Disabled" -UserRoleAssignment $userRoleAssignment -``` - -This command updates a project environment type named "DevTest" in the project "DevProject". - -### Example 1: Update a project environment type -```powershell -$projEnvTypeInput =Get-AzDevCenterAdminProjectEnvironmentType -ProjectName DevProject -ResourceGroupName testRg -EnvironmentTypeName DevTest - -$deploymentTargetId = '/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff' -$creatorRoleAssignmentRole = @{"b24988ac-6180-42a0-ab88-20f7382dd24c" = @{} } -$userRoleAssignment = @{ - $env.identityPrincipalId = @{ - "roles" = @{ - "b24988ac-6180-42a0-ab88-20f7382dd24c" = @{} - } - } -} - -Update-AzDevCenterAdminProjectEnvironmentType -InputObject $projEnvTypeInput -CreatorRoleAssignmentRole $creatorRoleAssignmentRole -IdentityType "SystemAssigned" -Status "Disabled" -UserRoleAssignment $userRoleAssignment -``` - -This command updates a project environment type named "DevTest" in the project "DevProject". - -## PARAMETERS - -### -CreatorRoleAssignmentRole -A map of roles to assign to the environment creator. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeploymentTargetId -Id of a subscription that the environment type will be mapped to. -The environment's resources will be deployed into this subscription. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentTypeName -The name of the environment type. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.ManagedServiceIdentityType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Defines whether this Environment Type can be used in this Project. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.EnvironmentTypeEnableStatus -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRoleAssignment -Role Assignments created on environment backing resources. -This is a mapping from a user object ID to an object of role definition IDs. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.IProjectEnvironmentType - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminSchedule.md b/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminSchedule.md deleted file mode 100644 index ce9b563b6a93..000000000000 --- a/src/DevCenter/DevCenter.AutoRest/help/help/Update-AzDevCenterAdminSchedule.md +++ /dev/null @@ -1,323 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenter -online version: https://learn.microsoft.com/powershell/module/az.devcenter/update-azdevcenteradminschedule -schema: 2.0.0 ---- - -# Update-AzDevCenterAdminSchedule - -## SYNOPSIS -Partially updates a Scheduled. - -## SYNTAX - -### UpdateExpanded (Default) -``` -Update-AzDevCenterAdminSchedule -PoolName -ProjectName -ResourceGroupName - [-SubscriptionId ] [-State ] [-Tag ] [-Time ] - [-TimeZone ] [-Type ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] -``` - -### UpdateViaIdentityExpanded -``` -Update-AzDevCenterAdminSchedule -InputObject [-State ] - [-Tag ] [-Time ] [-TimeZone ] [-Type ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Partially updates a Scheduled. - -## EXAMPLES - -### Example 1: Update a schedule -```powershell -New-AzDevCenterAdminSchedule -PoolName DevPool -ProjectName DevProject -ResourceGroupName testRg -State "Disabled" -Time "17:30" -TimeZone "America/New_York" -``` - -This command updates a schedule in the pool "DevPool". - -### Example 2: Update a schedule using InputObject -```powershell -$scheduleInput = Get-AzDevCenterAdminSchedule -PoolName DevPool -ProjectName DevProject -ResourceGroupName testRg - -New-AzDevCenterAdminSchedule -InputObject $scheduleInput -State "Disabled" -Time "17:30" -TimeZone "America/New_York" -``` - -This command updates a schedule in the pool "DevPool". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity -Parameter Sets: UpdateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolName -Name of the pool. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The name of the project. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceGroupName -The name of the resource group. -The name is case insensitive. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -Indicates whether or not this scheduled task is enabled. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.ScheduleEnableStatus -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded -Aliases: - -Required: False -Position: Named -Default value: (Get-AzContext).Subscription.Id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tag -Resource tags. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -The target time to trigger the action. -The format is HH:MM. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -The IANA timezone id at which the schedule should execute. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Supported type this scheduled task represents. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Support.ScheduledType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.IDevCenterIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20230401.ISchedule - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AttachedNetworkConnectionName ]`: The name of the attached NetworkConnection. - - `[CatalogName ]`: The name of the Catalog. - - `[DevBoxDefinitionName ]`: The name of the Dev Box definition. - - `[DevCenterName ]`: The name of the devcenter. - - `[EnvironmentTypeName ]`: The name of the environment type. - - `[GalleryName ]`: The name of the gallery. - - `[Id ]`: Resource identity path - - `[ImageName ]`: The name of the image. - - `[Location ]`: The Azure region - - `[NetworkConnectionName ]`: Name of the Network Connection that can be applied to a Pool. - - `[OperationId ]`: The ID of an ongoing async operation - - `[PoolName ]`: Name of the pool. - - `[ProjectName ]`: The name of the project. - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScheduleName ]`: The name of the schedule that uniquely identifies it. - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VersionName ]`: The version of the image. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Az.DevCenterdata.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Az.DevCenterdata.md deleted file mode 100644 index 7fa7103c5553..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Az.DevCenterdata.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -Module Name: Az.DevCenterdata -Module Guid: a5a2a512-ec9f-44e2-9943-c4cc9c42a4ad -Download Help Link: https://learn.microsoft.com/powershell/module/az.devcenterdata -Help Version: 1.0.0.0 -Locale: en-US ---- - -# Az.DevCenterdata Module -## Description -Microsoft Azure PowerShell: DevCenterdata cmdlets - -## Az.DevCenterdata Cmdlets -### [Deploy-AzDevCenterUserEnvironment](Deploy-AzDevCenterUserEnvironment.md) -Creates or updates an environment. - -### [Get-AzDevCenterUserCatalog](Get-AzDevCenterUserCatalog.md) -Gets the specified catalog within the project - -### [Get-AzDevCenterUserDevBox](Get-AzDevCenterUserDevBox.md) -Gets a Dev Box - -### [Get-AzDevCenterUserDevBoxAction](Get-AzDevCenterUserDevBoxAction.md) -Gets an action. - -### [Get-AzDevCenterUserDevBoxRemoteConnection](Get-AzDevCenterUserDevBoxRemoteConnection.md) -Gets RDP Connection info - -### [Get-AzDevCenterUserEnvironment](Get-AzDevCenterUserEnvironment.md) -Gets an environment - -### [Get-AzDevCenterUserEnvironmentDefinition](Get-AzDevCenterUserEnvironmentDefinition.md) -Get an environment definition from a catalog. - -### [Get-AzDevCenterUserEnvironmentType](Get-AzDevCenterUserEnvironmentType.md) -Lists all environment types configured for a project. - -### [Get-AzDevCenterUserPool](Get-AzDevCenterUserPool.md) -Gets a pool - -### [Get-AzDevCenterUserProject](Get-AzDevCenterUserProject.md) -Gets a project. - -### [Get-AzDevCenterUserSchedule](Get-AzDevCenterUserSchedule.md) -Gets a schedule. - -### [Invoke-AzDevCenterUserDelayDevBoxAction](Invoke-AzDevCenterUserDelayDevBoxAction.md) -Delays the occurrence of an action. - -### [New-AzDevCenterUserDevBox](New-AzDevCenterUserDevBox.md) -Creates or replaces a Dev Box. - -### [New-AzDevCenterUserEnvironment](New-AzDevCenterUserEnvironment.md) -Creates or updates an environment. - -### [Remove-AzDevCenterUserDevBox](Remove-AzDevCenterUserDevBox.md) -Deletes a Dev Box. - -### [Remove-AzDevCenterUserEnvironment](Remove-AzDevCenterUserEnvironment.md) -Deletes an environment and all its associated resources - -### [Restart-AzDevCenterUserDevBox](Restart-AzDevCenterUserDevBox.md) -Restarts a Dev Box - -### [Skip-AzDevCenterUserDevBoxAction](Skip-AzDevCenterUserDevBoxAction.md) -Skips an occurrence of an action. - -### [Start-AzDevCenterUserDevBox](Start-AzDevCenterUserDevBox.md) -Starts a Dev Box - -### [Stop-AzDevCenterUserDevBox](Stop-AzDevCenterUserDevBox.md) -Stops a Dev Box - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Deploy-AzDevCenterUserEnvironment.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Deploy-AzDevCenterUserEnvironment.md deleted file mode 100644 index 25083459339d..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Deploy-AzDevCenterUserEnvironment.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/deploy-azdevcenteruserenvironment -schema: 2.0.0 ---- - -# Deploy-AzDevCenterUserEnvironment - -## SYNOPSIS -Creates or updates an environment. - -## SYNTAX - -### CreateExpanded (Default) -``` -Deploy-AzDevCenterUserEnvironment -Endpoint -Name -ProjectName - -CatalogName -EnvironmentDefinitionName -EnvironmentType [-UserId ] - [-Parameter ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -### CreateExpandedByDevCenter -``` -Deploy-AzDevCenterUserEnvironment -DevCenter -Name -ProjectName - -CatalogName -EnvironmentDefinitionName -EnvironmentType [-UserId ] - [-Parameter ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -### CreateViaIdentityExpanded -``` -Deploy-AzDevCenterUserEnvironment -Endpoint -InputObject - -CatalogName -EnvironmentDefinitionName -EnvironmentType [-Parameter ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpandedByDevCenter -``` -Deploy-AzDevCenterUserEnvironment -DevCenter -InputObject - -CatalogName -EnvironmentDefinitionName -EnvironmentType [-Parameter ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates an environment. - -## EXAMPLES - -### Example 1: Deploy an environment by endpoint -```powershell -$functionAppParameters = @{"name" = "testfuncApp" } - -Deploy-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -Name "envtest" -ProjectName DevProject -CatalogName CentralCatalog -EnvironmentDefinitionName FunctionApp -EnvironmentType DevTest -Parameter $functionAppParameters -``` - -This command deploys an environment named "envtest" to the project "DevProject". - -### Example 2: Deploy an environment by dev center -```powershell -Deploy-AzDevCenterUserEnvironment -DevCenter Contoso -Name "envtest" -ProjectName DevProject -CatalogName CentralCatalog -EnvironmentDefinitionName Sandbox -EnvironmentType DevTest -``` - -This command deploys an environment named "envtest" to the project "DevProject". - -### Example 3: Deploy an environment by endpoint and InputObject -```powershell -$envInput = @{"UserId" = "me"; "ProjectName" = "DevProject"; "EnvironmentName" = "envtest" } - - -Deploy-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $envInput -CatalogName CentralCatalog -EnvironmentDefinitionName Sandbox -EnvironmentType DevTest - -``` - -This command deploys an environment named "envtest" to the project "DevProject". - -### Example 4: Deploy an environment by dev center and InputObject -```powershell -$functionAppParameters = @{"name" = "testfuncApp" } -$envInput = @{"UserId" = "me"; "ProjectName" = "DevProject"; "EnvironmentName" = "envtest" } - -Deploy-AzDevCenterUserEnvironment -DevCenter Contoso -InputObject $envInput -CatalogName CentralCatalog -EnvironmentDefinitionName FunctionApp -EnvironmentType DevTest -Parameter $functionAppParameters -``` - -This command deploys an environment named "envtest" to the project "DevProject". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CatalogName -Name of the catalog. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedByDevCenter, CreateViaIdentityExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentDefinitionName -Name of the environment definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentType -Environment type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: CreateViaIdentityExpanded, CreateViaIdentityExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameter -Parameters object for the environment. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserCatalog.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserCatalog.md deleted file mode 100644 index 7939b06da9ba..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserCatalog.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenterusercatalog -schema: 2.0.0 ---- - -# Get-AzDevCenterUserCatalog - -## SYNOPSIS -Gets the specified catalog within the project - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserCatalog -Endpoint -ProjectName [-DefaultProfile ] - [] -``` - -### Get -``` -Get-AzDevCenterUserCatalog -Endpoint -CatalogName -ProjectName - [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserCatalog -DevCenter -CatalogName -ProjectName - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserCatalog -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserCatalog -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserCatalog -DevCenter -ProjectName [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets the specified catalog within the project - -## EXAMPLES - -### Example 1: List catalogs by endpoint -```powershell -Get-AzDevCenterUserCatalog -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -``` - -This command lists catalogs in the project "DevProject". - -### Example 2: List catalogs by dev center -```powershell -Get-AzDevCenterUserCatalog -DevCenter Contoso -ProjectName DevProject -``` - -This command lists catalogs in the project "DevProject". - -### Example 3: Get a catalog by endpoint -```powershell -Get-AzDevCenterUserCatalog -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -CatalogName CentralCatalog -``` - -This command gets a catalog named "CentralCatalog" in the project "DevProject". - -### Example 4: Get a catalog by dev center -```powershell -Get-AzDevCenterUserCatalog -DevCenter Contoso -ProjectName DevProject -CatalogName CentralCatalog -``` - -This command gets a catalog named "CentralCatalog" in the project "DevProject". - -### Example 5: Get a catalog by endpoint and InputObject -```powershell -$catalogInput = @{"CatalogName" = "CentralCatalog"; "ProjectName" =" DevProject" } -Get-AzDevCenterUserCatalog -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $catalogInput -``` - -This command gets a catalog named "CentralCatalog" in the project "DevProject". - -### Example 6: Get a catalog by dev center and InputObject -```powershell -$catalogInput = @{"CatalogName" = "CentralCatalog"; "ProjectName" = "DevProject" } -Get-AzDevCenterUserCatalog -DevCenter Contoso -InputObject $catalogInput -``` - -This command gets a catalog named "CentralCatalog" in the project "DevProject". - -## PARAMETERS - -### -CatalogName -The name of the catalog - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.ICatalog - -### System.String - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBox.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBox.md deleted file mode 100644 index 4f3157be8562..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBox.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserdevbox -schema: 2.0.0 ---- - -# Get-AzDevCenterUserDevBox - -## SYNOPSIS -Gets a Dev Box - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserDevBox -Endpoint [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterUserDevBox -Endpoint -Name -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserDevBox -DevCenter -Name -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserDevBox -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserDevBox -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -### List1 -``` -Get-AzDevCenterUserDevBox -Endpoint -UserId [-DefaultProfile ] - [] -``` - -### List1ByDevCenter -``` -Get-AzDevCenterUserDevBox -DevCenter -UserId [-DefaultProfile ] - [] -``` - -### List2 -``` -Get-AzDevCenterUserDevBox -Endpoint -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### List2ByDevCenter -``` -Get-AzDevCenterUserDevBox -DevCenter -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserDevBox -DevCenter [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a Dev Box - -## EXAMPLES - -### Example 1: List dev boxes by endpoint -```powershell -Get-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -``` - -This command lists dev boxes under the endpoint. - -### Example 2: List dev boxes by endpoint and user id -```powershell -Get-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -``` - -This command lists dev boxes under the endpoint assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 3: List dev boxes by endpoint, user id, and project -```powershell -Get-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId "me" -``` - -This command lists dev boxes under the project "DevProject" assigned to the currently signed-in user. - -### Example 4: List dev boxes by dev center name -```powershell -Get-AzDevCenterUserDevBox -DevCenter Contoso -``` - -This command lists dev boxes under the dev center "Contoso". - -### Example 5: List dev boxes by dev center and user id -```powershell -Get-AzDevCenterUserDevBox -DevCenter Contoso -UserId "me" -``` - -This command lists dev boxes under the dev center "Contoso" assigned to the currently signed-in user. - -### Example 6: List dev boxes by dev center, user id, and project -```powershell -Get-AzDevCenterUserDevBox -DevCenter Contoso -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -``` - -This command lists dev boxes under the project "DevProject" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 7: Get a dev box by endpoint -```powershell -Get-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -Name myDevBox -``` - -This command gets the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 8: Get a dev box by dev center -```powershell -Get-AzDevCenterUserDevBox -DevCenter Contoso -ProjectName DevProject -UserId "me" -Name myDevBox -``` - -This command gets the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 9: Get a dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -Get-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command gets the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 10: Get a dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject" } -Get-AzDevCenterUserDevBox -DevCenter Contoso -InputObject $devBoxInput -``` - -This command gets the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter, List1ByDevCenter, List2ByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity, List, List1, List2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: DevBoxName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List2, List2ByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List1, List1ByDevCenter, List2, List2ByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IDevBox - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBoxAction.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBoxAction.md deleted file mode 100644 index 4b7fadae757a..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBoxAction.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserdevboxaction -schema: 2.0.0 ---- - -# Get-AzDevCenterUserDevBoxAction - -## SYNOPSIS -Gets an action. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserDevBoxAction -Endpoint -DevBoxName -ProjectName - [-UserId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterUserDevBoxAction -Endpoint -ActionName -DevBoxName - -ProjectName [-UserId ] [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserDevBoxAction -DevCenter -ActionName -DevBoxName - -ProjectName [-UserId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserDevBoxAction -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserDevBoxAction -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserDevBoxAction -DevCenter -DevBoxName -ProjectName - [-UserId ] [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets an action. - -## EXAMPLES - -### Example 1: List actions on the dev box by endpoint -```powershell -Get-AzDevCenterUserDevBoxAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -DevBoxName myDevBox -ProjectName DevProject -``` - -This command lists the actions on the dev box "myDevBox". - -### Example 2: List actions on the dev box by dev center -```powershell -Get-AzDevCenterUserDevBoxAction -DevCenter Contoso -DevBoxName myDevBox -ProjectName DevProject -``` - -This command lists the actions on the dev box "myDevBox". - -### Example 3: Get an action on the dev box by endpoint -```powershell -Get-AzDevCenterUserDevBoxAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -DevBoxName myDevBox -ProjectName DevProject -ActionName "schedule-default" -``` - -This command gets the action "schedule-default" for the dev box "myDevBox". - -### Example 4: Get an action on the dev box by dev center -```powershell -Get-AzDevCenterUserDevBoxAction -DevCenter Contoso -DevBoxName myDevBox -ProjectName DevProject -ActionName "schedule-default" -``` - -This command gets the action "schedule-default" for the dev box "myDevBox". - -### Example 5: Get an action on the dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject"; "ActionName" = "schedule-default"} -Get-AzDevCenterUserDevBoxAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command gets the action "schedule-default" for the dev box "myDevBox". - -### Example 6: Get an action on the dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject"; "ActionName" = "schedule-default"} -Get-AzDevCenterUserDevBoxAction -DevCenter Contoso -InputObject $devBoxInput -``` - -This command gets the action "schedule-default" for the dev box "myDevBox". - -## PARAMETERS - -### -ActionName -The name of an action that will take place on a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevBoxName -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List, ListByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IDevBoxAction - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBoxRemoteConnection.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBoxRemoteConnection.md deleted file mode 100644 index 32a31b6ed967..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserDevBoxRemoteConnection.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserdevboxremoteconnection -schema: 2.0.0 ---- - -# Get-AzDevCenterUserDevBoxRemoteConnection - -## SYNOPSIS -Gets RDP Connection info - -## SYNTAX - -### Get (Default) -``` -Get-AzDevCenterUserDevBoxRemoteConnection -Endpoint -DevBoxName -ProjectName - [-UserId ] [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserDevBoxRemoteConnection -DevCenter -DevBoxName -ProjectName - [-UserId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserDevBoxRemoteConnection -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserDevBoxRemoteConnection -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets RDP Connection info - -## EXAMPLES - -### Example 1: Get the remote connection on the dev box by endpoint -```powershell -Get-AzDevCenterUserDevBoxRemoteConnection -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -DevBoxName myDevBox -ProjectName DevProject -``` - -This commands gets the remote connection for the dev box "myDevBox". - -### Example 2: Get the remote connection on the dev box by dev center -```powershell -Get-AzDevCenterUserDevBoxRemoteConnection -DevCenter Contoso -DevBoxName myDevBox -ProjectName DevProject -``` - -This commands gets the remote connection for the dev box "myDevBox". - -### Example 3: Get the remote connection on the dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -Get-AzDevCenterUserDevBoxRemoteConnection -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This commands gets the remote connection for the dev box "myDevBox". - -### Example 4: Get the remote connection on the dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -Get-AzDevCenterUserDevBoxRemoteConnection -DevCenter Contoso -InputObject $devBoxInput -``` - -This commands gets the remote connection for the dev box "myDevBox". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevBoxName -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IRemoteConnection - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironment.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironment.md deleted file mode 100644 index 2f367759b97d..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironment.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserenvironment -schema: 2.0.0 ---- - -# Get-AzDevCenterUserEnvironment - -## SYNOPSIS -Gets an environment - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserEnvironment -Endpoint -ProjectName [-DefaultProfile ] - [] -``` - -### Get -``` -Get-AzDevCenterUserEnvironment -Endpoint -Name -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserEnvironment -DevCenter -Name -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserEnvironment -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserEnvironment -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -### List1 -``` -Get-AzDevCenterUserEnvironment -Endpoint -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### List1ByDevCenter -``` -Get-AzDevCenterUserEnvironment -DevCenter -ProjectName -UserId - [-DefaultProfile ] [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserEnvironment -DevCenter -ProjectName [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets an environment - -## EXAMPLES - -### Example 1: List environments by endpoint and project -```powershell - -``` - -```powershell - Get-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject - ``` -This command lists environments under the project "DevProject". - -### Example 2: List environments by dev center and project -```powershell -Get-AzDevCenterUserEnvironment -DevCenter Contoso -ProjectName DevProject -``` - -This command lists environments under the project "DevProject". - -### Example 3: List environments by endpoint, user id, and project -```powershell -Get-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId "me" -``` - -This command lists environments under the project "DevProject" assigned to the currently signed-in user. - -### Example 4: List environments by dev center, user id, and project -```powershell -Get-AzDevCenterUserEnvironment -DevCenter Contoso -ProjectName DevProject -UserId "786a823c-8037-48ab-89b8-8599901e67d0" -``` - -This command lists environments under the project "DevProject" assigned to the user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 5: Get an environment by endpoint -```powershell -Get-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId "me" -Name myEnv -``` - -This command gets the environment "myEnv" under the project "DevProject" assigned to the currently signed-in user. - -### Example 6: Get an environment by dev center -```powershell -Get-AzDevCenterUserEnvironment -DevCenter Contoso -ProjectName DevProject -UserId "786a823c-8037-48ab-89b8-8599901e67d0" -Name myEnv -``` - -This command gets the environment "myEnv" under the project "DevProject" assigned to the user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 7: Get an environment by endpoint and InputObject -```powershell -$envInput = @{"UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject"; "EnvironmentName" = "myEnv" } -Get-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $envInput -``` - -This command gets the environment "myEnv" under the project "DevProject" assigned to the user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 8: Get an environment by dev center and InputObject -```powershell -$envInput = @{"UserId" = "me"; "ProjectName" = "DevProject"; "EnvironmentName" = "myEnv" } -Get-AzDevCenterUserEnvironment -DevCenter Contoso -InputObject $envInput -``` - -This command gets the environment "myEnv" under the project "DevProject" assigned to the currently signed-in user. - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter, List1ByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity, List, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List, List1, List1ByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List1, List1ByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IEnvironment - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironmentDefinition.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironmentDefinition.md deleted file mode 100644 index ba283989c0c2..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironmentDefinition.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserenvironmentdefinition -schema: 2.0.0 ---- - -# Get-AzDevCenterUserEnvironmentDefinition - -## SYNOPSIS -Get an environment definition from a catalog. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserEnvironmentDefinition -Endpoint -ProjectName [-DefaultProfile ] - [] -``` - -### Get -``` -Get-AzDevCenterUserEnvironmentDefinition -Endpoint -CatalogName -DefinitionName - -ProjectName [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserEnvironmentDefinition -DevCenter -CatalogName -DefinitionName - -ProjectName [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserEnvironmentDefinition -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserEnvironmentDefinition -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -### List1 -``` -Get-AzDevCenterUserEnvironmentDefinition -Endpoint -CatalogName -ProjectName - [-DefaultProfile ] [] -``` - -### List1ByDevCenter -``` -Get-AzDevCenterUserEnvironmentDefinition -DevCenter -CatalogName -ProjectName - [-DefaultProfile ] [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserEnvironmentDefinition -DevCenter -ProjectName - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Get an environment definition from a catalog. - -## EXAMPLES - -### Example 1: List environment definitions by endpoint and project -```powershell - -``` - -```powershell - 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 -```powershell -Get-AzDevCenterUserEnvironmentDefinition -DevCenter Contoso -ProjectName DevProject -``` - -This command lists environment definitions under the project "DevProject". - -### Example 3: List environment definitions by endpoint, catalog, and project -```powershell -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 -```powershell -Get-AzDevCenterUserEnvironmentDefinition -DevCenter 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 -```powershell -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 -```powershell -Get-AzDevCenterUserEnvironmentDefinition -DevCenter 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 -```powershell -$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 -```powershell -$envInput = @{"CatalogName" = "CentralCatalog"; "ProjectName" = "DevProject"; "DefinitionName" = "Sandbox" } -Get-AzDevCenterUserEnvironmentDefinition -DevCenter Contoso -InputObject $envInput -``` - -This command gets the environment definition "Sandbox" under the project "DevProject" and the catalog "CentralCatalog". - -## PARAMETERS - -### -CatalogName -The name of the catalog - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List1, List1ByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefinitionName -The name of the environment definition - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter, List1ByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity, List, List1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List, List1, List1ByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IEnvironmentDefinition - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironmentType.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironmentType.md deleted file mode 100644 index aa6e44d30957..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserEnvironmentType.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserenvironmenttype -schema: 2.0.0 ---- - -# Get-AzDevCenterUserEnvironmentType - -## SYNOPSIS -Lists all environment types configured for a project. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserEnvironmentType -Endpoint -ProjectName [-DefaultProfile ] - [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserEnvironmentType -DevCenter -ProjectName [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Lists all environment types configured for a project. - -## EXAMPLES - -### Example 1: List environment types by endpoint and project -```powershell -Get-AzDevCenterUserEnvironmentType -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -``` - -This command lists environment types under the project "DevProject". - -### Example 2: List environment types by dev center and project -```powershell -Get-AzDevCenterUserEnvironmentType -DevCenter Contoso -ProjectName DevProject -``` - -This command lists environment types under the project "DevProject". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IEnvironmentType - -## NOTES - -ALIASES - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserPool.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserPool.md deleted file mode 100644 index e545cd797fa4..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserPool.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserpool -schema: 2.0.0 ---- - -# Get-AzDevCenterUserPool - -## SYNOPSIS -Gets a pool - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserPool -Endpoint -ProjectName [-DefaultProfile ] - [] -``` - -### Get -``` -Get-AzDevCenterUserPool -Endpoint -PoolName -ProjectName - [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserPool -DevCenter -PoolName -ProjectName - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserPool -Endpoint -InputObject [-DefaultProfile ] - [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserPool -DevCenter -InputObject [-DefaultProfile ] - [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserPool -DevCenter -ProjectName [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a pool - -## EXAMPLES - -### Example 1: List pools by endpoint -```powershell -Get-AzDevCenterUserPool -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -``` - -This command lists the pools in the project "DevProject". - -### Example 2: List pools by dev center -```powershell -Get-AzDevCenterUserPool -DevCenter Contoso -ProjectName DevProject -``` - -This command lists the pools in the project "DevProject". - -### Example 3: Get pool by endpoint -```powershell -Get-AzDevCenterUserPool -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -PoolName DevPool -``` - -This command gets the pool "DevPool" in the project "DevProject". - -### Example 4: Get pool by dev center -```powershell -Get-AzDevCenterUserPool -DevCenter Contoso -ProjectName DevProject -PoolName DevPool -``` - -This command gets the pool "DevPool" in the project "DevProject". - -### Example 5: Get pool by endpoint and InputObject -```powershell -$devBoxInput = @{"ProjectName" = "DevProject"; "PoolName" = "DevPool" } -Get-AzDevCenterUserPool -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command gets the pool "DevPool" in the project "DevProject". - -### Example 6: Get pool by dev center and InputObject -```powershell -$devBoxInput = @{"ProjectName" = "DevProject"; "PoolName" = "DevPool" } -Get-AzDevCenterUserPool -DevCenter Contoso -InputObject $devBoxInput -``` - -This command gets the pool "DevPool" in the project "DevProject". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PoolName -The name of a pool of Dev Boxes. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter, List, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IPool - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserProject.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserProject.md deleted file mode 100644 index 8b35e822142c..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserProject.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserproject -schema: 2.0.0 ---- - -# Get-AzDevCenterUserProject - -## SYNOPSIS -Gets a project. - -## SYNTAX - -### List (Default) -``` -Get-AzDevCenterUserProject -Endpoint [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzDevCenterUserProject -Endpoint -ProjectName [-DefaultProfile ] - [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserProject -DevCenter -ProjectName [-DefaultProfile ] - [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserProject -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserProject -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -### ListByDevCenter -``` -Get-AzDevCenterUserProject -DevCenter [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a project. - -## EXAMPLES - -### Example 1: List projects by endpoint -```powershell -Get-AzDevCenterUserProject -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -``` - -This command lists the projects under the endpoint. - -### Example 2: List projects by dev center -```powershell -Get-AzDevCenterUserProject -DevCenter Contoso -ProjectName DevProject -``` - -This command lists the projects under the dev center. - -### Example 3: Get project by endpoint -```powershell -Get-AzDevCenterUserProject -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -``` - -This command gets the project "DevProject". - -### Example 4: Get project by dev center -```powershell -Get-AzDevCenterUserProject -DevCenter Contoso -ProjectName DevProject -``` - -This command gets the project "DevProject". - -### Example 5: Get project by endpoint and InputObject -```powershell -$devBoxInput = @{"ProjectName" = "DevProject";} -Get-AzDevCenterUserProject -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command gets the project "DevProject". - -### Example 6: Get project by dev center and InputObject -```powershell -$devBoxInput = @{"ProjectName" = "DevProject";} -Get-AzDevCenterUserProject -DevCenter Contoso -InputObject $devBoxInput -``` - -This command gets the project "DevProject". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter, ListByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity, List -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IProject - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserSchedule.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserSchedule.md deleted file mode 100644 index 8a00e90620c2..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Get-AzDevCenterUserSchedule.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/get-azdevcenteruserschedule -schema: 2.0.0 ---- - -# Get-AzDevCenterUserSchedule - -## SYNOPSIS -Gets a schedule. - -## SYNTAX - -### Get (Default) -``` -Get-AzDevCenterUserSchedule -Endpoint -PoolName -ProjectName - [-DefaultProfile ] [] -``` - -### GetByDevCenter -``` -Get-AzDevCenterUserSchedule -DevCenter -PoolName -ProjectName - [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzDevCenterUserSchedule -Endpoint -InputObject - [-DefaultProfile ] [] -``` - -### GetViaIdentityByDevCenter -``` -Get-AzDevCenterUserSchedule -DevCenter -InputObject - [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a schedule. - -## EXAMPLES - -### Example 1: Get schedule by endpoint -```powershell -Get-AzDevCenterUserSchedule -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -PoolName DevPool -``` - -This command gets the schedule in the pool "DevPool". - -### Example 2: Get schedule by dev center -```powershell -Get-AzDevCenterUserSchedule -DevCenter Contoso -ProjectName DevProject -PoolName DevPool -``` - -This command gets the schedule in the pool "DevPool". - -### Example 3: Get schedule by endpoint and InputObject -```powershell -$devBoxInput = @{"ProjectName" = "DevProject"; "PoolName" = "DevPool" } -Get-AzDevCenterUserSchedule -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command gets the schedule in the pool "DevPool". - -### Example 4: Get schedule by dev center and InputObject -```powershell -$devBoxInput = @{"ProjectName" = "DevProject"; "PoolName" = "DevPool" } -Get-AzDevCenterUserSchedule -DevCenter Contoso -InputObject $devBoxInput -``` - -This command gets the schedule in the pool "DevPool". - -## PARAMETERS - -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: GetByDevCenter, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Get, GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: GetViaIdentity, GetViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PoolName -The name of a pool of Dev Boxes. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Get, GetByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.ISchedule - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Invoke-AzDevCenterUserDelayDevBoxAction.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Invoke-AzDevCenterUserDelayDevBoxAction.md deleted file mode 100644 index eb85c4cfbf40..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Invoke-AzDevCenterUserDelayDevBoxAction.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/invoke-azdevcenteruserdelaydevboxaction -schema: 2.0.0 ---- - -# Invoke-AzDevCenterUserDelayDevBoxAction - -## SYNOPSIS -Delays the occurrence of an action. - -## SYNTAX - -### Delay1 (Default) -``` -Invoke-AzDevCenterUserDelayDevBoxAction -Endpoint -DevBoxName -ProjectName - -DelayTime [-UserId ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### Delay -``` -Invoke-AzDevCenterUserDelayDevBoxAction -Endpoint -ActionName -DevBoxName - -ProjectName -DelayTime [-UserId ] [-DefaultProfile ] [-Confirm] - [-WhatIf] [] -``` - -### Delay1ByDevCenter -``` -Invoke-AzDevCenterUserDelayDevBoxAction -DevCenter -DevBoxName -ProjectName - -DelayTime [-UserId ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] -``` - -### DelayByDevCenter -``` -Invoke-AzDevCenterUserDelayDevBoxAction -DevCenter -ActionName -DevBoxName - -ProjectName -DelayTime [-UserId ] [-DefaultProfile ] [-Confirm] - [-WhatIf] [] -``` - -## DESCRIPTION -Delays the occurrence of an action. - -## EXAMPLES - -### Example 1: Delay all actions on the dev box by endpoint -```powershell -Invoke-AzDevCenterUserDelayDevBoxAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -DevBoxName myDevBox -UserId "me" -ProjectName DevProject -DelayTime "01:30" -``` - -This command delays all actions on the dev box "myDevBox" to the time 1 hour and 30 minutes from the earliest scheduled action. - -### Example 2: Delay all actions on the dev box by dev center -```powershell -Invoke-AzDevCenterUserDelayDevBoxAction -DevCenter Contoso -DevBoxName myDevBox -ProjectName DevProject -DelayTime "02:00" -``` - -This command delays all actions on the dev box "myDevBox" to the time 2 hours from the earliest scheduled action. - -### Example 3: Delay an action on the dev box by endpoint -```powershell -Invoke-AzDevCenterUserDelayDevBoxAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -DevBoxName myDevBox -ProjectName DevProject -ActionName "schedule-default" -DelayTime "00:30" -``` - -This command delays the action "schedule-default" for the dev box "myDevBox" for 30 minutes. - -### Example 4: Delay an action on the dev box by dev center -```powershell -Invoke-AzDevCenterUserDelayDevBoxAction -DevCenter Contoso -DevBoxName myDevBox -UserId "me" -ProjectName DevProject -ActionName "schedule-default" -DelayTime "05:15" -``` - -This command delays the action "schedule-default" for the dev box "myDevBox" for 5 hours and 15 minutes. - -## PARAMETERS - -### -ActionName -The name of an action that will take place on a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Delay, DelayByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelayTime -The delayed timespan from the scheduled action time. -Format HH:MM. - -```yaml -Type: System.TimeSpan -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevBoxName -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Delay1ByDevCenter, DelayByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Delay, Delay1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IDevBoxAction - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IDevBoxActionDelayResult - -## NOTES - -ALIASES - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/New-AzDevCenterUserDevBox.md b/src/DevCenter/DevCenterData.AutoRest/help/help/New-AzDevCenterUserDevBox.md deleted file mode 100644 index 1fecec968aad..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/New-AzDevCenterUserDevBox.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteruserdevbox -schema: 2.0.0 ---- - -# New-AzDevCenterUserDevBox - -## SYNOPSIS -Creates or replaces a Dev Box. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterUserDevBox -Endpoint -Name -ProjectName -PoolName - [-UserId ] [-LocalAdministrator ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-Confirm] [-WhatIf] [] -``` - -### CreateExpandedByDevCenter -``` -New-AzDevCenterUserDevBox -DevCenter -Name -ProjectName -PoolName - [-UserId ] [-LocalAdministrator ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterUserDevBox -Endpoint -InputObject -PoolName - [-LocalAdministrator ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -### CreateViaIdentityExpandedByDevCenter -``` -New-AzDevCenterUserDevBox -DevCenter -InputObject -PoolName - [-LocalAdministrator ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] -``` - -## DESCRIPTION -Creates or replaces a Dev Box. - -## EXAMPLES - -### Example 1: Create a dev box by endpoint -```powershell -New-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -Name myDevBox -PoolName DevPool -``` - -This command creates the dev box "myDevBox" for the user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 2: Create a dev box by dev center -```powershell -New-AzDevCenterUserDevBox -DevCenter Contoso -ProjectName DevProject -UserId "me" -Name myDevBox -PoolName DevPool -``` - -This command creates the dev box "myDevBox" for the currently signed-in user. - -### Example 3: Create a dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -New-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -PoolName DevPool -``` - -This command creates the dev box "myDevBox" for the currently signed-in user. - -### Example 4: Create a dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject" } -New-AzDevCenterUserDevBox -DevCenter Contoso -InputObject $devBoxInput -PoolName DevPool -``` - -This command creates the dev box "myDevBox" for the user "786a823c-8037-48ab-89b8-8599901e67d0". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedByDevCenter, CreateViaIdentityExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: CreateViaIdentityExpanded, CreateViaIdentityExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LocalAdministrator -Indicates whether the owner of the Dev Box is a local administrator. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Support.LocalAdminStatus -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: DevBoxName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PoolName -The name of the Dev Box pool this machine belongs to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.Api20230401.IDevBox - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/New-AzDevCenterUserEnvironment.md b/src/DevCenter/DevCenterData.AutoRest/help/help/New-AzDevCenterUserEnvironment.md deleted file mode 100644 index 3f0f46d78345..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/New-AzDevCenterUserEnvironment.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/new-azdevcenteruserenvironment -schema: 2.0.0 ---- - -# New-AzDevCenterUserEnvironment - -## SYNOPSIS -Creates or updates an environment. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzDevCenterUserEnvironment -Endpoint -Name -ProjectName -CatalogName - -EnvironmentDefinitionName -EnvironmentType [-UserId ] [-Parameter ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateExpandedByDevCenter -``` -New-AzDevCenterUserEnvironment -DevCenter -Name -ProjectName -CatalogName - -EnvironmentDefinitionName -EnvironmentType [-UserId ] [-Parameter ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpanded -``` -New-AzDevCenterUserEnvironment -Endpoint -InputObject -CatalogName - -EnvironmentDefinitionName -EnvironmentType [-Parameter ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### CreateViaIdentityExpandedByDevCenter -``` -New-AzDevCenterUserEnvironment -DevCenter -InputObject -CatalogName - -EnvironmentDefinitionName -EnvironmentType [-Parameter ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Creates or updates an environment. - -## EXAMPLES - -### Example 1: Create an environment by endpoint -```powershell -$functionAppParameters = @{"name" = "testfuncApp" } - -New-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -Name "envtest" -ProjectName DevProject -CatalogName CentralCatalog -EnvironmentDefinitionName FunctionApp -EnvironmentType DevTest -Parameter $functionAppParameters -``` - -This command creates an environment named envtest" to the project "DevProject". - -### Example 2: Create an environment by dev center -```powershell -New-AzDevCenterUserEnvironment -DevCenter Contoso -Name "envtest" -ProjectName DevProject -CatalogName CentralCatalog -EnvironmentDefinitionName Sandbox -EnvironmentType DevTest -``` - -This command creates an environment named envtest" to the project "DevProject". - -### Example 3: Create an environment by endpoint and InputObject -```powershell -$envInput = @{"UserId" = "me"; "ProjectName" = "DevProject"; "EnvironmentName" = "envtest" } - - -New-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $envInput -CatalogName CentralCatalog -EnvironmentDefinitionName Sandbox -EnvironmentType DevTest - -``` - -This command creates an environment named envtest" to the project "DevProject". - -### Example 4: Create an environment by dev center and InputObject -```powershell -$functionAppParameters = @{"name" = "testfuncApp" } -$envInput = @{"UserId" = "me"; "ProjectName" = "DevProject"; "EnvironmentName" = "envtest" } - -New-AzDevCenterUserEnvironment -DevCenter Contoso -InputObject $envInput -CatalogName CentralCatalog -EnvironmentDefinitionName FunctionApp -EnvironmentType DevTest -Parameter $functionAppParameters -``` - -This command creates an environment named envtest" to the project "DevProject". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CatalogName -Name of the catalog. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: CreateExpandedByDevCenter, CreateViaIdentityExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateViaIdentityExpanded -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentDefinitionName -Name of the environment definition. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnvironmentType -Environment type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: CreateViaIdentityExpanded, CreateViaIdentityExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameter -Parameters object for the environment. - -```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded, CreateExpandedByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/README.md b/src/DevCenter/DevCenterData.AutoRest/help/help/README.md deleted file mode 100644 index 6f1c634ec037..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Docs -This directory contains the documentation of the cmdlets for the `Az.DevCenterdata` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `..\examples` folder. - -## Info -- Modifiable: no -- Generated: all -- Committed: yes -- Packaged: yes - -## Details -The process of documentation generation loads `Az.DevCenterdata` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Remove-AzDevCenterUserDevBox.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Remove-AzDevCenterUserDevBox.md deleted file mode 100644 index ae7e24195805..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Remove-AzDevCenterUserDevBox.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteruserdevbox -schema: 2.0.0 ---- - -# Remove-AzDevCenterUserDevBox - -## SYNOPSIS -Deletes a Dev Box. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterUserDevBox -Endpoint -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteByDevCenter -``` -Remove-AzDevCenterUserDevBox -DevCenter -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterUserDevBox -Endpoint -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentityByDevCenter -``` -Remove-AzDevCenterUserDevBox -DevCenter -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a Dev Box. - -## EXAMPLES - -### Example 1: Delete a dev box by endpoint -```powershell -Remove-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -Name myDevBox -``` - -This command deletes the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 2: Delete a dev box by dev center -```powershell -Remove-AzDevCenterUserDevBox -DevCenter Contoso -ProjectName DevProject -UserId "me" -Name myDevBox -``` - -This command deletes the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 3: Delete a dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -Remove-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command deletes the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 4: Delete a dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject" } -Remove-AzDevCenterUserDevBox -DevCenter Contoso -InputObject $devBoxInput -``` - -This command deletes the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: DeleteByDevCenter, DeleteViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: DeleteViaIdentity, DeleteViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteByDevCenter -Aliases: DevBoxName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Remove-AzDevCenterUserEnvironment.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Remove-AzDevCenterUserEnvironment.md deleted file mode 100644 index 0bd70a65e76f..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Remove-AzDevCenterUserEnvironment.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/remove-azdevcenteruserenvironment -schema: 2.0.0 ---- - -# Remove-AzDevCenterUserEnvironment - -## SYNOPSIS -Deletes an environment and all its associated resources - -## SYNTAX - -### Delete (Default) -``` -Remove-AzDevCenterUserEnvironment -Endpoint -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteByDevCenter -``` -Remove-AzDevCenterUserEnvironment -DevCenter -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentity -``` -Remove-AzDevCenterUserEnvironment -Endpoint -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### DeleteViaIdentityByDevCenter -``` -Remove-AzDevCenterUserEnvironment -DevCenter -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes an environment and all its associated resources - -## EXAMPLES - -### Example 1: Delete an environment by endpoint -```powershell -Remove-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId "me" -Name myEnv -``` - -This command deletes the environment "myEnv" under the project "DevProject" assigned to the currently signed-in user. - -### Example 2: Delete an environment by dev center -```powershell -Remove-AzDevCenterUserEnvironment -DevCenter Contoso -ProjectName DevProject -UserId "786a823c-8037-48ab-89b8-8599901e67d0" -Name myEnv -``` - -This command deletes the environment "myEnv" under the project "DevProject" assigned to the user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 3: Delete an environment by endpoint and InputObject -```powershell -$envInput = @{"UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject"; "EnvironmentName" = "myEnv" } -Remove-AzDevCenterUserEnvironment -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $envInput -``` - -This command deletes the environment "myEnv" under the project "DevProject" assigned to the user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 4: Delete an environment by dev center and InputObject -```powershell -$envInput = @{"UserId" = "me"; "ProjectName" = "DevProject"; "EnvironmentName" = "myEnv" } -Remove-AzDevCenterUserEnvironment -DevCenter Contoso -InputObject $envInput -``` - -This command deletes the environment "myEnv" under the project "DevProject" assigned to the currently signed-in user. - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: DeleteByDevCenter, DeleteViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: DeleteViaIdentity, DeleteViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the environment. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteByDevCenter -Aliases: EnvironmentName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Delete, DeleteByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Restart-AzDevCenterUserDevBox.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Restart-AzDevCenterUserDevBox.md deleted file mode 100644 index 7ef91aab3864..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Restart-AzDevCenterUserDevBox.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/restart-azdevcenteruserdevbox -schema: 2.0.0 ---- - -# Restart-AzDevCenterUserDevBox - -## SYNOPSIS -Restarts a Dev Box - -## SYNTAX - -### Restart (Default) -``` -Restart-AzDevCenterUserDevBox -Endpoint -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### RestartByDevCenter -``` -Restart-AzDevCenterUserDevBox -DevCenter -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### RestartViaIdentity -``` -Restart-AzDevCenterUserDevBox -Endpoint -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### RestartViaIdentityByDevCenter -``` -Restart-AzDevCenterUserDevBox -DevCenter -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Restarts a Dev Box - -## EXAMPLES - -### Example 1: Restart a dev box by endpoint -```powershell -Restart-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -Name myDevBox -``` - -This command restarts the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 2: Restart a dev box by dev center -```powershell -Restart-AzDevCenterUserDevBox -DevCenter Contoso -ProjectName DevProject -UserId "me" -Name myDevBox -``` - -This command restarts the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 3: Restart a dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -Restart-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command restarts the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 4: Restart a dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject" } -Restart-AzDevCenterUserDevBox -DevCenter Contoso -InputObject $devBoxInput -``` - -This command restarts the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: RestartByDevCenter, RestartViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Restart, RestartViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: RestartViaIdentity, RestartViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Restart, RestartByDevCenter -Aliases: DevBoxName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Restart, RestartByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Restart, RestartByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Skip-AzDevCenterUserDevBoxAction.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Skip-AzDevCenterUserDevBoxAction.md deleted file mode 100644 index 1572d9fe5da3..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Skip-AzDevCenterUserDevBoxAction.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/skip-azdevcenteruserdevboxaction -schema: 2.0.0 ---- - -# Skip-AzDevCenterUserDevBoxAction - -## SYNOPSIS -Skips an occurrence of an action. - -## SYNTAX - -### Skip (Default) -``` -Skip-AzDevCenterUserDevBoxAction -Endpoint -ActionName -DevBoxName - -ProjectName [-UserId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### SkipByDevCenter -``` -Skip-AzDevCenterUserDevBoxAction -DevCenter -ActionName -DevBoxName - -ProjectName [-UserId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### SkipViaIdentity -``` -Skip-AzDevCenterUserDevBoxAction -Endpoint -InputObject - [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -### SkipViaIdentityByDevCenter -``` -Skip-AzDevCenterUserDevBoxAction -DevCenter -InputObject - [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Skips an occurrence of an action. - -## EXAMPLES - -### Example 1: Skip an action on the dev box by endpoint -```powershell -Skip-AzDevCenterUserDevBoxAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -DevBoxName myDevBox -ProjectName DevProject -ActionName "schedule-default" -``` - -This command skips the action "schedule-default" for the dev box "myDevBox". - -### Example 2: Skip an action on the dev box by dev center -```powershell -Skip-AzDevCenterUserDevBoxAction -DevCenter Contoso -DevBoxName myDevBox -ProjectName DevProject -ActionName "schedule-default" -``` - -This command skips the action "schedule-default" for the dev box "myDevBox". - -### Example 3: Skip an action on the dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject"; "ActionName" = "schedule-default"} -Skip-AzDevCenterUserDevBoxAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command skips the action "schedule-default" for the dev box "myDevBox". - -### Example 4: Skip an action on the dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject"; "ActionName" = "schedule-default"} -Skip-AzDevCenterUserDevBoxAction -DevCenter Contoso -InputObject $devBoxInput -``` - -This command skips the action "schedule-default" for the dev box "myDevBox". - -## PARAMETERS - -### -ActionName -The name of an action that will take place on a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Skip, SkipByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevBoxName -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Skip, SkipByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: SkipByDevCenter, SkipViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Skip, SkipViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: SkipViaIdentity, SkipViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns true when the command succeeds - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Skip, SkipByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Skip, SkipByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Start-AzDevCenterUserDevBox.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Start-AzDevCenterUserDevBox.md deleted file mode 100644 index 4632d9b136df..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Start-AzDevCenterUserDevBox.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/start-azdevcenteruserdevbox -schema: 2.0.0 ---- - -# Start-AzDevCenterUserDevBox - -## SYNOPSIS -Starts a Dev Box - -## SYNTAX - -### Start (Default) -``` -Start-AzDevCenterUserDevBox -Endpoint -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### StartByDevCenter -``` -Start-AzDevCenterUserDevBox -DevCenter -Name -ProjectName [-UserId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### StartViaIdentity -``` -Start-AzDevCenterUserDevBox -Endpoint -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### StartViaIdentityByDevCenter -``` -Start-AzDevCenterUserDevBox -DevCenter -InputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Starts a Dev Box - -## EXAMPLES - -### Example 1: Start a dev box by endpoint -```powershell -Start-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -Name myDevBox -``` - -This command starts the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 2: Start a dev box by dev center -```powershell -Start-AzDevCenterUserDevBox -DevCenter Contoso -ProjectName DevProject -UserId "me" -Name myDevBox -``` - -This command starts the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 3: Start a dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -Start-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command starts the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 4: Start a dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject" } -Start-AzDevCenterUserDevBox -DevCenter Contoso -InputObject $devBoxInput -``` - -This command starts the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: StartByDevCenter, StartViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Start, StartViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: StartViaIdentity, StartViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Start, StartByDevCenter -Aliases: DevBoxName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Start, StartByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Start, StartByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS - diff --git a/src/DevCenter/DevCenterData.AutoRest/help/help/Stop-AzDevCenterUserDevBox.md b/src/DevCenter/DevCenterData.AutoRest/help/help/Stop-AzDevCenterUserDevBox.md deleted file mode 100644 index c5f51d0e6bcf..000000000000 --- a/src/DevCenter/DevCenterData.AutoRest/help/help/Stop-AzDevCenterUserDevBox.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: -Module Name: Az.DevCenterdata -online version: https://learn.microsoft.com/powershell/module/az.devcenter/stop-azdevcenteruserdevbox -schema: 2.0.0 ---- - -# Stop-AzDevCenterUserDevBox - -## SYNOPSIS -Stops a Dev Box - -## SYNTAX - -### Stop (Default) -``` -Stop-AzDevCenterUserDevBox -Endpoint -Name -ProjectName [-UserId ] - [-Hibernate] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### StopByDevCenter -``` -Stop-AzDevCenterUserDevBox -DevCenter -Name -ProjectName [-UserId ] - [-Hibernate] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### StopViaIdentity -``` -Stop-AzDevCenterUserDevBox -Endpoint -InputObject [-Hibernate] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -### StopViaIdentityByDevCenter -``` -Stop-AzDevCenterUserDevBox -DevCenter -InputObject [-Hibernate] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Stops a Dev Box - -## EXAMPLES - -### Example 1: Stop a dev box by endpoint -```powershell -Stop-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -Name myDevBox -``` - -This command stops the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -### Example 2: Stop a dev box by dev center -```powershell -Stop-AzDevCenterUserDevBox -DevCenter Contoso -ProjectName DevProject -UserId "me" -Name myDevBox -``` - -This command stops the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 3: Stop a dev box by endpoint and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" } -Stop-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput -``` - -This command stops the dev box "myDevBox" assigned to the currently signed-in user. - -### Example 4: Stop a dev box by dev center and InputObject -```powershell -$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject" } -Stop-AzDevCenterUserDevBox -DevCenter Contoso -InputObject $devBoxInput -``` - -This command stops the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0". - -## PARAMETERS - -### -AsJob -Run the command as a job - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevCenter -The DevCenter upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: StopByDevCenter, StopViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Endpoint -The DevCenter-specific URI to operate on. - -```yaml -Type: System.String -Parameter Sets: Stop, StopViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Hibernate -Optional parameter to hibernate the dev box. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity -Parameter Sets: StopViaIdentity, StopViaIdentityByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of a Dev Box. - -```yaml -Type: System.String -Parameter Sets: Stop, StopByDevCenter -Aliases: DevBoxName - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait -Run the command asynchronously - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProjectName -The DevCenter Project upon which to execute operations. - -```yaml -Type: System.String -Parameter Sets: Stop, StopByDevCenter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The AAD object id of the user. -If value is 'me', the identity is taken from the authentication context. - -```yaml -Type: System.String -Parameter Sets: Stop, StopByDevCenter -Aliases: - -Required: False -Position: Named -Default value: "me" -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Models.IDevCenterdataIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[ActionName ]`: The name of an action that will take place on a Dev Box. - - `[CatalogName ]`: The name of the catalog - - `[DefinitionName ]`: The name of the environment definition - - `[DevBoxName ]`: The name of a Dev Box. - - `[EnvironmentName ]`: The name of the environment. - - `[Id ]`: Resource identity path - - `[PoolName ]`: The name of a pool of Dev Boxes. - - `[ProjectName ]`: The DevCenter Project upon which to execute operations. - - `[ScheduleName ]`: The name of a schedule. - - `[UserId ]`: The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. - -## RELATED LINKS -