Product - Create Or Update

リファレンス

Service:: API Management

API Version:: 2022-08-01

製品を作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
productId	path	True	string	製品識別子。現在のAPI Management サービスインスタンスで一意である必要があります。
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	エンティティの ETag。エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。

要求本文

名前	必須	型	説明
properties.displayName	True	string	製品名。
properties.approvalRequired		boolean	サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、開発者はサブスクライブ直後に製品の API を呼び出すことができます。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
properties.description		string	製品の説明。 HTML 書式設定タグを含めることができます。
properties.state		ProductState	製品が公開されているかどうか。公開された製品は、開発者ポータルのユーザーが検出できます。公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。
properties.subscriptionRequired		boolean	この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "protected" と呼ばれ、製品に含まれる API への要求が成功するには有効なサブスクリプションキーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプションキーなしで行うことができます。新しい製品を作成するときにプロパティを省略すると、値は true と見なされます。
properties.subscriptionsLimit		integer	ユーザーがこの製品に対して同時に持ち込むことができるサブスクリプションの数かどうか。ユーザーサブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
properties.terms		string	製品の使用条件。製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプションプロセスを完了する前にこれらの条件に同意する必要があります。

応答

名前	型	説明
200 OK	ProductContract	製品が正常に更新されました。 Headers ETag: string
201 Created	ProductContract	製品は正常に作成されました。 Headers ETag: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

ProductContract

製品が正常に更新されました。

Headers

ETag: string

201 Created

ProductContract

製品は正常に作成されました。

Headers

ETag: string

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ApiManagementCreateProduct

Sample Request

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

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

/** Samples for Product CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-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

from typing import Any, IO, Union

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="subid",
    )

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

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-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/subid/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

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

/**
 * 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/2022-08-01/examples/ApiManagementCreateProduct.json
 */
async function apiManagementCreateProduct() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  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

Sample Response

Status code:: 201

{
  "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",
    "subscriptionRequired": true,
    "approvalRequired": false,
    "state": "notPublished"
  }
}

Status code:: 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",
    "subscriptionRequired": true,
    "approvalRequired": false,
    "state": "notPublished"
  }
}

定義

名前	説明
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答。
ProductContract	製品の詳細。
ProductState	製品が公開されているかどうか。公開された製品は、開発者ポータルのユーザーが検出できます。公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。

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	製品が公開されているかどうか。公開された製品は、開発者ポータルのユーザーが検出できます。公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。
properties.subscriptionRequired	boolean	この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "protected" と呼ばれ、製品に含まれる API への要求が成功するには有効なサブスクリプションキーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプションキーなしで行うことができます。新しい製品を作成するときにプロパティを省略すると、値は true と見なされます。
properties.subscriptionsLimit	integer	ユーザーがこの製品に対して同時に持ち込むことができるサブスクリプションの数かどうか。ユーザーサブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
properties.terms	string	製品の使用条件。製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプションプロセスを完了する前にこれらの条件に同意する必要があります。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ProductState

製品が公開されているかどうか。公開された製品は、開発者ポータルのユーザーが検出できます。公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。

名前	型	説明
notPublished	string
published	string

Product - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

Scopes

例

ApiManagementCreateProduct

Sample Request

Sample Response

定義

ErrorFieldContract

ErrorResponse

ProductContract

ProductState

その他のリソース