Cache interface
キャッシュを表すインターフェイス。
メソッド
| create |
API Management インスタンスで使用される外部キャッシュを作成または更新します。 |
| delete(string, string, string, string, Cache |
特定のキャッシュを削除します。 |
| get(string, string, string, Cache |
識別子で指定されたキャッシュの詳細を取得します。 |
| get |
識別子で指定されたキャッシュのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定されたサービス インスタンスのすべての外部キャッシュのコレクションを一覧表示します。 |
| update(string, string, string, string, Cache |
識別子で指定されたキャッシュの詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, CacheContract, CacheCreateOrUpdateOptionalParams)
API Management インスタンスで使用される外部キャッシュを作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, cacheId: string, parameters: CacheContract, options?: CacheCreateOrUpdateOptionalParams): Promise<CacheCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- cacheId
-
string
Cache エンティティの識別子。 キャッシュ識別子 ('default' または有効な Azure リージョン識別子のいずれかである必要があります)。
- parameters
- CacheContract
パラメーターを作成または更新します。
options パラメーター。
戻り値
Promise<CacheCreateOrUpdateResponse>
delete(string, string, string, string, CacheDeleteOptionalParams)
特定のキャッシュを削除します。
function delete(resourceGroupName: string, serviceName: string, cacheId: string, ifMatch: string, options?: CacheDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- cacheId
-
string
Cache エンティティの識別子。 キャッシュ識別子 ('default' または有効な Azure リージョン識別子のいずれかである必要があります)。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- CacheDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, CacheGetOptionalParams)
識別子で指定されたキャッシュの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, cacheId: string, options?: CacheGetOptionalParams): Promise<CacheGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- cacheId
-
string
Cache エンティティの識別子。 キャッシュ識別子 ('default' または有効な Azure リージョン識別子のいずれかである必要があります)。
- options
- CacheGetOptionalParams
options パラメーター。
戻り値
Promise<CacheGetResponse>
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)
識別子で指定されたキャッシュのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, cacheId: string, options?: CacheGetEntityTagOptionalParams): Promise<CacheGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- cacheId
-
string
Cache エンティティの識別子。 キャッシュ識別子 ('default' または有効な Azure リージョン識別子のいずれかである必要があります)。
- options
- CacheGetEntityTagOptionalParams
options パラメーター。
戻り値
Promise<CacheGetEntityTagHeaders>
listByService(string, string, CacheListByServiceOptionalParams)
指定されたサービス インスタンスのすべての外部キャッシュのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: CacheListByServiceOptionalParams): PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- CacheListByServiceOptionalParams
options パラメーター。
戻り値
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)
識別子で指定されたキャッシュの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, cacheId: string, ifMatch: string, parameters: CacheUpdateParameters, options?: CacheUpdateOptionalParams): Promise<CacheUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- cacheId
-
string
Cache エンティティの識別子。 キャッシュ識別子 ('default' または有効な Azure リージョン識別子のいずれかである必要があります)。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- CacheUpdateParameters
パラメーターを更新します。
- options
- CacheUpdateOptionalParams
options パラメーター。
戻り値
Promise<CacheUpdateResponse>