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

• последние
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview

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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview' = {
  parent: resourceSymbolicName
  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'
      }
    }
  }
}

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

Microsoft.ApiManagement/service/portalconfigs

Имя	Описание	Ценность
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: служба
свойства	Свойства контракта конфигурации портала разработчика.	PortalConfigProperties

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

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

PortalConfigProperties

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

PortalConfigPropertiesSignin

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

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

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

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

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

• группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2022-04-01-preview",
  "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"
      }
    }
  }
}

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

Microsoft.ApiManagement/service/portalconfigs

Имя	Описание	Ценность
apiVersion	Версия API	'2022-04-01-preview'
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 80 (обязательно)
свойства	Свойства контракта конфигурации портала разработчика.	PortalConfigProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/portalconfigs"

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

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

PortalConfigProperties

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

PortalConfigPropertiesSignin

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

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

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

Примеры использования

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
        }
      }
    }
  }
}

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

Microsoft.ApiManagement/service/portalconfigs

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

PortalConfigCorsProperties

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

PortalConfigCspProperties

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

PortalConfigDelegationProperties

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

PortalConfigProperties

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

PortalConfigPropertiesSignin

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

PortalConfigPropertiesSignup

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

PortalConfigTermsOfServiceProperties

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