New-DBPoolContainer

SYNOPSIS

The New-DBPoolContainer function is used to create a new container from the DBPool API.

SYNTAX

New-DBPoolContainer [-ContainerName] <String> [-ParentId <Int32>] [-ParentName <String>]
 [-ParentDefaultDatabase <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function creates a new container in the DBPool based on the provided container name and parent container information. The ContainerName parameter is mandatory, and at least one of the parent parameters (ParentId, ParentName, or ParentDefaultDatabase) must be specified.

EXAMPLES

EXAMPLE 1

New-DBPoolContainer -ContainerName 'MyNewContainer' -ParentId 12345

This will create a new container named 'MyNewContainer' based on the parent container with ID 12345.

EXAMPLE 2

Get-DBPoolContainer -ParentContainer -Id 1 | New-DBPoolContainer -ContainerName 'MyNewContainer'

This will create a new container named 'MyNewContainer' based on the piped in parent container.

PARAMETERS

-ContainerName

The name for the new container.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ParentId

The ID of the parent container to clone.

Type: Int32
Parameter Sets: (All)
Aliases: Id

Required: False
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ParentName

The name of the parent container to clone.

Type: String
Parameter Sets: (All)
Aliases: Name

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ParentDefaultDatabase

The default database of the parent container to clone.

Type: String
Parameter Sets: (All)
Aliases: DefaultDatabase

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Force

Force the operation without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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.

INPUTS

[string] - ContainerName