通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.ApiManagement service/portalsettings 'signup' 2022-08-01

  • 项目

Bicep 资源定义

服务/门户设置资源类型可以使用以下目标操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

名称属性的选项

服务/门户设置资源根据 name 属性的值接受不同的属性。 本文介绍设置 name: 'signup'时可用的属性。

有关其他选项，请参阅：

资源格式

若要创建 Microsoft.ApiManagement/service/portalsettings 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2022-08-01' = {
  name: 'signup'
  parent: resourceSymbolicName
  properties: {
    enabled: bool
    termsOfService: {
      consentRequired: bool
      enabled: bool
      text: 'string'
    }
  }
}

属性值

service/portalsettings-signup

名称 说明 值
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。		 “注册”
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为“服务”的资源的符号名称
properties 注册设置协定属性。 PortalSignupSettingsProperties

PortalSignupSettingsProperties

名称 说明 值
enabled 允许用户在开发人员门户上注册。 bool
termsOfService 服务合同属性的条款。 TermsOfServiceProperties

TermsOfServiceProperties

名称 说明 值
consentRequired 要求用户同意服务条款。 bool
enabled 在注册过程中显示服务条款。 bool
text 服务条款文本。 字符串

ARM 模板资源定义

服务/门户设置资源类型可以使用以下目标操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

名称属性的选项

服务/门户设置资源根据 name 属性的值接受不同的属性。 本文介绍设置 name: 'signup'时可用的属性。

有关其他选项，请参阅：

资源格式

若要创建 Microsoft.ApiManagement/service/portalsettings 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ApiManagement/service/portalsettings",
  "apiVersion": "2022-08-01",
  "name": "signup",
  "properties": {
    "enabled": "bool",
    "termsOfService": {
      "consentRequired": "bool",
      "enabled": "bool",
      "text": "string"
    }
  }
}

属性值

service/portalsettings-signup

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/portalsettings”
apiVersion 资源 API 版本 '2022-08-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 “注册”
properties 注册设置协定属性。 PortalSignupSettingsProperties

PortalSignupSettingsProperties

名称 说明 值
enabled 允许用户在开发人员门户上注册。 bool
termsOfService 服务条款协定属性。 TermsOfServiceProperties

TermsOfServiceProperties

名称 说明 值
consentRequired 要求用户同意服务条款。 bool
enabled 在注册过程中显示服务条款。 bool
text 服务条款文本。 字符串

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 service/portalsettings 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

名称属性的选项

service/portalsettings 资源根据 name 属性的值接受不同的属性。 本文介绍设置 name: 'signup'时可用的属性。

有关其他选项，请参阅：

资源格式

若要创建 Microsoft.ApiManagement/service/portalsettings 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalsettings@2022-08-01"
  name = "signup"
  parent_id = "string"
  body = jsonencode({
    properties = {
      enabled = bool
      termsOfService = {
        consentRequired = bool
        enabled = bool
        text = "string"
      }
    }
  })
}

属性值

service/portalsettings-signup

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/portalsettings@2022-08-01”
name 资源名称 “注册”
parent_id 此资源的父资源的 ID。 类型为：service 的资源的 ID
properties 注册设置协定属性。 PortalSignupSettingsProperties

PortalSignupSettingsProperties

名称 说明 值
enabled 允许用户在开发人员门户上注册。 bool
termsOfService 服务条款协定属性。 TermsOfServiceProperties

TermsOfServiceProperties

名称 说明 值
consentRequired 要求用户同意服务条款。 bool
enabled 在注册过程中显示服务条款。 bool
text 服务条款文本。 字符串