Microsoft.ApiManagement サービス/バックエンド
-
[アーティクル]
-
-
Bicep リソース定義
サービス/バックエンド リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.ApiManagement/service/backends リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/backends@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
circuitBreaker: {
rules: [
{
failureCondition: {
count: int
errorReasons: [
'string'
]
interval: 'string'
percentage: int
statusCodeRanges: [
{
max: int
min: int
}
]
}
name: 'string'
tripDuration: 'string'
}
]
}
credentials: {
authorization: {
parameter: 'string'
scheme: 'string'
}
certificate: [
'string'
]
certificateIds: [
'string'
]
header: {
{customized property}: [
'string'
]
}
query: {
{customized property}: [
'string'
]
}
}
description: 'string'
pool: {
services: [
{
id: 'string'
}
]
}
properties: {
serviceFabricCluster: {
clientCertificateId: 'string'
clientCertificatethumbprint: 'string'
managementEndpoints: [
'string'
]
maxPartitionResolutionRetries: int
serverCertificateThumbprints: [
'string'
]
serverX509Names: [
{
issuerCertificateThumbprint: 'string'
name: 'string'
}
]
}
}
protocol: 'string'
proxy: {
password: 'string'
url: 'string'
username: 'string'
}
resourceId: 'string'
title: 'string'
tls: {
validateCertificateChain: bool
validateCertificateName: bool
}
type: 'string'
url: 'string'
}
}
プロパティ値
service/backends
| 名前 |
説明 |
値 |
| name |
リソース名
Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須)
文字制限: 1 から 80
有効な文字:
英数字とハイフン。
先頭は文字、末尾は英数字にします。 |
| parent |
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。
詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: service |
| properties |
バックエンド エンティティ コントラクトのプロパティ。 |
BackendContractProperties |
BackendContractProperties
BackendCircuitBreaker
CircuitBreakerRule
CircuitBreakerFailureCondition
| 名前 |
説明 |
値 |
| count |
回路を開くしきい値。 |
INT |
| errorReasons |
エラーと見なされるエラーの理由。 |
string[] |
| interval |
エラーがカウントされる間隔。 |
string |
| percentage |
回路を開くしきい値。 |
INT |
| statusCodeRanges |
エラーと見なされる状態コードの範囲。 |
FailureStatusCodeRange[] |
FailureStatusCodeRange
| 名前 |
説明 |
値 |
| max |
http 状態コードの最大数。 |
INT |
| 分 |
http 状態の最小コード。 |
INT |
BackendCredentialsContract
| 名前 |
説明 |
値 |
| parameter |
認証パラメーターの値。 |
string (必須) |
| scheme |
認証スキーム名。 |
string (必須) |
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string[] |
BackendCredentialsContractQuery
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string[] |
BackendBaseParametersPool
BackendPoolItem
| 名前 |
説明 |
値 |
| id |
バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。 |
string (必須) |
BackendProperties
BackendServiceFabricClusterProperties
| 名前 |
説明 |
値 |
| clientCertificateId |
管理エンドポイントのクライアント証明書 ID。 |
string |
| clientCertificatethumbprint |
管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます |
string |
| managementEndpoints |
クラスター管理エンドポイント。 |
string[] (必須) |
| maxPartitionResolutionRetries |
パーティションの解決中の再試行の最大数。 |
INT |
| serverCertificateThumbprints |
tls 通信にクラスター管理サービスが使用する証明書の拇印 |
string[] |
| serverX509Names |
サーバー X509 証明書名コレクション |
X509CertificateName[] |
X509CertificateName
| 名前 |
説明 |
値 |
| issuerCertificateThumbprint |
証明書の発行者の拇印。 |
string |
| name |
証明書の共通名。 |
string |
BackendProxyContract
| 名前 |
説明 |
値 |
| password |
WebProxy サーバーに接続するためのパスワード |
string |
| url |
すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。 |
string (必須) |
| username |
WebProxy サーバーに接続するためのユーザー名 |
string |
BackendTlsProperties
| 名前 |
説明 |
値 |
| validateCertificateChain |
このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書チェーンの検証を行う必要があるかどうかを示すフラグ。 |
[bool] |
| validateCertificateName |
このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。 |
[bool] |
ARM テンプレート リソース定義
サービス/バックエンド リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.ApiManagement/service/backends リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service/backends",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"circuitBreaker": {
"rules": [
{
"failureCondition": {
"count": "int",
"errorReasons": [ "string" ],
"interval": "string",
"percentage": "int",
"statusCodeRanges": [
{
"max": "int",
"min": "int"
}
]
},
"name": "string",
"tripDuration": "string"
}
]
},
"credentials": {
"authorization": {
"parameter": "string",
"scheme": "string"
},
"certificate": [ "string" ],
"certificateIds": [ "string" ],
"header": {
"{customized property}": [ "string" ]
},
"query": {
"{customized property}": [ "string" ]
}
},
"description": "string",
"pool": {
"services": [
{
"id": "string"
}
]
},
"properties": {
"serviceFabricCluster": {
"clientCertificateId": "string",
"clientCertificatethumbprint": "string",
"managementEndpoints": [ "string" ],
"maxPartitionResolutionRetries": "int",
"serverCertificateThumbprints": [ "string" ],
"serverX509Names": [
{
"issuerCertificateThumbprint": "string",
"name": "string"
}
]
}
},
"protocol": "string",
"proxy": {
"password": "string",
"url": "string",
"username": "string"
},
"resourceId": "string",
"title": "string",
"tls": {
"validateCertificateChain": "bool",
"validateCertificateName": "bool"
},
"type": "string",
"url": "string"
}
}
プロパティ値
service/backends
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
'Microsoft.ApiManagement/service/backends' |
| apiVersion |
リソース API のバージョン |
'2023-05-01-preview' |
| name |
リソース名
JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須)
文字制限: 1 から 80
有効な文字:
英数字とハイフン。
先頭は文字、末尾は英数字にします。 |
| properties |
バックエンド エンティティ コントラクトのプロパティ。 |
BackendContractProperties |
BackendContractProperties
BackendCircuitBreaker
CircuitBreakerRule
CircuitBreakerFailureCondition
| 名前 |
説明 |
値 |
| count |
回路を開くしきい値。 |
INT |
| errorReasons |
エラーと見なされるエラーの理由。 |
string[] |
| interval |
エラーがカウントされる間隔。 |
string |
| percentage |
回路を開くしきい値。 |
INT |
| statusCodeRanges |
エラーと見なされる状態コードの範囲。 |
FailureStatusCodeRange[] |
FailureStatusCodeRange
| 名前 |
説明 |
値 |
| max |
http 状態コードの最大数。 |
INT |
| 分 |
http 状態の最小コード。 |
INT |
BackendCredentialsContract
| 名前 |
説明 |
値 |
| parameter |
認証パラメーターの値。 |
string (必須) |
| scheme |
認証スキーム名。 |
string (必須) |
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string[] |
BackendCredentialsContractQuery
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string[] |
BackendBaseParametersPool
BackendPoolItem
| 名前 |
説明 |
値 |
| id |
バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。 |
string (必須) |
BackendProperties
BackendServiceFabricClusterProperties
| 名前 |
説明 |
値 |
| clientCertificateId |
管理エンドポイントのクライアント証明書 ID。 |
string |
| clientCertificatethumbprint |
管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます |
string |
| managementEndpoints |
クラスター管理エンドポイント。 |
string[] (必須) |
| maxPartitionResolutionRetries |
パーティションの解決中の再試行の最大数。 |
INT |
| serverCertificateThumbprints |
TLS 通信にクラスター管理サービスが使用する証明書の拇印 |
string[] |
| serverX509Names |
サーバー X509 証明書名コレクション |
X509CertificateName[] |
X509CertificateName
| 名前 |
説明 |
値 |
| issuerCertificateThumbprint |
証明書の発行者の拇印。 |
string |
| name |
証明書の共通名。 |
string |
BackendProxyContract
| 名前 |
説明 |
値 |
| password |
WebProxy サーバーに接続するためのパスワード |
string |
| url |
すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。 |
string (必須) |
| username |
WebProxy サーバーに接続するためのユーザー名 |
string |
BackendTlsProperties
| 名前 |
説明 |
値 |
| validateCertificateChain |
このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書チェーンの検証を行う必要があるかどうかを示すフラグ。 |
[bool] |
| validateCertificateName |
このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。 |
[bool] |
サービス/バックエンド リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.ApiManagement/service/backends リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
circuitBreaker = {
rules = [
{
failureCondition = {
count = int
errorReasons = [
"string"
]
interval = "string"
percentage = int
statusCodeRanges = [
{
max = int
min = int
}
]
}
name = "string"
tripDuration = "string"
}
]
}
credentials = {
authorization = {
parameter = "string"
scheme = "string"
}
certificate = [
"string"
]
certificateIds = [
"string"
]
header = {
{customized property} = [
"string"
]
}
query = {
{customized property} = [
"string"
]
}
}
description = "string"
pool = {
services = [
{
id = "string"
}
]
}
properties = {
serviceFabricCluster = {
clientCertificateId = "string"
clientCertificatethumbprint = "string"
managementEndpoints = [
"string"
]
maxPartitionResolutionRetries = int
serverCertificateThumbprints = [
"string"
]
serverX509Names = [
{
issuerCertificateThumbprint = "string"
name = "string"
}
]
}
}
protocol = "string"
proxy = {
password = "string"
url = "string"
username = "string"
}
resourceId = "string"
title = "string"
tls = {
validateCertificateChain = bool
validateCertificateName = bool
}
type = "string"
url = "string"
}
})
}
プロパティ値
service/backends
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
"Microsoft.ApiManagement/service/backends@2023-05-01-preview" |
| name |
リソース名 |
string (必須)
文字数制限: 1 から 80
有効な文字:
英数字とハイフン。
先頭は文字、末尾は英数字にします。 |
| parent_id |
このリソースの親であるリソースの ID。 |
種類のリソースの ID: サービス |
| properties |
バックエンド エンティティ コントラクトのプロパティ。 |
BackendContractProperties |
BackendContractProperties
BackendCircuitBreaker
CircuitBreakerRule
CircuitBreakerFailureCondition
| 名前 |
説明 |
値 |
| count |
回路を開くしきい値。 |
INT |
| errorReasons |
エラーと見なされるエラーの理由。 |
string[] |
| interval |
エラーがカウントされる間隔。 |
string |
| percentage |
回路を開くしきい値。 |
INT |
| statusCodeRanges |
エラーと見なされる状態コードの範囲。 |
FailureStatusCodeRange[] |
FailureStatusCodeRange
| 名前 |
説明 |
値 |
| max |
最大 http 状態コード。 |
INT |
| 分 |
最小 http 状態コード。 |
INT |
BackendCredentialsContract
| 名前 |
説明 |
値 |
| parameter |
認証パラメーターの値。 |
string (必須) |
| scheme |
認証スキーム名。 |
string (必須) |
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string[] |
BackendCredentialsContractQuery
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string[] |
BackendBaseParametersPool
BackendPoolItem
| 名前 |
説明 |
値 |
| id |
バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。 |
string (必須) |
BackendProperties
BackendServiceFabricClusterProperties
| 名前 |
説明 |
値 |
| clientCertificateId |
管理エンドポイントのクライアント証明書 ID。 |
string |
| clientCertificatethumbprint |
管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます |
string |
| managementEndpoints |
クラスター管理エンドポイント。 |
string[] (必須) |
| maxPartitionResolutionRetries |
パーティションの解決中の再試行の最大数。 |
INT |
| serverCertificateThumbprints |
tls 通信にクラスター管理サービスが使用する証明書の拇印 |
string[] |
| serverX509Names |
サーバー X509 証明書名コレクション |
X509CertificateName[] |
X509CertificateName
| 名前 |
説明 |
値 |
| issuerCertificateThumbprint |
証明書の発行者の拇印。 |
string |
| name |
証明書の共通名。 |
string |
BackendProxyContract
| 名前 |
説明 |
値 |
| password |
WebProxy サーバーに接続するためのパスワード |
string |
| url |
すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。 |
string (必須) |
| username |
WebProxy サーバーに接続するためのユーザー名 |
string |
BackendTlsProperties
| 名前 |
説明 |
値 |
| validateCertificateChain |
このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書チェーンの検証を行う必要があるかどうかを示すフラグ。 |
[bool] |
| validateCertificateName |
このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。 |
[bool] |