Служба Microsoft.ApiManagement/portalsettings

• последние
• 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
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01

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

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview' = {
  name: 'string'
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

объекты microsoft.apimanagement/service/portalsettings

Задайте свойство имени , чтобы указать тип объекта.

Для входаиспользуйте:

{
  name: 'signin'
  properties: {
    enabled: bool
  }
}

Для регистрации используйте:

{
  name: 'signup'
  properties: {
    enabled: bool
    termsOfService: {
      consentRequired: bool
      enabled: bool
      text: 'string'
    }
  }
}

Для делегированияиспользуйте:

{
  name: 'delegation'
  properties: {
    subscriptions: {
      enabled: bool
    }
    url: 'string'
    userRegistration: {
      enabled: bool
    }
    validationKey: 'string'
  }
}

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

microsoft.apimanagement/service/portalsettings

Имя	Описание	Ценность
имя	Задайте значение signin для типа Microsoft.ApiManagement/service/portalsettings. Задайте для типа Microsoft.ApiManagement/service/portalsettingsзначение "Регистрация". Задайте значение "делегирование" для типа Microsoft.ApiManagement/service/portalsettings.	"делегирование" "signin" "регистрация" (обязательно)

Microsoft.ApiManagement/service/portalsettings

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

Microsoft.ApiManagement/service/portalsettings

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

Microsoft.ApiManagement/service/portalsettings

Имя	Описание	Ценность
имя	Имя ресурса	"делегирование" (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: служба
свойства	Параметры делегирования свойств контракта.	PortalDelegationSettingsProperties

PortalDelegationSettingsProperties

Имя	Описание	Ценность
Подписки	Параметры делегирования подписок.	SubscriptionsDelegationSettingsProperties
URL-адрес	URL-адрес делегирования.	струна
userRegistration	Параметры делегирования регистрации пользователей.	RegistrationDelegationSettingsProperties
validationKey	Ключ проверки в кодировке Base64 для проверки того, что запрос поступает из службы "Управление API Azure".	струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра.

PortalSigninSettingProperties

Имя	Описание	Ценность
Включен	Перенаправьте анонимных пользователей на страницу Sign-In.	bool

PortalSignupSettingsProperties

Имя	Описание	Ценность
Включен	Разрешить пользователям регистрироваться на портале разработчика.	bool
termsOfService	Условия использования свойств контракта службы.	ТерминыOfServiceProperties

RegistrationDelegationSettingsProperties

Имя	Описание	Ценность
Включен	Включение или отключение делегирования для регистрации пользователей.	bool

SubscriptionsDelegationSettingsProperties

Имя	Описание	Ценность
Включен	Включение или отключение делегирования для подписок.	bool

ТерминыOfServiceProperties

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

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

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

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

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

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

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

{
  "name": "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

объекты microsoft.apimanagement/service/portalsettings

Задайте свойство имени , чтобы указать тип объекта.

Для входаиспользуйте:

{
  "name": "signin",
  "properties": {
    "enabled": "bool"
  }
}

Для регистрации используйте:

{
  "name": "signup",
  "properties": {
    "enabled": "bool",
    "termsOfService": {
      "consentRequired": "bool",
      "enabled": "bool",
      "text": "string"
    }
  }
}

Для делегированияиспользуйте:

{
  "name": "delegation",
  "properties": {
    "subscriptions": {
      "enabled": "bool"
    },
    "url": "string",
    "userRegistration": {
      "enabled": "bool"
    },
    "validationKey": "string"
  }
}

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

microsoft.apimanagement/service/portalsettings

Имя	Описание	Ценность
имя	Задайте значение signin для типа Microsoft.ApiManagement/service/portalsettings. Задайте для типа Microsoft.ApiManagement/service/portalsettingsзначение "Регистрация". Задайте значение "делегирование" для типа Microsoft.ApiManagement/service/portalsettings.	"делегирование" "signin" "регистрация" (обязательно)

Microsoft.ApiManagement/service/portalsettings

Имя	Описание	Ценность
apiVersion	Версия API	'2024-06-01-preview'
имя	Имя ресурса	Signin (обязательный)
свойства	Свойства контракта входа.	PortalSigninSettingProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/portalsettings"

Microsoft.ApiManagement/service/portalsettings

Имя	Описание	Ценность
apiVersion	Версия API	'2024-06-01-preview'
имя	Имя ресурса	"регистрация" (обязательно)
свойства	Регистрация параметров свойств контракта.	PortalSignupSettingsProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/portalsettings"

Microsoft.ApiManagement/service/portalsettings

Имя	Описание	Ценность
apiVersion	Версия API	'2024-06-01-preview'
имя	Имя ресурса	"делегирование" (обязательно)
свойства	Параметры делегирования свойств контракта.	PortalDelegationSettingsProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/portalsettings"

PortalDelegationSettingsProperties

Имя	Описание	Ценность
Подписки	Параметры делегирования подписок.	SubscriptionsDelegationSettingsProperties
URL-адрес	URL-адрес делегирования.	струна
userRegistration	Параметры делегирования регистрации пользователей.	RegistrationDelegationSettingsProperties
validationKey	Ключ проверки в кодировке Base64 для проверки того, что запрос поступает из службы "Управление API Azure".	струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра.

PortalSigninSettingProperties

Имя	Описание	Ценность
Включен	Перенаправьте анонимных пользователей на страницу Sign-In.	bool

PortalSignupSettingsProperties

Имя	Описание	Ценность
Включен	Разрешить пользователям регистрироваться на портале разработчика.	bool
termsOfService	Условия использования свойств контракта службы.	ТерминыOfServiceProperties

RegistrationDelegationSettingsProperties

Имя	Описание	Ценность
Включен	Включение или отключение делегирования для регистрации пользователей.	bool

SubscriptionsDelegationSettingsProperties

Имя	Описание	Ценность
Включен	Включение или отключение делегирования для подписок.	bool

ТерминыOfServiceProperties

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  name = "string"
  // For remaining properties, see microsoft.apimanagement/service/portalsettings objects
}

объекты microsoft.apimanagement/service/portalsettings

Задайте свойство имени , чтобы указать тип объекта.

Для входаиспользуйте:

{
  name = "signin"
  properties = {
    enabled = bool
  }
}

Для регистрации используйте:

{
  name = "signup"
  properties = {
    enabled = bool
    termsOfService = {
      consentRequired = bool
      enabled = bool
      text = "string"
    }
  }
}

Для делегированияиспользуйте:

{
  name = "delegation"
  properties = {
    subscriptions = {
      enabled = bool
    }
    url = "string"
    userRegistration = {
      enabled = bool
    }
    validationKey = "string"
  }
}

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

microsoft.apimanagement/service/portalsettings

Имя	Описание	Ценность
имя	Задайте значение signin для типа Microsoft.ApiManagement/service/portalsettings. Задайте для типа Microsoft.ApiManagement/service/portalsettingsзначение "Регистрация". Задайте значение "делегирование" для типа Microsoft.ApiManagement/service/portalsettings.	"делегирование" "signin" "регистрация" (обязательно)

Microsoft.ApiManagement/service/portalsettings

Имя	Описание	Ценность
имя	Имя ресурса	Signin (обязательный)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: службы
свойства	Свойства контракта входа.	PortalSigninSettingProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview"

Microsoft.ApiManagement/service/portalsettings

Имя	Описание	Ценность
имя	Имя ресурса	"регистрация" (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: службы
свойства	Регистрация параметров свойств контракта.	PortalSignupSettingsProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview"

Microsoft.ApiManagement/service/portalsettings

Имя	Описание	Ценность
имя	Имя ресурса	"делегирование" (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: службы
свойства	Параметры делегирования свойств контракта.	PortalDelegationSettingsProperties
тип	Тип ресурса	"Microsoft.ApiManagement/service/portalsettings@2024-06-01-preview"

PortalDelegationSettingsProperties

Имя	Описание	Ценность
Подписки	Параметры делегирования подписок.	SubscriptionsDelegationSettingsProperties
URL-адрес	URL-адрес делегирования.	струна
userRegistration	Параметры делегирования регистрации пользователей.	RegistrationDelegationSettingsProperties
validationKey	Ключ проверки в кодировке Base64 для проверки того, что запрос поступает из службы "Управление API Azure".	струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра.

PortalSigninSettingProperties

Имя	Описание	Ценность
Включен	Перенаправьте анонимных пользователей на страницу Sign-In.	bool

PortalSignupSettingsProperties

Имя	Описание	Ценность
Включен	Разрешить пользователям регистрироваться на портале разработчика.	bool
termsOfService	Условия использования свойств контракта службы.	ТерминыOfServiceProperties

RegistrationDelegationSettingsProperties

Имя	Описание	Ценность
Включен	Включение или отключение делегирования для регистрации пользователей.	bool

SubscriptionsDelegationSettingsProperties

Имя	Описание	Ценность
Включен	Включение или отключение делегирования для подписок.	bool

ТерминыOfServiceProperties

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