Microsoft.ServiceFabric クラスター/アプリケーション 2021-06-01
Bicep リソース定義
クラスター/アプリケーション リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceFabric/clusters/applications リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ServiceFabric/clusters/applications@2021-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
managedIdentities: [
{
name: 'string'
principalId: 'string'
}
]
maximumNodes: int
metrics: [
{
maximumCapacity: int
name: 'string'
reservationCapacity: int
totalApplicationCapacity: int
}
]
minimumNodes: int
parameters: {
{customized property}: 'string'
}
removeApplicationCapacity: bool
typeName: 'string'
typeVersion: 'string'
upgradePolicy: {
applicationHealthPolicy: {
considerWarningAsError: bool
defaultServiceTypeHealthPolicy: {
maxPercentUnhealthyPartitionsPerService: int
maxPercentUnhealthyReplicasPerPartition: int
maxPercentUnhealthyServices: int
}
maxPercentUnhealthyDeployedApplications: int
serviceTypeHealthPolicyMap: {
{customized property}: {
maxPercentUnhealthyPartitionsPerService: int
maxPercentUnhealthyReplicasPerPartition: int
maxPercentUnhealthyServices: int
}
}
}
forceRestart: bool
recreateApplication: bool
rollingUpgradeMonitoringPolicy: {
failureAction: 'string'
healthCheckRetryTimeout: 'string'
healthCheckStableDuration: 'string'
healthCheckWaitDuration: 'string'
upgradeDomainTimeout: 'string'
upgradeTimeout: 'string'
}
upgradeMode: 'string'
upgradeReplicaSetCheckTimeout: 'string'
}
}
}
プロパティ値
clusters/applications
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
location | 新しい API では非推奨になります。リソースの場所は親リソースによって異なります。 | string |
tags | Azure リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: クラスター |
identity | Azure リソースのマネージド ID について説明します。 | ManagedIdentity |
properties | アプリケーション リソースのプロパティ。 | ApplicationResourceProperties |
ManagedIdentity
名前 | 説明 | 値 |
---|---|---|
type | リソースのマネージド ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned、UserAssigned' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' |
UserAssignedIdentityMap |
UserAssignedIdentityMap
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity |
UserAssignedIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ApplicationResourceProperties
名前 | 説明 | 値 |
---|---|---|
managedIdentities | アプリケーションのユーザー割り当て ID の一覧。それぞれがフレンドリ名にマップされます。 | ApplicationUserAssignedIdentity[] |
maximumNodes | Service Fabric がこのアプリケーション用に容量を予約するノードの最大数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 既定では、このプロパティの値は 0 であり、サービスは任意のノードに配置できることを意味します。 | INT 制約: 最小値 = 0 |
metrics | アプリケーション容量メトリックの説明の一覧。 | ApplicationMetricDescription[] |
minimumNodes | Service Fabric がこのアプリケーション用に容量を予約するノードの最小数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 このプロパティが 0 に設定されている場合、容量は予約されません。 このプロパティの値は、MaximumNodes プロパティの値を超えることはできません。 | INT 制約: 最小値 = 0 |
parameters | アプリケーション マニフェストで指定された既定値からオーバーライドされた値を持つアプリケーション パラメーターの一覧。 | ApplicationParameterList |
removeApplicationCapacity | 現在のアプリケーション容量設定を削除します。 | [bool] |
typeName | アプリケーション マニフェストで定義されているアプリケーションの種類の名前。 | string |
typeVersion | アプリケーション マニフェストで定義されているアプリケーションの種類のバージョンです。 | string |
upgradePolicy | 監視対象アプリケーションのアップグレードのポリシーについて説明します。 | ApplicationUpgradePolicy |
ApplicationUserAssignedIdentity
名前 | 説明 | 値 |
---|---|---|
name | ユーザー割り当て ID のフレンドリ名。 | string (必須) |
principalId | ユーザー割り当て ID のプリンシパル ID。 | string (必須) |
ApplicationMetricDescription
名前 | 説明 | 値 |
---|---|---|
maximumCapacity | Service Fabric アプリケーションの最大ノード容量。 これは、1 つのノード上のこのアプリケーションのインスタンスの最大負荷です。 ノードの容量がこの値より大きい場合でも、Service Fabric は各ノード上のアプリケーション内のサービスの総負荷をこの値に制限します。 0 に設定すると、このメトリックの容量は各ノードで無制限になります。 アプリケーション容量が定義された新しいアプリケーションを作成する場合、MaximumNodes の積とこの値は常に TotalApplicationCapacity 以下である必要があります。 アプリケーション容量を使用して既存のアプリケーションを更新する場合、MaximumNodes の積とこの値は常に TotalApplicationCapacity 以下である必要があります。 |
INT |
name | メトリックの名前。 | string |
reservationCapacity | Service Fabric アプリケーションのノード予約容量。 これは、このアプリケーションのインスタンスを持つノードで予約されている負荷の量です。 MinimumNodes が指定されている場合、これらの値の積は、アプリケーション用にクラスターに予約されている容量になります。 0 に設定した場合、このメトリックの容量は予約されません。 アプリケーション容量を設定する場合、またはアプリケーション容量を更新する場合。この値は、各メトリックの MaximumCapacity 以下である必要があります。 |
INT |
totalApplicationCapacity | Service Fabric アプリケーションのメトリック容量の合計。 これは、クラスター内のこのアプリケーションの合計メトリック容量です。 Service Fabric は、アプリケーション内のサービスの負荷の合計をこの値に制限しようとします。 アプリケーション容量が定義された新しいアプリケーションを作成する場合、MaximumNodes と MaximumCapacity の積は常に、この値以下である必要があります。 |
INT |
ApplicationParameterList
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | string |
ApplicationUpgradePolicy
名前 | 説明 | 値 |
---|---|---|
applicationHealthPolicy | アプリケーションまたはその子エンティティの正常性を評価するために使用される正常性ポリシーを定義します。 | ArmApplicationHealthPolicy |
forceRestart | true の場合、コード バージョンが変更されていない場合 (アップグレードによって構成またはデータのみが変更される) 場合でも、アップグレード中にプロセスが強制的に再起動されます。 | [bool] |
recreateApplication | 更新時にアプリケーションを再作成するかどうかを決定します。 value=true の場合、アップグレード ポリシーパラメーターの残りの部分は許可されず、可用性が失われます。 | [bool] |
rollingUpgradeMonitoringPolicy | アプリケーションのアップグレードの監視に使用されるポリシー | ArmRollingUpgradeMonitoringPolicy |
upgradeMode | ローリング アップグレード時に正常性を監視するために使用されるモード。 値は UnmonitoredAuto、UnmonitoredManual、Monitored です。 | 'Invalid' 'Monitored' 'UnmonitoredAuto' 'UnmonitoredManual' |
upgradeReplicaSetCheckTimeout | アップグレード ドメインの処理をブロックし、予期しない問題が発生したときに可用性の損失を防ぐための最長時間。 このタイムアウトが期限切れになると、可用性の損失問題に関係なく、アップグレード ドメインの処理が続行されます。 タイムアウトは、各アップグレード ドメインの開始時にリセットされます。 有効な値は 0 から 42949672925 の範囲です (0 と 42949672925 を含みます)。 (符号なし 32 ビット整数)。 | string |
ArmApplicationHealthPolicy
名前 | 説明 | 値 |
---|---|---|
considerWarningAsError | 警告がエラーと同じ重大度で処理されることを示します。 | [bool] |
defaultServiceTypeHealthPolicy | サービスの種類の正常性を評価するために既定で使用される正常性ポリシー。 | ArmServiceTypeHealthPolicy |
maxPercentUnhealthyDeployedApplications | 異常なデプロイ済みアプリケーションの割合の最大許容パーセンテージ。 使用できる値は、0 から 100 までのバイト値です。 パーセンテージは、アプリケーションがエラーと見なされる前に異常になる可能性がある、デプロイされたアプリケーションの許容される最大割合を表します。 これは、異常にデプロイされたアプリケーションの数を、アプリケーションが現在クラスターにデプロイされているノードの数で割ることによって計算されます。 切り上げ計算が実行され、少数のノードに対する 1 つのエラーは許容されます。 既定のパーセンテージは 0 です。 |
INT |
serviceTypeHealthPolicyMap | サービスの種類ごとの正常性ポリシーを持つマップ。 このマップは、既定では空です。 | ArmServiceTypeHealthPolicyMap |
ArmServiceTypeHealthPolicy
名前 | 説明 | 値 |
---|---|---|
maxPercentUnhealthyPartitionsPerService | アプリケーションがエラーと見なされる前に、サービスごとに許容されるパーティションの最大割合。 | INT 制約: 最小値 = 0 最大値 = 100 |
maxPercentUnhealthyReplicasPerPartition | アプリケーションがエラーと見なされる前に、パーティションあたりのレプリカの最大割合が異常であることが許可されています。 | INT 制約: 最小値 = 0 最大値 = 100 |
maxPercentUnhealthyServices | アプリケーションがエラーと見なされる前に、異常が許容されるサービスの最大割合。 | INT 制約: 最小値 = 0 最大値 = 100 |
ArmServiceTypeHealthPolicyMap
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | ArmServiceTypeHealthPolicy |
ArmRollingUpgradeMonitoringPolicy
名前 | 説明 | 値 |
---|---|---|
failureAction | サービス パッケージのアクティブ化モード | 'Manual' 'Rollback' |
healthCheckRetryTimeout | アプリケーションまたはクラスターが正常でない場合に、正常性評価を再試行する時間。この時間を超えると、FailureAction に指定したアクションが実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
healthCheckStableDuration | アプリケーションまたはクラスターが正常な状態である必要がある時間。この時間を超えると、アップグレードが次のアップグレード ドメインに進みます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
healthCheckWaitDuration | ドメインのアップグレードを完了後、待機する時間。この時間を超えると、正常性ポリシーが適用されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
upgradeDomainTimeout | 各ドメインがアップグレードを完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
upgradeTimeout | アップグレード全体を完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
ARM テンプレート リソース定義
クラスター/アプリケーション リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceFabric/clusters/applications リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ServiceFabric/clusters/applications",
"apiVersion": "2021-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"managedIdentities": [
{
"name": "string",
"principalId": "string"
}
],
"maximumNodes": "int",
"metrics": [
{
"maximumCapacity": "int",
"name": "string",
"reservationCapacity": "int",
"totalApplicationCapacity": "int"
}
],
"minimumNodes": "int",
"parameters": {
"{customized property}": "string"
},
"removeApplicationCapacity": "bool",
"typeName": "string",
"typeVersion": "string",
"upgradePolicy": {
"applicationHealthPolicy": {
"considerWarningAsError": "bool",
"defaultServiceTypeHealthPolicy": {
"maxPercentUnhealthyPartitionsPerService": "int",
"maxPercentUnhealthyReplicasPerPartition": "int",
"maxPercentUnhealthyServices": "int"
},
"maxPercentUnhealthyDeployedApplications": "int",
"serviceTypeHealthPolicyMap": {
"{customized property}": {
"maxPercentUnhealthyPartitionsPerService": "int",
"maxPercentUnhealthyReplicasPerPartition": "int",
"maxPercentUnhealthyServices": "int"
}
}
},
"forceRestart": "bool",
"recreateApplication": "bool",
"rollingUpgradeMonitoringPolicy": {
"failureAction": "string",
"healthCheckRetryTimeout": "string",
"healthCheckStableDuration": "string",
"healthCheckWaitDuration": "string",
"upgradeDomainTimeout": "string",
"upgradeTimeout": "string"
},
"upgradeMode": "string",
"upgradeReplicaSetCheckTimeout": "string"
}
}
}
プロパティ値
clusters/applications
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.ServiceFabric/clusters/applications' |
apiVersion | リソース API のバージョン | '2021-06-01' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
location | 新しい API では非推奨になります。リソースの場所は親リソースによって異なります。 | string |
tags | Azure リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
identity | Azure リソースのマネージド ID について説明します。 | ManagedIdentity |
properties | アプリケーション リソースのプロパティ。 | ApplicationResourceProperties |
ManagedIdentity
名前 | 説明 | 値 |
---|---|---|
type | リソースのマネージド ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' |
UserAssignedIdentityMap |
UserAssignedIdentityMap
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity |
UserAssignedIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ApplicationResourceProperties
名前 | 説明 | 値 |
---|---|---|
managedIdentities | アプリケーションのユーザー割り当て ID の一覧。それぞれがフレンドリ名にマップされます。 | ApplicationUserAssignedIdentity[] |
maximumNodes | Service Fabric がこのアプリケーション用に容量を予約するノードの最大数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 既定では、このプロパティの値は 0 であり、サービスを任意のノードに配置できることを意味します。 | INT 制約: 最小値 = 0 |
metrics | アプリケーション容量メトリックの説明の一覧。 | ApplicationMetricDescription[] |
minimumNodes | Service Fabric がこのアプリケーション用に容量を予約するノードの最小数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 このプロパティが 0 に設定されている場合、容量は予約されません。 このプロパティの値は、MaximumNodes プロパティの値を超えることはできません。 | INT 制約: 最小値 = 0 |
parameters | アプリケーション マニフェストで指定された既定値からオーバーライドされた値を持つアプリケーション パラメーターの一覧。 | ApplicationParameterList |
removeApplicationCapacity | 現在のアプリケーション容量設定を削除します。 | [bool] |
typeName | アプリケーション マニフェストで定義されているアプリケーションの種類の名前。 | string |
typeVersion | アプリケーション マニフェストで定義されているアプリケーションの種類のバージョンです。 | string |
upgradePolicy | 監視対象アプリケーションのアップグレードのポリシーについて説明します。 | ApplicationUpgradePolicy |
ApplicationUserAssignedIdentity
名前 | 説明 | 値 |
---|---|---|
name | ユーザー割り当て ID のフレンドリ名。 | string (必須) |
principalId | ユーザー割り当て ID のプリンシパル ID。 | string (必須) |
ApplicationMetricDescription
名前 | 説明 | 値 |
---|---|---|
maximumCapacity | Service Fabric アプリケーションの最大ノード容量。 これは、1 つのノード上のこのアプリケーションのインスタンスの最大負荷です。 ノードの容量がこの値より大きい場合でも、Service Fabric は各ノード上のアプリケーション内のサービスの総負荷をこの値に制限します。 0 に設定すると、このメトリックの容量は各ノードで無制限になります。 アプリケーション容量が定義された新しいアプリケーションを作成する場合、MaximumNodes の積とこの値は常に TotalApplicationCapacity 以下である必要があります。 アプリケーション容量を使用して既存のアプリケーションを更新する場合、MaximumNodes とこの値の積は常に TotalApplicationCapacity 以下である必要があります。 |
INT |
name | メトリックの名前。 | string |
reservationCapacity | Service Fabric アプリケーションのノード予約容量。 これは、このアプリケーションのインスタンスを持つノードで予約されている負荷の量です。 MinimumNodes が指定されている場合、これらの値の積は、アプリケーションのクラスターで予約されている容量になります。 0 に設定すると、このメトリック用に容量は予約されません。 アプリケーション容量を設定する場合、またはアプリケーション容量を更新する場合。この値は、各メトリックの MaximumCapacity 以下である必要があります。 |
INT |
totalApplicationCapacity | Service Fabric アプリケーションのメトリック容量の合計。 これは、クラスター内のこのアプリケーションの合計メトリック容量です。 Service Fabric は、アプリケーション内のサービスの負荷の合計をこの値に制限しようとします。 アプリケーション容量が定義された新しいアプリケーションを作成する場合、MaximumNodes と MaximumCapacity の積は常に、この値以下である必要があります。 |
INT |
ApplicationParameterList
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | string |
ApplicationUpgradePolicy
名前 | 説明 | 値 |
---|---|---|
applicationHealthPolicy | アプリケーションまたはその子エンティティの正常性を評価するために使用される正常性ポリシーを定義します。 | ArmApplicationHealthPolicy |
forceRestart | true の場合、コード バージョンが変更されていない場合 (アップグレードによって構成またはデータのみが変更される) 場合でも、アップグレード中にプロセスが強制的に再起動されます。 | [bool] |
recreateApplication | 更新時にアプリケーションを再作成するかどうかを決定します。 value=true の場合、アップグレード ポリシーパラメーターの残りの部分は許可されず、可用性が失われます。 | [bool] |
rollingUpgradeMonitoringPolicy | アプリケーションのアップグレードの監視に使用されるポリシー | ArmRollingUpgradeMonitoringPolicy |
upgradeMode | ローリング アップグレード時に正常性を監視するために使用されるモード。 値は UnmonitoredAuto、UnmonitoredManual、Monitored です。 | 'Invalid' 'Monitored' 'UnmonitoredAuto' 'UnmonitoredManual' |
upgradeReplicaSetCheckTimeout | アップグレード ドメインの処理をブロックし、予期しない問題が発生したときに可用性の損失を防ぐための最長時間。 このタイムアウトが期限切れになると、可用性の損失問題に関係なく、アップグレード ドメインの処理が続行されます。 タイムアウトは、各アップグレード ドメインの開始時にリセットされます。 有効な値は 0 から 42949672925 の範囲です (0 と 42949672925 を含みます)。 (符号なし 32 ビット整数)。 | string |
ArmApplicationHealthPolicy
名前 | 説明 | 値 |
---|---|---|
considerWarningAsError | 警告がエラーと同じ重大度で処理されることを示します。 | [bool] |
defaultServiceTypeHealthPolicy | サービスの種類の正常性を評価するために既定で使用される正常性ポリシー。 | ArmServiceTypeHealthPolicy |
maxPercentUnhealthyDeployedApplications | 異常なデプロイ済みアプリケーションの割合の最大許容パーセンテージ。 使用できる値は、0 から 100 までのバイト値です。 パーセンテージは、アプリケーションがエラーと見なされる前に異常になる可能性がある、デプロイされたアプリケーションの許容される最大割合を表します。 これは、異常にデプロイされたアプリケーションの数を、アプリケーションが現在クラスターにデプロイされているノードの数で割ることによって計算されます。 切り上げ計算が実行され、少数のノードに対する 1 つのエラーは許容されます。 既定のパーセンテージは 0 です。 |
INT |
serviceTypeHealthPolicyMap | サービスの種類ごとの正常性ポリシーを持つマップ。 このマップは、既定では空です。 | ArmServiceTypeHealthPolicyMap |
ArmServiceTypeHealthPolicy
名前 | 説明 | 値 |
---|---|---|
maxPercentUnhealthyPartitionsPerService | アプリケーションがエラーと見なされる前に、サービスごとに許容されるパーティションの最大割合。 | INT 制約: 最小値 = 0 最大値 = 100 |
maxPercentUnhealthyReplicasPerPartition | アプリケーションがエラーと見なされる前に、パーティションあたりのレプリカの最大割合が異常であることが許可されています。 | INT 制約: 最小値 = 0 最大値 = 100 |
maxPercentUnhealthyServices | アプリケーションがエラーと見なされる前に、異常が許容されるサービスの最大割合。 | INT 制約: 最小値 = 0 最大値 = 100 |
ArmServiceTypeHealthPolicyMap
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | ArmServiceTypeHealthPolicy |
ArmRollingUpgradeMonitoringPolicy
名前 | 説明 | 値 |
---|---|---|
failureAction | サービス パッケージのアクティブ化モード | 'Manual' 'Rollback' |
healthCheckRetryTimeout | アプリケーションまたはクラスターが正常でない場合に、正常性評価を再試行する時間。この時間を超えると、FailureAction に指定したアクションが実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
healthCheckStableDuration | アプリケーションまたはクラスターが正常な状態である必要がある時間。この時間を超えると、アップグレードが次のアップグレード ドメインに進みます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
healthCheckWaitDuration | ドメインのアップグレードを完了後、待機する時間。この時間を超えると、正常性ポリシーが適用されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
upgradeDomainTimeout | 各ドメインがアップグレードを完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
upgradeTimeout | アップグレード全体を完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
Terraform (AzAPI プロバイダー) リソース定義
クラスター/アプリケーションのリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceFabric/clusters/applications リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceFabric/clusters/applications@2021-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
managedIdentities = [
{
name = "string"
principalId = "string"
}
]
maximumNodes = int
metrics = [
{
maximumCapacity = int
name = "string"
reservationCapacity = int
totalApplicationCapacity = int
}
]
minimumNodes = int
parameters = {
{customized property} = "string"
}
removeApplicationCapacity = bool
typeName = "string"
typeVersion = "string"
upgradePolicy = {
applicationHealthPolicy = {
considerWarningAsError = bool
defaultServiceTypeHealthPolicy = {
maxPercentUnhealthyPartitionsPerService = int
maxPercentUnhealthyReplicasPerPartition = int
maxPercentUnhealthyServices = int
}
maxPercentUnhealthyDeployedApplications = int
serviceTypeHealthPolicyMap = {
{customized property} = {
maxPercentUnhealthyPartitionsPerService = int
maxPercentUnhealthyReplicasPerPartition = int
maxPercentUnhealthyServices = int
}
}
}
forceRestart = bool
recreateApplication = bool
rollingUpgradeMonitoringPolicy = {
failureAction = "string"
healthCheckRetryTimeout = "string"
healthCheckStableDuration = "string"
healthCheckWaitDuration = "string"
upgradeDomainTimeout = "string"
upgradeTimeout = "string"
}
upgradeMode = "string"
upgradeReplicaSetCheckTimeout = "string"
}
}
})
}
プロパティ値
clusters/applications
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.ServiceFabric/clusters/applications@2021-06-01" |
name | リソース名 | string (必須) |
location | 新しい API では非推奨になります。リソースの場所は親リソースによって異なります。 | string |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: クラスター |
tags | Azure リソース タグ。 | タグ名と値のディクショナリ。 |
identity | Azure リソースのマネージド ID について説明します。 | ManagedIdentity |
properties | アプリケーション リソースのプロパティ。 | ApplicationResourceProperties |
ManagedIdentity
名前 | 説明 | 値 |
---|---|---|
type | リソースのマネージド ID の種類。 | "SystemAssigned" "SystemAssigned、UserAssigned" "UserAssigned" |
identity_ids | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' |
ユーザー ID ID の配列。 |
UserAssignedIdentityMap
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity |
UserAssignedIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ApplicationResourceProperties
名前 | 説明 | 値 |
---|---|---|
managedIdentities | アプリケーションのユーザー割り当て ID の一覧。それぞれがフレンドリ名にマップされます。 | ApplicationUserAssignedIdentity[] |
maximumNodes | Service Fabric がこのアプリケーション用に容量を予約するノードの最大数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 既定では、このプロパティの値は 0 であり、サービスを任意のノードに配置できることを意味します。 | INT 制約: 最小値 = 0 |
metrics | アプリケーション容量メトリックの説明の一覧。 | ApplicationMetricDescription[] |
minimumNodes | Service Fabric がこのアプリケーション用に容量を予約するノードの最小数。 このアプリケーションのサービスがこれらすべてのノードに配置されるわけではありません。 このプロパティが 0 に設定されている場合、容量は予約されません。 このプロパティの値は、MaximumNodes プロパティの値を超えることはできません。 | INT 制約: 最小値 = 0 |
parameters | アプリケーション マニフェストで指定された既定値からオーバーライドされた値を持つアプリケーション パラメーターの一覧。 | ApplicationParameterList |
removeApplicationCapacity | 現在のアプリケーション容量設定を削除します。 | [bool] |
typeName | アプリケーション マニフェストで定義されているアプリケーションの種類の名前。 | string |
typeVersion | アプリケーション マニフェストで定義されているアプリケーションの種類のバージョンです。 | string |
upgradePolicy | 監視対象アプリケーションのアップグレードのポリシーについて説明します。 | ApplicationUpgradePolicy |
ApplicationUserAssignedIdentity
名前 | 説明 | 値 |
---|---|---|
name | ユーザー割り当て ID のフレンドリ名。 | string (必須) |
principalId | ユーザー割り当て ID のプリンシパル ID。 | string (必須) |
ApplicationMetricDescription
名前 | 説明 | 値 |
---|---|---|
maximumCapacity | Service Fabric アプリケーションの最大ノード容量。 これは、1 つのノード上のこのアプリケーションのインスタンスの最大負荷です。 ノードの容量がこの値より大きい場合でも、Service Fabric は各ノード上のアプリケーション内のサービスの総負荷をこの値に制限します。 0 に設定すると、このメトリックの容量は各ノードで無制限になります。 アプリケーション容量が定義された新しいアプリケーションを作成する場合、MaximumNodes の積とこの値は常に TotalApplicationCapacity 以下である必要があります。 アプリケーション容量を使用して既存のアプリケーションを更新する場合、MaximumNodes とこの値の積は常に TotalApplicationCapacity 以下である必要があります。 |
INT |
name | メトリックの名前。 | string |
reservationCapacity | Service Fabric アプリケーションのノード予約容量。 これは、このアプリケーションのインスタンスを持つノードで予約されている負荷の量です。 MinimumNodes が指定されている場合、これらの値の積は、アプリケーションのクラスターで予約されている容量になります。 0 に設定すると、このメトリック用に容量は予約されません。 アプリケーション容量を設定する場合、またはアプリケーション容量を更新する場合。この値は、各メトリックの MaximumCapacity 以下である必要があります。 |
INT |
totalApplicationCapacity | Service Fabric アプリケーションの合計メトリック容量。 これは、クラスター内のこのアプリケーションの合計メトリック容量です。 Service Fabric は、アプリケーション内のサービスの負荷の合計をこの値に制限しようとします。 アプリケーション容量が定義された新しいアプリケーションを作成する場合、MaximumNodes と MaximumCapacity の積は常に、この値以下である必要があります。 |
INT |
ApplicationParameterList
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | string |
ApplicationUpgradePolicy
名前 | 説明 | 値 |
---|---|---|
applicationHealthPolicy | アプリケーションまたはその子エンティティの正常性を評価するために使用される正常性ポリシーを定義します。 | ArmApplicationHealthPolicy |
forceRestart | true の場合、コード バージョンが変更されていない場合でも、アップグレード中にプロセスが強制的に再起動されます (アップグレードによって構成またはデータのみが変更されます)。 | [bool] |
recreateApplication | 更新時にアプリケーションを再作成するかどうかを決定します。 value=true の場合、アップグレード ポリシーパラメーターの残りの部分は許可されず、可用性が失われます。 | [bool] |
rollingUpgradeMonitoringPolicy | アプリケーションのアップグレードの監視に使用されるポリシー | ArmRollingUpgradeMonitoringPolicy |
upgradeMode | ローリング アップグレード時に正常性を監視するために使用されるモード。 値は UnmonitoredAuto、UnmonitoredManual、Monitored です。 | "無効" "監視対象" "UnmonitoredAuto" "UnmonitoredManual" |
upgradeReplicaSetCheckTimeout | アップグレード ドメインの処理をブロックし、予期しない問題が発生したときに可用性の損失を防ぐための最長時間。 このタイムアウトが期限切れになると、可用性の損失問題に関係なく、アップグレード ドメインの処理が続行されます。 タイムアウトは、各アップグレード ドメインの開始時にリセットされます。 有効な値は 0 から 42949672925 の範囲です (0 と 42949672925 を含みます)。 (符号なし 32 ビット整数)。 | string |
ArmApplicationHealthPolicy
名前 | 説明 | 値 |
---|---|---|
considerWarningAsError | 警告がエラーと同じ重大度で処理されることを示します。 | [bool] |
defaultServiceTypeHealthPolicy | サービスの種類の正常性を評価するために既定で使用される正常性ポリシー。 | ArmServiceTypeHealthPolicy |
maxPercentUnhealthyDeployedApplications | 異常なデプロイ済みアプリケーションの割合の最大許容パーセンテージ。 使用できる値は、0 から 100 までのバイト値です。 パーセンテージは、アプリケーションがエラーと見なされる前に異常になる可能性がある、デプロイされたアプリケーションの最大許容パーセンテージを表します。 これは、異常なデプロイされたアプリケーションの数を、クラスター内でアプリケーションが現在デプロイされているノードの数で割ることによって計算されます。 切り上げ計算が実行され、少数のノードに対する 1 つのエラーは許容されます。 既定のパーセンテージは 0 です。 |
INT |
serviceTypeHealthPolicyMap | サービスの種類の名前ごとのサービスの種類の正常性ポリシーを含むマップ。 このマップは、既定では空です。 | ArmServiceTypeHealthPolicyMap |
ArmServiceTypeHealthPolicy
名前 | 説明 | 値 |
---|---|---|
maxPercentUnhealthyPartitionsPerService | アプリケーションがエラーと見なされる前に、サービスごとのパーティションの最大割合が異常であることが許可されています。 | INT 制約: 最小値 = 0 最大値 = 100 |
maxPercentUnhealthyReplicasPerPartition | アプリケーションがエラーと見なされる前に、パーティションごとのレプリカの最大割合が異常であることが許可されています。 | INT 制約: 最小値 = 0 最大値 = 100 |
maxPercentUnhealthyServices | アプリケーションがエラーと見なされる前に、異常が許容されるサービスの最大割合。 | INT 制約: 最小値 = 0 最大値 = 100 |
ArmServiceTypeHealthPolicyMap
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | ArmServiceTypeHealthPolicy |
ArmRollingUpgradeMonitoringPolicy
名前 | 説明 | 値 |
---|---|---|
failureAction | サービス パッケージのアクティブ化モード | "Manual" "ロールバック" |
healthCheckRetryTimeout | アプリケーションまたはクラスターが正常でない場合に、正常性評価を再試行する時間。この時間を超えると、FailureAction に指定したアクションが実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
healthCheckStableDuration | アプリケーションまたはクラスターが正常な状態である必要がある時間。この時間を超えると、アップグレードが次のアップグレード ドメインに進みます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
healthCheckWaitDuration | ドメインのアップグレードを完了後、待機する時間。この時間を超えると、正常性ポリシーが適用されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
upgradeDomainTimeout | 各ドメインがアップグレードを完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |
upgradeTimeout | アップグレード全体を完了する必要がある時間。この時間を超えると、FailureAction が実行されます。 最初に、ISO 8601 の期間を表す文字列として解釈されます。 それが失敗した場合、ミリ秒単位の合計数を表す数値として解釈されます。 | string |