Microsoft.ApiManagement サービス/バックエンド 2021-08-01

[アーティクル]
07/24/2024

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    credentials: {
      authorization: {
        parameter: 'string'
        scheme: 'string'
      }
      certificate: [
        'string'
      ]
      certificateIds: [
        'string'
      ]
      header: {
        {customized property}: [
          'string'
        ]
      }
      query: {
        {customized property}: [
          'string'
        ]
      }
    }
    description: '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
    }
    url: 'string'
  }
}

プロパティ値

service/backends

名前	形容	価値
名前	リソース名 Bicepで子リソースの名前と種類設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	バックエンドエンティティコントラクトのプロパティ。	BackendContractProperties

BackendContractProperties

名前	形容	価値
資格情報	バックエンド資格情報コントラクトのプロパティ	BackendCredentialsContract
形容	バックエンドの説明。	糸制約：最小長 = 1 最大長 = 2000
プロパティ	バックエンドプロパティコントラクト	BackendProperties
議定書	バックエンド通信プロトコル。	'`http`' 'soap' (必須)
プロキシ	バックエンドプロキシコントラクトのプロパティ	BackendProxyContract
resourceId	外部システムのリソースの管理 URI。この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。	糸制約：最小長 = 1 最大長 = 2000
タイトル	バックエンドタイトル。	糸制約：最小長 = 1 最大長 = 300
tls	バックエンド TLS プロパティ	BackendTlsProperties
url	バックエンドのランタイム URL。	string (必須) 制約：最小長 = 1 最大長 = 2000

BackendCredentialsContract

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

BackendAuthorizationHeaderCredentials

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

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

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": "2021-08-01",
  "name": "string",
  "properties": {
    "credentials": {
      "authorization": {
        "parameter": "string",
        "scheme": "string"
      },
      "certificate": [ "string" ],
      "certificateIds": [ "string" ],
      "header": {
        "{customized property}": [ "string" ]
      },
      "query": {
        "{customized property}": [ "string" ]
      }
    },
    "description": "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"
    },
    "url": "string"
  }
}

プロパティ値

service/backends

名前	形容	価値
種類	リソースの種類	'Microsoft.ApiManagement/service/backends'
apiVersion	リソース API のバージョン	'2021-08-01'
名前	リソース名 JSON ARM テンプレートで子リソースの名前と型設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
プロパティ	バックエンドエンティティコントラクトのプロパティ。	BackendContractProperties

BackendContractProperties

名前	形容	価値
資格情報	バックエンド資格情報コントラクトのプロパティ	BackendCredentialsContract
形容	バックエンドの説明。	糸制約：最小長 = 1 最大長 = 2000
プロパティ	バックエンドプロパティコントラクト	BackendProperties
議定書	バックエンド通信プロトコル。	'`http`' 'soap' (必須)
プロキシ	バックエンドプロキシコントラクトのプロパティ	BackendProxyContract
resourceId	外部システムのリソースの管理 URI。この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。	糸制約：最小長 = 1 最大長 = 2000
タイトル	バックエンドタイトル。	糸制約：最小長 = 1 最大長 = 300
tls	バックエンド TLS プロパティ	BackendTlsProperties
url	バックエンドのランタイム URL。	string (必須) 制約：最小長 = 1 最大長 = 2000

BackendCredentialsContract

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

BackendAuthorizationHeaderCredentials

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

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

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@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      credentials = {
        authorization = {
          parameter = "string"
          scheme = "string"
        }
        certificate = [
          "string"
        ]
        certificateIds = [
          "string"
        ]
        header = {
          {customized property} = [
            "string"
          ]
        }
        query = {
          {customized property} = [
            "string"
          ]
        }
      }
      description = "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
      }
      url = "string"
    }
  })
}

プロパティ値

service/backends

名前	形容	価値
種類	リソースの種類	"Microsoft.ApiManagement/service/backends@2021-08-01"
名前	リソース名	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	バックエンドエンティティコントラクトのプロパティ。	BackendContractProperties

BackendContractProperties

名前	形容	価値
資格情報	バックエンド資格情報コントラクトのプロパティ	BackendCredentialsContract
形容	バックエンドの説明。	糸制約：最小長 = 1 最大長 = 2000
プロパティ	バックエンドプロパティコントラクト	BackendProperties
議定書	バックエンド通信プロトコル。	"`http`" "soap" (必須)
プロキシ	バックエンドプロキシコントラクトのプロパティ	BackendProxyContract
resourceId	外部システムのリソースの管理 URI。この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。	糸制約：最小長 = 1 最大長 = 2000
タイトル	バックエンドタイトル。	糸制約：最小長 = 1 最大長 = 300
tls	バックエンド TLS プロパティ	BackendTlsProperties
url	バックエンドのランタイム URL。	string (必須) 制約：最小長 = 1 最大長 = 2000

BackendCredentialsContract

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

BackendAuthorizationHeaderCredentials

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

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

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

次の方法で共有

Microsoft.ApiManagement サービス/バックエンド 2021-08-01

Bicep リソース定義

リソースの形式

プロパティ値

service/backends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

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

リソースの形式

プロパティ値

service/backends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

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

リソースの形式

プロパティ値

service/backends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

フィードバック

その他のリソース

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