次の方法で共有

Microsoft.ApiManagement サービス/バックエンド

  • [アーティクル]

Bicep リソース定義

サービス/バックエンド リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/backends リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ApiManagement/service/backends@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    circuitBreaker: {
      rules: [
        {
          acceptRetryAfter: bool
          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'
          priority: int
          weight: int
        }
      ]
    }
    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

名前 形容 価値
名前 リソース名

Bicepで子リソースの名前と種類 設定する方法を参照してください。		 string (必須)

文字制限: 1 ~ 80

有効な文字:
英数字とハイフン。

文字で始まり、英数字で終わる。
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: サービス
プロパティ バックエンド エンティティ コントラクトのプロパティ。 BackendContractProperties

BackendContractProperties

名前 形容 価値
circuitBreaker バックエンド サーキット ブレーカーの構成 BackendCircuitBreaker
資格 情報 バックエンド資格情報コントラクトのプロパティ BackendCredentialsContract
形容 バックエンドの説明。 糸

制約：
最小長 = 1
最大長 = 2000
プール BackendBaseParametersPool
プロパティ バックエンド プロパティ コントラクト BackendProperties
議定書 バックエンド通信プロトコル。 'http'
'soap' (必須)
プロキシ バックエンド ゲートウェイ コントラクトのプロパティ BackendProxyContract
resourceId 外部システムのリソースの管理 URI。 この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。 糸

制約：
最小長 = 1
最大長 = 2000
タイトル バックエンド タイトル。 糸

制約：
最小長 = 1
最大長 = 300
tls バックエンド TLS プロパティ BackendTlsProperties
種類 バックエンドの種類。 バックエンドには、単一またはプールのいずれかを指定できます。 'Pool'
'Single'
url バックエンドのランタイム URL。 string (必須)

制約：
最小長 = 1
最大長 = 2000

BackendCircuitBreaker

名前 形容 価値
準則 バックエンドをトリップするための規則。 CircuitBreakerRule[]

制約：
最大長 = 15

CircuitBreakerRule

名前 形容 価値
acceptRetryAfter バックエンドからヘッダー Retry-After 受け入れるフラグ。 bool
failureCondition サーキット ブレーカーをトリップするための条件。 CircuitBreakerFailureCondition
名前 ルール名。 糸
tripDuration 回線がトリップする期間。 糸

CircuitBreakerFailureCondition

名前 形容 価値
数える 回路を開くしきい値。 int
errorReasons エラーと見なされるエラーの理由。 糸

制約：
最大長 = 10
間 エラーがカウントされる間隔。 糸
百分率 回路を開くしきい値。 int
statusCodeRanges エラーと見なされる状態コードの範囲。 FailureStatusCodeRange[]

制約：
最大長 = 10

FailureStatusCodeRange

名前 形容 価値
マックス 最大 http 状態コード。 int

制約：
最小値 = 200
最大値 = 599
分 http 状態の最小コード。 int

制約：
最小値 = 200
最大値 = 599

BackendCredentialsContract

名前 形容 価値
認可 承認ヘッダー認証 BackendAuthorizationHeaderCredentials
証書 クライアント証明書の拇印の一覧。 certificatesId が指定されている場合は無視されます。 string[]

制約：
最大長 = 32
certificateIds クライアント証明書 ID の一覧。 string[]

制約：
最大長 = 32
ヘッダ ヘッダー パラメーターの説明。 BackendCredentialsContractHeader
クエリ クエリ パラメーターの説明。 BackendCredentialsContractQuery の

BackendAuthorizationHeaderCredentials

名前 形容 価値
パラメーター 認証パラメーターの値。 string (必須)

制約：
最小長 = 1
最大長 = 300
計画 認証スキーム名。 string (必須)

制約：
最小長 = 1
最大長 = 100

BackendCredentialsContractHeader

名前 形容 価値
{カスタマイズされたプロパティ} string[]

BackendCredentialsContractQuery

名前 形容 価値
{カスタマイズされたプロパティ} string[]

BackendBaseParametersPool

名前 形容 価値
サービス プールに属するバックエンド エンティティの一覧。 BackendPoolItem[]

制約：
最小長 = 1

BackendPoolItem

名前 形容 価値
身分証明書 バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。 string (必須)
優先権 バックエンド プール内のバックエンド エンティティの優先順位。 0 ~ 100 の間である必要があります。 値が指定されていない場合は null にすることもできます。 int

制約：
最小値 = 0
最大値 = 100
重量 バックエンド プール内のバックエンド エンティティの重み。 0 ~ 100 の間である必要があります。 値が指定されていない場合は null にすることもできます。 int

制約：
最小値 = 0
最大値 = 100

BackendProperties

名前 形容 価値
serviceFabricCluster バックエンド Service Fabric クラスターのプロパティ BackendServiceFabricClusterProperties の

BackendServiceFabricClusterProperties

名前 形容 価値
clientCertificateId 管理エンドポイントのクライアント証明書 ID。 糸
clientCertificatethumbprint 管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます 糸
managementEndpoints クラスター管理エンドポイント。 string[] (必須)
maxPartitionResolutionRetries パーティションの解決を試みている間の再試行の最大数。 int
serverCertificateThumbprints クラスター管理サービスが TLS 通信に使用する証明書の拇印 string[]
serverX509Names Server X509 証明書名コレクション X509CertificateName[]

X509CertificateName

名前 形容 価値
issuerCertificateThumbprint 証明書の発行者の拇印。 糸
名前 証明書の共通名。 糸

BackendProxyContract

名前 形容 価値
パスワード WebProxy サーバーに接続するためのパスワード 糸
url すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。 string (必須)

制約：
最小長 = 1
最大長 = 2000
username WebProxy サーバーに接続するためのユーザー名 糸

BackendTlsProperties

名前 形容 価値
validateCertificateChain このバックエンド ホストで自己署名証明書を使用するときに SSL 証明書チェーンの検証を行う必要があるかどうかを示すフラグ。 bool
validateCertificateName このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。 bool

ARM テンプレート リソース定義

サービス/バックエンド リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/backends リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "circuitBreaker": {
      "rules": [
        {
          "acceptRetryAfter": "bool",
          "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",
          "priority": "int",
          "weight": "int"
        }
      ]
    },
    "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

名前 形容 価値
種類 リソースの種類 'Microsoft.ApiManagement/service/backends'
apiVersion リソース API のバージョン '2023-09-01-preview'
名前 リソース名

JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。		 string (必須)

文字制限: 1 ~ 80

有効な文字:
英数字とハイフン。

文字で始まり、英数字で終わる。
プロパティ バックエンド エンティティ コントラクトのプロパティ。 BackendContractProperties

BackendContractProperties

名前 形容 価値
circuitBreaker バックエンド サーキット ブレーカーの構成 BackendCircuitBreaker
資格 情報 バックエンド資格情報コントラクトのプロパティ BackendCredentialsContract
形容 バックエンドの説明。 糸

制約：
最小長 = 1
最大長 = 2000
プール BackendBaseParametersPool
プロパティ バックエンド プロパティ コントラクト BackendProperties
議定書 バックエンド通信プロトコル。 'http'
'soap' (必須)
プロキシ バックエンド ゲートウェイ コントラクトのプロパティ BackendProxyContract
resourceId 外部システムのリソースの管理 URI。 この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。 糸

制約：
最小長 = 1
最大長 = 2000
タイトル バックエンド タイトル。 糸

制約：
最小長 = 1
最大長 = 300
tls バックエンド TLS プロパティ BackendTlsProperties
種類 バックエンドの種類。 バックエンドには、単一またはプールのいずれかを指定できます。 'Pool'
'Single'
url バックエンドのランタイム URL。 string (必須)

制約：
最小長 = 1
最大長 = 2000

BackendCircuitBreaker

名前 形容 価値
準則 バックエンドをトリップするための規則。 CircuitBreakerRule[]

制約：
最大長 = 15

CircuitBreakerRule

名前 形容 価値
acceptRetryAfter バックエンドからヘッダー Retry-After 受け入れるフラグ。 bool
failureCondition サーキット ブレーカーをトリップするための条件。 CircuitBreakerFailureCondition
名前 ルール名。 糸
tripDuration 回線がトリップする期間。 糸

CircuitBreakerFailureCondition

名前 形容 価値
数える 回路を開くしきい値。 int
errorReasons エラーと見なされるエラーの理由。 糸

制約：
最大長 = 10
間 エラーがカウントされる間隔。 糸
百分率 回路を開くしきい値。 int
statusCodeRanges エラーと見なされる状態コードの範囲。 FailureStatusCodeRange[]

制約：
最大長 = 10

FailureStatusCodeRange

名前 形容 価値
マックス 最大 http 状態コード。 int

制約：
最小値 = 200
最大値 = 599
分 http 状態の最小コード。 int

制約：
最小値 = 200
最大値 = 599

BackendCredentialsContract

名前 形容 価値
認可 承認ヘッダー認証 BackendAuthorizationHeaderCredentials
証書 クライアント証明書の拇印の一覧。 certificatesId が指定されている場合は無視されます。 string[]

制約：
最大長 = 32
certificateIds クライアント証明書 ID の一覧。 string[]

制約：
最大長 = 32
ヘッダ ヘッダー パラメーターの説明。 BackendCredentialsContractHeader
クエリ クエリ パラメーターの説明。 BackendCredentialsContractQuery の

BackendAuthorizationHeaderCredentials

名前 形容 価値
パラメーター 認証パラメーターの値。 string (必須)

制約：
最小長 = 1
最大長 = 300
計画 認証スキーム名。 string (必須)

制約：
最小長 = 1
最大長 = 100

BackendCredentialsContractHeader

名前 形容 価値
{カスタマイズされたプロパティ} string[]

BackendCredentialsContractQuery

名前 形容 価値
{カスタマイズされたプロパティ} string[]

BackendBaseParametersPool

名前 形容 価値
サービス プールに属するバックエンド エンティティの一覧。 BackendPoolItem[]

制約：
最小長 = 1

BackendPoolItem

名前 形容 価値
身分証明書 バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。 string (必須)
優先権 バックエンド プール内のバックエンド エンティティの優先順位。 0 ~ 100 の間である必要があります。 値が指定されていない場合は null にすることもできます。 int

制約：
最小値 = 0
最大値 = 100
重量 バックエンド プール内のバックエンド エンティティの重み。 0 ~ 100 の間である必要があります。 値が指定されていない場合は null にすることもできます。 int

制約：
最小値 = 0
最大値 = 100

BackendProperties

名前 形容 価値
serviceFabricCluster バックエンド Service Fabric クラスターのプロパティ BackendServiceFabricClusterProperties の

BackendServiceFabricClusterProperties

名前 形容 価値
clientCertificateId 管理エンドポイントのクライアント証明書 ID。 糸
clientCertificatethumbprint 管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます 糸
managementEndpoints クラスター管理エンドポイント。 string[] (必須)
maxPartitionResolutionRetries パーティションの解決を試みている間の再試行の最大数。 int
serverCertificateThumbprints クラスター管理サービスが TLS 通信に使用する証明書の拇印 string[]
serverX509Names Server X509 証明書名コレクション X509CertificateName[]

X509CertificateName

名前 形容 価値
issuerCertificateThumbprint 証明書の発行者の拇印。 糸
名前 証明書の共通名。 糸

BackendProxyContract

名前 形容 価値
パスワード WebProxy サーバーに接続するためのパスワード 糸
url すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。 string (必須)

制約：
最小長 = 1
最大長 = 2000
username WebProxy サーバーに接続するためのユーザー名 糸

BackendTlsProperties

名前 形容 価値
validateCertificateChain このバックエンド ホストで自己署名証明書を使用するときに SSL 証明書チェーンの検証を行う必要があるかどうかを示すフラグ。 bool
validateCertificateName このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。 bool

Terraform (AzAPI プロバイダー) リソース定義

サービス/バックエンド リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/backends リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      circuitBreaker = {
        rules = [
          {
            acceptRetryAfter = bool
            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"
            priority = int
            weight = int
          }
        ]
      }
      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

名前 形容 価値
種類 リソースの種類 "Microsoft.ApiManagement/service/backends@2023-09-01-preview"
名前 リソース名 string (必須)

文字制限: 1 ~ 80

有効な文字:
英数字とハイフン。

文字で始まり、英数字で終わる。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ バックエンド エンティティ コントラクトのプロパティ。 BackendContractProperties

BackendContractProperties

名前 形容 価値
circuitBreaker バックエンド サーキット ブレーカーの構成 BackendCircuitBreaker
資格 情報 バックエンド資格情報コントラクトのプロパティ BackendCredentialsContract
形容 バックエンドの説明。 糸

制約：
最小長 = 1
最大長 = 2000
プール BackendBaseParametersPool
プロパティ バックエンド プロパティ コントラクト BackendProperties
議定書 バックエンド通信プロトコル。 "http"
"soap" (必須)
プロキシ バックエンド ゲートウェイ コントラクトのプロパティ BackendProxyContract
resourceId 外部システムのリソースの管理 URI。 この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。 糸

制約：
最小長 = 1
最大長 = 2000
タイトル バックエンド タイトル。 糸

制約：
最小長 = 1
最大長 = 300
tls バックエンド TLS プロパティ BackendTlsProperties
種類 バックエンドの種類。 バックエンドには、単一またはプールのいずれかを指定できます。 "プール"
"Single"
url バックエンドのランタイム URL。 string (必須)

制約：
最小長 = 1
最大長 = 2000

BackendCircuitBreaker

名前 形容 価値
準則 バックエンドをトリップするための規則。 CircuitBreakerRule[]

制約：
最大長 = 15

CircuitBreakerRule

名前 形容 価値
acceptRetryAfter バックエンドからヘッダー Retry-After 受け入れるフラグ。 bool
failureCondition サーキット ブレーカーをトリップするための条件。 CircuitBreakerFailureCondition
名前 ルール名。 糸
tripDuration 回線がトリップする期間。 糸

CircuitBreakerFailureCondition

名前 形容 価値
数える 回路を開くしきい値。 int
errorReasons エラーと見なされるエラーの理由。 糸

制約：
最大長 = 10
間 エラーがカウントされる間隔。 糸
百分率 回路を開くしきい値。 int
statusCodeRanges エラーと見なされる状態コードの範囲。 FailureStatusCodeRange[]

制約：
最大長 = 10

FailureStatusCodeRange

名前 形容 価値
マックス 最大 http 状態コード。 int

制約：
最小値 = 200
最大値 = 599
分 http 状態の最小コード。 int

制約：
最小値 = 200
最大値 = 599

BackendCredentialsContract

名前 形容 価値
認可 承認ヘッダー認証 BackendAuthorizationHeaderCredentials
証書 クライアント証明書の拇印の一覧。 certificatesId が指定されている場合は無視されます。 string[]

制約：
最大長 = 32
certificateIds クライアント証明書 ID の一覧。 string[]

制約：
最大長 = 32
ヘッダ ヘッダー パラメーターの説明。 BackendCredentialsContractHeader
クエリ クエリ パラメーターの説明。 BackendCredentialsContractQuery の

BackendAuthorizationHeaderCredentials

名前 形容 価値
パラメーター 認証パラメーターの値。 string (必須)

制約：
最小長 = 1
最大長 = 300
計画 認証スキーム名。 string (必須)

制約：
最小長 = 1
最大長 = 100

BackendCredentialsContractHeader

名前 形容 価値
{カスタマイズされたプロパティ} string[]

BackendCredentialsContractQuery

名前 形容 価値
{カスタマイズされたプロパティ} string[]

BackendBaseParametersPool

名前 形容 価値
サービス プールに属するバックエンド エンティティの一覧。 BackendPoolItem[]

制約：
最小長 = 1

BackendPoolItem

名前 形容 価値
身分証明書 バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。 string (必須)
優先権 バックエンド プール内のバックエンド エンティティの優先順位。 0 ~ 100 の間である必要があります。 値が指定されていない場合は null にすることもできます。 int

制約：
最小値 = 0
最大値 = 100
重量 バックエンド プール内のバックエンド エンティティの重み。 0 ~ 100 の間である必要があります。 値が指定されていない場合は null にすることもできます。 int

制約：
最小値 = 0
最大値 = 100

BackendProperties

名前 形容 価値
serviceFabricCluster バックエンド Service Fabric クラスターのプロパティ BackendServiceFabricClusterProperties の

BackendServiceFabricClusterProperties

名前 形容 価値
clientCertificateId 管理エンドポイントのクライアント証明書 ID。 糸
clientCertificatethumbprint 管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます 糸
managementEndpoints クラスター管理エンドポイント。 string[] (必須)
maxPartitionResolutionRetries パーティションの解決を試みている間の再試行の最大数。 int
serverCertificateThumbprints クラスター管理サービスが TLS 通信に使用する証明書の拇印 string[]
serverX509Names Server X509 証明書名コレクション X509CertificateName[]

X509CertificateName

名前 形容 価値
issuerCertificateThumbprint 証明書の発行者の拇印。 糸
名前 証明書の共通名。 糸

BackendProxyContract

名前 形容 価値
パスワード WebProxy サーバーに接続するためのパスワード 糸
url すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。 string (必須)

制約：
最小長 = 1
最大長 = 2000
username WebProxy サーバーに接続するためのユーザー名 糸

BackendTlsProperties

名前 形容 価値
validateCertificateChain このバックエンド ホストで自己署名証明書を使用するときに SSL 証明書チェーンの検証を行う必要があるかどうかを示すフラグ。 bool
validateCertificateName このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。 bool