AzureStaticWebApp@0 - Azure Static Web App v0 タスクをデプロイする
このタスクでは、Azure Static Web アプリをビルドしてデプロイします。
構文
# Deploy Azure Static Web App v0
# Build and deploy an Azure Static Web App.
- task: AzureStaticWebApp@0
inputs:
#workingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd | rootDirectory. Working directory. Default: $(System.DefaultWorkingDirectory).
#app_location: # string. App location.
#app_build_command: # string. App build command.
#output_location: # string. Output location.
#api_location: # string. Api location.
#api_build_command: # string. Api build command.
#routes_location: # string. Routes location.
#config_file_location: # string. Config file location.
#skip_app_build: # boolean. Skip app build.
#skip_api_build: # boolean. Skip api build.
#is_static_export: # boolean. Set static export.
#verbose: # boolean. Verbose.
#build_timeout_in_minutes: # string. Build timeout in minutes.
#azure_static_web_apps_api_token: # string. Azure Static Web Apps api token.
#deployment_environment: # string. Deployment Environment.
#production_branch: # string. Production Branch.
#data_api_location: # string. Data api location.
# Deploy Azure Static Web App v0
# Build and deploy an Azure Static Web App.
- task: AzureStaticWebApp@0
inputs:
#workingDirectory: '$(System.DefaultWorkingDirectory)' # string. Alias: cwd | rootDirectory. Working directory. Default: $(System.DefaultWorkingDirectory).
#app_location: # string. App location.
#app_build_command: # string. App build command.
#output_location: # string. Output location.
#api_location: # string. Api location.
#api_build_command: # string. Api build command.
#routes_location: # string. Routes location.
#config_file_location: # string. Config file location.
#skip_app_build: # boolean. Skip app build.
#skip_api_build: # boolean. Skip api build.
#is_static_export: # boolean. Set static export.
#verbose: # boolean. Verbose.
#build_timeout_in_minutes: # string. Build timeout in minutes.
#azure_static_web_apps_api_token: # string. Azure Static Web Apps api token.
#deployment_environment: # string. Deployment Environment.
#production_branch: # string. Production Branch.
入力
workingDirectory
-
作業ディレクトリの
入力エイリアス: cwd | rootDirectory
。
string
. 既定値: $(System.DefaultWorkingDirectory)
.
このタスクを実行する絶対作業ディレクトリを指定します。 空のままにすると、既定の作業ディレクトリが使用されます。
app_location
-
アプリの場所の
string
.
作業ディレクトリを基準とした、アプリケーション ソース コードのディレクトリの場所。
skip_app_build: true
で使用する場合、この値はアプリのビルド出力場所です。
app_build_command
-
App build コマンド
string
.
アプリケーションのソース コードをビルドするときに Oryx を実行するために使用されるカスタム コマンド。
output_location
-
出力場所の
string
.
ビルドが完了した後のコンパイル済みアプリケーション コードのディレクトリの場所 。作業ディレクトリを基準とします。 自動ビルドをバイパスし、デプロイのみが必要な場合は、空の文字列 (''
) を設定します。
api_location
-
Api の場所の
string
.
作業ディレクトリを基準とした Azure Functions ソース コードのディレクトリの場所。
api_build_command
-
Api ビルド コマンドの
string
.
Azure Functions のソース コードをビルドするときに Oryx を実行するために使用されるカスタム コマンド。
routes_location
-
ルートの場所の
string
.
作業ディレクトリを基準とした routes.json ファイルのディレクトリの場所。
注: Routes.json は非推奨です。 staticwebapp.config.jsonを使用します。
config_file_location
-
構成ファイルの場所の
string
.
作業ディレクトリを基準とした staticwebapp.config.json ファイルのディレクトリの場所。
skip_app_build
-
アプリのビルド をスキップする
boolean
.
アプリ フォルダーの Oryx ビルドをスキップします。
skip_api_build
-
API ビルド をスキップする
boolean
.
API フォルダーの Oryx ビルドをスキップします。
is_static_export
-
静的エクスポート を設定する
boolean
.
next export
を使用する場合など、アプリケーションが静的 HTML にエクスポートするように構成されている場合に、このフラグを true
に設定します。
このフラグが true
に設定されている場合
詳細 verbose
-
boolean
.
詳細ログを有効にします。
build_timeout_in_minutes
-
ビルドのタイムアウト (分)
string
.
Oryx アプリ フォルダービルドの時間制限を分単位で指定します。
Azure Static Web Apps api トークン の
string
.
デプロイ用の API トークンを指定します。
注: 環境変数として渡された場合は不要です。
deployment_environment
-
デプロイ環境の
string
.
デプロイする環境を指定します。 運用環境では空白のままにします。 この入力は、運用ブランチよりも優先されます。
production_branch
-
Production Branch
string
.
運用ブランチを指定します。 定義されているデプロイ環境が空の場合、他のブランチからのデプロイはプレビュー環境になります。
data_api_location
-
Data API の場所の
string
.
作業ディレクトリに対するデータ API ソース ファイルのディレクトリの場所。
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
このタスクでは、次の 出力変数を定義します。この変数は、ダウンストリームのステップ、ジョブ、およびステージで使用できます。
AZURESTATICWEBAPP_STATIC_WEB_APP_URL
デプロイが成功した後に静的 Web アプリの URL を します。
備考
手記
このタスクは Linux エージェントでのみ実行されます。
例
trigger:
- main
pool:
vmImage: ubuntu-latest
steps:
- checkout: self
submodules: true
- task: AzureStaticWebApp@0
inputs:
app_location: '/build'
api_location: 'api'
output_location: '/output'
azure_static_web_apps_api_token: $(deployment_token)
フロントエンド アプリのビルドをスキップし、デプロイのみを実行する
trigger:
- main
pool:
vmImage: ubuntu-latest
steps:
- task: NodeTool@0
inputs:
versionSpec: '20.x'
displayName: 'Install Node.js'
- script: |
npm ci
npm run build
displayName: 'dependencies install and distribution build'
- task: AzureStaticWebApp@0
inputs:
app_location : '/dist'
output_location: '' # Leave this empty
skip_app_build: true
skip_api_build: true
azure_static_web_apps_api_token: $(deployment_token)