ApiOperation interface

パッケージ:: @azure/arm-apimanagement

ApiOperation を表すインターフェイス。

メソッド

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)	API で新しい操作を作成するか、既存の操作を更新します。
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)	API で指定された操作を削除します。
get(string, string, string, string, ApiOperationGetOptionalParams)	識別子で指定された API 操作の詳細を取得します。
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)	識別子で指定された API 操作のエンティティ状態 (Etag) バージョンを取得します。
listByApi(string, string, string, ApiOperationListByApiOptionalParams)	指定した API の操作のコレクションを一覧表示します。
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)	識別子で指定された API の操作の詳細を更新します。

メソッドの詳細

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

API で新しい操作を作成するか、既存の操作を更新します。

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

API リビジョン識別子。現在の API Management サービスインスタンスで一意である必要があります。現在のリビジョン以外のリビジョンには、rev=n はサフィックスであり、n はリビジョン番号です。

operationId: string

API 内の操作識別子。現在の API Management サービスインスタンスで一意である必要があります。

parameters: OperationContract

パラメーターを作成します。

options: ApiOperationCreateOrUpdateOptionalParams

オプションパラメーター。

戻り値

Promise<ApiOperationCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

API で指定された操作を削除します。

function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): Promise<void>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

operationId: string

API 内の操作識別子。現在の API Management サービスインスタンスで一意である必要があります。

ifMatch: string

エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

options: ApiOperationDeleteOptionalParams

オプションパラメーター。

戻り値

Promise<void>

get(string, string, string, string, ApiOperationGetOptionalParams)

識別子で指定された API 操作の詳細を取得します。

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

operationId: string

API 内の操作識別子。現在の API Management サービスインスタンスで一意である必要があります。

options: ApiOperationGetOptionalParams

オプションパラメーター。

戻り値

Promise<ApiOperationGetResponse>

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

識別子で指定された API 操作のエンティティ状態 (Etag) バージョンを取得します。

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

operationId: string

API 内の操作識別子。現在の API Management サービスインスタンスで一意である必要があります。

options: ApiOperationGetEntityTagOptionalParams

オプションパラメーター。

戻り値

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

指定した API の操作のコレクションを一覧表示します。

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

options: ApiOperationListByApiOptionalParams

オプションパラメーター。

戻り値

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

識別子で指定された API の操作の詳細を更新します。

function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

operationId: string

API 内の操作識別子。現在の API Management サービスインスタンスで一意である必要があります。

ifMatch: string

parameters: OperationUpdateContract

API 操作の更新パラメーター。

options: ApiOperationUpdateOptionalParams

オプションパラメーター。

戻り値

Promise<ApiOperationUpdateResponse>