Share via

Cache - Create Or Update

  • Reference
Service:
API Management
API Version:
2024-05-01

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=2024-05-01

URI Parameters

Name In Required Type Description
cacheId
 path True

string

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

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

string

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

The name of the API Management service.

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

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

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

CacheContract

The Cache details were successfully updated.

Headers

ETag: string
201 Created

CacheContract

The new Cache was successfully added.

Headers

ETag: string
Other Status Codes

ErrorResponse

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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1?api-version=2024-05-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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"
  }
}

Sample response

Status code:
201 
{
  "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": "default",
    "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"
  }
}
Status code:
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": "default",
    "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"
  }
}

Definitions

Name Description
CacheContract

Cache details.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

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"

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.