Edit

Share via

New-AzSqlDatabaseExport

  • Reference
Module:
Az.Sql

Exports an Azure SQL Database as a .bacpac file to a storage account.

Syntax

PowerShell 
New-AzSqlDatabaseExport
   [-DatabaseName] <String>
   [-ServerName] <String>
   -StorageKeyType <StorageKeyType>
   -StorageKey <String>
   -StorageUri <Uri>
   -AdministratorLogin <String>
   -AdministratorLoginPassword <SecureString>
   [-AuthenticationType <AuthenticationType>]
   [-UseNetworkIsolation <Boolean>]
   [-StorageAccountResourceIdForPrivateLink <String>]
   [-SqlServerResourceIdForPrivateLink <String>]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzSqlDatabaseExport cmdlet exports an Azure SQL Database as a .bacpac file to a storage account. The get export database status request may be sent to retrieve status information for this request. This cmdlet is also supported by the SQL Server Stretch Database service on Azure.

Important

In order to make use of this cmdlet the firewall on the Azure SQL Server will need to be configured to "Allow Azure services and resources to access this server". If this is not configured then GatewayTimeout errors will be experienced.

Examples

Example 1: Create an export request for a database

PowerShell 
New-AzSqlDatabaseExport -ResourceGroupName "RG01" -ServerName "Server01" -DatabaseName "Database01" -StorageKeyType "StorageAccessKey" -StorageKey "StorageKey01" -StorageUri "http://account01.blob.core.contoso.net/bacpacs/database01.bacpac" -AdministratorLogin "User" -AdministratorLoginPassword "secure password"

ResourceGroupName          : RG01
ServerName                 : Server01
DatabaseName               : Database01
StorageKeyType             : StorageAccessKey
StorageKey                 : 
StorageUri                 : http://account01.blob.core.contoso.net/bacpacs/database01.bacpac
AdministratorLogin         : User
AdministratorLoginPassword : 
AuthenticationType         : None
OperationStatusLink        : https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource01/providers/Microsoft.Sql/servers/server01/databases/database01/importExportOperationResults/00000000-00
                             0-0000-0000-000000000000?api-version=2014-04-01
Status                     : InProgress
ErrorMessage               :

This command creates an export request for the specified database.

Parameters

-AdministratorLogin

Specifies the name of the SQL administrator.

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

-AdministratorLoginPassword

Specifies the password of the SQL administrator.

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

-AuthenticationType

Specifies the type of authentication used to access the server. The default value is SQL if no authentication type is set. The acceptable values for this parameter are:

  • Sql. SQL authentication. Set the AdministratorLogin and AdministratorLoginPassword to the SQL administrator username and password.
  • ADPassword. Microsoft Entra authentication. Set AdministratorLogin and AdministratorLoginPassword to the Microsoft Entra administrator username and password. This parameter is only available on SQL Database V12 servers.
Type:AuthenticationType
Accepted values:None, Sql, AdPassword, ManagedIdentity
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DatabaseName

Specifies the name of the SQL Database.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group for the SQL Database server.

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

-ServerName

Specifies the name of the SQL Database server.

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

-SqlServerResourceIdForPrivateLink

The sql server resource id to create private link

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

-StorageAccountResourceIdForPrivateLink

The storage account resource id to create private link

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

-StorageKey

Specifies the access key for the storage account.

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

-StorageKeyType

Specifies the type of access key for the storage account. The acceptable values for this parameter are:

  • StorageAccessKey. This value uses a storage account key.
  • SharedAccessKey. This value uses a Shared Access Signature (SAS) key.
Type:StorageKeyType
Accepted values:StorageAccessKey, SharedAccessKey, ManagedIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-StorageUri

Specifies the blob link, as a URL, to the .bacpac file.

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

-UseNetworkIsolation

If set, will create private link for storage account and/or SQL server

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

Outputs

Notes

  • Keywords: azure, azurerm, arm, resource, management, manager, sql, database, mssql