Remove-AzureSqlJobChildTarget

  • Reference
Module:
ElasticDatabaseJobs

Removes a child target from another target.

Syntax

Remove-AzureSqlJobChildTarget
      -CustomCollectionName <String>
      -TargetId <Guid[]>
      [[-AzureSqlJobConnection] <AzureSqlJobConnection>]
      [<CommonParameters>]
Remove-AzureSqlJobChildTarget
      -CustomCollectionName <String>
      -ServerName <String[]>
      -DatabaseName <String[]>
      [-LiteralServerName]
      [[-AzureSqlJobConnection] <AzureSqlJobConnection>]
      [<CommonParameters>]

Description

The Remove-AzureSqlJobChildTarget cmdlet removes a child target from another target. This cmdlet removes the child target from a custom collection, but it does not delete the target.

Examples

Example 1: Remove a database target as a child target from a custom collection

PS C:\>Remove-AzureSqlJobChildTarget -CustomCollectionName "MyCustomCollection" -ServerName "MyServer.database.contoso.net" -DatabaseName "MyDatabase"

This command removes the database target named MyServer.database.contoso.net as a child target from the custom collection named MyCustomCollection.

Parameters

-AzureSqlJobConnection

Specifies the connection state object for the job. You can get the connection state object through the New-AzureSqlJobConnection cmdlet. If you do not specify this parameter, the connection state is used from a prior call to the Use-AzureSqlJobConnection cmdlet.

Type:AzureSqlJobConnection
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CustomCollectionName

Specifies the name of the custom collection.

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

-DatabaseName

Specifies an array that contains the database name of the database target to remove from the custom collection.

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

-LiteralServerName

{{Fill LiteralServerName Description}}

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

-ServerName

Specifies an array that contains the database server name of the database target to remove from the custom collection.

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

-TargetId

Specifies an array of GUIDs that contains the target ID to remove from the custom collection.

Type:Guid[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False