Microsoft.ApiManagement サービス/バックエンド 2023-05-01-preview

• 最新の を する
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/backends@2023-05-01-preview' = {
  parent: resourceSymbolicName
  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'
  }
}

プロパティ値

BackendAuthorizationHeaderCredentials

名前	形容	価値
パラメーター	認証パラメーターの値。	糸 制約： 最小長 = 1 最大長 = 300 (必須)
計画	認証スキーム名。	糸 制約： 最小長 = 1 最大長 = 100 (必須)

BackendBaseParametersPool

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

BackendCircuitBreaker

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

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。	糸 制約： 最小長 = 1 最大長 = 2000 (必須)

BackendCredentialsContract

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

BackendCredentialsContractHeader

名前	形容	価値

BackendCredentialsContractQuery

名前	形容	価値

BackendPoolItem

名前	形容	価値
身分証明書	バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。	string (必須)

BackendProperties

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

BackendProxyContract

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

BackendServiceFabricClusterProperties

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

BackendTlsProperties

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

CircuitBreakerFailureCondition

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

CircuitBreakerRule

名前	形容	価値
failureCondition	サーキット ブレーカーをトリップするための条件。	CircuitBreakerFailureCondition
名前	ルール名。	糸
tripDuration	回線がトリップする期間。	糸

FailureStatusCodeRange

名前	形容	価値
マックス	最大 http 状態コード。	int 制約： 最小値 = 200 最大値 = 599
分	http 状態の最小コード。	int 制約： 最小値 = 200 最大値 = 599

Microsoft.ApiManagement/service/backends

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	バックエンド エンティティ コントラクトのプロパティ。	BackendContractProperties

X509CertificateName

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

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"
  }
}

プロパティ値

BackendAuthorizationHeaderCredentials

名前	形容	価値
パラメーター	認証パラメーターの値。	糸 制約： 最小長 = 1 最大長 = 300 (必須)
計画	認証スキーム名。	糸 制約： 最小長 = 1 最大長 = 100 (必須)

BackendBaseParametersPool

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

BackendCircuitBreaker

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

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。	糸 制約： 最小長 = 1 最大長 = 2000 (必須)

BackendCredentialsContract

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

BackendCredentialsContractHeader

名前	形容	価値

BackendCredentialsContractQuery

名前	形容	価値

BackendPoolItem

名前	形容	価値
身分証明書	バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。	string (必須)

BackendProperties

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

BackendProxyContract

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

BackendServiceFabricClusterProperties

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

BackendTlsProperties

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

CircuitBreakerFailureCondition

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

CircuitBreakerRule

名前	形容	価値
failureCondition	サーキット ブレーカーをトリップするための条件。	CircuitBreakerFailureCondition
名前	ルール名。	糸
tripDuration	回線がトリップする期間。	糸

FailureStatusCodeRange

名前	形容	価値
マックス	最大 http 状態コード。	int 制約： 最小値 = 200 最大値 = 599
分	http 状態の最小コード。	int 制約： 最小値 = 200 最大値 = 599

Microsoft.ApiManagement/service/backends

名前	形容	価値
apiVersion	API のバージョン	'2023-05-01-preview'
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 (必須)
プロパティ	バックエンド エンティティ コントラクトのプロパティ。	BackendContractProperties
種類	リソースの種類	'Microsoft.ApiManagement/service/backends'

X509CertificateName

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

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

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

• リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
  name = "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"
    }
  })
}

プロパティ値

BackendAuthorizationHeaderCredentials

名前	形容	価値
パラメーター	認証パラメーターの値。	糸 制約： 最小長 = 1 最大長 = 300 (必須)
計画	認証スキーム名。	糸 制約： 最小長 = 1 最大長 = 100 (必須)

BackendBaseParametersPool

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

BackendCircuitBreaker

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

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。	糸 制約： 最小長 = 1 最大長 = 2000 (必須)

BackendCredentialsContract

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

BackendCredentialsContractHeader

名前	形容	価値

BackendCredentialsContractQuery

名前	形容	価値

BackendPoolItem

名前	形容	価値
身分証明書	バックエンド エンティティの一意の ARM ID。 ARM ID は、既存のバックエンド エンティティを参照する必要があります。	string (必須)

BackendProperties

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

BackendProxyContract

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

BackendServiceFabricClusterProperties

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

BackendTlsProperties

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

CircuitBreakerFailureCondition

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

CircuitBreakerRule

名前	形容	価値
failureCondition	サーキット ブレーカーをトリップするための条件。	CircuitBreakerFailureCondition
名前	ルール名。	糸
tripDuration	回線がトリップする期間。	糸

FailureStatusCodeRange

名前	形容	価値
マックス	最大 http 状態コード。	int 制約： 最小値 = 200 最大値 = 599
分	http 状態の最小コード。	int 制約： 最小値 = 200 最大値 = 599

Microsoft.ApiManagement/service/backends

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	バックエンド エンティティ コントラクトのプロパティ。	BackendContractProperties
種類	リソースの種類	"Microsoft.ApiManagement/service/backends@2023-05-01-preview"

X509CertificateName

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