Bicep リソース定義
Spring/apps/deployments リソースの種類は、次をターゲットとする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.AppPlatform/Spring/apps/deployments リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
active: bool
deploymentSettings: {
addonConfigs: {
{customized property}: any(...)
}
apms: [
{
resourceId: 'string'
}
]
containerProbeSettings: {
disableProbe: bool
}
environmentVariables: {
{customized property}: 'string'
}
livenessProbe: {
disableProbe: bool
failureThreshold: int
initialDelaySeconds: int
periodSeconds: int
probeAction: {
type: 'string'
// For remaining properties, see ProbeAction objects
}
successThreshold: int
timeoutSeconds: int
}
readinessProbe: {
disableProbe: bool
failureThreshold: int
initialDelaySeconds: int
periodSeconds: int
probeAction: {
type: 'string'
// For remaining properties, see ProbeAction objects
}
successThreshold: int
timeoutSeconds: int
}
resourceRequests: {
cpu: 'string'
memory: 'string'
}
scale: {
maxReplicas: int
minReplicas: int
rules: [
{
azureQueue: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
queueLength: int
queueName: 'string'
}
custom: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {
{customized property}: 'string'
}
type: 'string'
}
http: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {
{customized property}: 'string'
}
}
name: 'string'
tcp: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {
{customized property}: 'string'
}
}
}
]
}
startupProbe: {
disableProbe: bool
failureThreshold: int
initialDelaySeconds: int
periodSeconds: int
probeAction: {
type: 'string'
// For remaining properties, see ProbeAction objects
}
successThreshold: int
timeoutSeconds: int
}
terminationGracePeriodSeconds: int
}
source: {
version: 'string'
type: 'string'
// For remaining properties, see UserSourceInfo objects
}
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
}
UserSourceInfo オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
BuildResultの場合は、次を使用します。
{
buildResultId: 'string'
type: 'BuildResult'
}
コンテナーの場合は、次を使用します。
{
customContainer: {
args: [
'string'
]
command: [
'string'
]
containerImage: 'string'
imageRegistryCredential: {
password: 'string'
username: 'string'
}
languageFramework: 'string'
server: 'string'
}
type: 'Container'
}
Jarの場合は、次を使用します。
{
jvmOptions: 'string'
relativePath: 'string'
runtimeVersion: 'string'
type: 'Jar'
}
NetCoreZipの場合は、次の値を使用します。
{
netCoreMainEntryPath: 'string'
relativePath: 'string'
runtimeVersion: 'string'
type: 'NetCoreZip'
}
ソースの場合は、次を使用します。
{
artifactSelector: 'string'
relativePath: 'string'
runtimeVersion: 'string'
type: 'Source'
}
Warの場合は、次を使用します。
{
jvmOptions: 'string'
relativePath: 'string'
runtimeVersion: 'string'
serverVersion: 'string'
type: 'War'
}
ProbeAction オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
ExecActionの場合は、次のコマンドを使用します。
{
command: [
'string'
]
type: 'ExecAction'
}
HTTPGetActionを する場合は、次のコマンドを使用します。
{
path: 'string'
scheme: 'string'
type: 'HTTPGetAction'
}
TCPSocketActionを する場合は、次のコマンドを使用します。
{
type: 'TCPSocketAction'
}
プロパティ値
名前 |
形容 |
価値 |
名前 |
リソース名 |
string (必須) |
親 |
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。
詳細については、「親リソースの外部 子リソース」を参照してください。 |
種類のリソースのシンボリック名: spring/apps |
プロパティ |
デプロイ リソースのプロパティ |
DeploymentResourceProperties の |
エスケーユー |
デプロイ リソースの SKU |
SKU |
APMリファレンス
名前 |
形容 |
価値 |
リソースID |
APM のリソース ID |
string (必須) |
BuildResultUserSourceInfo (ビルド結果ユーザーソース情報)
名前 |
形容 |
価値 |
buildResultId (ビルド結果イド) |
同じ Spring インスタンスの既存の成功したビルド結果のリソース ID。 |
文字列 |
型 |
アップロードされたソースの種類 |
'BuildResult' (必須) |
コンテナプローブ設定
名前 |
形容 |
価値 |
ディセーブルプローブ |
liveness プローブと準備プローブを無効にするかどうかを示します |
ブール (bool) |
カスタムコンテナ
名前 |
形容 |
価値 |
引数 |
エントリポイントの引数。 これが指定されていない場合は、Docker イメージの CMD が使用されます。 |
文字列[] |
命令 |
Entrypoint 配列。 シェル内では実行されません。 これが指定されていない場合は、Docker イメージの ENTRYPOINT が使用されます。 |
文字列[] |
コンテナ画像 |
カスタム コンテナーのコンテナー イメージ。 これは、<リポジトリの>の形式である必要があります。レジストリのサーバー名のないタグ<> |
文字列 |
imageRegistryCredential |
イメージ レジストリの資格情報 |
ImageRegistryCredential |
言語フレームワーク |
アップロードされたコンテナー イメージの言語フレームワーク。 サポートされる値: "springboot"、""、null。 |
文字列 |
サーバー |
コンテナー イメージを含むレジストリの名前 |
文字列 |
CustomContainerUserSourceInfo (カスタムコンテナユーザーソース情報)
名前 |
形容 |
価値 |
カスタムコンテナ |
カスタム コンテナー ペイロード |
CustomContainer の |
型 |
アップロードされたソースの種類 |
'Container' (必須) |
CustomScaleRule
名前 |
形容 |
価値 |
認証 |
カスタム スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
カスタム スケール ルールを記述するメタデータ プロパティ。 |
CustomScaleRuleMetadata を する |
型 |
カスタム スケール ルールの種類 例: azure-servicebus、redis など。 |
文字列 |
デプロイメントリソースプロパティ
名前 |
形容 |
価値 |
能動 |
展開がアクティブかどうかを示します |
ブール (bool) |
deploymentSettings (デプロイメント設定) |
展開の展開設定 |
DeploymentSettings (デプロイメント設定) |
ソース |
デプロイのアップロードされたソース情報。 |
UserSourceInfo の |
DeploymentSettings (デプロイメント設定)
DeploymentSettingsアドオンコンフィグ
DeploymentSettingsEnvironment変数
ExecAction(エグゼクティブアクション)
名前 |
形容 |
価値 |
命令 |
コマンドはコンテナー内で実行するコマンド ラインであり、コマンドの作業ディレクトリはコンテナーのファイルシステムのルート ('/') です。 このコマンドはシェル内で実行されないため、従来のシェル命令 ('|'など) は機能しません。 シェルを使用するには、そのシェルを明示的に呼び出す必要があります。 終了ステータス 0 はライブ/正常として扱われ、0 以外は異常として扱われます。 |
文字列[] |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'ExecAction' (必須) |
HttpGetActionの
名前 |
形容 |
価値 |
パス |
HTTP サーバー上のアクセスのパス。 |
文字列 |
計画 |
ホストへの接続に使用するスキーム。 既定値は HTTP です。
指定できる列挙値:
-
"HTTP" は、使用されるスキームが http:// されることを意味します
-
"HTTPS" は、使用されるスキームが https:// されることを意味します |
「HTTP」 「HTTPS」 |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'HTTPGetAction' (必須) |
HttpScaleRule (英語)
名前 |
形容 |
価値 |
認証 |
カスタム スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
http スケール ルールを記述するメタデータ プロパティ。 |
HttpScaleRuleMetadata を する |
ImageRegistryCredential
名前 |
形容 |
価値 |
パスワード |
イメージ レジストリ資格情報のパスワード |
文字列 |
ユーザー名 |
イメージ レジストリ資格情報のユーザー名 |
文字列 |
JarUploadedUserSourceInfo さん
名前 |
形容 |
価値 |
jvmオプション |
JVM パラメーター |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
Jar ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'Jar' (必須) |
NetCoreZipUploadedUserSourceInfo
名前 |
形容 |
価値 |
netCoreMainEntryPath (英語) |
zip ルートを基準とした .NET 実行可能ファイルへのパス |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
.Net ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'NetCoreZip' (必須) |
プローブ
名前 |
形容 |
価値 |
ディセーブルプローブ |
プローブが無効かどうかを示します。 |
bool (必須) |
failureThreshold(失敗しきい値) |
成功した後に失敗したと見なされるプローブの連続する最小障害。 最小値は 1 です。 |
整数 (int) |
initialDelaySeconds (初期遅延秒) |
プローブが開始されるまでのアプリ インスタンスの開始後の秒数。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
整数 (int) |
period秒 |
プローブを実行する頻度 (秒単位)。 最小値は 1 です。 |
整数 (int) |
プローブアクション |
プローブのアクション。 |
ProbeAction の |
successThreshold(成功のしきい値) |
失敗した後にプローブが成功したと見なされる最小連続成功数。 ライブ性と起動には 1 にする必要があります。 最小値は 1 です。 |
整数 (int) |
タイムアウト秒 |
プローブがタイムアウトする秒数。最小値は 1 です。 |
整数 (int) |
プローブアクション
名前 |
形容 |
価値 |
型 |
ExecAction型 'ExecAction' に設定します。 HttpGetActionの型 'HTTPGetAction' に設定します。 TCPSocketAction型 'TCPSocketAction' に設定します。 |
「ExecAction」 「HTTPGetAction」 'TCPSocketAction' (必須) |
キュー スケール ルール
名前 |
形容 |
価値 |
認証 |
キュー スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
キューの長さ |
キューの長さ。 |
整数 (int) |
キュー名 |
キュー名。 |
文字列 |
リソースリクエスト
名前 |
形容 |
価値 |
CPUの |
必要な CPU。 1 コアは 1 または 1000m で表すことができます。 Basic レベルの場合は 500m または 1、Standard レベルの場合は {500m、1、2、3、4} です。 |
文字列 |
メモリ |
必要なメモリ。 1 GB は 1Gi または 1024Mi で表すことができます。 Basic レベルの場合は {512Mi、1Gi、2Gi}、Standard レベルの場合は {512Mi、1Gi、2Gi、...、8Gi} です。 |
文字列 |
規模
名前 |
形容 |
価値 |
マックスレプリカ |
随意。 コンテナー レプリカの最大数。 既定値は 10 (設定されていない場合) です。 |
整数 (int) |
minレプリカ |
随意。 コンテナー レプリカの最小数。 |
整数 (int) |
準則 |
スケーリング ルール。 |
スケールルール[] |
ScaleRule (スケールルール)
名前 |
形容 |
価値 |
azureキュー |
Azure Queue ベースのスケーリング。 |
QueueScaleRule の |
習慣 |
カスタム スケール ルール。 |
CustomScaleRule の |
http |
HTTP 要求ベースのスケーリング。 |
HttpScaleRule を する |
名前 |
スケール ルール名 |
文字列 |
TCP |
Tcp 要求ベースのスケーリング。 |
TcpScaleRule の |
ScaleRuleAuth (英語)
名前 |
形容 |
価値 |
secretRef です。 |
認証パラメーターのプル元となる Azure Spring Apps アプリ インスタンス シークレットの名前。 |
文字列 |
triggerパラメータ |
シークレットを使用するトリガー パラメーター |
文字列 |
SKU
名前 |
形容 |
価値 |
キャパシティ |
ターゲット リソースの現在の容量 |
整数 (int) |
名前 |
SKU の名前 |
文字列 |
レベル |
SKU の階層 |
文字列 |
SourceUploadedUserSourceInfo
名前 |
形容 |
価値 |
アーティファクトセレクタ |
マルチモジュール プロジェクトのデプロイに使用する成果物のセレクター。 これは次のようになります。 ターゲット モジュール/プロジェクトへの相対パス。 |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
ソース ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'Source' (必須) |
TcpScaleRule の略
名前 |
形容 |
価値 |
認証 |
TCP スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
TCP スケール ルールを記述するメタデータ プロパティ。 |
TcpScaleRuleMetadata の |
TCPSocketAction (英語)
名前 |
形容 |
価値 |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'TCPSocketAction' (必須) |
ユーザーソース情報
名前 |
形容 |
価値 |
型 |
BuildResultUserSourceInfoの型 'BuildResult' に設定します。 CustomContainerUserSourceInfoの型 'Container' に設定します。 JarUploadedUserSourceInfoの型 'Jar' に設定します。 NetCoreZipUploadedUserSourceInfo種類として 'NetCoreZip' に設定します。 SourceUploadedUserSourceInfo種類として 'Source' に設定します。 WarUploadedUserSourceInfo種類として 'War' に設定します。 |
'ビルド結果' 「コンテナ」 「ジャー」 「NetCoreZip」 「ソース」 'War' (必須) |
バージョン |
ソースのバージョン |
文字列 |
WarUploadedUserSourceInfo
名前 |
形容 |
価値 |
jvmオプション |
JVM パラメーター |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
war ファイルのランタイム バージョン |
文字列 |
サーバーバージョン |
サーバー のバージョン。現在サポートされているのは Apache Tomcat のみです |
文字列 |
型 |
アップロードされたソースの種類 |
'War' (必須) |
使用例
Azure クイック スタートのサンプル
次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。
ARM テンプレート リソース定義
Spring/apps/deployments リソースの種類は、次をターゲットとする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.AppPlatform/Spring/apps/deployments リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.AppPlatform/Spring/apps/deployments",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"active": "bool",
"deploymentSettings": {
"addonConfigs": {
"{customized property}": {}
},
"apms": [
{
"resourceId": "string"
}
],
"containerProbeSettings": {
"disableProbe": "bool"
},
"environmentVariables": {
"{customized property}": "string"
},
"livenessProbe": {
"disableProbe": "bool",
"failureThreshold": "int",
"initialDelaySeconds": "int",
"periodSeconds": "int",
"probeAction": {
"type": "string"
// For remaining properties, see ProbeAction objects
},
"successThreshold": "int",
"timeoutSeconds": "int"
},
"readinessProbe": {
"disableProbe": "bool",
"failureThreshold": "int",
"initialDelaySeconds": "int",
"periodSeconds": "int",
"probeAction": {
"type": "string"
// For remaining properties, see ProbeAction objects
},
"successThreshold": "int",
"timeoutSeconds": "int"
},
"resourceRequests": {
"cpu": "string",
"memory": "string"
},
"scale": {
"maxReplicas": "int",
"minReplicas": "int",
"rules": [
{
"azureQueue": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"queueLength": "int",
"queueName": "string"
},
"custom": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {
"{customized property}": "string"
},
"type": "string"
},
"http": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {
"{customized property}": "string"
}
},
"name": "string",
"tcp": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {
"{customized property}": "string"
}
}
}
]
},
"startupProbe": {
"disableProbe": "bool",
"failureThreshold": "int",
"initialDelaySeconds": "int",
"periodSeconds": "int",
"probeAction": {
"type": "string"
// For remaining properties, see ProbeAction objects
},
"successThreshold": "int",
"timeoutSeconds": "int"
},
"terminationGracePeriodSeconds": "int"
},
"source": {
"version": "string",
"type": "string"
// For remaining properties, see UserSourceInfo objects
}
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
}
}
UserSourceInfo オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
BuildResultの場合は、次を使用します。
{
"buildResultId": "string",
"type": "BuildResult"
}
コンテナーの場合は、次を使用します。
{
"customContainer": {
"args": [ "string" ],
"command": [ "string" ],
"containerImage": "string",
"imageRegistryCredential": {
"password": "string",
"username": "string"
},
"languageFramework": "string",
"server": "string"
},
"type": "Container"
}
Jarの場合は、次を使用します。
{
"jvmOptions": "string",
"relativePath": "string",
"runtimeVersion": "string",
"type": "Jar"
}
NetCoreZipの場合は、次の値を使用します。
{
"netCoreMainEntryPath": "string",
"relativePath": "string",
"runtimeVersion": "string",
"type": "NetCoreZip"
}
ソースの場合は、次を使用します。
{
"artifactSelector": "string",
"relativePath": "string",
"runtimeVersion": "string",
"type": "Source"
}
Warの場合は、次を使用します。
{
"jvmOptions": "string",
"relativePath": "string",
"runtimeVersion": "string",
"serverVersion": "string",
"type": "War"
}
ProbeAction オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
ExecActionの場合は、次のコマンドを使用します。
{
"command": [ "string" ],
"type": "ExecAction"
}
HTTPGetActionを する場合は、次のコマンドを使用します。
{
"path": "string",
"scheme": "string",
"type": "HTTPGetAction"
}
TCPSocketActionを する場合は、次のコマンドを使用します。
{
"type": "TCPSocketAction"
}
プロパティ値
名前 |
形容 |
価値 |
apiVersion (英語) |
API のバージョン |
「2024-05-01-プレビュー」 |
名前 |
リソース名 |
string (必須) |
プロパティ |
デプロイ リソースのプロパティ |
DeploymentResourceProperties の |
エスケーユー |
デプロイ リソースの SKU |
SKU |
型 |
リソースの種類 |
「Microsoft.AppPlatform/Spring/apps/deployments」 |
APMリファレンス
名前 |
形容 |
価値 |
リソースID |
APM のリソース ID |
string (必須) |
BuildResultUserSourceInfo (ビルド結果ユーザーソース情報)
名前 |
形容 |
価値 |
buildResultId (ビルド結果イド) |
同じ Spring インスタンスの既存の成功したビルド結果のリソース ID。 |
文字列 |
型 |
アップロードされたソースの種類 |
'BuildResult' (必須) |
コンテナプローブ設定
名前 |
形容 |
価値 |
ディセーブルプローブ |
liveness プローブと準備プローブを無効にするかどうかを示します |
ブール (bool) |
カスタムコンテナ
名前 |
形容 |
価値 |
引数 |
エントリポイントの引数。 これが指定されていない場合は、Docker イメージの CMD が使用されます。 |
文字列[] |
命令 |
Entrypoint 配列。 シェル内では実行されません。 これが指定されていない場合は、Docker イメージの ENTRYPOINT が使用されます。 |
文字列[] |
コンテナ画像 |
カスタム コンテナーのコンテナー イメージ。 これは、<リポジトリの>の形式である必要があります。レジストリのサーバー名のないタグ<> |
文字列 |
imageRegistryCredential |
イメージ レジストリの資格情報 |
ImageRegistryCredential |
言語フレームワーク |
アップロードされたコンテナー イメージの言語フレームワーク。 サポートされる値: "springboot"、""、null。 |
文字列 |
サーバー |
コンテナー イメージを含むレジストリの名前 |
文字列 |
CustomContainerUserSourceInfo (カスタムコンテナユーザーソース情報)
名前 |
形容 |
価値 |
カスタムコンテナ |
カスタム コンテナー ペイロード |
CustomContainer の |
型 |
アップロードされたソースの種類 |
'Container' (必須) |
CustomScaleRule
名前 |
形容 |
価値 |
認証 |
カスタム スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
カスタム スケール ルールを記述するメタデータ プロパティ。 |
CustomScaleRuleMetadata を する |
型 |
カスタム スケール ルールの種類 例: azure-servicebus、redis など。 |
文字列 |
デプロイメントリソースプロパティ
名前 |
形容 |
価値 |
能動 |
展開がアクティブかどうかを示します |
ブール (bool) |
deploymentSettings (デプロイメント設定) |
展開の展開設定 |
DeploymentSettings (デプロイメント設定) |
ソース |
デプロイのアップロードされたソース情報。 |
UserSourceInfo の |
DeploymentSettings (デプロイメント設定)
DeploymentSettingsアドオンコンフィグ
DeploymentSettingsEnvironment変数
ExecAction(エグゼクティブアクション)
名前 |
形容 |
価値 |
命令 |
コマンドはコンテナー内で実行するコマンド ラインであり、コマンドの作業ディレクトリはコンテナーのファイルシステムのルート ('/') です。 このコマンドはシェル内で実行されないため、従来のシェル命令 ('|'など) は機能しません。 シェルを使用するには、そのシェルを明示的に呼び出す必要があります。 終了ステータス 0 はライブ/正常として扱われ、0 以外は異常として扱われます。 |
文字列[] |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'ExecAction' (必須) |
HttpGetActionの
名前 |
形容 |
価値 |
パス |
HTTP サーバー上のアクセスのパス。 |
文字列 |
計画 |
ホストへの接続に使用するスキーム。 既定値は HTTP です。
指定できる列挙値:
-
"HTTP" は、使用されるスキームが http:// されることを意味します
-
"HTTPS" は、使用されるスキームが https:// されることを意味します |
「HTTP」 「HTTPS」 |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'HTTPGetAction' (必須) |
HttpScaleRule (英語)
名前 |
形容 |
価値 |
認証 |
カスタム スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
http スケール ルールを記述するメタデータ プロパティ。 |
HttpScaleRuleMetadata を する |
ImageRegistryCredential
名前 |
形容 |
価値 |
パスワード |
イメージ レジストリ資格情報のパスワード |
文字列 |
ユーザー名 |
イメージ レジストリ資格情報のユーザー名 |
文字列 |
JarUploadedUserSourceInfo さん
名前 |
形容 |
価値 |
jvmオプション |
JVM パラメーター |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
Jar ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'Jar' (必須) |
NetCoreZipUploadedUserSourceInfo
名前 |
形容 |
価値 |
netCoreMainEntryPath (英語) |
zip ルートを基準とした .NET 実行可能ファイルへのパス |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
.Net ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'NetCoreZip' (必須) |
プローブ
名前 |
形容 |
価値 |
ディセーブルプローブ |
プローブが無効かどうかを示します。 |
bool (必須) |
failureThreshold(失敗しきい値) |
成功した後に失敗したと見なされるプローブの連続する最小障害。 最小値は 1 です。 |
整数 (int) |
initialDelaySeconds (初期遅延秒) |
プローブが開始されるまでのアプリ インスタンスの開始後の秒数。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
整数 (int) |
period秒 |
プローブを実行する頻度 (秒単位)。 最小値は 1 です。 |
整数 (int) |
プローブアクション |
プローブのアクション。 |
ProbeAction の |
successThreshold(成功のしきい値) |
失敗した後にプローブが成功したと見なされる最小連続成功数。 ライブ性と起動には 1 にする必要があります。 最小値は 1 です。 |
整数 (int) |
タイムアウト秒 |
プローブがタイムアウトする秒数。最小値は 1 です。 |
整数 (int) |
プローブアクション
名前 |
形容 |
価値 |
型 |
ExecAction型 'ExecAction' に設定します。 HttpGetActionの型 'HTTPGetAction' に設定します。 TCPSocketAction型 'TCPSocketAction' に設定します。 |
「ExecAction」 「HTTPGetAction」 'TCPSocketAction' (必須) |
キュー スケール ルール
名前 |
形容 |
価値 |
認証 |
キュー スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
キューの長さ |
キューの長さ。 |
整数 (int) |
キュー名 |
キュー名。 |
文字列 |
リソースリクエスト
名前 |
形容 |
価値 |
CPUの |
必要な CPU。 1 コアは 1 または 1000m で表すことができます。 Basic レベルの場合は 500m または 1、Standard レベルの場合は {500m、1、2、3、4} です。 |
文字列 |
メモリ |
必要なメモリ。 1 GB は 1Gi または 1024Mi で表すことができます。 Basic レベルの場合は {512Mi、1Gi、2Gi}、Standard レベルの場合は {512Mi、1Gi、2Gi、...、8Gi} です。 |
文字列 |
規模
名前 |
形容 |
価値 |
マックスレプリカ |
随意。 コンテナー レプリカの最大数。 既定値は 10 (設定されていない場合) です。 |
整数 (int) |
minレプリカ |
随意。 コンテナー レプリカの最小数。 |
整数 (int) |
準則 |
スケーリング ルール。 |
スケールルール[] |
ScaleRule (スケールルール)
名前 |
形容 |
価値 |
azureキュー |
Azure Queue ベースのスケーリング。 |
QueueScaleRule の |
習慣 |
カスタム スケール ルール。 |
CustomScaleRule の |
http |
HTTP 要求ベースのスケーリング。 |
HttpScaleRule を する |
名前 |
スケール ルール名 |
文字列 |
TCP |
Tcp 要求ベースのスケーリング。 |
TcpScaleRule の |
ScaleRuleAuth (英語)
名前 |
形容 |
価値 |
secretRef です。 |
認証パラメーターのプル元となる Azure Spring Apps アプリ インスタンス シークレットの名前。 |
文字列 |
triggerパラメータ |
シークレットを使用するトリガー パラメーター |
文字列 |
SKU
名前 |
形容 |
価値 |
キャパシティ |
ターゲット リソースの現在の容量 |
整数 (int) |
名前 |
SKU の名前 |
文字列 |
レベル |
SKU の階層 |
文字列 |
SourceUploadedUserSourceInfo
名前 |
形容 |
価値 |
アーティファクトセレクタ |
マルチモジュール プロジェクトのデプロイに使用する成果物のセレクター。 これは次のようになります。 ターゲット モジュール/プロジェクトへの相対パス。 |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
ソース ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'Source' (必須) |
TcpScaleRule の略
名前 |
形容 |
価値 |
認証 |
TCP スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
TCP スケール ルールを記述するメタデータ プロパティ。 |
TcpScaleRuleMetadata の |
TCPSocketAction (英語)
名前 |
形容 |
価値 |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'TCPSocketAction' (必須) |
ユーザーソース情報
名前 |
形容 |
価値 |
型 |
BuildResultUserSourceInfoの型 'BuildResult' に設定します。 CustomContainerUserSourceInfoの型 'Container' に設定します。 JarUploadedUserSourceInfoの型 'Jar' に設定します。 NetCoreZipUploadedUserSourceInfo種類として 'NetCoreZip' に設定します。 SourceUploadedUserSourceInfo種類として 'Source' に設定します。 WarUploadedUserSourceInfo種類として 'War' に設定します。 |
'ビルド結果' 「コンテナ」 「ジャー」 「NetCoreZip」 「ソース」 'War' (必須) |
バージョン |
ソースのバージョン |
文字列 |
WarUploadedUserSourceInfo
名前 |
形容 |
価値 |
jvmオプション |
JVM パラメーター |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
war ファイルのランタイム バージョン |
文字列 |
サーバーバージョン |
サーバー のバージョン。現在サポートされているのは Apache Tomcat のみです |
文字列 |
型 |
アップロードされたソースの種類 |
'War' (必須) |
使用例
Azure のクイック スタート テンプレート
このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。
Spring/apps/deployments リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.AppPlatform/Spring/apps/deployments リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apps/deployments@2024-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
active = bool
deploymentSettings = {
addonConfigs = {
{customized property} = ?
}
apms = [
{
resourceId = "string"
}
]
containerProbeSettings = {
disableProbe = bool
}
environmentVariables = {
{customized property} = "string"
}
livenessProbe = {
disableProbe = bool
failureThreshold = int
initialDelaySeconds = int
periodSeconds = int
probeAction = {
type = "string"
// For remaining properties, see ProbeAction objects
}
successThreshold = int
timeoutSeconds = int
}
readinessProbe = {
disableProbe = bool
failureThreshold = int
initialDelaySeconds = int
periodSeconds = int
probeAction = {
type = "string"
// For remaining properties, see ProbeAction objects
}
successThreshold = int
timeoutSeconds = int
}
resourceRequests = {
cpu = "string"
memory = "string"
}
scale = {
maxReplicas = int
minReplicas = int
rules = [
{
azureQueue = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
queueLength = int
queueName = "string"
}
custom = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {
{customized property} = "string"
}
type = "string"
}
http = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {
{customized property} = "string"
}
}
name = "string"
tcp = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {
{customized property} = "string"
}
}
}
]
}
startupProbe = {
disableProbe = bool
failureThreshold = int
initialDelaySeconds = int
periodSeconds = int
probeAction = {
type = "string"
// For remaining properties, see ProbeAction objects
}
successThreshold = int
timeoutSeconds = int
}
terminationGracePeriodSeconds = int
}
source = {
version = "string"
type = "string"
// For remaining properties, see UserSourceInfo objects
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
UserSourceInfo オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
BuildResultの場合は、次を使用します。
{
buildResultId = "string"
type = "BuildResult"
}
コンテナーの場合は、次を使用します。
{
customContainer = {
args = [
"string"
]
command = [
"string"
]
containerImage = "string"
imageRegistryCredential = {
password = "string"
username = "string"
}
languageFramework = "string"
server = "string"
}
type = "Container"
}
Jarの場合は、次を使用します。
{
jvmOptions = "string"
relativePath = "string"
runtimeVersion = "string"
type = "Jar"
}
NetCoreZipの場合は、次の値を使用します。
{
netCoreMainEntryPath = "string"
relativePath = "string"
runtimeVersion = "string"
type = "NetCoreZip"
}
ソースの場合は、次を使用します。
{
artifactSelector = "string"
relativePath = "string"
runtimeVersion = "string"
type = "Source"
}
Warの場合は、次を使用します。
{
jvmOptions = "string"
relativePath = "string"
runtimeVersion = "string"
serverVersion = "string"
type = "War"
}
ProbeAction オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
ExecActionの場合は、次のコマンドを使用します。
{
command = [
"string"
]
type = "ExecAction"
}
HTTPGetActionを する場合は、次のコマンドを使用します。
{
path = "string"
scheme = "string"
type = "HTTPGetAction"
}
TCPSocketActionを する場合は、次のコマンドを使用します。
{
type = "TCPSocketAction"
}
プロパティ値
名前 |
形容 |
価値 |
名前 |
リソース名 |
string (必須) |
parent_id |
このリソースの親であるリソースの ID。 |
種類のリソースの ID: Spring/apps |
プロパティ |
デプロイ リソースのプロパティ |
DeploymentResourceProperties の |
エスケーユー |
デプロイ リソースの SKU |
SKU |
型 |
リソースの種類 |
"Microsoft.AppPlatform/Spring/apps/deployments@2024-05-01-preview" (英語) |
APMリファレンス
名前 |
形容 |
価値 |
リソースID |
APM のリソース ID |
string (必須) |
BuildResultUserSourceInfo (ビルド結果ユーザーソース情報)
名前 |
形容 |
価値 |
buildResultId (ビルド結果イド) |
同じ Spring インスタンスの既存の成功したビルド結果のリソース ID。 |
文字列 |
型 |
アップロードされたソースの種類 |
'BuildResult' (必須) |
コンテナプローブ設定
名前 |
形容 |
価値 |
ディセーブルプローブ |
liveness プローブと準備プローブを無効にするかどうかを示します |
ブール (bool) |
カスタムコンテナ
名前 |
形容 |
価値 |
引数 |
エントリポイントの引数。 これが指定されていない場合は、Docker イメージの CMD が使用されます。 |
文字列[] |
命令 |
Entrypoint 配列。 シェル内では実行されません。 これが指定されていない場合は、Docker イメージの ENTRYPOINT が使用されます。 |
文字列[] |
コンテナ画像 |
カスタム コンテナーのコンテナー イメージ。 これは、<リポジトリの>の形式である必要があります。レジストリのサーバー名のないタグ<> |
文字列 |
imageRegistryCredential |
イメージ レジストリの資格情報 |
ImageRegistryCredential |
言語フレームワーク |
アップロードされたコンテナー イメージの言語フレームワーク。 サポートされる値: "springboot"、""、null。 |
文字列 |
サーバー |
コンテナー イメージを含むレジストリの名前 |
文字列 |
CustomContainerUserSourceInfo (カスタムコンテナユーザーソース情報)
名前 |
形容 |
価値 |
カスタムコンテナ |
カスタム コンテナー ペイロード |
CustomContainer の |
型 |
アップロードされたソースの種類 |
'Container' (必須) |
CustomScaleRule
名前 |
形容 |
価値 |
認証 |
カスタム スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
カスタム スケール ルールを記述するメタデータ プロパティ。 |
CustomScaleRuleMetadata を する |
型 |
カスタム スケール ルールの種類 例: azure-servicebus、redis など。 |
文字列 |
デプロイメントリソースプロパティ
名前 |
形容 |
価値 |
能動 |
展開がアクティブかどうかを示します |
ブール (bool) |
deploymentSettings (デプロイメント設定) |
展開の展開設定 |
DeploymentSettings (デプロイメント設定) |
ソース |
デプロイのアップロードされたソース情報。 |
UserSourceInfo の |
DeploymentSettings (デプロイメント設定)
DeploymentSettingsアドオンコンフィグ
DeploymentSettingsEnvironment変数
ExecAction(エグゼクティブアクション)
名前 |
形容 |
価値 |
命令 |
コマンドはコンテナー内で実行するコマンド ラインであり、コマンドの作業ディレクトリはコンテナーのファイルシステムのルート ('/') です。 このコマンドはシェル内で実行されないため、従来のシェル命令 ('|'など) は機能しません。 シェルを使用するには、そのシェルを明示的に呼び出す必要があります。 終了ステータス 0 はライブ/正常として扱われ、0 以外は異常として扱われます。 |
文字列[] |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'ExecAction' (必須) |
HttpGetActionの
名前 |
形容 |
価値 |
パス |
HTTP サーバー上のアクセスのパス。 |
文字列 |
計画 |
ホストへの接続に使用するスキーム。 既定値は HTTP です。
指定できる列挙値:
-
"HTTP" は、使用されるスキームが http:// されることを意味します
-
"HTTPS" は、使用されるスキームが https:// されることを意味します |
「HTTP」 「HTTPS」 |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'HTTPGetAction' (必須) |
HttpScaleRule (英語)
名前 |
形容 |
価値 |
認証 |
カスタム スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
http スケール ルールを記述するメタデータ プロパティ。 |
HttpScaleRuleMetadata を する |
ImageRegistryCredential
名前 |
形容 |
価値 |
パスワード |
イメージ レジストリ資格情報のパスワード |
文字列 |
ユーザー名 |
イメージ レジストリ資格情報のユーザー名 |
文字列 |
JarUploadedUserSourceInfo さん
名前 |
形容 |
価値 |
jvmオプション |
JVM パラメーター |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
Jar ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'Jar' (必須) |
NetCoreZipUploadedUserSourceInfo
名前 |
形容 |
価値 |
netCoreMainEntryPath (英語) |
zip ルートを基準とした .NET 実行可能ファイルへのパス |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
.Net ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'NetCoreZip' (必須) |
プローブ
名前 |
形容 |
価値 |
ディセーブルプローブ |
プローブが無効かどうかを示します。 |
bool (必須) |
failureThreshold(失敗しきい値) |
成功した後に失敗したと見なされるプローブの連続する最小障害。 最小値は 1 です。 |
整数 (int) |
initialDelaySeconds (初期遅延秒) |
プローブが開始されるまでのアプリ インスタンスの開始後の秒数。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
整数 (int) |
period秒 |
プローブを実行する頻度 (秒単位)。 最小値は 1 です。 |
整数 (int) |
プローブアクション |
プローブのアクション。 |
ProbeAction の |
successThreshold(成功のしきい値) |
失敗した後にプローブが成功したと見なされる最小連続成功数。 ライブ性と起動には 1 にする必要があります。 最小値は 1 です。 |
整数 (int) |
タイムアウト秒 |
プローブがタイムアウトする秒数。最小値は 1 です。 |
整数 (int) |
プローブアクション
名前 |
形容 |
価値 |
型 |
ExecAction型 'ExecAction' に設定します。 HttpGetActionの型 'HTTPGetAction' に設定します。 TCPSocketAction型 'TCPSocketAction' に設定します。 |
「ExecAction」 「HTTPGetAction」 'TCPSocketAction' (必須) |
キュー スケール ルール
名前 |
形容 |
価値 |
認証 |
キュー スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
キューの長さ |
キューの長さ。 |
整数 (int) |
キュー名 |
キュー名。 |
文字列 |
リソースリクエスト
名前 |
形容 |
価値 |
CPUの |
必要な CPU。 1 コアは 1 または 1000m で表すことができます。 Basic レベルの場合は 500m または 1、Standard レベルの場合は {500m、1、2、3、4} です。 |
文字列 |
メモリ |
必要なメモリ。 1 GB は 1Gi または 1024Mi で表すことができます。 Basic レベルの場合は {512Mi、1Gi、2Gi}、Standard レベルの場合は {512Mi、1Gi、2Gi、...、8Gi} です。 |
文字列 |
規模
名前 |
形容 |
価値 |
マックスレプリカ |
随意。 コンテナー レプリカの最大数。 既定値は 10 (設定されていない場合) です。 |
整数 (int) |
minレプリカ |
随意。 コンテナー レプリカの最小数。 |
整数 (int) |
準則 |
スケーリング ルール。 |
スケールルール[] |
ScaleRule (スケールルール)
名前 |
形容 |
価値 |
azureキュー |
Azure Queue ベースのスケーリング。 |
QueueScaleRule の |
習慣 |
カスタム スケール ルール。 |
CustomScaleRule の |
http |
HTTP 要求ベースのスケーリング。 |
HttpScaleRule を する |
名前 |
スケール ルール名 |
文字列 |
TCP |
Tcp 要求ベースのスケーリング。 |
TcpScaleRule の |
ScaleRuleAuth (英語)
名前 |
形容 |
価値 |
secretRef です。 |
認証パラメーターのプル元となる Azure Spring Apps アプリ インスタンス シークレットの名前。 |
文字列 |
triggerパラメータ |
シークレットを使用するトリガー パラメーター |
文字列 |
SKU
名前 |
形容 |
価値 |
キャパシティ |
ターゲット リソースの現在の容量 |
整数 (int) |
名前 |
SKU の名前 |
文字列 |
レベル |
SKU の階層 |
文字列 |
SourceUploadedUserSourceInfo
名前 |
形容 |
価値 |
アーティファクトセレクタ |
マルチモジュール プロジェクトのデプロイに使用する成果物のセレクター。 これは次のようになります。 ターゲット モジュール/プロジェクトへの相対パス。 |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
ソース ファイルのランタイム バージョン |
文字列 |
型 |
アップロードされたソースの種類 |
'Source' (必須) |
TcpScaleRule の略
名前 |
形容 |
価値 |
認証 |
TCP スケール ルールの認証シークレット。 |
ScaleRuleAuth[] |
メタデータ |
TCP スケール ルールを記述するメタデータ プロパティ。 |
TcpScaleRuleMetadata の |
TCPSocketAction (英語)
名前 |
形容 |
価値 |
型 |
正常性チェックを実行するために実行するアクションの種類。 |
'TCPSocketAction' (必須) |
ユーザーソース情報
名前 |
形容 |
価値 |
型 |
BuildResultUserSourceInfoの型 'BuildResult' に設定します。 CustomContainerUserSourceInfoの型 'Container' に設定します。 JarUploadedUserSourceInfoの型 'Jar' に設定します。 NetCoreZipUploadedUserSourceInfo種類として 'NetCoreZip' に設定します。 SourceUploadedUserSourceInfo種類として 'Source' に設定します。 WarUploadedUserSourceInfo種類として 'War' に設定します。 |
'ビルド結果' 「コンテナ」 「ジャー」 「NetCoreZip」 「ソース」 'War' (必須) |
バージョン |
ソースのバージョン |
文字列 |
WarUploadedUserSourceInfo
名前 |
形容 |
価値 |
jvmオプション |
JVM パラメーター |
文字列 |
relativePath (相対パス) |
ソースを格納するストレージの相対パス |
文字列 |
ランタイムバージョン |
war ファイルのランタイム バージョン |
文字列 |
サーバーバージョン |
サーバー のバージョン。現在サポートされているのは Apache Tomcat のみです |
文字列 |
型 |
アップロードされたソースの種類 |
'War' (必須) |