Portal Revision - Create Or Update

Service:

API Management

API Version:

2022-08-01

ポータルの発行を実行して、新しい開発者ポータルのリビジョンを作成します。 プロパティは isCurrent 、リビジョンにパブリックにアクセスできるかどうかを示します。

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

URI パラメーター

名前	/	必須	型	説明
portalRevisionId	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 バージョン。

要求本文

名前	型	説明
properties.description	string	ポータルリビジョンの説明。
properties.isCurrent	boolean	ポータルのリビジョンがパブリックかどうかを示します。

応答

名前	型	説明
201 Created	PortalRevisionContract	開発者ポータルのリビジョンが正常に作成されました。 Headers ETag: string
202 Accepted		開発者ポータルリビジョンの作成要求が受け入れられました。
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	ユーザー アカウントの借用

例

ApiManagementCreatePortalRevision

Sample Request

HTTP

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

{
  "properties": {
    "description": "portal revision 1",
    "isCurrent": true
  }
}

Java

/** Samples for PortalRevision CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePortalRevision.json
     */
    /**
     * Sample code: ApiManagementCreatePortalRevision.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreatePortalRevision(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .portalRevisions()
            .define("20201112101010")
            .withExistingService("rg1", "apimService1")
            .withDescription("portal revision 1")
            .withIsCurrent(true)
            .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 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_portal_revision.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.portal_revision.begin_create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        portal_revision_id="20201112101010",
        parameters={"properties": {"description": "portal revision 1", "isCurrent": True}},
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePortalRevision.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/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/ApiManagementCreatePortalRevision.json
func ExamplePortalRevisionClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewPortalRevisionClient().BeginCreateOrUpdate(ctx, "rg1", "apimService1", "20201112101010", armapimanagement.PortalRevisionContract{
		Properties: &armapimanagement.PortalRevisionContractProperties{
			Description: to.Ptr("portal revision 1"),
			IsCurrent:   to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
 *
 * @summary Creates a new developer portal's revision by running the portal's publishing. The `isCurrent` property indicates if the revision is publicly accessible.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreatePortalRevision.json
 */
async function apiManagementCreatePortalRevision() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const portalRevisionId = "20201112101010";
  const parameters = {
    description: "portal revision 1",
    isCurrent: true,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.portalRevision.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    portalRevisionId,
    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:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2022-08-01&asyncId=5faf089b1d9a026694220e0c&asyncCode=201

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010",
  "type": "Microsoft.ApiManagement/service/portalRevisions",
  "name": "20201112101010",
  "properties": {
    "description": "portal revision 1",
    "statusDetails": null,
    "status": "completed",
    "isCurrent": true,
    "createdDateTime": "2020-11-13T22:28:43.657Z",
    "updatedDateTime": "2020-11-13T22:29:22.68Z"
  }
}

定義

名前	説明
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。
PortalRevisionContract	ポータル リビジョンの契約の詳細。
portalRevisionStatus	ポータルのリビジョンの状態。

ErrorFieldContract

エラー フィールド コントラクト。

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

PortalRevisionContract

ポータル リビジョンの契約の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.createdDateTime	string	ポータルのリビジョン作成日時。
properties.description	string	ポータルリビジョンの説明。
properties.isCurrent	boolean	ポータルのリビジョンがパブリックかどうかを示します。
properties.status	portalRevisionStatus	ポータルのリビジョンの状態。
properties.statusDetails	string	ポータル リビジョンの発行状態の詳細。
properties.updatedDateTime	string	最終更新日時。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

portalRevisionStatus

ポータルのリビジョンの状態。

名前	型	説明
completed	string	ポータルのリビジョン発行が完了しました。
failed	string	ポータルのリビジョンの発行に失敗しました。
pending	string	ポータルのリビジョンがキューに登録されました。
publishing	string	ポータルのリビジョンが発行されています。