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

Microsoft.ApiManagement 服务/apis 2024-05-01

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2024-05-01' = {
  parent: resourceSymbolicName
  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'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          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'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

属性值

ApiContactInformation

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

名字 描述 价值
apiRevision 描述 API 的修订。 如果未提供任何值,则会创建默认修订版 1 字符串

约束:
最小长度 = 1
最大长度 = 1
apiRevisionDescription API 修订的说明。 字符串

约束:
最大长度 =
apiType 要创建的 API 的类型。
* http 创建 REST API
* soap 创建 SOAP 直通 API
* websocket 创建 websocket API
* graphql 创建 GraphQL API。
将来可以添加新类型。
“graphql”
“grpc”
“http”
“odata”
“soap”
“websocket”
apiVersion 指示 API 的版本标识符(如果 API 已进行版本控制) 字符串

约束:
最大长度 =
apiVersionDescription API 版本的说明。 字符串

约束:
最大长度 =
apiVersionSet 版本集详细信息 ApiVersionSetContractDetails
apiVersionSetId 相关 ApiVersionSet 的资源标识符。 字符串
authenticationSettings 此 API 中包含的身份验证设置的集合。 AuthenticationSettingsContract
联系 API 的联系信息。 ApiContactInformation
描述 API 的说明。 可能包括 HTML 格式标记。 字符串
displayName API 名称。 长度必须为 1 到 300 个字符。 字符串

约束:
最小长度 = 1
最大长度 = 1
格式 导入 API 的内容的格式。 将来可以添加新格式 “graphql-link”
“grpc”
“grpc-link”
“odata”
“odata-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
许可证 API 的许可证信息。 ApiLicenseInformation
路径 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。 它追加到服务实例创建期间指定的 API 终结点基 URL,以形成此 API 的公共 URL。 字符串

约束:
最大长度 = (必需)
协议 描述可以调用此 API 中的操作的协议。 包含任一项的字符串数组:
“http”
“https”
“ws”
“wss”
serviceUrl 实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。 字符串

约束:
最大长度 =
sourceApiId 源 API 的 API 标识符。 字符串
subscriptionKeyParameterNames 提供 API 的协议。 SubscriptionKeyParameterNamesContract
subscriptionRequired 指定访问 API 是否需要 API 或产品订阅。 bool
termsOfServiceUrl API 服务条款的 URL。 必须采用 URL 格式。 字符串
translateRequiredQueryParameters 将所需查询参数转换为模板参数的策略。 默认情况下,值为“template”。 可能的值:“template”、“query” “query”
“template”
类型 API 的类型。 “graphql”
“grpc”
“http”
“odata”
“soap”
“websocket”
价值 导入 API 时的内容值。 字符串
wsdlSelector 将 WSDL 导入限制为文档子集的条件。 ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

名字 描述 价值
名字 用于 API 的许可证名称 字符串
url 用于 API 的许可证的 URL。 必须采用 URL 格式 字符串

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名字 描述 价值
oAuth2 OAuth2 身份验证设置 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings 包含在此 API 中的 OAuth2 身份验证设置的集合。 OAuth2AuthenticationSettingsContract[]
openid OpenID Connect 身份验证设置 OpenIdAuthenticationSettingsContract
openidAuthenticationSettings 此 API 中包含的 Open ID Connect 身份验证设置的集合。 OpenIdAuthenticationSettingsContract[]

Microsoft.ApiManagement/service/apis

名字 描述 价值
名字 资源名称 字符串

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

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:服务
性能 API 实体创建更新属性。 ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2024-05-01",
  "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"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "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",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

属性值

ApiContactInformation

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

名字 描述 价值
apiRevision 描述 API 的修订。 如果未提供任何值,则会创建默认修订版 1 字符串

约束:
最小长度 = 1
最大长度 = 1
apiRevisionDescription API 修订的说明。 字符串

约束:
最大长度 =
apiType 要创建的 API 的类型。
* http 创建 REST API
* soap 创建 SOAP 直通 API
* websocket 创建 websocket API
* graphql 创建 GraphQL API。
将来可以添加新类型。
“graphql”
“grpc”
“http”
“odata”
“soap”
“websocket”
apiVersion 指示 API 的版本标识符(如果 API 已进行版本控制) 字符串

约束:
最大长度 =
apiVersionDescription API 版本的说明。 字符串

约束:
最大长度 =
apiVersionSet 版本集详细信息 ApiVersionSetContractDetails
apiVersionSetId 相关 ApiVersionSet 的资源标识符。 字符串
authenticationSettings 此 API 中包含的身份验证设置的集合。 AuthenticationSettingsContract
联系 API 的联系信息。 ApiContactInformation
描述 API 的说明。 可能包括 HTML 格式标记。 字符串
displayName API 名称。 长度必须为 1 到 300 个字符。 字符串

约束:
最小长度 = 1
最大长度 = 1
格式 导入 API 的内容的格式。 将来可以添加新格式 “graphql-link”
“grpc”
“grpc-link”
“odata”
“odata-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
许可证 API 的许可证信息。 ApiLicenseInformation
路径 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。 它追加到服务实例创建期间指定的 API 终结点基 URL,以形成此 API 的公共 URL。 字符串

约束:
最大长度 = (必需)
协议 描述可以调用此 API 中的操作的协议。 包含任一项的字符串数组:
“http”
“https”
“ws”
“wss”
serviceUrl 实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。 字符串

约束:
最大长度 =
sourceApiId 源 API 的 API 标识符。 字符串
subscriptionKeyParameterNames 提供 API 的协议。 SubscriptionKeyParameterNamesContract
subscriptionRequired 指定访问 API 是否需要 API 或产品订阅。 bool
termsOfServiceUrl API 服务条款的 URL。 必须采用 URL 格式。 字符串
translateRequiredQueryParameters 将所需查询参数转换为模板参数的策略。 默认情况下,值为“template”。 可能的值:“template”、“query” “query”
“template”
类型 API 的类型。 “graphql”
“grpc”
“http”
“odata”
“soap”
“websocket”
价值 导入 API 时的内容值。 字符串
wsdlSelector 将 WSDL 导入限制为文档子集的条件。 ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

名字 描述 价值
名字 用于 API 的许可证名称 字符串
url 用于 API 的许可证的 URL。 必须采用 URL 格式 字符串

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名字 描述 价值
oAuth2 OAuth2 身份验证设置 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings 包含在此 API 中的 OAuth2 身份验证设置的集合。 OAuth2AuthenticationSettingsContract[]
openid OpenID Connect 身份验证设置 OpenIdAuthenticationSettingsContract
openidAuthenticationSettings 此 API 中包含的 Open ID Connect 身份验证设置的集合。 OpenIdAuthenticationSettingsContract[]

Microsoft.ApiManagement/service/apis

名字 描述 价值
apiVersion API 版本 '2024-05-01'
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[^*#&+:<>?]+$ (必需)
性能 API 实体创建更新属性。 ApiCreateOrUpdatePropertiesOrApiContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/apis”

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2024-05-01"
  name = "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"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            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"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

属性值

ApiContactInformation

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

名字 描述 价值
apiRevision 描述 API 的修订。 如果未提供任何值,则会创建默认修订版 1 字符串

约束:
最小长度 = 1
最大长度 = 1
apiRevisionDescription API 修订的说明。 字符串

约束:
最大长度 =
apiType 要创建的 API 的类型。
* http 创建 REST API
* soap 创建 SOAP 直通 API
* websocket 创建 websocket API
* graphql 创建 GraphQL API。
将来可以添加新类型。
“graphql”
“grpc”
“http”
“odata”
“soap”
“websocket”
apiVersion 指示 API 的版本标识符(如果 API 已进行版本控制) 字符串

约束:
最大长度 =
apiVersionDescription API 版本的说明。 字符串

约束:
最大长度 =
apiVersionSet 版本集详细信息 ApiVersionSetContractDetails
apiVersionSetId 相关 ApiVersionSet 的资源标识符。 字符串
authenticationSettings 此 API 中包含的身份验证设置的集合。 AuthenticationSettingsContract
联系 API 的联系信息。 ApiContactInformation
描述 API 的说明。 可能包括 HTML 格式标记。 字符串
displayName API 名称。 长度必须为 1 到 300 个字符。 字符串

约束:
最小长度 = 1
最大长度 = 1
格式 导入 API 的内容的格式。 将来可以添加新格式 “graphql-link”
“grpc”
“grpc-link”
“odata”
“odata-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
许可证 API 的许可证信息。 ApiLicenseInformation
路径 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。 它追加到服务实例创建期间指定的 API 终结点基 URL,以形成此 API 的公共 URL。 字符串

约束:
最大长度 = (必需)
协议 描述可以调用此 API 中的操作的协议。 包含任一项的字符串数组:
“http”
“https”
“ws”
“wss”
serviceUrl 实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。 字符串

约束:
最大长度 =
sourceApiId 源 API 的 API 标识符。 字符串
subscriptionKeyParameterNames 提供 API 的协议。 SubscriptionKeyParameterNamesContract
subscriptionRequired 指定访问 API 是否需要 API 或产品订阅。 bool
termsOfServiceUrl API 服务条款的 URL。 必须采用 URL 格式。 字符串
translateRequiredQueryParameters 将所需查询参数转换为模板参数的策略。 默认情况下,值为“template”。 可能的值:“template”、“query” “query”
“template”
类型 API 的类型。 “graphql”
“grpc”
“http”
“odata”
“soap”
“websocket”
价值 导入 API 时的内容值。 字符串
wsdlSelector 将 WSDL 导入限制为文档子集的条件。 ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

名字 描述 价值
名字 用于 API 的许可证名称 字符串
url 用于 API 的许可证的 URL。 必须采用 URL 格式 字符串

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名字 描述 价值
oAuth2 OAuth2 身份验证设置 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings 包含在此 API 中的 OAuth2 身份验证设置的集合。 OAuth2AuthenticationSettingsContract[]
openid OpenID Connect 身份验证设置 OpenIdAuthenticationSettingsContract
openidAuthenticationSettings 此 API 中包含的 Open ID Connect 身份验证设置的集合。 OpenIdAuthenticationSettingsContract[]

Microsoft.ApiManagement/service/apis

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[^*#&+:<>?]+$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:服务
性能 API 实体创建更新属性。 ApiCreateOrUpdatePropertiesOrApiContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/apis@2024-05-01”

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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