Cache - Update

サービス:

API Management

API バージョン:

2024-05-01

識別子で指定されたキャッシュの詳細を更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
cacheId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	キャッシュ エンティティの識別子。 キャッシュ識別子 ("既定" または有効な Azure リージョン識別子のいずれかである必要があります)。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

要求本文

名前	型	説明
properties.connectionString	string maxLength: 300	キャッシュするランタイム接続文字列
properties.description	string maxLength: 2000	キャッシュの説明
properties.resourceId	string maxLength: 2000	外部システム キャッシュ内のエンティティの元の URI は、
properties.useFromLocation	string maxLength: 256	キャッシュを使用する場所識別子 ("既定" または有効な Azure リージョン識別子のいずれかである必要があります)

応答

名前	型	説明
200 OK	CacheContract	キャッシュの詳細が正常に更新されました。 ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ApiManagementUpdateCache

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1?api-version=2024-05-01


{
  "properties": {
    "useFromLocation": "westindia"
  }
}

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1",
  "type": "Microsoft.ApiManagement/service/caches",
  "name": "c1",
  "properties": {
    "useFromLocation": "westindia",
    "description": "Redis cache instances in West India",
    "connectionString": "{{5f7fbca77a891a2200f3db38}}",
    "resourceId": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"
  }
}

定義

名前	説明
CacheContract	キャッシュの詳細。
CacheUpdateParameters	キャッシュ更新の詳細。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

CacheContract

Object

キャッシュの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.connectionString	string maxLength: 300	キャッシュするランタイム接続文字列
properties.description	string maxLength: 2000	キャッシュの説明
properties.resourceId	string maxLength: 2000	外部システム キャッシュ内のエンティティの元の URI は、
properties.useFromLocation	string maxLength: 256	キャッシュを使用する場所識別子 ("既定" または有効な Azure リージョン識別子のいずれかである必要があります)
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

CacheUpdateParameters

Object

キャッシュ更新の詳細。

名前	型	説明
properties.connectionString	string maxLength: 300	キャッシュするランタイム接続文字列
properties.description	string maxLength: 2000	キャッシュの説明
properties.resourceId	string maxLength: 2000	外部システム キャッシュ内のエンティティの元の URI は、
properties.useFromLocation	string maxLength: 256	キャッシュを使用する場所識別子 ("既定" または有効な Azure リージョン識別子のいずれかである必要があります)

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。