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

Portal Settings - List By Service

参考

Service:: API Management

API Version:: 2022-08-01

列出在服务实例中定义的 portalsettings 集合。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
serviceName	path	True	string	API 管理服务的名称。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	PortalSettingsCollection	列出门户设置实体的集合。
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	模拟用户帐户

示例

ApiManagementListPortalSettings

Sample Request

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

/** Samples for PortalSettings ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPortalSettings.json
     */
    /**
     * Sample code: ApiManagementListPortalSettings.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListPortalSettings(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.portalSettings().listByServiceWithResponse("rg1", "apimService1", 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.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_portal_settings.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_settings.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPortalSettings.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/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/ApiManagementListPortalSettings.json
func ExamplePortalSettingsClient_ListByService() {
	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.NewPortalSettingsClient().ListByService(ctx, "rg1", "apimService1", 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.PortalSettingsCollection = armapimanagement.PortalSettingsCollection{
	// 	Count: to.Ptr[int64](3),
	// 	Value: []*armapimanagement.PortalSettingsContract{
	// 		{
	// 			Name: to.Ptr("delegation"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalsettings"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation"),
	// 			Properties: &armapimanagement.PortalSettingsContractProperties{
	// 				Enabled: to.Ptr(false),
	// 				Subscriptions: &armapimanagement.SubscriptionsDelegationSettingsProperties{
	// 					Enabled: to.Ptr(false),
	// 				},
	// 				UserRegistration: &armapimanagement.RegistrationDelegationSettingsProperties{
	// 					Enabled: to.Ptr(false),
	// 				},
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("signin"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalsettings"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin"),
	// 			Properties: &armapimanagement.PortalSettingsContractProperties{
	// 				Enabled: to.Ptr(false),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("signup"),
	// 			Type: to.Ptr("Microsoft.ApiManagement/service/portalsettings"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup"),
	// 			Properties: &armapimanagement.PortalSettingsContractProperties{
	// 				Enabled: to.Ptr(true),
	// 				TermsOfService: &armapimanagement.TermsOfServiceProperties{
	// 					ConsentRequired: to.Ptr(false),
	// 					Enabled: to.Ptr(false),
	// 					Text: to.Ptr("Terms of service"),
	// 				},
	// 			},
	// 	}},
	// }
}

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 Lists a collection of portalsettings defined within a service instance..
 *
 * @summary Lists a collection of portalsettings defined within a service instance..
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPortalSettings.json
 */
async function apiManagementListPortalSettings() {
  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 result = await client.portalSettings.listByService(resourceGroupName, serviceName);
  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

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation",
      "type": "Microsoft.ApiManagement/service/portalsettings",
      "name": "delegation",
      "properties": {
        "subscriptions": {
          "enabled": false
        },
        "userRegistration": {
          "enabled": false
        },
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin",
      "type": "Microsoft.ApiManagement/service/portalsettings",
      "name": "signin",
      "properties": {
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup",
      "type": "Microsoft.ApiManagement/service/portalsettings",
      "name": "signup",
      "properties": {
        "enabled": true,
        "termsOfService": {
          "text": "Terms of service",
          "enabled": false,
          "consentRequired": false
        }
      }
    }
  ],
  "count": 3
}

定义

名称	说明
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应。
PortalSettingsCollection	API 管理策略的说明。
PortalSettingsContract	开发人员门户的门户设置。
RegistrationDelegationSettingsProperties	用户注册委派设置属性。
SubscriptionsDelegationSettingsProperties	订阅委派设置属性。
TermsOfServiceProperties	服务条款协定属性。

ErrorFieldContract

错误字段协定。

名称	类型	说明
code	string	属性级错误代码。
message	string	属性级错误的可读表示形式。
target	string	属性名称。

ErrorResponse

错误响应。

名称	类型	说明
error.code	string	服务定义的错误代码。此代码用作响应中指定的 HTTP 错误代码的子状态。
error.details	ErrorFieldContract[]	在发生验证错误时，请求中发送的无效字段列表。
error.message	string	错误的用户可读表示形式。

PortalSettingsCollection

API 管理策略的说明。

名称	类型	说明
count	integer	总记录计数数。
value	PortalSettingsContract[]	API 管理策略的说明。

PortalSettingsContract

开发人员门户的门户设置。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.enabled	boolean	将匿名用户重定向到 Sign-In 页。
properties.subscriptions	SubscriptionsDelegationSettingsProperties	订阅委派设置。
properties.termsOfService	TermsOfServiceProperties	服务条款协定属性。
properties.url	string	委派 URL。
properties.userRegistration	RegistrationDelegationSettingsProperties	用户注册委派设置。
properties.validationKey	string	要验证的 base64 编码验证密钥，请求是否来自 Azure API 管理。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

RegistrationDelegationSettingsProperties

用户注册委派设置属性。

名称	类型	说明
enabled	boolean	启用或禁用用户注册的委派。

SubscriptionsDelegationSettingsProperties

订阅委派设置属性。

名称	类型	说明
enabled	boolean	启用或禁用订阅委派。

TermsOfServiceProperties

服务条款协定属性。

名称	类型	说明
consentRequired	boolean	要求用户同意服务条款。
enabled	boolean	在注册过程中显示服务条款。
text	string	服务条款文本。

Portal Settings - List By Service

URI 参数

响应

安全性

azure_auth

Scopes

示例

ApiManagementListPortalSettings

Sample Request

Sample Response

定义

ErrorFieldContract

ErrorResponse

PortalSettingsCollection

PortalSettingsContract

RegistrationDelegationSettingsProperties

SubscriptionsDelegationSettingsProperties

TermsOfServiceProperties

其他资源