Microsoft.ApiManagement service/portalsettings 2018-06-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
- 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-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
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 針對類型 Microsoft.ApiManagement/service/portalsettings設定為 'signin'。 設定為類型為 Microsoft.ApiManagement/service/portalsettings的 'signup'。 針對類型 Microsoft.ApiManagement/service/portalsettings設定為 'delegation'。 | 'delegation' '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的 'signup'。 針對類型 Microsoft.ApiManagement/service/portalsettings設定為 'delegation'。 | 'delegation' 'signin' 'signup' （必要） |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2018-06-01-preview' |
| 名字 | 資源名稱 | 'signin' （必要） |
| 性能 | 登入設定合約屬性。 | PortalSigninSettingProperties |
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2018-06-01-preview' |
| 名字 | 資源名稱 | 'signup' （必要） |
| 性能 | 註冊設定合約屬性。 | PortalSignupSettingsProperties |
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/portalsettings' |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2018-06-01-preview' |
| 名字 | 資源名稱 | '委派' （必要） |
| 性能 | 委派設定合約屬性。 | 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的 'signup'。 針對類型 Microsoft.ApiManagement/service/portalsettings設定為 'delegation'。 | 'delegation' 'signin' 'signup' （必要） |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 'signin' （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | 登入設定合約屬性。 | PortalSigninSettingProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/portalsettings@2018-06-01-preview” |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 'signup' （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | 註冊設定合約屬性。 | PortalSignupSettingsProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/portalsettings@2018-06-01-preview” |
Microsoft.ApiManagement/service/portalsettings
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | '委派' （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | 委派設定合約屬性。 | PortalDelegationSettingsProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/portalsettings@2018-06-01-preview” |
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 |
| 發簡訊 | 服務條款文字。 | 字串 |