Product - Create Or Update

Layanan:

API Management

Versi API:

2024-05-01

Membuat atau Memperbarui produk.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
productId	path	True	string minLength: 1 maxLength: 256	Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nama layanan API Management.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match		string	ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.displayName	True	string minLength: 1 maxLength: 300	Nama produk.
properties.approvalRequired		boolean	apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
properties.description		string minLength: 0 maxLength: 1000	Deskripsi produk. Dapat mencakup tag pemformatan HTML.
properties.state		ProductState	apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan.
properties.subscriptionRequired		boolean	Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini. Jika true, produk disebut sebagai "dilindungi" dan kunci langganan yang valid diperlukan agar permintaan ke API yang disertakan dalam produk berhasil. Jika false, produk disebut sebagai "terbuka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar.
properties.subscriptionsLimit		integer (int32)	Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
properties.terms		string	Ketentuan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses langganan.

Respons

Nama	Jenis	Deskripsi
200 OK	ProductContract	Produk berhasil diperbarui. Header ETag: string
201 Created	ProductContract	Produk berhasil dibuat. Header ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreateProduct

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct?api-version=2024-05-01

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

Java

/**
 * Samples for Product CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementCreateProduct.json
     */
    /**
     * Sample code: ApiManagementCreateProduct.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementCreateProduct(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.products().define("testproduct").withExistingService("rg1", "apimService1")
            .withDisplayName("Test Template ProductName 4").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_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="00000000-0000-0000-0000-000000000000",
    )

    response = client.product.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        product_id="testproduct",
        parameters={"properties": {"displayName": "Test Template ProductName 4"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateProduct.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/ApiManagementCreateProduct.json
func ExampleProductClient_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.NewProductClient().CreateOrUpdate(ctx, "rg1", "apimService1", "testproduct", armapimanagement.ProductContract{
		Properties: &armapimanagement.ProductContractProperties{
			DisplayName: to.Ptr("Test Template ProductName 4"),
		},
	}, &armapimanagement.ProductClientCreateOrUpdateOptions{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.ProductContract = armapimanagement.ProductContract{
	// 	Name: to.Ptr("testproduct"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/products"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct"),
	// 	Properties: &armapimanagement.ProductContractProperties{
	// 		ApprovalRequired: to.Ptr(false),
	// 		State: to.Ptr(armapimanagement.ProductStateNotPublished),
	// 		SubscriptionRequired: to.Ptr(true),
	// 		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");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or Updates a product.
 *
 * @summary Creates or Updates a product.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateProduct.json
 */
async function apiManagementCreateProduct() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const productId = "testproduct";
  const parameters = {
    displayName: "Test Template ProductName 4",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.product.createOrUpdate(
    resourceGroupName,
    serviceName,
    productId,
    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;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateProduct.json
// this example is just showing the usage of "Product_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 = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementProductResource
ApiManagementProductCollection collection = apiManagementService.GetApiManagementProducts();

// invoke the operation
string productId = "testproduct";
ApiManagementProductData data = new ApiManagementProductData
{
    DisplayName = "Test Template ProductName 4",
};
ArmOperation<ApiManagementProductResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, productId, data);
ApiManagementProductResource 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
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

Respon sampel

Kode status:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "testproduct",
  "properties": {
    "displayName": "Test Template ProductName 4",
    "subscriptionRequired": true,
    "approvalRequired": false,
    "state": "notPublished"
  }
}

Kode status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "testproduct",
  "properties": {
    "displayName": "Test Template ProductName 4",
    "subscriptionRequired": true,
    "approvalRequired": false,
    "state": "notPublished"
  }
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ProductContract	Detail produk.
ProductState	apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ProductContract

Objek

Detail produk.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.approvalRequired	boolean	apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
properties.description	string minLength: 0 maxLength: 1000	Deskripsi produk. Dapat mencakup tag pemformatan HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nama produk.
properties.state	ProductState	apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan.
properties.subscriptionRequired	boolean	Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini. Jika true, produk disebut sebagai "dilindungi" dan kunci langganan yang valid diperlukan agar permintaan ke API yang disertakan dalam produk berhasil. Jika false, produk disebut sebagai "terbuka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar.
properties.subscriptionsLimit	integer (int32)	Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
properties.terms	string	Ketentuan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses langganan.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ProductState

Enumeration

apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan.

Nilai	Deskripsi
notPublished
published