Microsoft.ApiManagement 服務/portalconfigs 2022-08-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

Bicep 資源定義

服務/入口網站設定資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/portalconfigs 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    csp: {
      allowedSources: [
        'string'
      ]
      mode: 'string'
      reportUri: [
        'string'
      ]
    }
    delegation: {
      delegateRegistration: bool
      delegateSubscription: bool
      delegationUrl: 'string'
      validationKey: 'string'
    }
    enableBasicAuth: bool
    signin: {
      require: bool
    }
    signup: {
      termsOfService: {
        requireConsent: bool
        text: 'string'
      }
    }
  }
}

屬性值

Microsoft.ApiManagement/service/portalconfigs

名字	描述	價值
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 （必要）
父母	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型的資源符號名稱：服務
性能	開發人員入口網站設定合約屬性。	PortalConfigProperties

PortalConfigCorsProperties

名字	描述	價值
allowedOrigins	允許的來源，例如 https://trusted.com。	string[]

PortalConfigCspProperties

名字	描述	價值
allowedSources	允許的來源，例如 *.trusted.com、trusted.com、https://。	string[]
模式	開發人員入口網站內容安全策略 （CSP） 的模式。	'disabled' 'enabled' 'reportOnly'
reportUri	瀏覽器用來報告 CSP 違規的 URL。	string[]

PortalConfigDelegationProperties

名字	描述	價值
delegateRegistration	啟用或停用用戶註冊的委派。	bool
delegateSubscription	啟用或停用產品訂閱的委派。	bool
delegationUrl	委派端點 URL。	字串
validationKey	Base64 編碼的驗證密鑰，以確保要求源自 Azure API 管理服務。	字串 約束： 敏感性值。 以安全參數的形式傳入。

PortalConfigProperties

名字	描述	價值
cors	開發人員入口網站跨原始來源資源分享 （CORS） 設定。	PortalConfigCorsProperties
csp	開發人員入口網站內容安全策略 （CSP） 設定。	PortalConfigCspProperties
代表團	開發人員入口網站委派設定。	PortalConfigDelegationProperties
enableBasicAuth	啟用或停用基本身份驗證方法。	bool
signin		PortalConfigPropertiesSignin
註冊		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

名字	描述	價值
需要	將匿名使用者重新導向至登入頁面。	bool

PortalConfigPropertiesSignup

名字	描述	價值
termsOfService	服務條款設定。	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

名字	描述	價值
requireConsent	要求使用者同意服務條款。	bool
發簡訊	服務條款文字。	字串

ARM 樣本資源定義

服務/入口網站設定資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/portalconfigs 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "csp": {
      "allowedSources": [ "string" ],
      "mode": "string",
      "reportUri": [ "string" ]
    },
    "delegation": {
      "delegateRegistration": "bool",
      "delegateSubscription": "bool",
      "delegationUrl": "string",
      "validationKey": "string"
    },
    "enableBasicAuth": "bool",
    "signin": {
      "require": "bool"
    },
    "signup": {
      "termsOfService": {
        "requireConsent": "bool",
        "text": "string"
      }
    }
  }
}

屬性值

Microsoft.ApiManagement/service/portalconfigs

名字	描述	價值
apiVersion	API 版本	'2022-08-01'
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 （必要）
性能	開發人員入口網站設定合約屬性。	PortalConfigProperties
類型	資源類型	'Microsoft.ApiManagement/service/portalconfigs'

PortalConfigCorsProperties

名字	描述	價值
allowedOrigins	允許的來源，例如 https://trusted.com。	string[]

PortalConfigCspProperties

名字	描述	價值
allowedSources	允許的來源，例如 *.trusted.com、trusted.com、https://。	string[]
模式	開發人員入口網站內容安全策略 （CSP） 的模式。	'disabled' 'enabled' 'reportOnly'
reportUri	瀏覽器用來報告 CSP 違規的 URL。	string[]

PortalConfigDelegationProperties

名字	描述	價值
delegateRegistration	啟用或停用用戶註冊的委派。	bool
delegateSubscription	啟用或停用產品訂閱的委派。	bool
delegationUrl	委派端點 URL。	字串
validationKey	Base64 編碼的驗證密鑰，以確保要求源自 Azure API 管理服務。	字串 約束： 敏感性值。 以安全參數的形式傳入。

PortalConfigProperties

名字	描述	價值
cors	開發人員入口網站跨原始來源資源分享 （CORS） 設定。	PortalConfigCorsProperties
csp	開發人員入口網站內容安全策略 （CSP） 設定。	PortalConfigCspProperties
代表團	開發人員入口網站委派設定。	PortalConfigDelegationProperties
enableBasicAuth	啟用或停用基本身份驗證方法。	bool
signin		PortalConfigPropertiesSignin
註冊		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

名字	描述	價值
需要	將匿名使用者重新導向至登入頁面。	bool

PortalConfigPropertiesSignup

名字	描述	價值
termsOfService	服務條款設定。	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

名字	描述	價值
requireConsent	要求使用者同意服務條款。	bool
發簡訊	服務條款文字。	字串

Terraform （AzAPI 提供者） 資源定義

服務/入口網站設定資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/portalconfigs 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2022-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      csp = {
        allowedSources = [
          "string"
        ]
        mode = "string"
        reportUri = [
          "string"
        ]
      }
      delegation = {
        delegateRegistration = bool
        delegateSubscription = bool
        delegationUrl = "string"
        validationKey = "string"
      }
      enableBasicAuth = bool
      signin = {
        require = bool
      }
      signup = {
        termsOfService = {
          requireConsent = bool
          text = "string"
        }
      }
    }
  })
}

屬性值

Microsoft.ApiManagement/service/portalconfigs

名字	描述	價值
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 （必要）
parent_id	此資源為父系之資源的標識碼。	類型的資源標識碼：服務
性能	開發人員入口網站設定合約屬性。	PortalConfigProperties
類型	資源類型	“Microsoft.ApiManagement/service/portalconfigs@2022-08-01”

PortalConfigCorsProperties

名字	描述	價值
allowedOrigins	允許的來源，例如 https://trusted.com。	string[]

PortalConfigCspProperties

名字	描述	價值
allowedSources	允許的來源，例如 *.trusted.com、trusted.com、https://。	string[]
模式	開發人員入口網站內容安全策略 （CSP） 的模式。	'disabled' 'enabled' 'reportOnly'
reportUri	瀏覽器用來報告 CSP 違規的 URL。	string[]

PortalConfigDelegationProperties

名字	描述	價值
delegateRegistration	啟用或停用用戶註冊的委派。	bool
delegateSubscription	啟用或停用產品訂閱的委派。	bool
delegationUrl	委派端點 URL。	字串
validationKey	Base64 編碼的驗證密鑰，以確保要求源自 Azure API 管理服務。	字串 約束： 敏感性值。 以安全參數的形式傳入。

PortalConfigProperties

名字	描述	價值
cors	開發人員入口網站跨原始來源資源分享 （CORS） 設定。	PortalConfigCorsProperties
csp	開發人員入口網站內容安全策略 （CSP） 設定。	PortalConfigCspProperties
代表團	開發人員入口網站委派設定。	PortalConfigDelegationProperties
enableBasicAuth	啟用或停用基本身份驗證方法。	bool
signin		PortalConfigPropertiesSignin
註冊		PortalConfigPropertiesSignup

PortalConfigPropertiesSignin

名字	描述	價值
需要	將匿名使用者重新導向至登入頁面。	bool

PortalConfigPropertiesSignup

名字	描述	價值
termsOfService	服務條款設定。	PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

名字	描述	價值
requireConsent	要求使用者同意服務條款。	bool
發簡訊	服務條款文字。	字串