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

Api Portals - Get

参考

Service:: Azure Spring Apps

API Version:: 2023-12-01

获取 API 门户及其属性。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}?api-version=2023-12-01

URI 参数

名称	在	必需	类型	说明
apiPortalName	path	True	string	API 门户的名称。
resourceGroupName	path	True	string	包含该资源的资源组名称。可以从 Azure 资源管理器 API 或门户获取此值。
serviceName	path	True	string	服务资源的名称。 Regex pattern: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	获取唯一标识 Microsoft Azure 订阅的订阅 ID。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ApiPortalResource	成功。响应描述相应的 API 门户。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ApiPortals_Get

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default?api-version=2023-12-01


/**
 * Samples for ApiPortals Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_Get.json
     */
    /**
     * Sample code: ApiPortals_Get.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void apiPortalsGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getApiPortals().getWithResponse("myResourceGroup", "myservice",
            "default", 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

from azure.identity import DefaultAzureCredential
from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python api_portals_get.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 = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_portals.get(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        api_portal_name="default",
    )
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_Get.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 armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_Get.json
func ExampleAPIPortalsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAPIPortalsClient().Get(ctx, "myResourceGroup", "myservice", "default", 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.APIPortalResource = armappplatform.APIPortalResource{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/apiPortals"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default"),
	// 	SystemData: &armappplatform.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 		CreatedBy: to.Ptr("sample-user"),
	// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("sample-user"),
	// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 	},
	// 	Properties: &armappplatform.APIPortalProperties{
	// 		APITryOutEnabledState: to.Ptr(armappplatform.APIPortalAPITryOutEnabledStateEnabled),
	// 		GatewayIDs: []*string{
	// 			to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default")},
	// 			Instances: []*armappplatform.APIPortalInstance{
	// 				{
	// 					Name: to.Ptr("instance1"),
	// 					Status: to.Ptr("Running"),
	// 				},
	// 				{
	// 					Name: to.Ptr("instance2"),
	// 					Status: to.Ptr("Running"),
	// 			}},
	// 			ProvisioningState: to.Ptr(armappplatform.APIPortalProvisioningStateSucceeded),
	// 			Public: to.Ptr(true),
	// 			ResourceRequests: &armappplatform.APIPortalResourceRequests{
	// 				CPU: to.Ptr("1"),
	// 				Memory: to.Ptr("1G"),
	// 			},
	// 			URL: to.Ptr("test-url"),
	// 		},
	// 		SKU: &armappplatform.SKU{
	// 			Name: to.Ptr("E0"),
	// 			Capacity: to.Ptr[int32](2),
	// 			Tier: to.Ptr("Enterprise"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to Get the API portal and its properties.
 *
 * @summary Get the API portal and its properties.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApiPortals_Get.json
 */
async function apiPortalsGet() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const apiPortalName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.apiPortals.get(resourceGroupName, serviceName, apiPortalName);
  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:: 200

{
  "properties": {
    "provisioningState": "Succeeded",
    "public": true,
    "url": "test-url",
    "gatewayIds": [
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"
    ],
    "resourceRequests": {
      "cpu": "1",
      "memory": "1G"
    },
    "instances": [
      {
        "name": "instance1",
        "status": "Running"
      },
      {
        "name": "instance2",
        "status": "Running"
      }
    ],
    "apiTryOutEnabledState": "Enabled"
  },
  "sku": {
    "name": "E0",
    "tier": "Enterprise",
    "capacity": 2
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/apiPortals",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default",
  "name": "default"
}

定义

名称	说明
ApiPortalApiTryOutEnabledState	指示是启用还是禁用 API 试用功能。启用后，用户可以通过发送请求并在 API 门户中查看响应来试用 API。禁用后，用户无法试用 API。
ApiPortalInstance	属于 API 门户的实例集合
ApiPortalProperties	API 门户属性有效负载
ApiPortalProvisioningState	API 门户的状态。
ApiPortalResource	API 门户资源
ApiPortalResourceRequests	API 门户的资源请求
CloudError	来自服务的错误响应。
CloudErrorBody	来自服务的错误响应。
createdByType	创建资源的标识类型。
lastModifiedByType	上次修改资源的标识类型。
Sku	Azure Spring Apps 的 SKU
SsoProperties	单一登录相关配置
SystemData	与资源的创建和上次修改相关的元数据。

ApiPortalApiTryOutEnabledState

指示是启用还是禁用 API 试用功能。启用后，用户可以通过发送请求并在 API 门户中查看响应来试用 API。禁用后，用户无法试用 API。

名称	类型	说明
Disabled	string
Enabled	string

ApiPortalInstance

属于 API 门户的实例集合

名称	类型	说明
name	string	API 门户实例的名称
status	string	API 门户实例的状态

ApiPortalProperties

API 门户属性有效负载

名称	类型	默认值	说明
apiTryOutEnabledState	ApiPortalApiTryOutEnabledState	Enabled	指示是启用还是禁用 API 试用功能。启用后，用户可以通过发送请求并在 API 门户中查看响应来试用 API。禁用后，用户无法试用 API。
gatewayIds	string[]		要与 API 门户集成的网关的资源 ID 数组。
httpsOnly	boolean	False	指示是否只允许 https。
instances	ApiPortalInstance[]		实例集合属于 API 门户。
provisioningState	ApiPortalProvisioningState		API 门户的状态。
public	boolean	False	指示 API 门户是否公开终结点。
resourceRequests	ApiPortalResourceRequests		所需 CPU 和内存的请求资源数量。
sourceUrls	string[]		OpenAPI 源 URL 位置的集合。
ssoProperties	SsoProperties		单一登录相关配置
url	string		API 门户的 URL，在“public”为 true 时公开。

ApiPortalProvisioningState

API 门户的状态。

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ApiPortalResource

API 门户资源

名称	类型	说明
id	string	资源的完全限定资源 ID。
name	string	资源的名称。
properties	ApiPortalProperties	API 门户属性有效负载
sku	Sku	API 门户资源的 SKU
systemData	SystemData	与资源的创建和上次修改相关的元数据。
type	string	资源类型。

ApiPortalResourceRequests

API 门户的资源请求

名称	类型	说明
cpu	string	分配给每个 API 门户实例的 CPU
memory	string	分配给每个 API 门户实例的内存

CloudError

来自服务的错误响应。

名称	类型	说明
error	CloudErrorBody	来自服务的错误响应。

CloudErrorBody

来自服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，该消息适用于在用户界面中显示。
target	string	特定错误的目标。例如，属性的名称出错。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

上次修改资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

Sku

Azure Spring Apps 的 SKU

名称	类型	默认值	说明
capacity	integer		目标资源的当前容量
name	string	S0	SKU 的名称
tier	string	Standard	SKU 的层

SsoProperties

单一登录相关配置

名称	类型	说明
clientId	string	应用程序的公共标识符
clientSecret	string	只有应用程序和授权服务器知道的机密
issuerUri	string	颁发者标识符的 URI
scope	string[]	它定义允许应用程序代表用户执行的特定操作

SystemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源修改的时间戳 (UTC) 。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	lastModifiedByType	上次修改资源的标识类型。

Api Portals - Get

URI 参数

响应

安全性

azure_auth

Scopes

示例

ApiPortals_Get

Sample Request

Sample Response

定义

ApiPortalApiTryOutEnabledState

ApiPortalInstance

ApiPortalProperties

ApiPortalProvisioningState

ApiPortalResource

ApiPortalResourceRequests

CloudError

CloudErrorBody

createdByType

lastModifiedByType

Sku

SsoProperties

SystemData

其他资源