AdMigrationPlanBuilder

Edit on GitHub

Namespace ADPlayground.Migrations.Core

Assembly ADPlayground

Source ADPlayground/Migrations/Core/AdMigrationPlanBuilder.cs:8

Modifiers sealed

Builds typed Active Directory migration plan requests from reusable C# code or thin scripting surfaces.

Inheritance

Object
AdMigrationPlanBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Method AdMigrationPlanBuilder.Add
Method AdMigrationPlanBuilder.AddComputer
Method AdMigrationPlanBuilder.AddGroup
Method AdMigrationPlanBuilder.AddResource
Method AdMigrationPlanBuilder.AddUser

Constructors

public AdMigrationPlanBuilder(AdMigrationDefaults defaults) #

ADPlayground/Migrations/Core/AdMigrationPlanBuilder.cs:8

Initializes a new instance of the AdMigrationPlanBuilder class.

Parameters

defaults ADPlayground.Migrations.Core.AdMigrationDefaults requiredposition: 0: Default migration context.

Methods

public AdMigrationPlanBuilder Add(AdMigrationItem item) #

ADPlayground/Migrations/Core/AdMigrationPlanBuilder.cs:32

Returns: AdMigrationPlanBuilder

Adds an already constructed migration item.

Parameters

item ADPlayground.Migrations.Core.AdMigrationItem requiredposition: 0: Migration item.

Returns

The current builder.

public AdMigrationPlanBuilder AddComputer(String sourceSamAccountName, String destinationSamAccountName = null, Func<AdMigrationPrincipalItem, AdMigrationPrincipalItem> configure = null)

ADPlayground/Migrations/Core/AdMigrationPlanBuilder.cs:78

Returns: AdMigrationPlanBuilder

Adds a computer migration item.

Parameters

sourceSamAccountName System.String requiredposition: 0: Source computer SAM account name.
destinationSamAccountName System.String = null optionalposition: 1: Destination computer SAM account name. Defaults to the source name.
configure System.Func{ADPlayground.Migrations.Core.AdMigrationPrincipalItem,ADPlayground.Migrations.Core.AdMigrationPrincipalItem} = null optionalposition: 2: Optional item customizer.

Returns

The current builder.

public AdMigrationPlanBuilder AddGroup(String sourceSamAccountName, String destinationSamAccountName = null, Func<AdMigrationPrincipalItem, AdMigrationPrincipalItem> configure = null)

ADPlayground/Migrations/Core/AdMigrationPlanBuilder.cs:65

Returns: AdMigrationPlanBuilder

Adds a group migration item.

Parameters

sourceSamAccountName System.String requiredposition: 0: Source SAM account name.
destinationSamAccountName System.String = null optionalposition: 1: Destination SAM account name. Defaults to the source name.
configure System.Func{ADPlayground.Migrations.Core.AdMigrationPrincipalItem,ADPlayground.Migrations.Core.AdMigrationPrincipalItem} = null optionalposition: 2: Optional item customizer.

Returns

The current builder.

public AdMigrationPlanBuilder AddResource(String path, AdMigrationResourceReAclMode mode = ReportOnly) #

ADPlayground/Migrations/Core/AdMigrationPlanBuilder.cs:87

Returns: AdMigrationPlanBuilder

Adds a resource ACL migration item.

Parameters

path System.String requiredposition: 0: Resource path.
mode ADPlayground.Migrations.Core.AdMigrationResourceReAclMode = ReportOnly optionalposition: 1: Resource re-ACL mode.

Returns

The current builder.

public AdMigrationPlanBuilder AddUser(String sourceSamAccountName, String destinationSamAccountName = null, Func<AdMigrationPrincipalItem, AdMigrationPrincipalItem> configure = null)

ADPlayground/Migrations/Core/AdMigrationPlanBuilder.cs:52

Returns: AdMigrationPlanBuilder

Adds a user migration item.

Parameters

sourceSamAccountName System.String requiredposition: 0: Source SAM account name.
destinationSamAccountName System.String = null optionalposition: 1: Destination SAM account name. Defaults to the source name.
configure System.Func{ADPlayground.Migrations.Core.AdMigrationPrincipalItem,ADPlayground.Migrations.Core.AdMigrationPrincipalItem} = null optionalposition: 2: Optional item customizer.