Backend interface
バックエンドを表すインターフェイス。
メソッド
| create |
バックエンドを作成または更新します。 |
| delete(string, string, string, string, Backend |
指定されたバックエンドを削除します。 |
| get(string, string, string, Backend |
識別子で指定されたバックエンドの詳細を取得します。 |
| get |
識別子で指定されたバックエンドのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定されたサービス インスタンスのバックエンドのコレクションを一覧表示します。 |
| reconnect(string, string, string, Backend |
指定したタイムアウト後にバックエンドへの新しい接続を作成するように、API Management ゲートウェイに通知します。 タイムアウトが指定されていない場合は、2 分のタイムアウトが使用されます。 |
| update(string, string, string, string, Backend |
既存のバックエンドを更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
バックエンドを作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- backendId
-
string
Backend エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- BackendContract
パラメーターを作成します。
options パラメーター。
戻り値
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
指定されたバックエンドを削除します。
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- backendId
-
string
Backend エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- BackendDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, BackendGetOptionalParams)
識別子で指定されたバックエンドの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- backendId
-
string
Backend エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- BackendGetOptionalParams
options パラメーター。
戻り値
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
識別子で指定されたバックエンドのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- backendId
-
string
Backend エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
指定されたサービス インスタンスのバックエンドのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
reconnect(string, string, string, BackendReconnectOptionalParams)
指定したタイムアウト後にバックエンドへの新しい接続を作成するように、API Management ゲートウェイに通知します。 タイムアウトが指定されていない場合は、2 分のタイムアウトが使用されます。
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- backendId
-
string
Backend エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- BackendReconnectOptionalParams
options パラメーター。
戻り値
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
既存のバックエンドを更新します。
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- backendId
-
string
Backend エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- BackendUpdateParameters
パラメーターを更新します。
- options
- BackendUpdateOptionalParams
options パラメーター。
戻り値
Promise<BackendUpdateResponse>