Cache - Update

Serviço:

API Management

Versão da API:

2024-05-01

Atualiza os detalhes do cache especificado por seu identificador.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
cacheId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador da entidade cache. Identificador de cache (deve ser 'padrão' ou identificador de região do Azure válido).
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match	True	string	ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

Corpo da solicitação

Nome	Tipo	Description
properties.connectionString	string maxLength: 300	Cadeia de conexão de runtime para cache
properties.description	string maxLength: 2000	Descrição do cache
properties.resourceId	string maxLength: 2000	URI original da entidade no cache do sistema externo aponta para
properties.useFromLocation	string maxLength: 256	Identificador de local do qual usar o cache (deve ser 'padrão' ou identificador de região do Azure válido)

Respostas

Nome	Tipo	Description
200 OK	CacheContract	Os detalhes do Cache foram atualizados com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementUpdateCache

Solicitação de exemplo

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

Java

import com.azure.resourcemanager.apimanagement.models.CacheContract;

/**
 * Samples for Cache Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementUpdateCache.json
     */
    /**
     * Sample code: ApiManagementUpdateCache.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateCache(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        CacheContract resource = manager.caches()
            .getWithResponse("rg1", "apimService1", "c1", com.azure.core.util.Context.NONE).getValue();
        resource.update().withUseFromLocation("westindia").withIfMatch("*").apply();
    }
}

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_update_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="00000000-0000-0000-0000-000000000000",
    )

    response = client.cache.update(
        resource_group_name="rg1",
        service_name="apimService1",
        cache_id="c1",
        if_match="*",
        parameters={"properties": {"useFromLocation": "westindia"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementUpdateCache.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementUpdateCache.json
func ExampleCacheClient_Update() {
	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().Update(ctx, "rg1", "apimService1", "c1", "*", armapimanagement.CacheUpdateParameters{
		Properties: &armapimanagement.CacheUpdateProperties{
			UseFromLocation: to.Ptr("westindia"),
		},
	}, 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/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"),
	// 		UseFromLocation: to.Ptr("westindia"),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates the details of the cache specified by its identifier.
 *
 * @summary Updates the details of the cache specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementUpdateCache.json
 */
async function apiManagementUpdateCache() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const cacheId = "c1";
  const ifMatch = "*";
  const parameters = { useFromLocation: "westindia" };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.cache.update(
    resourceGroupName,
    serviceName,
    cacheId,
    ifMatch,
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementUpdateCache.json
// this example is just showing the usage of "Cache_Update" 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 ApiManagementCacheResource created on azure
// for more information of creating ApiManagementCacheResource, please refer to the document of ApiManagementCacheResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string cacheId = "c1";
ResourceIdentifier apiManagementCacheResourceId = ApiManagementCacheResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, cacheId);
ApiManagementCacheResource apiManagementCache = client.GetApiManagementCacheResource(apiManagementCacheResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementCachePatch patch = new ApiManagementCachePatch
{
    UseFromLocation = "westindia",
};
ApiManagementCacheResource result = await apiManagementCache.UpdateAsync(ifMatch, patch);

// 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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
CacheContract	Detalhes do cache.
CacheUpdateParameters	Detalhes da atualização do cache.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

CacheContract

Objeto

Detalhes do cache.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.connectionString	string maxLength: 300	Cadeia de conexão de runtime para cache
properties.description	string maxLength: 2000	Descrição do cache
properties.resourceId	string maxLength: 2000	URI original da entidade no cache do sistema externo aponta para
properties.useFromLocation	string maxLength: 256	Identificador de local do qual usar o cache (deve ser 'padrão' ou identificador de região do Azure válido)
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CacheUpdateParameters

Objeto

Detalhes da atualização do cache.

Nome	Tipo	Description
properties.connectionString	string maxLength: 300	Cadeia de conexão de runtime para cache
properties.description	string maxLength: 2000	Descrição do cache
properties.resourceId	string maxLength: 2000	URI original da entidade no cache do sistema externo aponta para
properties.useFromLocation	string maxLength: 256	Identificador de local do qual usar o cache (deve ser 'padrão' ou identificador de região do Azure válido)

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.