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

Microsoft.AppPlatform Spring/apiPortals 2022-05-01-preview

  • 项目

Bicep 资源定义

Spring/apiPortals 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

若要创建 Microsoft.AppPlatform/Spring/apiPortals 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.AppPlatform/Spring/apiPortals@2022-05-01-preview' = {
  name: 'string'
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    gatewayIds: [
      'string'
    ]
    httpsOnly: bool
    public: bool
    sourceUrls: [
      'string'
    ]
    ssoProperties: {
      clientId: 'string'
      clientSecret: 'string'
      issuerUri: 'string'
      scope: [
        'string'
      ]
    }
  }
}

属性值

Spring/apiPortals

名称 说明 值
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。		 字符串 (必需)
sku API 门户资源的 SKU Sku
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为 的资源的符号名称： Spring
properties API 门户属性有效负载 ApiPortalProperties

ApiPortalProperties

名称 说明 值
gatewayIds 要与 API 门户集成的网关的资源 ID 数组。 string[]
httpsOnly 指示是否只允许 https。 bool
公共 指示 API 门户是否公开终结点。 bool
sourceUrls OpenAPI 源 URL 位置的集合。 string[]
ssoProperties 单一登录相关配置 SsoProperties

SsoProperties

名称 说明 值
clientId 应用程序的公共标识符 字符串
clientSecret 只有应用程序和授权服务器知道的机密 字符串
issuerUri 颁发者标识符的 URI 字符串
scope 它定义允许应用程序代表用户执行的特定操作 string[]

SKU

名称 说明 值
容量 目标资源的当前容量 int
name SKU 的名称 字符串
层 SKU 的层 字符串

ARM 模板资源定义

Spring/apiPortals 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

若要创建 Microsoft.AppPlatform/Spring/apiPortals 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.AppPlatform/Spring/apiPortals",
  "apiVersion": "2022-05-01-preview",
  "name": "string",
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "gatewayIds": [ "string" ],
    "httpsOnly": "bool",
    "public": "bool",
    "sourceUrls": [ "string" ],
    "ssoProperties": {
      "clientId": "string",
      "clientSecret": "string",
      "issuerUri": "string",
      "scope": [ "string" ]
    }
  }
}

属性值

Spring/apiPortals

名称 说明 Value
type 资源类型 “Microsoft.AppPlatform/Spring/apiPortals”
apiVersion 资源 API 版本 “2022-05-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)
sku API 门户资源的 SKU Sku
properties API 门户属性有效负载 ApiPortalProperties

ApiPortalProperties

名称 说明 值
gatewayIds 要与 API 门户集成的网关的资源 ID 数组。 string[]
httpsOnly 指示是否仅允许 https。 bool
公共 指示 API 门户是否公开终结点。 bool
sourceUrls OpenAPI 源 URL 位置的集合。 string[]
ssoProperties 单一登录相关配置 SsoProperties

SsoProperties

名称 说明 值
clientId 应用程序的公共标识符 字符串
clientSecret 只有应用程序和授权服务器才知道的机密 字符串
issuerUri 颁发者标识符的 URI 字符串
scope 它定义了允许应用程序代表用户执行的特定操作 string[]

SKU

名称 说明 值
容量 目标资源的当前容量 int
name SKU 的名称 字符串
层 SKU 层 字符串

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

Spring/apiPortals 资源类型可以使用以下目标操作进行部署：

  • 资源组

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

资源格式

若要创建 Microsoft.AppPlatform/Spring/apiPortals 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/apiPortals@2022-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      gatewayIds = [
        "string"
      ]
      httpsOnly = bool
      public = bool
      sourceUrls = [
        "string"
      ]
      ssoProperties = {
        clientId = "string"
        clientSecret = "string"
        issuerUri = "string"
        scope = [
          "string"
        ]
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

属性值

Spring/apiPortals

名称 说明 Value
type 资源类型 “Microsoft.AppPlatform/Spring/apiPortals@2022-05-01-preview”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为：Spring 的资源的 ID
sku API 门户资源的 SKU Sku
properties API 门户属性有效负载 ApiPortalProperties

ApiPortalProperties

名称 说明 值
gatewayIds 要与 API 门户集成的网关的资源 ID 数组。 string[]
httpsOnly 指示是否仅允许 https。 bool
公共 指示 API 门户是否公开终结点。 bool
sourceUrls OpenAPI 源 URL 位置的集合。 string[]
ssoProperties 单一登录相关配置 SsoProperties

SsoProperties

名称 说明 值
clientId 应用程序的公共标识符 字符串
clientSecret 只有应用程序和授权服务器知道的机密 字符串
issuerUri 颁发者标识符的 URI 字符串
scope 它定义允许应用程序代表用户执行的特定操作 string[]

SKU

名称 说明 值
容量 目标资源的当前容量 int
name SKU 的名称 字符串
层 SKU 的层 字符串