Portal Revision - List By Service

Service:

API Management

API Version:

2022-08-01

開発者ポータルのリビジョンを一覧表示します。

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI パラメーター

名前	/	必須	型	説明
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 バージョン。
$filter	query		string	フィールド サポートされている演算子 サポートされる関数 |name |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith| |description |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith| |isCurrent |eq, ne | |
$skip	query		integer int32	スキップするレコードの数。
$top	query		integer int32	返されるレコードの数。

応答

名前	型	説明
200 OK	PortalRevisionCollection	ポータルのリビジョンを一覧表示します。
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	ユーザー アカウントの借用

例

ApiManagementListPortalRevisions

Sample Request

HTTP

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

Java

/** Samples for PortalRevision ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPortalRevisions.json
     */
    /**
     * Sample code: ApiManagementListPortalRevisions.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListPortalRevisions(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .portalRevisions()
            .listByService("rg1", "apimService1", null, null, null, com.azure.core.util.Context.NONE);
    }
}

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_list_portal_revisions.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.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPortalRevisions.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/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/ApiManagementListPortalRevisions.json
func ExamplePortalRevisionClient_NewListByServicePager() {
	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)
	}
	pager := clientFactory.NewPortalRevisionClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.PortalRevisionClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PortalRevisionCollection = armapimanagement.PortalRevisionCollection{
		// 	Value: []*armapimanagement.PortalRevisionContract{
		// 		{
		// 			Name: to.Ptr("20201112000000"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalRevisions"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112000000"),
		// 			Properties: &armapimanagement.PortalRevisionContractProperties{
		// 				Description: to.Ptr("portal revision"),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-12T22:10:09.673Z"); return t}()),
		// 				IsCurrent: to.Ptr(false),
		// 				Status: to.Ptr(armapimanagement.PortalRevisionStatusCompleted),
		// 				UpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-12T22:12:41.460Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("20201112101010"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalRevisions"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010"),
		// 			Properties: &armapimanagement.PortalRevisionContractProperties{
		// 				Description: to.Ptr("portal revision 1"),
		// 				CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-12T22:51:36.470Z"); return t}()),
		// 				IsCurrent: to.Ptr(true),
		// 				Status: to.Ptr(armapimanagement.PortalRevisionStatusCompleted),
		// 				UpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-12T22:52:00.097Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

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 Lists developer portal's revisions.
 *
 * @summary Lists developer portal's revisions.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPortalRevisions.json
 */
async function apiManagementListPortalRevisions() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.portalRevision.listByService(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112000000",
      "type": "Microsoft.ApiManagement/service/portalRevisions",
      "name": "20201112000000",
      "properties": {
        "description": "portal revision",
        "statusDetails": null,
        "status": "completed",
        "isCurrent": false,
        "createdDateTime": "2020-11-12T22:10:09.673Z",
        "updatedDateTime": "2020-11-12T22:12:41.46Z"
      }
    },
    {
      "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-12T22:51:36.47Z",
        "updatedDateTime": "2020-11-12T22:52:00.097Z"
      }
    }
  ]
}

定義

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

ErrorFieldContract

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

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

ErrorResponse

エラー応答。

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

PortalRevisionCollection

ポータルのリビジョンのページ一覧。

名前	型	説明
nextLink	string	次のページ リンク (存在する場合)。
value	PortalRevisionContract[]	ポータルのリビジョンのコレクション。

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	ポータルのリビジョンが発行されています。