Edit

Share via


Set-SPOMigrationPackageAzureSource

Cmdlet to create Azure containers, upload migration package files into the appropriate containers and snapshot the uploaded content.

Syntax

ImplicitSourceExplicitAzure

Set-SPOMigrationPackageAzureSource
    -MigrationSourceLocations <MigrationPackageLocation>
    -AccountName <String>
    -AccountKey <String>
    [-FileContainerName <String>]
    [-PackageContainerName <String>]
    [-AzureQueueName <String>]
    [-EncryptionParameters <EncryptionParameters>]
    [-NoUpload]
    [-NoSnapshotCreation]
    [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>]
    [-NoLogFile]
    [-Overwrite]
    [-ParallelUpload]
    [<CommonParameters>]

ImplicitSourceImplicitAzure

Set-SPOMigrationPackageAzureSource
    -MigrationSourceLocations <MigrationPackageLocation>
    -MigrationPackageAzureLocations <MigrationPackageAzureLocations>
    [-EncryptionParameters <EncryptionParameters>]
    [-NoUpload]
    [-NoSnapshotCreation]
    [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>]
    [-NoLogFile]
    [-Overwrite]
    [-ParallelUpload]
    [<CommonParameters>]

ExplicitSourceExplicitAzure

Set-SPOMigrationPackageAzureSource
    -SourceFilesPath <String>
    -SourcePackagePath <String>
    -AccountName <String>
    -AccountKey <String>
    [-FileContainerName <String>]
    [-PackageContainerName <String>]
    [-AzureQueueName <String>]
    [-EncryptionParameters <EncryptionParameters>]
    [-NoUpload]
    [-NoSnapshotCreation]
    [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>]
    [-NoLogFile]
    [-Overwrite]
    [-ParallelUpload]
    [<CommonParameters>]

ExplicitSourceImplicitAzure

Set-SPOMigrationPackageAzureSource
    -SourceFilesPath <String>
    -SourcePackagePath <String>
    -MigrationPackageAzureLocations <MigrationPackageAzureLocations>
    [-EncryptionParameters <EncryptionParameters>]
    [-NoUpload]
    [-NoSnapshotCreation]
    [-EncryptionMetaInfo <MigrationFileEncryptionInfo[]>]
    [-NoLogFile]
    [-Overwrite]
    [-ParallelUpload]
    [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

This cmdlet returns a Microsoft.Online.SharePoint.Migration. MigrationPackageAzureLocations object, which can be used as a source for this cmdlet or, more commonly, as a source for the Submit-SPOMigrationJob cmdlet.

Examples

EXAMPLE 1

$azurelocations = Set-SPOMigrationPackageAzureSource -SourcePath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_TgtPkg -FileContainerUri migration-files -PackageContainerUri migration-package -AccountName migrationstore -AccountKey "nmcXQ+1NctB7BlRVm+8+qWUn6GUFIH7E5ZQPThcjg8SfFWTJ34HthyOEoROwxHYIajpOYxYDt7qUwSEBQlLWoA=="

This example creates migration package containers in Azure storage using the supplied account credentials, uploads the package files into them, snapshots the files and lastly returns the connection strings to a PowerShell variable.

EXAMPLE 2

Set-SPOMigrationPackageAzureSource -SourcePath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_TgtPkg -MigrationPackageAzureLocations $azurelocations -AccountName migrationstore -AccountKey "nmcXQ+1NctB7BlRVm+8+qWUn6GUFIH7E5ZQPThcjg8SfFWTJ34HthyOEoROwxHYIajpOYxYDt7qUwSEBQlLWoA==" -NoUpload

This example uses existing migration package containers in Azure storage to snapshot previously uploaded files and then returns the connection strings to a PowerShell variable.

Parameters

-AccountKey

Applicable: SharePoint Online

The account key for the Azure Storage account.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ImplicitSourceExplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceExplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AccountName

Applicable: SharePoint Online

The account name for the Azure Storage account.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ImplicitSourceExplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceExplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AzureQueueName

Applicable: SharePoint Online

An optional name of the Azure Storage Reporting Queue where import operations lists events during import. This value must be in lower case and conform to Azure's queue naming rules.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ImplicitSourceExplicitAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceExplicitAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EncryptionMetaInfo

Applicable: SharePoint Online

PARAMVALUE: MigrationFileEncryptionInfo[]

Parameter properties

Type:

Microsoft.Online.SharePoint.Migration.MigrationFileEncryptionInfo[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EncryptionParameters

Applicable: SharePoint Online

An EncryptionParameters object. See New-SPOMigrationEncryptionParameters for more information.

Parameter properties

Type:Microsoft.Online.SharePoint.Migration.EncryptionParameters
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FileContainerName

Applicable: SharePoint Online

The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package content files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format <GUID>-files.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ImplicitSourceExplicitAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceExplicitAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MigrationPackageAzureLocations

Applicable: SharePoint Online

A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the Set-SPOMigrationPackageAzureSource

Parameter properties

Type:Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ImplicitSourceImplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceImplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MigrationSourceLocations

Applicable: SharePoint Online

Possible Source locations to migrate.

Parameter properties

Type:Microsoft.Online.SharePoint.Migration.MigrationPackageLocation
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ImplicitSourceExplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ImplicitSourceImplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoLogFile

Applicable: SharePoint Online

Indicates to not create a log file. The default is to create a new CopyMigrationPackage log file within the directory specified within the SourcePackagePath parameter.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoSnapshotCreation

Applicable: SharePoint Online

Indicates to not perform snapshots on the content in the containers. The default is to snapshot each of the packages files in the containers.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoUpload

Applicable: SharePoint Online

Indicates to not upload the package files. The default is to upload all the package files.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Overwrite

Applicable: SharePoint Online

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PackageContainerName

Applicable: SharePoint Online

The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package metadata files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format <GUID>-package.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ImplicitSourceExplicitAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceExplicitAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParallelUpload

{{ Fill ParallelUpload Description }}

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceFilesPath

Applicable: SharePoint Online

The directory ___location where the package's source content files exist.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ExplicitSourceExplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceImplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourcePackagePath

Applicable: SharePoint Online

The directory ___location where the package's metadata files exist.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ExplicitSourceExplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ExplicitSourceImplicitAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object