SQL Clone 3

New-SqlCloneMask

New-SqlCloneMask

Creates an ModificationScript masking modification for consumption by New-SqlCloneImage.

Syntax

New-SqlCloneMask [-Content] <string> [-Name <string>] [<CommonParameters>]

New-SqlCloneMask [-Path] <string> [-Name <string>] [<CommonParameters>]

Description

The New-SqlCloneMask cmdlet creates a simple data object containing the details needed for Clone to perform an image masking modification.

This cmdlet returns an ModificationScript which can be passed to the New-SqlCloneImage cmdlet's Modifications parameter.

Parameters

-Content <System.String>

Specifies the plaintext masking set data to use in this modification.

Connection details and credentials in the masking set data will be automatically replaced by Clone.

Aliases None
Required? true
Position? 1
Default Value None
Accept Pipeline Input true (ByValue)
Accept Wildcard Characters false

-Path <System.String>

Specifies the path to a masking set file (normally *.DMSMaskSet) or a mask plan file (normally *.maskplan) to use in this modification.

Connection details and credentials in the masking set data will be automatically replaced by Clone.

Aliases None
Required? true
Position? 1
Default Value None
Accept Pipeline Input true (ByValue)
Accept Wildcard Characters false

-Name <System.String>

Names this modification step for logging and display purposes.

Aliases None
Required? false
Position? named
Default Value None
Accept Pipeline Input false
Accept Wildcard Characters false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    Specifies the plaintext masking set data to use in this modification.

    Connection details and credentials in the masking set data will be automatically replaced by Clone.

  • System.String

    Specifies the path to a masking set file (normally *.DMSMaskSet) or a mask plan file (normally *.maskplan) to use in this modification.

    Connection details and credentials in the masking set data will be automatically replaced by Clone.

Return values

The output type is the type of the objects that the cmdlet emits.

  • RedGate.SqlClone.Api.ScriptRunning.ModificationScript

Examples

---------- EXAMPLE 1 ----------

$myMaskingModification = New-SqlCloneMask -Path '\\red-gate\data-masking\production.dmsmaskset' -Name 'Production Mask'

This example creates a masking modification object that can be provided to the -Modifications parameter of New-SqlCloneImage.

---------- EXAMPLE 2 ----------

$myMaskingModification = New-SqlCloneMask -Path '\\red-gate\data-masking\production.maskplan' -Name 'Production Mask'

This example creates a masking modification object that can be provided to the -Modifications parameter of New-SqlCloneImage.


Didn't find what you were looking for?