GatewayApi interface
GatewayApi を表すインターフェイス。
メソッド
| create |
指定されたゲートウェイに API を追加します。 |
| delete(string, string, string, string, Gateway |
指定されたゲートウェイから指定された API を削除します。 |
| get |
識別子で指定された API エンティティが Gateway エンティティに関連付けられていることを確認します。 |
| list |
ゲートウェイに関連付けられている API のコレクションを一覧表示します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
指定されたゲートウェイに API を追加します。
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
指定されたゲートウェイから指定された API を削除します。
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- GatewayApiDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
識別子で指定された API エンティティが Gateway エンティティに関連付けられていることを確認します。
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
ゲートウェイに関連付けられている API のコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- gatewayId
-
string
ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
options パラメーター。