SqlAzureDacpacDeployment@1 - Azure SQL Database deployment v1 タスク

このタスクを使用して、DACPAC を使用して Azure SQL Database をデプロイするか、SQLCMD を使用してスクリプトを実行します。

構文

# Azure SQL Database deployment v1
# Deploy an Azure SQL Database using DACPAC or run scripts using SQLCMD.
- task: SqlAzureDacpacDeployment@1
  inputs:
    #azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Service Connection Type. Default: ConnectedServiceNameARM.
    #azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription. 
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. Azure Subscription. 
  # SQL Database
    AuthenticationType: 'server' # 'server' | 'aadAuthenticationPassword' | 'aadAuthenticationIntegrated' | 'connectionString' | 'servicePrincipal'. Required. Authentication Type. Default: server.
    #ServerName: # string. Required when AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal. Azure SQL Server. 
    #DatabaseName: # string. Required when AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal. Database. 
    SqlUsername: # string. Required when AuthenticationType = server. Login. 
    SqlPassword: # string. Required when AuthenticationType = server. Password. 
    #aadSqlUsername: # string. Required when AuthenticationType = aadAuthenticationPassword. Login. 
    #aadSqlPassword: # string. Required when AuthenticationType = aadAuthenticationPassword. Password. 
    #ConnectionString: # string. Required when AuthenticationType = connectionString. Connection String. 
  # Deployment Package
    deployType: 'DacpacTask' # 'DacpacTask' | 'SqlTask' | 'InlineSqlTask'. Alias: TaskNameSelector. Required. Deploy type. Default: DacpacTask.
    DeploymentAction: 'Publish' # 'Publish' | 'Extract' | 'Export' | 'Import' | 'Script' | 'DriftReport' | 'DeployReport'. Required when TaskNameSelector = DacpacTask. Action. Default: Publish.
    #DacpacFile: # string. Required when DeploymentAction = Publish || DeploymentAction = Script || DeploymentAction = DeployReport. DACPAC File. 
    #BacpacFile: # string. Required when DeploymentAction = Import. BACPAC File. 
    #SqlFile: # string. Required when TaskNameSelector = SqlTask. SQL Script. 
    #SqlInline: # string. Required when TaskNameSelector = InlineSqlTask. Inline SQL Script. 
    #PublishProfile: # string. Optional. Use when TaskNameSelector = DacpacTask || DeploymentAction = Script || DeploymentAction = DeployReport. Publish Profile. 
    #AdditionalArguments: # string. Optional. Use when TaskNameSelector = DacpacTask || DeploymentAction = Extract || DeploymentAction = Export || DeploymentAction = Import || DeploymentAction = Script || DeploymentAction = DeployReport || DeploymentAction = DriftReport. Additional SqlPackage.exe Arguments. 
    #SqlAdditionalArguments: # string. Optional. Use when TaskNameSelector = SqlTask. Additional Invoke-Sqlcmd Arguments. 
    #InlineAdditionalArguments: # string. Optional. Use when TaskNameSelector = InlineSqlTask. Additional Invoke-Sqlcmd Arguments. 
  # Firewall
    IpDetectionMethod: 'AutoDetect' # 'AutoDetect' | 'IPAddressRange'. Required. Specify Firewall Rules Using. Default: AutoDetect.
    #StartIpAddress: # string. Required when IpDetectionMethod = IPAddressRange. Start IP Address. 
    #EndIpAddress: # string. Required when IpDetectionMethod = IPAddressRange. End IP Address. 
    #DeleteFirewallRule: true # boolean. Delete Rule After Task Ends. Default: true.

入力

azureConnectionType - Azure サービス接続の種類
入力エイリアス: ConnectedServiceNameSelector。 string. 使用できる値: ConnectedServiceName (Azure クラシック)、 ConnectedServiceNameARM (Azure Resource Manager)。 既定値: ConnectedServiceNameARM。

azureClassicSubscription - Azure クラシック サブスクリプション
入力エイリアス: ConnectedServiceName。 string. ConnectedServiceNameSelector = ConnectedServiceName の場合に必要です。

SQL ファイルをデプロイするためのターゲット Azure クラシック サブスクリプションを指定します。

azureSubscription - Azure サブスクリプション
入力エイリアス: ConnectedServiceNameARM。 string. ConnectedServiceNameSelector = ConnectedServiceNameARM の場合に必要です。

SQL ファイルをデプロイするためのターゲット Azure Resource Manager サブスクリプションを指定します。

AuthenticationType - 認証の種類
string. 必須です。 使用できる値: server (SQL Server認証)、 aadAuthenticationPassword (Active Directory - パスワード)、 aadAuthenticationIntegrated (Active Directory - 統合)、 connectionString (接続文字列)、 servicePrincipal (サービス プリンシパル)。 既定値: server。

データベース認証の種類を指定します。 SQL Server、Active Directory (統合)、Active Directory (パスワード)、接続文字列、またはサービス プリンシパル認証を指定できます。 統合認証とは、エージェントが現在の Active Directory アカウント コンテキストを使用してデータベースにアクセスすることを意味します。

Azure SQL Server データベースに接続するオプションを指定します。 Azure SQL Server データベースの詳細、SQL Server 接続文字列、AD 認証 (パスワードまたは統合)、またはサービス プリンシパルを使用できます。 SQL Server認証には、SQL Serverのユーザー資格情報を使用します。 AD 認証の場合は、SQL Serverに構成された AD ユーザーの資格情報を使用します。

ServerName - Azure SQL サーバー
string. AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal の場合に必要です。

や Fabrikam.database.windows.netなどFabrikam.database.windows.net,1433、Azure SQL サーバー名を指定します。

DatabaseName - データベース
string. AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal の場合に必要です。

ファイルが配置されるAzure SQL データベースの名前を指定します。

SqlUsername - ログイン
string. AuthenticationType = server の場合に必要です。

Azure SQL サーバー管理者ログインを指定します。

SqlPassword - パスワード
string. AuthenticationType = server の場合に必要です。

Azure SQL サーバー管理者のパスワードを指定します。 としてビルドまたはリリース パイプライン $(passwordVariable) で定義されている変数が受け入れられます。 変数の型を として secret マークして、セキュリティで保護することができます。

aadSqlUsername - ログイン
string. AuthenticationType = aadAuthenticationPassword の場合に必要です。

Active Directory ユーザー名を指定します。

aadSqlPassword - パスワード
string. AuthenticationType = aadAuthenticationPassword の場合に必要です。

Active Directory ユーザーのパスワードを指定します。 としてビルドまたはリリース パイプライン $(passwordVariable) で定義されている変数が受け入れられます。 変数の型を として secret マークして、セキュリティで保護することができます。

ConnectionString - 接続文字列
string. AuthenticationType = connectionString の場合に必要です。

などのServer=testServer.database.windows.net;Database=testdb;User ID=AccountPlaceholder;Password=$(securePassword);Azure SQL Server 接続文字列を指定します。

deployType - デプロイの種類
入力エイリアス: TaskNameSelector。 string. 必須です。 使用できる値: DacpacTask (SQL DACPAC ファイル)、 SqlTask (SQL スクリプト ファイル)、 InlineSqlTask (インライン SQL スクリプト)。 既定値: DacpacTask。

DeploymentAction - アクション
string. TaskNameSelector = DacpacTask の場合に必要です。 使用できる値は、、、、、、 ScriptDriftReport (Drift Report)、 DeployReport (Deploy Report) です。 ImportExportExtractPublish 既定値: Publish。

一覧から SQL アクションのいずれかを指定します。 SQL アクションの一覧の詳細を確認してください。

DacpacFile - DACPAC ファイル
string. DeploymentAction = Publish || DeploymentAction = Script || DeploymentAction = DeployReport の場合に必要です。

オートメーション エージェントまたはオートメーション エージェントからアクセスできる UNC パス上の DACPAC ファイルの場所を指定します (例: \\BudgetIT\Web\Deploy\FabrikamDB.dacpac)。 などの $(agent.releaseDirectory)定義済みのシステム変数も使用できます。

BacpacFile - BACPAC ファイル
string. DeploymentAction = Import の場合に必要です。

オートメーション エージェントまたはオートメーション エージェントからアクセスできる UNC パス上の BACPAC ファイルの場所を指定します (例: \\BudgetIT\Web\Deploy\FabrikamDB.bacpac)。 などの $(agent.releaseDirectory)定義済みのシステム変数も使用できます。

SqlFile - SQL スクリプト
string. TaskNameSelector = SqlTask の場合に必要です。

オートメーション エージェントまたはオートメーション エージェントからアクセスできる UNC パス上の SQL スクリプト ファイルの場所を指定します (例: \\BudgetIT\Web\Deploy\FabrikamDB.sql)。 などの $(agent.releaseDirectory)定義済みのシステム変数も使用できます。

SqlInline - インライン SQL スクリプト
string. TaskNameSelector = InlineSqlTask の場合に必要です。

前に選択したデータベースで実行する SQL スクリプトを指定します。

PublishProfile - プロファイルの発行
string. 省略可能。 の場合は TaskNameSelector = DacpacTask || DeploymentAction = Script || DeploymentAction = DeployReportを使用します。

データベースの作成またはアップグレードAzure SQLきめ細かく制御できます。
自動化エージェント コンピューターまたは UNC 共有上の発行プロファイル XML ファイルへのパスを指定します。 発行プロファイルに資格情報などのシークレットが含まれている場合は、暗号化で安全に保存されている セキュリティで保護されたファイル ライブラリにアップロードします。 次に、パイプラインの開始時に [セキュリティで保護されたファイルのダウンロード ] タスクを使用して、パイプラインの実行時にエージェント コンピューターにダウンロードします。 パイプラインが完了したら削除します。 や $(agent.releaseDirectory)などの$(agent.buildDirectory)定義済みのシステム変数も使用できます。

AdditionalArguments - その他の SqlPackage.exe 引数
string. 省略可能。 の場合は TaskNameSelector = DacpacTask || DeploymentAction = Extract || DeploymentAction = Export || DeploymentAction = Import || DeploymentAction = Script || DeploymentAction = DeployReport || DeploymentAction = DriftReportを使用します。

DACPAC オプションが選択されている場合に、Azure SQL データベースを配置するときに適用される追加SqlPackage.exeの引数を指定します (例: /p:IgnoreAnsiNulls=True /p:IgnoreComments=True)。 これらの引数は、発行プロファイル XML ファイルの設定をオーバーライドします (指定されている場合)。

SqlAdditionalArguments - その他の Invoke-Sqlcmd 引数
string. 省略可能。 の場合は TaskNameSelector = SqlTaskを使用します。

など-ConnectionTimeout 100 -OutputSqlErrors、Azure SQL データベースで指定された SQL クエリを実行するときに適用される追加の Invoke-Sqlcmd 引数を指定します。

InlineAdditionalArguments - その他の Invoke-Sqlcmd 引数
string. 省略可能。 の場合は TaskNameSelector = InlineSqlTaskを使用します。

など-ConnectionTimeout 100 -OutputSqlErrors、Azure SQL データベースで指定された SQL クエリを実行するときに適用される追加の Invoke-Sqlcmd 引数を指定します。

IpDetectionMethod - を使用してファイアウォール規則を指定する
string. 必須です。 使用できる値: AutoDetect、IPAddressRange。 既定値: AutoDetect。

タスクを実行するには、自動化エージェントの IP アドレスを、Azure SQL サーバーのファイアウォールの許可された IP アドレスに追加する必要があります。 自動検出を選択して、自動化エージェントの使用可能な IP アドレスの範囲に対してファイアウォール例外を自動的に追加するか、範囲を明示的に指定します。

StartIpAddress - 開始 IP アドレス
string. IpDetectionMethod = IPAddressRange の場合に必要です。

オートメーション エージェント マシン プールの開始 IP アドレスを指定します (例: 196.21.30.50)。

EndIpAddress - 終了 IP アドレス
string. IpDetectionMethod = IPAddressRange の場合に必要です。

などの 196.21.30.65オートメーション エージェント マシン プールの終了 IP アドレスを指定します。

DeleteFirewallRule - タスク終了後にルールを削除する
boolean. 既定値: true。

選択した場合、タスクが終了すると、ここで指定した IP アドレスが、Azure SQL サーバーのファイアウォールの [許可された IP アドレス] の一覧から削除されます。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

このタスクでは、ダウンストリームのステップ、ジョブ、およびステージで使用できる次の 出力変数を定義します。

SqlDeploymentOutputFile
デプロイ パッケージ アクションExtractが 、DriftReportExportScriptまたは DeployReportの場合に生成される出力ファイル パス。

注釈

このタスクを使用して、DACPAC を使用してAzure SQL データベースをデプロイするか、SQLCMD を使用してスクリプトを実行します。

重要

このタスクは、Windows 環境でのみサポートされています。 Azure Active Directory (Azure AD) 統合認証を使用する場合は、プライベート エージェントを作成する必要があります。 Azure AD 統合認証は、ホステッド エージェントにはサポートされていません。

要件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント
確認要求	セルフホステッド エージェントには、このタスクを使用するジョブを実行するための次の要求に一致する機能が必要です: sqlpackage
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	1.103.0 以上
タスクのカテゴリ	配置