Product - Update

Serviço:

API Management

Versão da API:

2021-08-01

Atualize os detalhes do produto existentes.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2021-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
productId	path	True	string	Identificador de produto. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match	True	string	ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name	Tipo	Description
properties.approvalRequired	boolean	se a aprovação da subscrição é necessária. Se forem falsas, as novas subscrições serão aprovadas permitindo automaticamente aos programadores chamar as APIs do produto imediatamente após a subscrição. Se for verdade, os administradores têm de aprovar manualmente a subscrição antes de o programador poder fazer qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
properties.description	string	Descrição do produto. Pode incluir etiquetas de formatação HTML.
properties.displayName	string	Nome do produto.
properties.state	ProductState	se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado.
properties.subscriptionRequired	boolean	Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro.
properties.subscriptionsLimit	integer	Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
properties.terms	string	Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição.

Respostas

Name	Tipo	Description
200 OK	ProductContract	O produto foi atualizado com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementUpdateProduct

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct?api-version=2021-08-01


{
  "properties": {
    "displayName": "Test Template ProductName 4"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.ProductContract;

/** Samples for Product Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
     */
    /**
     * Sample code: ApiManagementUpdateProduct.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateProduct(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        ProductContract resource =
            manager.products().getWithResponse("rg1", "apimService1", "testproduct", Context.NONE).getValue();
        resource.update().withDisplayName("Test Template ProductName 4").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_product.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.product.update(
        resource_group_name="rg1",
        service_name="apimService1",
        product_id="testproduct",
        if_match="*",
        parameters={"properties": {"displayName": "Test Template ProductName 4"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.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/ApiManagementUpdateProduct.json
func ExampleProductClient_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.NewProductClient().Update(ctx, "rg1", "apimService1", "testproduct", "*", armapimanagement.ProductUpdateParameters{
		Properties: &armapimanagement.ProductUpdateProperties{
			DisplayName: to.Ptr("Test Template ProductName 4"),
		},
	}, 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.ProductContract = armapimanagement.ProductContract{
	// 	Name: to.Ptr("testproduct"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/products"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct"),
	// 	Properties: &armapimanagement.ProductContractProperties{
	// 		Description: to.Ptr("Subscribers have completely unlimited access to the API. Administrator approval is required."),
	// 		ApprovalRequired: to.Ptr(true),
	// 		State: to.Ptr(armapimanagement.ProductStatePublished),
	// 		SubscriptionRequired: to.Ptr(true),
	// 		SubscriptionsLimit: to.Ptr[int32](1),
	// 		DisplayName: to.Ptr("Test Template ProductName 4"),
	// 	},
	// }
}

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 Update existing product details.
 *
 * @summary Update existing product details.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
 */
async function apiManagementUpdateProduct() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const productId = "testproduct";
  const ifMatch = "*";
  const parameters = {
    displayName: "Test Template ProductName 4",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.product.update(
    resourceGroupName,
    serviceName,
    productId,
    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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
// this example is just showing the usage of "Product_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 ApiManagementProductResource created on azure
// for more information of creating ApiManagementProductResource, please refer to the document of ApiManagementProductResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string productId = "testproduct";
ResourceIdentifier apiManagementProductResourceId = ApiManagementProductResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, productId);
ApiManagementProductResource apiManagementProduct = client.GetApiManagementProductResource(apiManagementProductResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementProductPatch patch = new ApiManagementProductPatch()
{
    DisplayName = "Test Template ProductName 4",
};
ApiManagementProductResource result = await apiManagementProduct.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
ApiManagementProductData 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 da amostra

Código de estado:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "testproduct",
  "properties": {
    "displayName": "Test Template ProductName 4",
    "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
    "subscriptionRequired": true,
    "approvalRequired": true,
    "subscriptionsLimit": 1,
    "state": "published"
  }
}

Definições

Name	Description
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.
ProductContract	Detalhes do produto.
ProductState	se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado.
ProductUpdateParameters	Parâmetros de Atualização de Produtos.

ErrorFieldContract

Contrato de campo de erro.

Name	Tipo	Description
code	string	Código de erro ao nível da propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

ProductContract

Detalhes do produto.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.approvalRequired	boolean	se a aprovação da subscrição é necessária. Se forem falsas, as novas subscrições serão aprovadas permitindo automaticamente aos programadores chamar as APIs do produto imediatamente após a subscrição. Se for verdade, os administradores têm de aprovar manualmente a subscrição antes de o programador poder fazer qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
properties.description	string	Descrição do produto. Pode incluir etiquetas de formatação HTML.
properties.displayName	string	Nome do produto.
properties.state	ProductState	se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado.
properties.subscriptionRequired	boolean	Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro.
properties.subscriptionsLimit	integer	Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
properties.terms	string	Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ProductState

se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado.

Name	Tipo	Description
notPublished	string
published	string

ProductUpdateParameters

Parâmetros de Atualização de Produtos.

Name	Tipo	Description
properties.approvalRequired	boolean	se a aprovação da subscrição é necessária. Se forem falsas, as novas subscrições serão aprovadas permitindo automaticamente aos programadores chamar as APIs do produto imediatamente após a subscrição. Se for verdade, os administradores têm de aprovar manualmente a subscrição antes de o programador poder fazer qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
properties.description	string	Descrição do produto. Pode incluir etiquetas de formatação HTML.
properties.displayName	string	Nome do produto.
properties.state	ProductState	se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado.
properties.subscriptionRequired	boolean	Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro.
properties.subscriptionsLimit	integer	Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
properties.terms	string	Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição.