你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Product - Update

服务:

API Management

API 版本:

2021-08-01

更新现有产品详细信息。

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

URI 参数

名称	在	必需	类型	说明
productId	path	True	string	产品标识符。 在当前API 管理服务实例中必须是唯一的。
resourceGroupName	path	True	string	资源组的名称。
serviceName	path	True	string	API 管理服务的名称。 正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

请求头

名称	必需	类型	说明
If-Match	True	string	实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。

请求正文

名称	类型	说明
properties.approvalRequired	boolean	是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
properties.description	string	产品说明。 可以包含 HTML 格式标记。
properties.displayName	string	产品名称。
properties.state	ProductState	是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。
properties.subscriptionRequired	boolean	访问此产品中包含的 API 是否需要产品订阅。 如果为 true，则产品称为“受保护”，并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false，则产品称为“打开”，并且无需订阅密钥即可对产品中包含的 API 发出请求。 如果在创建新产品时省略属性，则假定其值为 true。
properties.subscriptionsLimit	integer	用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许无限制的每个用户订阅。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
properties.terms	string	产品使用条款。 当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。

响应

名称	类型	说明
200 OK	ProductContract	已成功更新产品。 标头 ETag: string
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementUpdateProduct

示例请求

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

示例响应

状态代码:

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

定义

名称	说明
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应。
ProductContract	产品详细信息。
ProductState	是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。
ProductUpdateParameters	产品更新参数。

ErrorFieldContract

错误字段协定。

名称	类型	说明
code	string	属性级错误代码。
message	string	属性级错误的可读表示形式。
target	string	属性名称。

ErrorResponse

错误响应。

名称	类型	说明
error.code	string	服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。
error.details	ErrorFieldContract[]	在发生验证错误时，请求中发送的无效字段列表。
error.message	string	错误的用户可读表示形式。

ProductContract

产品详细信息。

名称	类型	说明
id	string	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.approvalRequired	boolean	是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
properties.description	string	产品说明。 可以包含 HTML 格式标记。
properties.displayName	string	产品名称。
properties.state	ProductState	是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。
properties.subscriptionRequired	boolean	访问此产品中包含的 API 是否需要产品订阅。 如果为 true，则产品称为“受保护”，并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false，则产品称为“打开”，并且无需订阅密钥即可对产品中包含的 API 发出请求。 如果在创建新产品时省略属性，则假定其值为 true。
properties.subscriptionsLimit	integer	用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许无限制的每个用户订阅。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
properties.terms	string	产品使用条款。 当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ProductState

是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。

名称	类型	说明
notPublished	string
published	string

ProductUpdateParameters

产品更新参数。

名称	类型	说明
properties.approvalRequired	boolean	是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
properties.description	string	产品说明。 可以包含 HTML 格式标记。
properties.displayName	string	产品名称。
properties.state	ProductState	是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。
properties.subscriptionRequired	boolean	访问此产品中包含的 API 是否需要产品订阅。 如果为 true，则产品称为“受保护”，并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false，则产品称为“打开”，并且无需订阅密钥即可对产品中包含的 API 发出请求。 如果在创建新产品时省略属性，则假定其值为 true。
properties.subscriptionsLimit	integer	用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许无限制的每个用户订阅。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
properties.terms	string	产品使用条款。 当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。