Поделиться через


Служба Microsoft.ApiManagement/portalconfigs 2022-08-01

Определение ресурсов Bicep

Тип ресурса service/portalconfigs можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/portalconfigs, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    csp: {
      allowedSources: [
        'string'
      ]
      mode: 'string'
      reportUri: [
        'string'
      ]
    }
    delegation: {
      delegateRegistration: bool
      delegateSubscription: bool
      delegationUrl: 'string'
      validationKey: 'string'
    }
    enableBasicAuth: bool
    signin: {
      require: bool
    }
    signup: {
      termsOfService: {
        requireConsent: bool
        text: 'string'
      }
    }
  }
}

Значения свойств

service/portalconfigs

Имя Описание Ценность
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в Bicep.
строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: служба
свойства Свойства контракта конфигурации портала разработчика. PortalConfigProperties

PortalConfigProperties

Имя Описание Ценность
cors Параметры общего доступа к ресурсам (CORS) на портале разработчика. PortalConfigCorsProperties
csp Параметры политики безопасности содержимого портала разработчика (CSP). PortalConfigCspProperties
делегация Параметры делегирования портала разработчика. PortalConfigDelegationProperties
enableBasicAuth Включение или отключение метода базовой проверки подлинности. bool
signin PortalConfigPropertiesSignin
регистрация PortalConfigPropertiesSignup

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Имя Описание Ценность
делегатRegistration Включение или отключение делегирования для регистрации пользователей. bool
делегатSubscription Включение или отключение делегирования для подписок на продукты. bool
делегированиеUrl URL-адрес конечной точки делегирования. струна
validationKey Ключ проверки в кодировке Base64 для обеспечения того, чтобы запросы поступили из службы управления API Azure. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

PortalConfigPropertiesSignin

Имя Описание Ценность
нуждаться Перенаправьте анонимных пользователей на страницу входа. bool

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

Имя Описание Ценность
requireConsent Попросите пользователя предоставить согласие на условия обслуживания. bool
СМС Текст условий обслуживания. струна

Определение ресурса шаблона ARM

Тип ресурса service/portalconfigs можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/portalconfigs, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "csp": {
      "allowedSources": [ "string" ],
      "mode": "string",
      "reportUri": [ "string" ]
    },
    "delegation": {
      "delegateRegistration": "bool",
      "delegateSubscription": "bool",
      "delegationUrl": "string",
      "validationKey": "string"
    },
    "enableBasicAuth": "bool",
    "signin": {
      "require": "bool"
    },
    "signup": {
      "termsOfService": {
        "requireConsent": "bool",
        "text": "string"
      }
    }
  }
}

Значения свойств

service/portalconfigs

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/portalconfigs"
apiVersion Версия API ресурсов '2022-08-01'
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.
строка (обязательно)
свойства Свойства контракта конфигурации портала разработчика. PortalConfigProperties

PortalConfigProperties

Имя Описание Ценность
cors Параметры общего доступа к ресурсам (CORS) на портале разработчика. PortalConfigCorsProperties
csp Параметры политики безопасности содержимого портала разработчика (CSP). PortalConfigCspProperties
делегация Параметры делегирования портала разработчика. PortalConfigDelegationProperties
enableBasicAuth Включение или отключение метода базовой проверки подлинности. bool
signin PortalConfigPropertiesSignin
регистрация PortalConfigPropertiesSignup

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Имя Описание Ценность
делегатRegistration Включение или отключение делегирования для регистрации пользователей. bool
делегатSubscription Включение или отключение делегирования для подписок на продукты. bool
делегированиеUrl URL-адрес конечной точки делегирования. струна
validationKey Ключ проверки в кодировке Base64 для обеспечения того, чтобы запросы поступили из службы управления API Azure. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

PortalConfigPropertiesSignin

Имя Описание Ценность
нуждаться Перенаправьте анонимных пользователей на страницу входа. bool

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

Имя Описание Ценность
requireConsent Попросите пользователя предоставить согласие на условия обслуживания. bool
СМС Текст условий обслуживания. струна

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса service/portalconfigs можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/portalconfigs, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      csp = {
        allowedSources = [
          "string"
        ]
        mode = "string"
        reportUri = [
          "string"
        ]
      }
      delegation = {
        delegateRegistration = bool
        delegateSubscription = bool
        delegationUrl = "string"
        validationKey = "string"
      }
      enableBasicAuth = bool
      signin = {
        require = bool
      }
      signup = {
        termsOfService = {
          requireConsent = bool
          text = "string"
        }
      }
    }
  })
}

Значения свойств

service/portalconfigs

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/portalconfigs@2022-08-01"
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: службы
свойства Свойства контракта конфигурации портала разработчика. PortalConfigProperties

PortalConfigProperties

Имя Описание Ценность
cors Параметры общего доступа к ресурсам (CORS) на портале разработчика. PortalConfigCorsProperties
csp Параметры политики безопасности содержимого портала разработчика (CSP). PortalConfigCspProperties
делегация Параметры делегирования портала разработчика. PortalConfigDelegationProperties
enableBasicAuth Включение или отключение метода базовой проверки подлинности. bool
signin PortalConfigPropertiesSignin
регистрация PortalConfigPropertiesSignup

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

Имя Описание Ценность
делегатRegistration Включение или отключение делегирования для регистрации пользователей. bool
делегатSubscription Включение или отключение делегирования для подписок на продукты. bool
делегированиеUrl URL-адрес конечной точки делегирования. струна
validationKey Ключ проверки в кодировке Base64 для обеспечения того, чтобы запросы поступили из службы управления API Azure. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

PortalConfigPropertiesSignin

Имя Описание Ценность
нуждаться Перенаправьте анонимных пользователей на страницу входа. bool

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

Имя Описание Ценность
requireConsent Попросите пользователя предоставить согласие на условия обслуживания. bool
СМС Текст условий обслуживания. струна