Edit

Share via

Start-AzureSqlDatabaseImport

Module:
Azure Module

Starts an import operation from blob storage to an Azure SQL Database.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

ByContainerObject 

Start-AzureSqlDatabaseImport
    -SqlConnectionContext <ISqlServerConnectionInformation>
    -StorageContainer <AzureStorageContainer>
    -DatabaseName <String>
    -BlobName <String>
    [-Edition <DatabaseEdition>]
    [-DatabaseMaxSize <Int32>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

ByContainerName 

Start-AzureSqlDatabaseImport
    -SqlConnectionContext <ISqlServerConnectionInformation>
    -StorageContext <IStorageContext>
    -StorageContainerName <String>
    -DatabaseName <String>
    -BlobName <String>
    [-Edition <DatabaseEdition>]
    [-DatabaseMaxSize <Int32>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Start-AzureSqlDatabaseImport cmdlet starts an import operation from Azure Blob storage to an Azure SQL Database. If the database does not exist, this cmdlet creates it by using the size and edition values that you specify. The operation requires a database server connection context. Use the Get-AzureSqlDatabaseImportExportStatus cmdlet to get the status of the import operation.

Examples

Example 1: Import a database

PS C:\>$Credential = Get-Credential
PS C:\> $SqlContext = New-AzureSqlDatabaseServerContext -ServerName $ServerName -Credentials $Credential
PS C:\> $StorageContext = New-AzureStorageContext -StorageAccountName $StorageName -StorageAccountKey $StorageKey
PS C:\> $Container = Get-AzureStorageContainer -Name $ContainerName -Context $StorageContext
PS C:\> $ImportRequest = Start-AzureSqlDatabaseImport -SqlConnectionContext $SqlContext -StorageContainer $Container -DatabaseName $DatabaseName -BlobName $BlobName

This example initiates an import process from the Blob storage in the $BlobName variable into the Azure SQL Database named DatabaseName.

Parameters

-BlobName

Specifies the name of the Azure Blob storage from which this cmdlet imports the database.

Parameter properties

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

Parameter sets

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

-DatabaseMaxSize

Specifies the maximum size, in gigabytes, for the database. If the database does not exist, this cmdlet creates it based on this maximum size. The acceptable values differ based on edition.

Parameter properties

Type:Int32
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

-DatabaseName

Specifies a name for the database. If the database does not exist, this cmdlet creates it, and assigns the name that this parameter specifies.

Parameter properties

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

Parameter sets

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

-Edition

Specifies the edition of the database. If the database does not exist, this cmdlet creates it as this edition. Valid values are:

  • None
  • Web
  • Business
  • Basic
  • Standard
  • Premium

The default is Web.

Parameter properties

Type:DatabaseEdition
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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Parameter properties

Type:AzureSMProfile
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

-SqlConnectionContext

Specifies the connection context of a server that contains the database.

Parameter properties

Type:ISqlServerConnectionInformation
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-StorageContainer

Specifies the storage container that contains the Blob from which this cmdlet imports a database.

Parameter properties

Type:AzureStorageContainer
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-StorageContainerName

Specifies the name of the Blob storage container.

Parameter properties

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

Parameter sets

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

-StorageContext

Specifies the context of the Blob storage container.

Parameter properties

Type:IStorageContext
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByContainerName
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.

Outputs

Microsoft.WindowsAzure.Commands.SqlDatabase.Services.ImportExportRequest