你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement 服务/portalsettings 2018-01-01
- 最新
- 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 资源定义
可以使用目标操作部署服务/门户设置资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/portalsettings 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/portalsettings@2018-01-01' = {
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
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 对于类型 Microsoft.ApiManagement/service/portalsettings，设置为“signin”。 设置为 Microsoft.ApiManagement/service/portalsettings类型的“注册”。 对于类型 Microsoft.ApiManagement/service/portalsettings，设置为“委派”。 | “委派” “signin” “signup”（必需） |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “signin”（必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：服务 |
| 性能 | 登录设置协定属性。 | PortalSigninSettingProperties |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “signup”（必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：服务 |
| 性能 | 注册设置协定属性。 | PortalSignupSettingsProperties |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “委派”（必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：服务 |
| 性能 | 委派设置协定属性。 | PortalDelegationSettingsProperties |
PortalDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 订阅 | 订阅委派设置。 | SubscriptionsDelegationSettingsProperties |
| url | 委派 URL。 | 字符串 |
| userRegistration | 用户注册委派设置。 | RegistrationDelegationSettingsProperties |
| validationKey | 要验证的 base64 编码验证密钥，请求是否来自 Azure API 管理。 | 字符串 |
PortalSigninSettingProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 将匿名用户重定向到 Sign-In 页面。 | bool |
PortalSignupSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 允许用户在开发人员门户中注册。 | bool |
| termsOfService | 服务条款协定属性。 | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 启用或禁用用户注册的委派。 | bool |
SubscriptionsDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 启用或禁用订阅的委派。 | bool |
TermsOfServiceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consentRequired | 要求用户同意服务条款。 | bool |
| 启用 | 在注册过程中显示服务条款。 | bool |
| 发短信 | 服务条款文本。 | 字符串 |
ARM 模板资源定义
可以使用目标操作部署服务/门户设置资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 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
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 对于类型 Microsoft.ApiManagement/service/portalsettings，设置为“signin”。 设置为 Microsoft.ApiManagement/service/portalsettings类型的“注册”。 对于类型 Microsoft.ApiManagement/service/portalsettings，设置为“委派”。 | “委派” “signin” “signup”（必需） |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-01-01' |
| 名字 | 资源名称 | “signin”（必需） |
| 性能 | 登录设置协定属性。 | PortalSigninSettingProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/portalsettings” |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-01-01' |
| 名字 | 资源名称 | “signup”（必需） |
| 性能 | 注册设置协定属性。 | PortalSignupSettingsProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/portalsettings” |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2018-01-01' |
| 名字 | 资源名称 | “委派”（必需） |
| 性能 | 委派设置协定属性。 | PortalDelegationSettingsProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/portalsettings” |
PortalDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 订阅 | 订阅委派设置。 | SubscriptionsDelegationSettingsProperties |
| url | 委派 URL。 | 字符串 |
| userRegistration | 用户注册委派设置。 | RegistrationDelegationSettingsProperties |
| validationKey | 要验证的 base64 编码验证密钥，请求是否来自 Azure API 管理。 | 字符串 |
PortalSigninSettingProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 将匿名用户重定向到 Sign-In 页面。 | bool |
PortalSignupSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 允许用户在开发人员门户中注册。 | bool |
| termsOfService | 服务条款协定属性。 | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 启用或禁用用户注册的委派。 | bool |
SubscriptionsDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 启用或禁用订阅的委派。 | bool |
TermsOfServiceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consentRequired | 要求用户同意服务条款。 | bool |
| 启用 | 在注册过程中显示服务条款。 | bool |
| 发短信 | 服务条款文本。 | 字符串 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署服务/门户设置资源类型：
- 资源组
有关每个 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
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 对于类型 Microsoft.ApiManagement/service/portalsettings，设置为“signin”。 设置为 Microsoft.ApiManagement/service/portalsettings类型的“注册”。 对于类型 Microsoft.ApiManagement/service/portalsettings，设置为“委派”。 | “委派” “signin” “signup”（必需） |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “signin”（必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：服务 |
| 性能 | 登录设置协定属性。 | PortalSigninSettingProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/portalsettings@2018-01-01” |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “signup”（必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：服务 |
| 性能 | 注册设置协定属性。 | PortalSignupSettingsProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/portalsettings@2018-01-01” |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | “委派”（必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：服务 |
| 性能 | 委派设置协定属性。 | PortalDelegationSettingsProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/portalsettings@2018-01-01” |
PortalDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 订阅 | 订阅委派设置。 | SubscriptionsDelegationSettingsProperties |
| url | 委派 URL。 | 字符串 |
| userRegistration | 用户注册委派设置。 | RegistrationDelegationSettingsProperties |
| validationKey | 要验证的 base64 编码验证密钥，请求是否来自 Azure API 管理。 | 字符串 |
PortalSigninSettingProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 将匿名用户重定向到 Sign-In 页面。 | bool |
PortalSignupSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 允许用户在开发人员门户中注册。 | bool |
| termsOfService | 服务条款协定属性。 | TermsOfServiceProperties |
RegistrationDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 启用或禁用用户注册的委派。 | bool |
SubscriptionsDelegationSettingsProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 启用 | 启用或禁用订阅的委派。 | bool |
TermsOfServiceProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| consentRequired | 要求用户同意服务条款。 | bool |
| 启用 | 在注册过程中显示服务条款。 | bool |
| 发短信 | 服务条款文本。 | 字符串 |