次の方法で共有

Backend - List By Service

  • リファレンス
サービス:
API Management
API バージョン:
2022-08-01

指定されたサービス インスタンスのバックエンドのコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?api-version=2022-08-01
省略可能なパラメーターを含む: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName
 path True

string

API Management サービスの名前。

正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する API バージョン。
$filter
 query

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|name |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|title |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|url |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
$skip
 query

integer

int32

スキップするレコードの数。
$top
 query

integer

int32

返されるレコードの数。

応答

名前 型 説明
200 OK

BackendCollection

バックエンド エンティティのコレクションを一覧表示します。
Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

例

ApiManagementListBackends

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends?api-version=2022-08-01

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
      "type": "Microsoft.ApiManagement/service/backends",
      "name": "proxybackend",
      "properties": {
        "description": "description5308",
        "url": "https://backendname2644/",
        "protocol": "http",
        "credentials": {
          "query": {
            "sv": [
              "xx",
              "bb",
              "cc"
            ]
          },
          "header": {
            "x-my-1": [
              "val1",
              "val2"
            ]
          },
          "authorization": {
            "scheme": "Basic",
            "parameter": "opensesma"
          }
        },
        "proxy": {
          "url": "http://192.168.1.1:8080",
          "username": "Contoso\\admin",
          "password": "<password>"
        },
        "tls": {
          "validateCertificateChain": false,
          "validateCertificateName": false
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
      "type": "Microsoft.ApiManagement/service/backends",
      "name": "sfbackend",
      "properties": {
        "description": "Service Fabric Test App 1",
        "url": "fabric:/mytestapp/mytestservice",
        "protocol": "http",
        "properties": {
          "serviceFabricCluster": {
            "managementEndpoints": [
              "https://somecluster.com"
            ],
            "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
            "serverX509Names": [
              {
                "name": "ServerCommonName1",
                "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
              }
            ],
            "maxPartitionResolutionRetries": 5
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

定義

名前 説明
BackendAuthorizationHeaderCredentials

承認ヘッダー情報。
BackendCollection

ページ バックエンド リスト表現。
BackendContract

バックエンドの詳細。
BackendCredentialsContract

バックエンドへの接続に使用される資格情報の詳細。
BackendProperties

バックエンドの種類に固有のプロパティ。
BackendProtocol

バックエンド通信プロトコル。
BackendProxyContract

バックエンドへの要求で使用するバックエンド WebProxy サーバーの詳細。
BackendServiceFabricClusterProperties

Service Fabric Type Backend のプロパティ。
BackendTlsProperties

TLS 証明書の検証を制御するプロパティ。
ErrorFieldContract

エラー フィールド コントラクト。
ErrorResponse

エラー応答。
X509CertificateName

サーバー X509Names のプロパティ。

BackendAuthorizationHeaderCredentials

承認ヘッダー情報。

名前 型 説明
parameter

string

認証パラメーターの値。
scheme

string

認証スキーム名。

BackendCollection

ページ バックエンド リスト表現。

名前 型 説明
count

integer

すべてのページの合計レコード数。
nextLink

string

次のページリンク (存在する場合)。
value

BackendContract[]

バックエンド値。

BackendContract

バックエンドの詳細。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

リソースの名前
properties.credentials

BackendCredentialsContract

バックエンド資格情報コントラクトのプロパティ
properties.description

string

バックエンドの説明。
properties.properties

BackendProperties

バックエンド プロパティ コントラクト
properties.protocol

BackendProtocol

バックエンド通信プロトコル。
properties.proxy

BackendProxyContract

バックエンド ゲートウェイ コントラクトのプロパティ
properties.resourceId

string

外部システムのリソースの管理 URI。 この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。
properties.title

string

バックエンド タイトル。
properties.tls

BackendTlsProperties

バックエンド TLS プロパティ
properties.url

string

バックエンドのランタイム URL。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

バックエンドへの接続に使用される資格情報の詳細。

名前 型 説明
authorization

BackendAuthorizationHeaderCredentials

承認ヘッダー認証
certificate

string[]

クライアント証明書の拇印の一覧。 certificatesId が指定されている場合は無視されます。
certificateIds

string[]

クライアント証明書 ID の一覧。
header

object

ヘッダー パラメーターの説明。
query

object

クエリ パラメーターの説明。

BackendProperties

バックエンドの種類に固有のプロパティ。

名前 型 説明
serviceFabricCluster

BackendServiceFabricClusterProperties

バックエンド Service Fabric クラスターのプロパティ

BackendProtocol

バックエンド通信プロトコル。

名前 型 説明
http

string

バックエンドは RESTful サービスです。
soap

string

バックエンドは SOAP サービスです。

BackendProxyContract

バックエンドへの要求で使用するバックエンド WebProxy サーバーの詳細。

名前 型 説明
password

string

WebProxy サーバーに接続するためのパスワード
url

string

すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。
username

string

WebProxy サーバーに接続するためのユーザー名

BackendServiceFabricClusterProperties

Service Fabric Type Backend のプロパティ。

名前 型 説明
clientCertificateId

string

管理エンドポイントのクライアント証明書 ID。
clientCertificatethumbprint

string

管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます
managementEndpoints

string[]

クラスター管理エンドポイント。
maxPartitionResolutionRetries

integer

パーティションの解決中の再試行の最大数。
serverCertificateThumbprints

string[]

tls 通信にクラスター管理サービスが使用する証明書の拇印
serverX509Names

X509CertificateName[]

サーバー X509 証明書名コレクション

BackendTlsProperties

TLS 証明書の検証を制御するプロパティ。

名前 型 規定値 説明
validateCertificateChain

boolean

True

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

boolean

True

このバックエンド ホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。

ErrorFieldContract

エラー フィールド コントラクト。

名前 型 説明
code

string

プロパティ レベルのエラー コード。
message

string

プロパティ レベルエラーの人間が判読できる表現。
target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

X509CertificateName

サーバー X509Names のプロパティ。

名前 型 説明
issuerCertificateThumbprint

string

証明書の発行者の拇印。
name

string

証明書の共通名。