Portal Config - Get

Служба:

API Management

Версия API:

2024-05-01

Получите конфигурацию портала разработчика.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}?api-version=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
portalConfigId	path	True	string minLength: 1 maxLength: 80	Идентификатор конфигурации портала.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	PortalConfigContract	Конфигурация портала разработчика. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementPortalConfig

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default?api-version=2024-05-01

Пример ответа

Код состояния:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default",
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "name": "default",
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
PortalConfigContract	Контракт конфигурации портала разработчика.
PortalConfigCorsProperties	Параметры общего доступа к ресурсам (CORS) на портале разработчика.
PortalConfigCspProperties	Параметры политики безопасности содержимого портала разработчика (CSP).
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	Условия использования свойств контракта службы.
PortalSettingsCspMode	Режим политики безопасности содержимого портала разработчика (CSP).
Signin
Signup

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

PortalConfigContract

Object

Контракт конфигурации портала разработчика.

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Имя ресурса
properties.cors	PortalConfigCorsProperties		Параметры общего доступа к ресурсам (CORS) на портале разработчика.
properties.csp	PortalConfigCspProperties		Параметры политики безопасности содержимого портала разработчика (CSP).
properties.delegation	PortalConfigDelegationProperties		Параметры делегирования портала разработчика.
properties.enableBasicAuth	boolean	True	Включение или отключение метода базовой проверки подлинности.
properties.signin	Signin
properties.signup	Signup
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Object

Параметры общего доступа к ресурсам (CORS) на портале разработчика.

Имя	Тип	Описание
allowedOrigins	string[]	Допустимые источники, например https://trusted.com.

PortalConfigCspProperties

Object

Параметры политики безопасности содержимого портала разработчика (CSP).

Имя	Тип	Default value	Описание
allowedSources	string[]		Допустимые источники, например *.trusted.com, trusted.com, https://.
mode	PortalSettingsCspMode	disabled	Режим политики безопасности содержимого портала разработчика (CSP).
reportUri	string[]		URL-адреса, используемые браузером для сообщения о нарушениях CSP.

PortalConfigDelegationProperties

Object

Имя	Тип	Default value	Описание
delegateRegistration	boolean	False	Включение или отключение делегирования для регистрации пользователей.
delegateSubscription	boolean	False	Включение или отключение делегирования для подписок на продукты.
delegationUrl	string		URL-адрес конечной точки делегирования.
validationKey	string		Ключ проверки в кодировке Base64 для обеспечения того, чтобы запросы поступили из службы управления API Azure.

PortalConfigTermsOfServiceProperties

Object

Условия использования свойств контракта службы.

Имя	Тип	Default value	Описание
requireConsent	boolean	False	Попросите пользователя предоставить согласие на условия обслуживания.
text	string		Текст условий обслуживания.

PortalSettingsCspMode

Перечисление

Режим политики безопасности содержимого портала разработчика (CSP).

Значение	Описание
disabled	Браузер не будет применять ограничения источника.
enabled	Браузер блокирует запросы, не соответствующие допустимым источникам.
reportOnly	Браузер сообщит о запросах, не соответствующих допустимым источникам, не блокируя их.

Signin

Object

Имя	Тип	Default value	Описание
require	boolean	False	Перенаправьте анонимных пользователей на страницу входа.

Signup

Object

Имя	Тип	Описание
termsOfService	PortalConfigTermsOfServiceProperties	Условия обслуживания.