ApiPolicy interface
ApiPolicy を表すインターフェイス。
メソッド
| create |
API のポリシー構成を作成または更新します。 |
| delete(string, string, string, string, string, Api |
API のポリシー構成を削除します。 |
| get(string, string, string, string, Api |
API レベルでポリシー構成を取得します。 |
| get |
識別子で指定された API ポリシーのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
API レベルでポリシー構成を取得します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)
API のポリシー構成を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- policyId
-
string
ポリシーの識別子。
- parameters
- PolicyContract
適用するポリシーの内容。
options パラメーター。
戻り値
Promise<ApiPolicyCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)
API のポリシー構成を削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, ifMatch: string, options?: ApiPolicyDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- policyId
-
string
ポリシーの識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ApiPolicyDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ApiPolicyGetOptionalParams)
API レベルでポリシー構成を取得します。
function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- policyId
-
string
ポリシーの識別子。
- options
- ApiPolicyGetOptionalParams
options パラメーター。
戻り値
Promise<ApiPolicyGetResponse>
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)
識別子で指定された API ポリシーのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- policyId
-
string
ポリシーの識別子。
options パラメーター。
戻り値
Promise<ApiPolicyGetEntityTagHeaders>
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)
API レベルでポリシー構成を取得します。
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- options
- ApiPolicyListByApiOptionalParams
options パラメーター。
戻り値
Promise<PolicyCollection>