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