Microsoft.AppPlatform Spring/apps/deployments
Bicep リソース定義
Spring/apps/deployments リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.AppPlatform/Spring/apps/deployments リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview' = {
name: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
active: bool
deploymentSettings: {
addonConfigs: {}
containerProbeSettings: {
disableProbe: bool
}
environmentVariables: {}
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: {}
type: 'string'
}
http: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {}
}
name: 'string'
tcp: {
auth: [
{
secretRef: 'string'
triggerParameter: 'string'
}
]
metadata: {}
}
}
]
}
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
}
}
}
ProbeAction オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
ExecAction の場合は、次を使用します。
type: 'ExecAction'
command: [
'string'
]
HTTPGetAction の場合は、次の値を使用します。
type: 'HTTPGetAction'
path: 'string'
scheme: 'string'
TCPSocketAction の場合は、次を使用します。
type: 'TCPSocketAction'
UserSourceInfo オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
BuildResult の場合は、次の値を使用します。
type: 'BuildResult'
buildResultId: 'string'
Container の場合は、次の値を使用します。
type: 'Container'
customContainer: {
args: [
'string'
]
command: [
'string'
]
containerImage: 'string'
imageRegistryCredential: {
password: 'string'
username: 'string'
}
languageFramework: 'string'
server: 'string'
}
Jar の場合は、次の値を使用します。
type: 'Jar'
jvmOptions: 'string'
relativePath: 'string'
runtimeVersion: 'string'
NetCoreZip の場合は、次の値を使用します。
type: 'NetCoreZip'
netCoreMainEntryPath: 'string'
relativePath: 'string'
runtimeVersion: 'string'
[ソース] には、次の値を使用します。
type: 'Source'
artifactSelector: 'string'
relativePath: 'string'
runtimeVersion: 'string'
プロパティ値
Spring/apps/deployments
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
sku | デプロイ リソースの SKU | SKU |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: アプリ |
properties | デプロイ リソースのプロパティ | DeploymentResourceProperties |
DeploymentResourceProperties
名前 | 説明 | 値 |
---|---|---|
active | 展開がアクティブかどうかを示します | [bool] |
deploymentSettings | デプロイの展開設定 | DeploymentSettings |
source | デプロイのアップロードされたソース情報。 | UserSourceInfo |
DeploymentSettings
名前 | 説明 | 値 |
---|---|---|
addonConfigs | アドオンのコレクション | object |
containerProbeSettings | コンテナーのライブネスと準備プローブの設定 | ContainerProbeSettings |
environmentVariables | 環境変数のコレクション | object |
livenessProbe | App Instance のライブネスの定期的なプローブ。 プローブが失敗すると、アプリ インスタンスが再起動されます。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
readinessProbe | App Instance サービスの準備状態の定期的なプローブ。 プローブが失敗した場合、App Instance はサービス エンドポイントから削除されます。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
resourceRequests | 必要な CPU とメモリに対して要求されたリソース量。 必要な CPU とメモリを表すためにこのフィールドを使用することをお勧めします。古いフィールド cpu と memoryInGB は後で非推奨になります。 | ResourceRequests |
scale | Azure Spring Apps アプリ インスタンスのスケーリング プロパティ。 | スケール |
startupProbe | StartupProbe は、アプリ インスタンスが正常に初期化されたことを示します。 指定した場合、これが正常に完了するまで、他のプローブは実行されません。 このプローブが失敗した場合、livenessProbe が失敗した場合と同様に、ポッドが再起動されます。 これは、アプリ インスタンスのライフサイクルの開始時に、データの読み込みまたはキャッシュのウォームアップに長い時間がかかる場合に、安定した状態の操作時とは異なるプローブ パラメーターを提供するために使用できます。 これは更新できません。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
terminationGracePeriodSeconds | アプリ インスタンスが正常に終了する必要があるオプションの期間 (秒単位)。 削除要求で減少する可能性があります。 値は負以外の整数である必要があります。 値 0 は、強制終了シグナルを介して直ちに停止することを示します (シャットダウンする機会はありません)。 この値が nil の場合は、代わりに既定の猶予期間が使用されます。 猶予期間は、アプリ インスタンスで実行されているプロセスが終了シグナルを送信してから、プロセスが強制終了シグナルで強制的に停止された時間 (秒単位) です。 この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。 既定値は 90 秒です。 | INT |
ContainerProbeSettings
名前 | 説明 | 値 |
---|---|---|
disableProbe | ライブネスと準備プローブを無効にするかどうかを示します | [bool] |
プローブ
名前 | 説明 | 値 |
---|---|---|
disableProbe | プローブが無効になっているかどうかを示します。 | bool (必須) |
failureThreshold | プローブが成功した後に失敗したと見なされるプローブの連続する最小障害。 最大値は 1 です。 | INT |
initialDelaySeconds | アプリ インスタンスが開始されてからプローブが開始されるまでの秒数。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
INT |
periodSeconds | プローブを実行する頻度 (秒単位)。 最大値は 1 です。 | INT |
probeAction | プローブのアクション。 | ProbeAction |
successThreshold | 失敗した後にプローブが成功したと見なされる最小連続成功数。 ライブネスとスタートアップの場合は 1 にする必要があります。 最大値は 1 です。 | INT |
timeoutSeconds | プローブがタイムアウトした秒数。最小値は 1 です。 | INT |
ProbeAction
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | ExecAction HTTPGetAction TCPSocketAction (必須) |
ExecAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | 'ExecAction' (必須) |
command | Command はコンテナー内で実行するコマンド ラインであり、コマンドの作業ディレクトリはコンテナーのファイルシステムのルート ('/') です。 コマンドはシェル内で実行されないため、従来のシェル命令 (','など) は機能しません。 シェルを使用するには、そのシェルを明示的に呼び出す必要があります。 終了ステータス 0 はライブ/正常として扱われ、0 以外は異常として扱われます。 | string[] |
HttpGetAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | 'HTTPGetAction' (必須) |
path | HTTP サーバーでアクセスするためのパス。 | string |
scheme | ホストへの接続に使用するスキーム。 既定では HTTP です。 可能な列挙型の値: - "HTTP" は、使用されるスキームが 次のことを意味します。 http:// - "HTTPS" は、使用されるスキームが 次のことを意味します。 https:// |
'HTTP' 'HTTPS' |
TCPSocketAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | 'TCPSocketAction' (必須) |
ResourceRequests
名前 | 説明 | 値 |
---|---|---|
cpu | 必要な CPU。 1コアは1または1000mで表すことができます。 Basic レベルの場合は 500m または 1、Standard レベルの場合は {500m、1、2、3、4} です。 | string |
メモリ | 必要なメモリ。 1 GB は 1Gi または 1024Mi で表すことができます。 Basic レベルの場合は {512Mi、1Gi、2Gi}、Standard レベルの場合は {512Mi、1Gi、2Gi、...、8Gi} です。 | string |
スケール
名前 | 説明 | 値 |
---|---|---|
maxReplicas | 省略可能。 コンテナー レプリカの最大数。 設定されていない場合、既定値は 10 です。 | INT |
minReplicas | 省略可能。 コンテナー レプリカの最小数。 | INT |
rules | スケーリング ルール。 | ScaleRule[] |
ScaleRule
名前 | 説明 | 値 |
---|---|---|
azureQueue | Azure Queue ベースのスケーリング。 | QueueScaleRule |
custom | カスタム スケール ルール。 | CustomScaleRule |
http | HTTP 要求ベースのスケーリング。 | HttpScaleRule |
name | スケール ルール名 | string |
tcp | Tcp 要求ベースのスケーリング。 | TcpScaleRule |
QueueScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | キュー スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
queueLength | キューの長さ。 | INT |
queueName | キュー名。 | string |
ScaleRuleAuth
名前 | 説明 | 値 |
---|---|---|
secretRef | 認証パラメーターをプルする Azure Spring Apps アプリ インスタンス シークレットの名前。 | string |
triggerParameter | シークレットを使用するトリガー パラメーター | string |
CustomScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | カスタム スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
metadata | カスタム スケール ルールを記述するためのメタデータ プロパティ。 | object |
type | カスタム スケール ルールの種類 例: azure-servicebus、redis など。 |
string |
HttpScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | カスタム スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
metadata | http スケール ルールを記述するメタデータ プロパティ。 | object |
TcpScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | TCP スケール 規則の認証シークレット。 | ScaleRuleAuth[] |
metadata | tcp スケール ルールを記述するためのメタデータ プロパティ。 | object |
UserSourceInfo
名前 | 説明 | 値 |
---|---|---|
version | ソースのバージョン | string |
type | オブジェクトの種類を設定する | BuildResult コンテナー 瓶 NetCoreZip ソース (必須) |
BuildResultUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'BuildResult' (必須) |
buildResultId | 同じ Spring インスタンスの下にある既存の成功したビルド結果のリソース ID。 | string |
CustomContainerUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'Container' (必須) |
customContainer | カスタム コンテナー ペイロード | CustomContainer |
CustomContainer
名前 | 説明 | 値 |
---|---|---|
args | エントリポイントの引数。 これが指定されていない場合は、Docker イメージの CMD が使用されます。 | string[] |
command | Entrypoint 配列。 シェル内では実行されません。 これが指定されていない場合は、Docker イメージの ENTRYPOINT が使用されます。 | string[] |
containerImage | カスタム コンテナーのコンテナー イメージ。 これは、レジストリのサーバー名を含まない {repository}:{tag} の形式である必要があります | string |
imageRegistryCredential | イメージ レジストリの資格情報 | ImageRegistryCredential |
languageFramework | アップロードされたコンテナー イメージの言語フレームワーク | string |
server | コンテナー イメージを含むレジストリの名前 | string |
ImageRegistryCredential
名前 | 説明 | 値 |
---|---|---|
password | イメージ レジストリ資格情報のパスワード | string |
username | イメージ レジストリ資格情報のユーザー名 | string |
JarUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'Jar' (必須) |
jvmOptions | JVM パラメーター | string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | Jar ファイルのランタイム バージョン | string |
NetCoreZipUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'NetCoreZip' (必須) |
netCoreMainEntryPath | zip ルートを基準とした .NET 実行可能ファイルへのパス | string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | .Net ファイルのランタイム バージョン | string |
SourceUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'Source' (必須) |
artifactSelector | マルチモジュール プロジェクトのデプロイに使用する成果物のセレクター。 これは次のようになります。 ターゲット モジュール/プロジェクトへの相対パス。 |
string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | ソース ファイルのランタイム バージョン | string |
Sku
名前 | 説明 | 値 |
---|---|---|
capacity | ターゲット リソースの現在の容量 | INT |
name | Sku の名前 | string |
レベル | Sku のレベル | string |
ARM テンプレート リソース定義
Spring/apps/deployments リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.AppPlatform/Spring/apps/deployments リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.AppPlatform/Spring/apps/deployments",
"apiVersion": "2023-03-01-preview",
"name": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"properties": {
"active": "bool",
"deploymentSettings": {
"addonConfigs": {},
"containerProbeSettings": {
"disableProbe": "bool"
},
"environmentVariables": {},
"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": {},
"type": "string"
},
"http": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {}
},
"name": "string",
"tcp": {
"auth": [
{
"secretRef": "string",
"triggerParameter": "string"
}
],
"metadata": {}
}
}
]
},
"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
}
}
}
ProbeAction オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
ExecAction の場合は、次を使用します。
"type": "ExecAction",
"command": [ "string" ]
HTTPGetAction の場合は、次の値を使用します。
"type": "HTTPGetAction",
"path": "string",
"scheme": "string"
TCPSocketAction の場合は、次を使用します。
"type": "TCPSocketAction"
UserSourceInfo オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
BuildResult の場合は、次の値を使用します。
"type": "BuildResult",
"buildResultId": "string"
Container の場合は、次の値を使用します。
"type": "Container",
"customContainer": {
"args": [ "string" ],
"command": [ "string" ],
"containerImage": "string",
"imageRegistryCredential": {
"password": "string",
"username": "string"
},
"languageFramework": "string",
"server": "string"
}
Jar の場合は、次の値を使用します。
"type": "Jar",
"jvmOptions": "string",
"relativePath": "string",
"runtimeVersion": "string"
NetCoreZip の場合は、次の値を使用します。
"type": "NetCoreZip",
"netCoreMainEntryPath": "string",
"relativePath": "string",
"runtimeVersion": "string"
[ソース] には、次の値を使用します。
"type": "Source",
"artifactSelector": "string",
"relativePath": "string",
"runtimeVersion": "string"
プロパティ値
Spring/apps/deployments
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.AppPlatform/Spring/apps/deployments' |
apiVersion | リソース API のバージョン | '2023-03-01-preview' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
sku | デプロイ リソースの SKU | SKU |
properties | デプロイ リソースのプロパティ | DeploymentResourceProperties |
DeploymentResourceProperties
名前 | 説明 | 値 |
---|---|---|
active | 展開がアクティブかどうかを示します | [bool] |
deploymentSettings | デプロイの展開設定 | DeploymentSettings |
source | デプロイのアップロードされたソース情報。 | UserSourceInfo |
DeploymentSettings
名前 | 説明 | 値 |
---|---|---|
addonConfigs | アドオンのコレクション | object |
containerProbeSettings | コンテナーのライブネスと準備プローブの設定 | ContainerProbeSettings |
environmentVariables | 環境変数のコレクション | object |
livenessProbe | App Instance のライブネスの定期的なプローブ。 プローブが失敗すると、アプリ インスタンスが再起動されます。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
readinessProbe | App Instance サービスの準備状況の定期的なプローブ。 プローブが失敗した場合、App Instance はサービス エンドポイントから削除されます。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
resourceRequests | 必要な CPU とメモリに対して要求されたリソース量。 このフィールドを使用して必要な CPU とメモリを表し、古いフィールド cpu と memoryInGB は後で非推奨とすることをお勧めします。 | ResourceRequests |
scale | Azure Spring Apps アプリ インスタンスのプロパティのスケーリング。 | スケール |
startupProbe | StartupProbe は、アプリ インスタンスが正常に初期化されたことを示します。 指定した場合、これが正常に完了するまで、他のプローブは実行されません。 このプローブが失敗した場合、livenessProbe が失敗した場合と同様に、ポッドが再起動されます。 これは、アプリ インスタンスのライフサイクルの開始時に、データの読み込みまたはキャッシュのウォームアップに長い時間がかかる場合に、安定した状態の操作時とは異なるプローブ パラメーターを提供するために使用できます。 これは更新できません。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
terminationGracePeriodSeconds | アプリ インスタンスが正常に終了する必要があるオプションの期間 (秒単位)。 削除要求で減少する可能性があります。 値は負以外の整数である必要があります。 値 0 は、強制終了シグナルを介して直ちに停止することを示します (シャットダウンする機会はありません)。 この値が nil の場合は、代わりに既定の猶予期間が使用されます。 猶予期間は、アプリ インスタンスで実行されているプロセスが終了シグナルを送信してから、プロセスが強制終了シグナルで強制的に停止された時間 (秒単位) です。 この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。 既定値は 90 秒です。 | INT |
ContainerProbeSettings
名前 | 説明 | 値 |
---|---|---|
disableProbe | ライブネスと準備プローブを無効にするかどうかを示します | [bool] |
プローブ
名前 | 説明 | 値 |
---|---|---|
disableProbe | プローブが無効になっているかどうかを示します。 | bool (必須) |
failureThreshold | プローブが成功した後に失敗したと見なされるプローブの連続する最小障害。 最大値は 1 です。 | INT |
initialDelaySeconds | アプリ インスタンスが開始されてからプローブが開始されるまでの秒数。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
INT |
periodSeconds | プローブを実行する頻度 (秒単位)。 最大値は 1 です。 | INT |
probeAction | プローブのアクション。 | ProbeAction |
successThreshold | 失敗した後にプローブが成功したと見なされる最小連続成功数。 ライブネスとスタートアップの場合は 1 にする必要があります。 最大値は 1 です。 | INT |
timeoutSeconds | プローブがタイムアウトした秒数。最小値は 1 です。 | INT |
ProbeAction
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | ExecAction HTTPGetAction TCPSocketAction (必須) |
ExecAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | 'ExecAction' (必須) |
command | Command はコンテナー内で実行するコマンド ラインであり、コマンドの作業ディレクトリはコンテナーのファイルシステムのルート ('/') です。 コマンドはシェル内で実行されないため、従来のシェル命令 (','など) は機能しません。 シェルを使用するには、そのシェルを明示的に呼び出す必要があります。 終了ステータス 0 はライブ/正常として扱われ、0 以外は異常として扱われます。 | string[] |
HttpGetAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | 'HTTPGetAction' (必須) |
path | HTTP サーバーでアクセスするためのパス。 | string |
scheme | ホストへの接続に使用するスキーム。 既定では HTTP です。 可能な列挙型の値: - "HTTP" は、使用されるスキームが 次のことを意味します。 http:// - "HTTPS" は、使用されるスキームが 次のことを意味します。 https:// |
'HTTP' 'HTTPS' |
TCPSocketAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | 'TCPSocketAction' (必須) |
ResourceRequests
名前 | 説明 | 値 |
---|---|---|
cpu | 必要な CPU。 1 コアは 1 または 1000 m で表すことができます。 Basic レベルの場合は 500m または 1、Standard レベルの場合は {500m、1、2、3、4} である必要があります。 | string |
メモリ | 必要なメモリ。 1 GB は、1Gi または 1024Mi で表すことができます。 Basic レベルの場合は {512Mi、1Gi、2Gi}、Standard レベルの場合は {512Mi、1Gi、2Gi、...、8Gi} です。 | string |
スケール
名前 | 説明 | 値 |
---|---|---|
maxReplicas | 省略可能。 コンテナー レプリカの最大数。 設定されていない場合、既定値は 10 です。 | INT |
minReplicas | 省略可能。 コンテナー レプリカの最小数。 | INT |
rules | スケーリング ルール。 | ScaleRule[] |
ScaleRule
名前 | 説明 | 値 |
---|---|---|
azureQueue | Azure Queue ベースのスケーリング。 | QueueScaleRule |
custom | カスタム スケール ルール。 | CustomScaleRule |
http | HTTP 要求ベースのスケーリング。 | HttpScaleRule |
name | スケール ルール名 | string |
tcp | Tcp 要求ベースのスケーリング。 | TcpScaleRule |
QueueScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | キュー スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
queueLength | キューの長さ。 | INT |
queueName | キュー名。 | string |
ScaleRuleAuth
名前 | 説明 | 値 |
---|---|---|
secretRef | 認証パラメーターをプルする Azure Spring Apps App Instance シークレットの名前。 | string |
triggerParameter | シークレットを使用するトリガー パラメーター | string |
CustomScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | カスタム スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
metadata | カスタム スケール ルールを記述するためのメタデータ プロパティ。 | object |
type | カスタム スケール ルールの種類 例: azure-servicebus、redis など。 |
string |
HttpScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | カスタム スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
metadata | http スケール ルールを記述するメタデータ プロパティ。 | object |
TcpScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | TCP スケール 規則の認証シークレット。 | ScaleRuleAuth[] |
metadata | tcp スケール ルールを記述するためのメタデータ プロパティ。 | object |
UserSourceInfo
名前 | 説明 | 値 |
---|---|---|
version | ソースのバージョン | string |
type | オブジェクトの種類を設定する | BuildResult コンテナー 瓶 NetCoreZip ソース (必須) |
BuildResultUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'BuildResult' (必須) |
buildResultId | 同じ Spring インスタンスの下にある既存の成功したビルド結果のリソース ID。 | string |
CustomContainerUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'Container' (必須) |
customContainer | カスタム コンテナー ペイロード | CustomContainer |
CustomContainer
名前 | 説明 | 値 |
---|---|---|
args | エントリポイントの引数。 これが指定されていない場合は、Docker イメージの CMD が使用されます。 | string[] |
command | Entrypoint 配列。 シェル内では実行されません。 これが指定されていない場合は、Docker イメージの ENTRYPOINT が使用されます。 | string[] |
containerImage | カスタム コンテナーのコンテナー イメージ。 これは、レジストリのサーバー名を含まない {repository}:{tag} の形式である必要があります | string |
imageRegistryCredential | イメージ レジストリの資格情報 | ImageRegistryCredential |
languageFramework | アップロードされたコンテナー イメージの言語フレームワーク | string |
server | コンテナー イメージを含むレジストリの名前 | string |
ImageRegistryCredential
名前 | 説明 | 値 |
---|---|---|
password | イメージ レジストリ資格情報のパスワード | string |
username | イメージ レジストリ資格情報のユーザー名 | string |
JarUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'Jar' (必須) |
jvmOptions | JVM パラメーター | string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | Jar ファイルのランタイム バージョン | string |
NetCoreZipUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'NetCoreZip' (必須) |
netCoreMainEntryPath | zip ルートを基準とした .NET 実行可能ファイルへのパス | string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | .Net ファイルのランタイム バージョン | string |
SourceUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | 'Source' (必須) |
artifactSelector | マルチモジュール プロジェクトのデプロイに使用する成果物のセレクター。 これは、次のようになります。 ターゲット モジュール/プロジェクトへの相対パス。 |
string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | ソース ファイルのランタイム バージョン | string |
Sku
名前 | 説明 | 値 |
---|---|---|
capacity | ターゲット リソースの現在の容量 | INT |
name | SKU の名前 | string |
レベル | Sku のレベル | string |
Terraform (AzAPI プロバイダー) リソース定義
Spring/apps/deployments リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.AppPlatform/Spring/apps/deployments リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
active = bool
deploymentSettings = {
addonConfigs = {}
containerProbeSettings = {
disableProbe = bool
}
environmentVariables = {}
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 = {}
type = "string"
}
http = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {}
}
name = "string"
tcp = {
auth = [
{
secretRef = "string"
triggerParameter = "string"
}
]
metadata = {}
}
}
]
}
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"
}
})
}
ProbeAction オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
ExecAction の場合は、次を使用します。
type = "ExecAction"
command = [
"string"
]
HTTPGetAction の場合は、次を使用します。
type = "HTTPGetAction"
path = "string"
scheme = "string"
TCPSocketAction の場合は、次を使用します。
type = "TCPSocketAction"
UserSourceInfo オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
BuildResult の場合は、次の値を使用します。
type = "BuildResult"
buildResultId = "string"
[コンテナー] には、次の値を使用します。
type = "Container"
customContainer = {
args = [
"string"
]
command = [
"string"
]
containerImage = "string"
imageRegistryCredential = {
password = "string"
username = "string"
}
languageFramework = "string"
server = "string"
}
Jar の場合は、次の値を使用します。
type = "Jar"
jvmOptions = "string"
relativePath = "string"
runtimeVersion = "string"
NetCoreZip の場合は、次の値を使用します。
type = "NetCoreZip"
netCoreMainEntryPath = "string"
relativePath = "string"
runtimeVersion = "string"
[ソース] には、次の値を使用します。
type = "Source"
artifactSelector = "string"
relativePath = "string"
runtimeVersion = "string"
プロパティ値
Spring/apps/deployments
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.AppPlatform/Spring/apps/deployments@2023-03-01-preview" |
name | リソース名 | string (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: アプリ |
sku | デプロイ リソースの SKU | SKU |
properties | デプロイ リソースのプロパティ | DeploymentResourceProperties |
DeploymentResourceProperties
名前 | 説明 | 値 |
---|---|---|
active | 展開がアクティブかどうかを示します | [bool] |
deploymentSettings | 展開の展開設定 | DeploymentSettings |
source | デプロイのアップロードされたソース情報。 | UserSourceInfo |
DeploymentSettings
名前 | 説明 | 値 |
---|---|---|
addonConfigs | アドオンのコレクション | object |
containerProbeSettings | コンテナーのライブネスと準備プローブの設定 | ContainerProbeSettings |
environmentVariables | 環境変数のコレクション | object |
livenessProbe | App Instance のライブネスの定期的なプローブ。 プローブが失敗すると、アプリ インスタンスが再起動されます。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
readinessProbe | App Instance サービスの準備状況の定期的なプローブ。 プローブが失敗した場合、App Instance はサービス エンドポイントから削除されます。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
resourceRequests | 必要な CPU とメモリに対して要求されたリソース量。 このフィールドを使用して必要な CPU とメモリを表し、古いフィールド cpu と memoryInGB は後で非推奨とすることをお勧めします。 | ResourceRequests |
scale | Azure Spring Apps アプリ インスタンスのプロパティのスケーリング。 | スケール |
startupProbe | StartupProbe は、アプリ インスタンスが正常に初期化されたことを示します。 指定した場合、これが正常に完了するまで、他のプローブは実行されません。 このプローブが失敗した場合、livenessProbe が失敗した場合と同様に、ポッドが再起動されます。 これは、アプリ インスタンスのライフサイクルの開始時に、データの読み込みまたはキャッシュのウォームアップに長い時間がかかる場合に、安定した状態の操作時とは異なるプローブ パラメーターを提供するために使用できます。 これは更新できません。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
プローブ |
terminationGracePeriodSeconds | アプリ インスタンスが正常に終了する必要があるオプションの期間 (秒単位)。 削除要求で減少する可能性があります。 値は負以外の整数である必要があります。 値 0 は、強制終了シグナルを介して直ちに停止することを示します (シャットダウンする機会はありません)。 この値が nil の場合は、代わりに既定の猶予期間が使用されます。 猶予期間は、アプリ インスタンスで実行されているプロセスが終了シグナルを送信してから、プロセスが強制終了シグナルで強制的に停止された時間 (秒単位) です。 この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。 既定値は 90 秒です。 | INT |
ContainerProbeSettings
名前 | 説明 | 値 |
---|---|---|
disableProbe | ライブネスと準備プローブを無効にするかどうかを示します | [bool] |
プローブ
名前 | 説明 | 値 |
---|---|---|
disableProbe | プローブが無効になっているかどうかを示します。 | bool (必須) |
failureThreshold | プローブが成功した後に失敗したと見なされるプローブの連続する最小障害。 最大値は 1 です。 | INT |
initialDelaySeconds | アプリ インスタンスが開始されてからプローブが開始されるまでの秒数。 詳細情報: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
INT |
periodSeconds | プローブを実行する頻度 (秒単位)。 最大値は 1 です。 | INT |
probeAction | プローブのアクション。 | ProbeAction |
successThreshold | 失敗した後にプローブが成功したと見なされる最小連続成功数。 ライブネスとスタートアップの場合は 1 にする必要があります。 最大値は 1 です。 | INT |
timeoutSeconds | プローブがタイムアウトした秒数。最小値は 1 です。 | INT |
ProbeAction
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | ExecAction HTTPGetAction TCPSocketAction (必須) |
ExecAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | "ExecAction" (必須) |
command | Command はコンテナー内で実行するコマンド ラインであり、コマンドの作業ディレクトリはコンテナーのファイルシステムのルート ('/') です。 コマンドはシェル内で実行されないため、従来のシェル命令 (','など) は機能しません。 シェルを使用するには、そのシェルを明示的に呼び出す必要があります。 終了状態 0 はライブ/正常として扱われ、0 以外は異常です。 | string[] |
HttpGetAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | "HTTPGetAction" (必須) |
path | HTTP サーバーでアクセスするためのパス。 | string |
scheme | ホストへの接続に使用するスキーム。 既定では HTTP です。 可能な列挙値: - "HTTP" は、使用されるスキームが 次のことを意味します。 http:// - "HTTPS" は、使用されるスキームが 次のことを意味します。 https:// |
"HTTP" "HTTPS" |
TCPSocketAction
名前 | 説明 | 値 |
---|---|---|
type | 正常性チェックを実行するために実行するアクションの種類。 | "TCPSocketAction" (必須) |
ResourceRequests
名前 | 説明 | 値 |
---|---|---|
cpu | 必要な CPU。 1コアは1または1000mで表すことができます。 Basic レベルの場合は 500m または 1、Standard レベルの場合は {500m、1、2、3、4} です。 | string |
メモリ | 必要なメモリ。 1 GB は 1Gi または 1024Mi で表すことができます。 Basic レベルの場合は {512Mi、1Gi、2Gi}、Standard レベルの場合は {512Mi、1Gi、2Gi、...、8Gi} です。 | string |
スケール
名前 | 説明 | 値 |
---|---|---|
maxReplicas | 省略可能。 コンテナー レプリカの最大数。 設定されていない場合、既定値は 10 です。 | INT |
minReplicas | 省略可能。 コンテナー レプリカの最小数。 | INT |
rules | スケーリング ルール。 | ScaleRule[] |
ScaleRule
名前 | 説明 | 値 |
---|---|---|
azureQueue | Azure Queue ベースのスケーリング。 | QueueScaleRule |
custom | カスタム スケール ルール。 | CustomScaleRule |
http | HTTP 要求ベースのスケーリング。 | HttpScaleRule |
name | スケール ルール名 | string |
tcp | Tcp 要求ベースのスケーリング。 | TcpScaleRule |
QueueScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | キュー スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
queueLength | キューの長さ。 | INT |
queueName | キュー名。 | string |
ScaleRuleAuth
名前 | 説明 | 値 |
---|---|---|
secretRef | 認証パラメーターをプルする Azure Spring Apps アプリ インスタンス シークレットの名前。 | string |
triggerParameter | シークレットを使用するトリガー パラメーター | string |
CustomScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | カスタム スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
metadata | カスタム スケール ルールを記述するためのメタデータ プロパティ。 | object |
type | カスタム スケール ルールの種類 例: azure-servicebus、redis など。 |
string |
HttpScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | カスタム スケール ルールの認証シークレット。 | ScaleRuleAuth[] |
metadata | http スケール ルールを記述するメタデータ プロパティ。 | object |
TcpScaleRule
名前 | 説明 | 値 |
---|---|---|
auth | TCP スケール 規則の認証シークレット。 | ScaleRuleAuth[] |
metadata | tcp スケール ルールを記述するためのメタデータ プロパティ。 | object |
UserSourceInfo
名前 | 説明 | 値 |
---|---|---|
version | ソースのバージョン | string |
type | オブジェクトの種類を設定する | BuildResult コンテナー 瓶 NetCoreZip ソース (必須) |
BuildResultUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | "BuildResult" (必須) |
buildResultId | 同じ Spring インスタンスの下にある既存の成功したビルド結果のリソース ID。 | string |
CustomContainerUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | "Container" (必須) |
customContainer | カスタム コンテナー ペイロード | CustomContainer |
CustomContainer
名前 | 説明 | 値 |
---|---|---|
args | エントリポイントの引数。 これが指定されていない場合は、Docker イメージの CMD が使用されます。 | string[] |
command | Entrypoint 配列。 シェル内では実行されません。 これが指定されていない場合は、Docker イメージの ENTRYPOINT が使用されます。 | string[] |
containerImage | カスタム コンテナーのコンテナー イメージ。 これは、レジストリのサーバー名を含まない {repository}:{tag} の形式である必要があります | string |
imageRegistryCredential | イメージ レジストリの資格情報 | ImageRegistryCredential |
languageFramework | アップロードされたコンテナー イメージの言語フレームワーク | string |
server | コンテナー イメージを含むレジストリの名前 | string |
ImageRegistryCredential
名前 | 説明 | 値 |
---|---|---|
password | イメージ レジストリ資格情報のパスワード | string |
username | イメージ レジストリ資格情報のユーザー名 | string |
JarUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | "Jar" (必須) |
jvmOptions | JVM パラメーター | string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | Jar ファイルのランタイム バージョン | string |
NetCoreZipUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | "NetCoreZip" (必須) |
netCoreMainEntryPath | zip ルートを基準とした .NET 実行可能ファイルへのパス | string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | .Net ファイルのランタイム バージョン | string |
SourceUploadedUserSourceInfo
名前 | 説明 | 値 |
---|---|---|
type | アップロードされたソースの種類 | "Source" (必須) |
artifactSelector | マルチモジュール プロジェクトのデプロイに使用する成果物のセレクター。 これは次のようになります。 ターゲット モジュール/プロジェクトへの相対パス。 |
string |
relativePath | ソースを格納するストレージの相対パス | string |
runtimeVersion | ソース ファイルのランタイム バージョン | string |
Sku
名前 | 説明 | 値 |
---|---|---|
capacity | ターゲット リソースの現在の容量 | INT |
name | Sku の名前 | string |
レベル | Sku のレベル | string |