Cache - Create Or Update
Creates or updates an External Cache to be used in Api Management instance.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}?api-version=2021-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
cache
|
path | True |
string |
Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier). Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
If-Match |
string |
ETag of the Entity. Not required when creating an entity, but required when updating an entity. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
properties.connectionString | True |
string |
Runtime connection string to cache |
properties.useFromLocation | True |
string |
Location identifier to use cache from (should be either 'default' or valid Azure region identifier) |
properties.description |
string |
Cache description |
|
properties.resourceId |
string |
Original uri of entity in external system cache points to |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The Cache details were successfully updated. Headers ETag: string |
|
201 Created |
The new Cache was successfully added. Headers ETag: string |
|
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
ApiManagementCreateCache
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1?api-version=2021-08-01
{
"properties": {
"connectionString": "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False",
"description": "Redis cache instances in West India",
"useFromLocation": "default",
"resourceId": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"
}
}
Sample response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1",
"type": "Microsoft.ApiManagement/service/caches",
"name": "c1",
"properties": {
"useFromLocation": "default",
"description": "Redis cache instances in West India",
"connectionString": "{{5f7fbca77a891a2200f3db38}}",
"resourceId": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1",
"type": "Microsoft.ApiManagement/service/caches",
"name": "c1",
"properties": {
"useFromLocation": "default",
"description": "Redis cache instances in West India",
"connectionString": "{{5f7fbca77a891a2200f3db38}}",
"resourceId": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"
}
}
Definitions
Name | Description |
---|---|
Cache |
Cache details. |
Error |
Error Field contract. |
Error |
Error Response. |
CacheContract
Cache details.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
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 |
properties.useFromLocation |
string |
Location identifier to use cache from (should be either 'default' or valid Azure region identifier) |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
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. |