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

Microsoft.ApiManagement service/apis 2021-12-01-preview

项目
01/18/2024

Bicep 资源定义

可以使用面向以下操作部署服务/apis 资源类型：

资源组 - 请参阅资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2021-12-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

属性值

service/apis

名称	说明	值
name	资源名称了解如何在 Bicep 中设置子资源的名称和类型。	字符串 (必需) 字符限制：1-80 有效字符：字母数字和连字符。以字母开头且以字母数字结尾。
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。仅当子资源在父资源外部声明时，才需要添加此属性。有关详细信息，请参阅父资源之外的子资源。	类型为：service 的资源的符号名称
properties	更新属性的 API 实体创建。	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

名称	说明	值
apiRevision	描述 API 的修订。如果未提供任何值，则创建默认修订版 1	字符串
apiRevisionDescription	API 修订版的说明。	字符串
apiType	要创建的 API 的类型。 * `http` 创建 REST API * `soap` 创建 SOAP 传递 API * `websocket` 创建 websocket API * `graphql`创建 GraphQL API。	'graphql' 'http' 'soap' 'websocket'
apiVersion	指示 API 的版本标识符（如果 API 已进行版本控制）	字符串
apiVersionDescription	API 版本的说明。	字符串
apiVersionSet	版本集详细信息	ApiVersionSetContractDetails
apiVersionSetId	相关 ApiVersionSet 的资源标识符。	字符串
authenticationSettings	此 API 中包含的身份验证设置的集合。	AuthenticationSettingsContract
contact	API 的联系信息。	ApiContactInformation
description	API 的说明。可以包含 HTML 格式标记。	字符串
displayName	API 名称。长度必须为 1 到 300 个字符。	字符串
format	要导入 API 的内容的格式。	'graphql-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	指示 API 修订是否为当前 API 修订。	bool
license	API 的许可证信息。	ApiLicenseInformation
path	相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。可将其追加到在服务实例创建过程中指定的 API 终结点基 URL，构成此 API 的公共 URL。	字符串 (必需)
protocols	说明可在哪些协议上调用此 API 中的操作。	包含任意项的字符串数组： “http” “https” 'ws' “wss”
serviceUrl	实现此 API 的后端服务的绝对 URL。长度不能超过 2000 个字符。	字符串
sourceApiId	源 API 的 API 标识符。	字符串
subscriptionKeyParameterNames	提供 API 的协议。	SubscriptionKeyParameterNamesContract
subscriptionRequired	指定访问 API 是否需要 API 订阅或产品订阅。	bool
termsOfServiceUrl	API 服务条款的 URL。必须采用 URL 的格式。	字符串
type	API 的类型。	“graphql” “http” “soap” “websocket”
value	导入 API 时的内容值。	字符串
wsdlSelector	将 WSDL 导入限制为文档子集的条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

名称	说明	值
description	API 版本集的说明。	string
id	现有 API 版本集的标识符。省略此值以创建新的版本集。	字符串
name	API 版本集的显示名称。	字符串
versionHeaderName	HTTP 标头参数的名称，如果 versioningScheme 设置为 `header`，则指示 API 版本。	字符串
versioningScheme	一个值，该值确定 API 版本标识符在 HTTP 请求中的位置。	“Header” “Query” “Segment”
versionQueryName	如果 versioningScheme 设置为 `query`，则指示 API 版本的查询参数的名称。	字符串

AuthenticationSettingsContract

名称	说明	值
oAuth2	OAuth2 身份验证设置	OAuth2AuthenticationSettingsContract
openid	OpenID Connect 身份验证设置	OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

名称	说明	值
authorizationServerId	OAuth 授权服务器标识符。	字符串
scope	操作范围。	字符串

OpenIdAuthenticationSettingsContract

名称	说明	值
bearerTokenSendingMethods	如何将令牌发送到服务器。	包含任意项的字符串数组： “authorizationHeader” “query”
openidProviderId	OAuth 授权服务器标识符。	字符串

ApiContactInformation

名称	说明	值
电子邮件	联系人/组织的电子邮件地址。必须采用电子邮件地址的格式	字符串
name	联系人/组织的标识名称	字符串
url	指向联系人信息的 URL。必须采用 URL 的格式	字符串

ApiLicenseInformation

名称	说明	值
name	用于 API 的许可证名称	字符串
url	用于 API 的许可证的 URL。必须采用 URL 的格式	字符串

SubscriptionKeyParameterNamesContract

名称	说明	值
标头的值开始缓存响应	订阅密钥标头名称。	字符串
query	订阅密钥查询字符串参数名称。	字符串

ApiCreateOrUpdatePropertiesWsdlSelector

名称	说明	值
wsdlEndpointName	要从 WSDL 导入的终结点 (端口) 的名称	字符串
wsdlServiceName	要从 WSDL 导入的服务的名称	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用模板创建 API 管理实例和所有子资源	此模板演示如何创建API 管理服务和配置子实体
在 Azure API 管理前面创建 Azure Front Door	此示例演示如何在 Azure API 管理前面使用 Azure Front Door 作为全局负载均衡器。

ARM 模板资源定义

可以使用针对以下操作部署服务/apis 资源类型：

资源组 - 请参阅资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      }
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

属性值

service/apis

名称	说明	Value
type	资源类型	“Microsoft.ApiManagement/service/apis”
apiVersion	资源 API 版本	“2021-12-01-preview”
name	资源名称了解如何在 JSON ARM 模板中为子资源设置名称和类型。	字符串 (必需) 字符限制：1-80 有效字符：字母数字和连字符。以字母开头且以字母数字结尾。
properties	API 实体创建更新属性。	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

名称	说明	值
apiRevision	描述 API 的修订。如果未提供任何值，则会创建默认修订版 1	字符串
apiRevisionDescription	API 修订的说明。	字符串
apiType	要创建的 API 的类型。 * `http` 创建 REST API * `soap` 创建 SOAP 传递 API * `websocket` 创建 websocket API * `graphql`创建 GraphQL API。	“graphql” “http” “soap” “websocket”
apiVersion	指示 API 的版本标识符（如果 API 已版本控制）	字符串
apiVersionDescription	API 版本的说明。	字符串
apiVersionSet	版本集详细信息	ApiVersionSetContractDetails
apiVersionSetId	相关 ApiVersionSet 的资源标识符。	字符串
authenticationSettings	此 API 中包含的身份验证设置的集合。	AuthenticationSettingsContract
contact	API 的联系信息。	ApiContactInformation
description	API 的说明。可以包含 HTML 格式标记。	字符串
displayName	API 名称。长度必须为 1 到 300 个字符。	字符串
format	要导入 API 的内容的格式。	'graphql-link' “openapi” “openapi+json” “openapi+json-link” “openapi-link” “swagger-json” “swagger-link-json” “wadl-link-json” “wadl-xml” 'wsdl' 'wsdl-link'
isCurrent	指示 API 修订是否为当前 API 修订。	bool
license	API 的许可证信息。	ApiLicenseInformation
path	相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。可将其追加到在服务实例创建过程中指定的 API 终结点基 URL，构成此 API 的公共 URL。	字符串 (必需)
protocols	说明可在哪些协议上调用此 API 中的操作。	包含任意项的字符串数组： “http” “https” 'ws' “wss”
serviceUrl	实现此 API 的后端服务的绝对 URL。长度不能超过 2000 个字符。	字符串
sourceApiId	源 API 的 API 标识符。	字符串
subscriptionKeyParameterNames	提供 API 的协议。	SubscriptionKeyParameterNamesContract
subscriptionRequired	指定访问 API 是否需要 API 订阅或产品订阅。	bool
termsOfServiceUrl	API 服务条款的 URL。必须采用 URL 的格式。	字符串
type	API 的类型。	“graphql” “http” “soap” “websocket”
value	导入 API 时的内容值。	字符串
wsdlSelector	将 WSDL 导入限制为文档子集的条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

名称	说明	值
description	API 版本集的说明。	string
id	现有 API 版本集的标识符。省略此值以创建新的版本集。	字符串
name	API 版本集的显示名称。	字符串
versionHeaderName	HTTP 标头参数的名称，如果 versioningScheme 设置为 `header`，则指示 API 版本。	字符串
versioningScheme	一个值，该值确定 API 版本标识符在 HTTP 请求中的位置。	'Header' 'Query' “Segment”
versionQueryName	如果 versioningScheme 设置为 `query`，则指示 API 版本的查询参数的名称。	字符串

AuthenticationSettingsContract

名称	说明	值
oAuth2	OAuth2 身份验证设置	OAuth2AuthenticationSettingsContract
openid	OpenID Connect 身份验证设置	OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

名称	说明	值
authorizationServerId	OAuth 授权服务器标识符。	字符串
scope	操作范围。	字符串

OpenIdAuthenticationSettingsContract

名称	说明	值
bearerTokenSendingMethods	如何将令牌发送到服务器。	包含任何一项的字符串数组： “authorizationHeader” 'query'
openidProviderId	OAuth 授权服务器标识符。	字符串

ApiContactInformation

名称	说明	值
电子邮件	联系人/组织的电子邮件地址。必须采用电子邮件地址格式	字符串
name	联系人/组织的标识名称	字符串
url	指向联系人信息的 URL。必须采用 URL 的格式	字符串

ApiLicenseInformation

名称	说明	值
name	用于 API 的许可证名称	字符串
url	用于 API 的许可证的 URL。必须采用 URL 的格式	字符串

SubscriptionKeyParameterNamesContract

名称	说明	值
标头的值开始缓存响应	订阅密钥标头名称。	字符串
query	订阅密钥查询字符串参数名称。	字符串

ApiCreateOrUpdatePropertiesWsdlSelector

名称	说明	值
wsdlEndpointName	要从 WSDL 导入的终结点 (端口) 的名称	字符串
wsdlServiceName	要从 WSDL 导入的服务的名称	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用模板创建 API 管理实例和所有子资源	此模板演示如何创建API 管理服务和配置子实体
在 Azure API 管理前面创建 Azure Front Door	此示例演示如何在 Azure API 管理前面使用 Azure Front Door 作为全局负载均衡器。

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

可以使用面向以下操作部署服务/apis 资源类型：

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2021-12-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

属性值

service/apis

名称	说明	Value
type	资源类型	“Microsoft.ApiManagement/service/apis@2021-12-01-preview”
name	资源名称	字符串 (必需) 字符限制：1-80 有效字符：字母数字和连字符。以字母开头且以字母数字结尾。
parent_id	此资源的父资源的 ID。	类型为：service 的资源的 ID
properties	更新属性的 API 实体创建。	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

名称	说明	值
apiRevision	描述 API 的修订。如果未提供任何值，则创建默认修订版 1	字符串
apiRevisionDescription	API 修订版的说明。	字符串
apiType	要创建的 API 的类型。 * `http` 创建 REST API * `soap` 创建 SOAP 传递 API * `websocket` 创建 websocket API * `graphql`创建 GraphQL API。	“graphql” “http” “soap” “websocket”
apiVersion	指示 API 的版本标识符（如果 API 已进行版本控制）	字符串
apiVersionDescription	API 版本的说明。	字符串
apiVersionSet	版本集详细信息	ApiVersionSetContractDetails
apiVersionSetId	相关 ApiVersionSet 的资源标识符。	字符串
authenticationSettings	此 API 中包含的身份验证设置的集合。	AuthenticationSettingsContract
contact	API 的联系信息。	ApiContactInformation
description	API 的说明。可以包含 HTML 格式标记。	字符串
displayName	API 名称。长度必须为 1 到 300 个字符。	字符串
format	要导入 API 的内容的格式。	“graphql-link” “openapi” “openapi+json” “openapi+json-link” “openapi-link” “swagger-json” “swagger-link-json” “wadl-link-json” “wadl-xml” “wsdl” “wsdl-link”
isCurrent	指示 API 修订是否为当前 API 修订版。	bool
license	API 的许可证信息。	ApiLicenseInformation
path	相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。可将其追加到在服务实例创建过程中指定的 API 终结点基 URL，构成此 API 的公共 URL。	字符串 (必需)
protocols	说明可在哪些协议上调用此 API 中的操作。	包含任何一项的字符串数组： “http” “https” “ws” “wss”
serviceUrl	实现此 API 的后端服务的绝对 URL。长度不能超过 2000 个字符。	字符串
sourceApiId	源 API 的 API 标识符。	字符串
subscriptionKeyParameterNames	提供 API 的协议。	SubscriptionKeyParameterNamesContract
subscriptionRequired	指定访问 API 是否需要 API 订阅或产品订阅。	bool
termsOfServiceUrl	指向 API 服务条款的 URL。必须采用 URL 的格式。	字符串
type	API 的类型。	“graphql” “http” “soap” “websocket”
value	导入 API 时的内容值。	字符串
wsdlSelector	将 WSDL 导入限制为文档子集的条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

名称	说明	值
description	API 版本集的说明。	string
id	现有 API 版本集的标识符。省略此值以创建新的版本集。	字符串
name	API 版本集的显示名称。	字符串
versionHeaderName	HTTP 标头参数的名称，如果 versioningScheme 设置为 `header`，则指示 API 版本。	字符串
versioningScheme	一个值，该值确定 API 版本标识符在 HTTP 请求中的位置。	“标头” “查询” “Segment”
versionQueryName	如果 versioningScheme 设置为 `query`，则指示 API 版本的查询参数的名称。	字符串

AuthenticationSettingsContract

名称	说明	值
oAuth2	OAuth2 身份验证设置	OAuth2AuthenticationSettingsContract
openid	OpenID Connect 身份验证设置	OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

名称	说明	值
authorizationServerId	OAuth 授权服务器标识符。	字符串
scope	操作范围。	字符串

OpenIdAuthenticationSettingsContract

名称	说明	值
bearerTokenSendingMethods	如何将令牌发送到服务器。	包含任何一项的字符串数组： “authorizationHeader” “query”
openidProviderId	OAuth 授权服务器标识符。	字符串

ApiContactInformation

名称	说明	值
电子邮件	联系人/组织的电子邮件地址。必须采用电子邮件地址的格式	字符串
name	联系人/组织的标识名称	字符串
url	指向联系人信息的 URL。必须采用 URL 的格式	字符串

ApiLicenseInformation

名称	说明	值
name	用于 API 的许可证名称	字符串
url	用于 API 的许可证的 URL。必须采用 URL 的格式	字符串

SubscriptionKeyParameterNamesContract

名称	说明	值
标头的值开始缓存响应	订阅密钥标头名称。	字符串
查询	订阅密钥查询字符串参数名称。	字符串

ApiCreateOrUpdatePropertiesWsdlSelector

名称	说明	值
wsdlEndpointName	要从 WSDL 导入的终结点 (端口) 的名称	字符串
wsdlServiceName	要从 WSDL 导入的服务的名称	字符串

通过

Microsoft.ApiManagement service/apis 2021-12-01-preview

Bicep 资源定义

资源格式

属性值

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

快速入门模板

ARM 模板资源定义

资源格式

属性值

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

快速入门模板

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

资源格式

属性值

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

其他资源