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

Служба Microsoft.ApiManagement/portalsettings 2023-03-01-preview

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2023-03-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 (обязательный)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: служба
свойства Свойства контракта входа. PortalSigninSettingProperties (Свойства PortalSigninSetting)

Microsoft.ApiManagement/service/portalsettings

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

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

Microsoft.ApiManagement/service/portalsettings

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

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

microsoft.apimanagement/service/portalsettings

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

PortalDelegationSettingsProperties

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

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

PortalSigninSettingProperties (Свойства PortalSigninSetting)

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

PortalSignupSettingsProperties

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

RegistrationDelegationSettingsProperties

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

ПодпискиДелегированиеНастройкиСвойства

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

ТерминыOfServiceProperties

Имя Описание Ценность
согласиеТребуется Попросите пользователя предоставить согласие на условия обслуживания. булевая переменная (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

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

Microsoft.ApiManagement/service/portalsettings

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

Microsoft.ApiManagement/service/portalsettings

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

microsoft.apimanagement/service/portalsettings

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

PortalDelegationSettingsProperties

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

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

PortalSigninSettingProperties (Свойства PortalSigninSetting)

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

PortalSignupSettingsProperties

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

RegistrationDelegationSettingsProperties

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

ПодпискиДелегированиеНастройкиСвойства

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

ТерминыOfServiceProperties

Имя Описание Ценность
согласиеТребуется Попросите пользователя предоставить согласие на условия обслуживания. булевая переменная (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 (обязательный)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: службы
свойства Свойства контракта входа. PortalSigninSettingProperties (Свойства PortalSigninSetting)
тип Тип ресурса "Microsoft.ApiManagement/service/portalsettings@2023-03-01-preview"

Microsoft.ApiManagement/service/portalsettings

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

Microsoft.ApiManagement/service/portalsettings

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

microsoft.apimanagement/service/portalsettings

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

PortalDelegationSettingsProperties

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

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

PortalSigninSettingProperties (Свойства PortalSigninSetting)

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

PortalSignupSettingsProperties

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

RegistrationDelegationSettingsProperties

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

ПодпискиДелегированиеНастройкиСвойства

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

ТерминыOfServiceProperties

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