通过

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

Microsoft.ApiManagement 服务/apis 2016-10-10

  • 项目

Bicep 资源定义

可以使用目标操作部署服务/apis 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-10-10' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

属性值

AuthenticationSettingsContract

名字 描述 价值
oAuth2 API OAuth2 身份验证设置详细信息。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名字 描述 价值
authenticationSettings 此 API 中包含的身份验证设置的集合。 AuthenticationSettingsContract
描述 API 的说明。 可能包括 HTML 格式标记。 字符串
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 1
模式 = ^[^*#&+:<>?]+$ （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：服务
路径 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。 它追加到服务实例创建期间指定的 API 终结点基 URL，以形成此 API 的公共 URL。 字符串

约束：
最大长度 = （必需）
协议 描述可以调用此 API 中的操作的协议。 包含任一项的字符串数组：
“Http”
“Https”（必需）
serviceUrl 实现此 API 的后端服务的绝对 URL。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
subscriptionKeyParameterNames 提供 API 的协议。 SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

名字 描述 价值
authorizationServerId OAuth 授权服务器标识符。 字符串
范围 操作范围。 字符串

SubscriptionKeyParameterNamesContract

名字 描述 价值
页眉 订阅密钥标头名称。 字符串
查询 订阅密钥查询字符串参数名称。 字符串

ARM 模板资源定义

可以使用目标操作部署服务/apis 资源类型：

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-10-10",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

属性值

AuthenticationSettingsContract

名字 描述 价值
oAuth2 API OAuth2 身份验证设置详细信息。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名字 描述 价值
apiVersion API 版本 '2016-10-10'
authenticationSettings 此 API 中包含的身份验证设置的集合。 AuthenticationSettingsContract
描述 API 的说明。 可能包括 HTML 格式标记。 字符串
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 1
模式 = ^[^*#&+:<>?]+$ （必需）
路径 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。 它追加到服务实例创建期间指定的 API 终结点基 URL，以形成此 API 的公共 URL。 字符串

约束：
最大长度 = （必需）
协议 描述可以调用此 API 中的操作的协议。 包含任一项的字符串数组：
“Http”
“Https”（必需）
serviceUrl 实现此 API 的后端服务的绝对 URL。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
subscriptionKeyParameterNames 提供 API 的协议。 SubscriptionKeyParameterNamesContract
类型 资源类型 “Microsoft.ApiManagement/service/apis”

OAuth2AuthenticationSettingsContract

名字 描述 价值
authorizationServerId OAuth 授权服务器标识符。 字符串
范围 操作范围。 字符串

SubscriptionKeyParameterNamesContract

名字 描述 价值
页眉 订阅密钥标头名称。 字符串
查询 订阅密钥查询字符串参数名称。 字符串

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务/apis 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2016-10-10"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

属性值

AuthenticationSettingsContract

名字 描述 价值
oAuth2 API OAuth2 身份验证设置详细信息。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名字 描述 价值
authenticationSettings 此 API 中包含的身份验证设置的集合。 AuthenticationSettingsContract
描述 API 的说明。 可能包括 HTML 格式标记。 字符串
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 1
模式 = ^[^*#&+:<>?]+$ （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：服务
路径 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。 它追加到服务实例创建期间指定的 API 终结点基 URL，以形成此 API 的公共 URL。 字符串

约束：
最大长度 = （必需）
协议 描述可以调用此 API 中的操作的协议。 包含任一项的字符串数组：
“Http”
“Https”（必需）
serviceUrl 实现此 API 的后端服务的绝对 URL。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
subscriptionKeyParameterNames 提供 API 的协议。 SubscriptionKeyParameterNamesContract
类型 资源类型 “Microsoft.ApiManagement/service/apis@2016-10-10”

OAuth2AuthenticationSettingsContract

名字 描述 价值
authorizationServerId OAuth 授权服务器标识符。 字符串
范围 操作范围。 字符串

SubscriptionKeyParameterNamesContract

名字 描述 价值
页眉 订阅密钥标头名称。 字符串
查询 订阅密钥查询字符串参数名称。 字符串