Cache - Create Or Update

Service:

API Management

API-versie:

2021-08-01

Hiermee maakt of werkt u een externe cache bij die moet worden gebruikt in het API Management-exemplaar.

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	Vereist	Type	Description
cacheId	path	True	string	Id van de entiteit Cache. Cache-id (moet 'standaard' of geldige Azure-regio-id zijn). Regex-patroon: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string	De naam van de API Management service. Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Aanvraagbody

Name	Vereist	Type	Description
properties.connectionString	True	string	Runtime-verbindingsreeks voor cache
properties.useFromLocation	True	string	Locatie-id om cache van te gebruiken (moet 'standaard' of geldige Azure-regio-id zijn)
properties.description		string	Cachebeschrijving
properties.resourceId		string	Oorspronkelijke URI van entiteit in externe systeemcache verwijst naar

Antwoorden

Name	Type	Description
200 OK	CacheContract	De cachegegevens zijn bijgewerkt. Kopteksten ETag: string
201 Created	CacheContract	De nieuwe cache is toegevoegd. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateCache

Voorbeeldaanvraag

HTTP

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"
  }
}

Java

/** Samples for Cache CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateCache.json
     */
    /**
     * Sample code: ApiManagementCreateCache.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateCache(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .caches()
            .define("c1")
            .withExistingService("rg1", "apimService1")
            .withDescription("Redis cache instances in West India")
            .withConnectionString("apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False")
            .withUseFromLocation("default")
            .withResourceId(
                "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_cache.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.cache.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        cache_id="c1",
        parameters={
            "properties": {
                "connectionString": "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False",
                "description": "Redis cache instances in West India",
                "resourceId": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1",
                "useFromLocation": "default",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateCache.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateCache.json
func ExampleCacheClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCacheClient().CreateOrUpdate(ctx, "rg1", "apimService1", "c1", armapimanagement.CacheContract{
		Properties: &armapimanagement.CacheContractProperties{
			Description:      to.Ptr("Redis cache instances in West India"),
			ConnectionString: to.Ptr("apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False"),
			ResourceID:       to.Ptr("https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"),
			UseFromLocation:  to.Ptr("default"),
		},
	}, &armapimanagement.CacheClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CacheContract = armapimanagement.CacheContract{
	// 	Name: to.Ptr("c1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/caches"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/caches/c1"),
	// 	Properties: &armapimanagement.CacheContractProperties{
	// 		Description: to.Ptr("Redis cache instances in West India"),
	// 		ConnectionString: to.Ptr("{{5f7fbca77a891a2200f3db38}}"),
	// 		ResourceID: to.Ptr("https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"),
	// 		UseFromLocation: to.Ptr("default"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates an External Cache to be used in Api Management instance.
 *
 * @summary Creates or updates an External Cache to be used in Api Management instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateCache.json
 */
async function apiManagementCreateCache() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const cacheId = "c1";
  const parameters = {
    description: "Redis cache instances in West India",
    connectionString: "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False",
    resourceId:
      "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1",
    useFromLocation: "default",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.cache.createOrUpdate(
    resourceGroupName,
    serviceName,
    cacheId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateCache.json
// this example is just showing the usage of "Cache_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementCacheResource
ApiManagementCacheCollection collection = apiManagementService.GetApiManagementCaches();

// invoke the operation
string cacheId = "c1";
ApiManagementCacheData data = new ApiManagementCacheData()
{
    Description = "Redis cache instances in West India",
    ConnectionString = "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False",
    UseFromLocation = "default",
    ResourceUri = new Uri("https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"),
};
ArmOperation<ApiManagementCacheResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, cacheId, data);
ApiManagementCacheResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementCacheData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:

201

{
  "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"
  }
}

Statuscode:

200

{
  "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"
  }
}

Definities

Name	Description
CacheContract	Cachedetails.
ErrorFieldContract	Fout Veldcontract.
ErrorResponse	Foutreactie.

CacheContract

Cachedetails.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.connectionString	string	Runtime-verbindingsreeks voor cache
properties.description	string	Cachebeschrijving
properties.resourceId	string	Oorspronkelijke URI van entiteit in externe systeemcache verwijst naar
properties.useFromLocation	string	Locatie-id om cache van te gebruiken (moet 'standaard' of geldige Azure-regio-id zijn)
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorFieldContract

Fout Veldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Door mensen leesbare weergave van fout op eigenschapsniveau.
target	string	Naam van eigenschap.

ErrorResponse

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.
error.message	string	Door mensen leesbare weergave van de fout.