Cache - Update

Updates the details of the cache specified by its identifier.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

cacheId
path True
  • string

Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True
  • string

Version of the API to be used with the client request.

Request Header

Name Required Type Description
If-Match True
  • string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name Type Description
properties.connectionString
  • string

Runtime connection string to cache

properties.description
  • string

Cache description

properties.resourceId
  • string

Original uri of entity in external system cache points to

Responses

Name Type Description
204 No Content

The cache details were successfully updated.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementUpdateCache

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/westindia?api-version=2019-01-01
If-Match: *
{
  "properties": {
    "description": "Update Cache in west India"
  }
}

Sample Response

Definitions

CacheUpdateParameters

Cache update details.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

CacheUpdateParameters

Cache update details.

Name Type Description
properties.connectionString
  • string

Runtime connection string to cache

properties.description
  • string

Cache description

properties.resourceId
  • string

Original uri of entity in external system cache points to

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.