ApiOperationPolicy interface

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

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

メソッド

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)

API 操作レベルのポリシー構成を作成または更新します。
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)

API 操作でポリシー構成を削除します。
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)

API 操作レベルでポリシー構成を取得します。
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)

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

API 操作レベルでポリシー構成の一覧を取得します。

メソッドの詳細

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)

API 操作レベルのポリシー構成を作成または更新します。

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

apiId

string

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

operationId

string

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

policyId

string

ポリシーの識別子。

parameters
PolicyContract

適用するポリシーの内容。

options
ApiOperationPolicyCreateOrUpdateOptionalParams

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

戻り値

Promise<ApiOperationPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)

API 操作でポリシー構成を削除します。

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

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

apiId

string

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

operationId

string

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

policyId

string

ポリシーの識別子。

ifMatch

string

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

options
ApiOperationPolicyDeleteOptionalParams

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

戻り値

Promise<void>

get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)

API 操作レベルでポリシー構成を取得します。

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

apiId

string

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

operationId

string

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

policyId

string

ポリシーの識別子。

options
ApiOperationPolicyGetOptionalParams

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

戻り値

Promise<ApiOperationPolicyGetResponse>

getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

apiId

string

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

operationId

string

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

policyId

string

ポリシーの識別子。

options
ApiOperationPolicyGetEntityTagOptionalParams

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

戻り値

Promise<ApiOperationPolicyGetEntityTagHeaders>

listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)

API 操作レベルでポリシー構成の一覧を取得します。

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

apiId

string

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

operationId

string

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

options
ApiOperationPolicyListByOperationOptionalParams

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

戻り値

Promise<PolicyCollection>