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

Microsoft.Web customApis

Bicep 资源定义

可以使用目标操作部署 customApis 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiDefinitions: {
      modifiedSwaggerUrl: 'string'
      originalSwaggerUrl: 'string'
    }
    apiType: 'string'
    backendService: {
      serviceUrl: 'string'
    }
    brandColor: 'string'
    capabilities: [
      'string'
    ]
    connectionParameters: {
      {customized property}: {
        oAuthSettings: {
          clientId: 'string'
          clientSecret: 'string'
          customParameters: {
            {customized property}: {
              options: any(Azure.Bicep.Types.Concrete.AnyType)
              uiDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
              value: 'string'
            }
          }
          identityProvider: 'string'
          properties: any(Azure.Bicep.Types.Concrete.AnyType)
          redirectUrl: 'string'
          scopes: [
            'string'
          ]
        }
        type: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any(Azure.Bicep.Types.Concrete.AnyType)
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ApiOAuthSettings

名字 描述 价值
clientId 资源提供程序客户端 ID 字符串
clientSecret OAuth 所需的客户端密码 字符串
customParameters OAuth 参数密钥是参数的名称 ApiOAuthSettingsCustomParameters
identityProvider 标识提供者 字符串
性能 此 oauth 设置的只读属性。 任何
redirectUrl URL 字符串
范围 OAuth 范围 string[]

ApiOAuthSettingsCustomParameters

名字 描述 价值

ApiOAuthSettingsParameter

名字 描述 价值
选项 此参数可用的选项 任何
uiDefinition 每个区域性的 UI 定义,因为调用方可以指定区域性 任何
价值 设置的值 字符串

ApiResourceBackendService

名字 描述 价值
serviceUrl 服务 URL 字符串

ApiResourceDefinitions

名字 描述 价值
modifiedSwaggerUrl 修改后的 swagger URL 字符串
originalSwaggerUrl 原始 Swagger URL 字符串

ConnectionParameter

名字 描述 价值
oAuthSettings 连接提供程序的 OAuth 设置 ApiOAuthSettings
类型 参数的类型 “array”
“bool”
“connection”
“int”
“oauthSetting”
'object'
“secureobject”
“securestring”
“string”

CustomApiPropertiesDefinition

名字 描述 价值
apiDefinitions API 定义 ApiResourceDefinitions
apiType API 类型 “NotSpecified”
“Rest”
“Soap”
backendService API 后端服务 ApiResourceBackendService
brandColor 品牌颜色 字符串
能力 自定义 API 功能 string[]
connectionParameters 连接参数 CustomApiPropertiesDefinitionConnectionParameters
描述 自定义 API 说明 字符串
displayName 显示名称 字符串
iconUri 图标 URI 字符串
runtimeUrls 运行时 URL string[]
斯瓦格 swagger 的 JSON 表示形式 任何
wsdlDefinition WSDL 定义 WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

名字 描述 价值

Microsoft.Web/customApis

名字 描述 价值
etag 资源 ETag 字符串
位置 资源位置 字符串
名字 资源名称 string (必需)
性能 自定义 API 属性 CustomApiPropertiesDefinition
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

TagsDictionary

名字 描述 价值

WsdlDefinition

名字 描述 价值
内容 WSDL 内容 字符串
importMethod WSDL 导入方法 “NotSpecified”
“SoapPassThrough”
“SoapToRest”
服务 名称和终结点名称的服务 WsdlService
url The WSDL URL 字符串

WsdlService

名字 描述 价值
endpointQualifiedNames 终结点限定名称的列表 string[]
qualifiedName 服务的限定名称 string (必需)

ARM 模板资源定义

可以使用目标操作部署 customApis 资源类型:

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

资源格式

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

{
  "type": "Microsoft.Web/customApis",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "apiDefinitions": {
      "modifiedSwaggerUrl": "string",
      "originalSwaggerUrl": "string"
    },
    "apiType": "string",
    "backendService": {
      "serviceUrl": "string"
    },
    "brandColor": "string",
    "capabilities": [ "string" ],
    "connectionParameters": {
      "{customized property}": {
        "oAuthSettings": {
          "clientId": "string",
          "clientSecret": "string",
          "customParameters": {
            "{customized property}": {
              "options": {},
              "uiDefinition": {},
              "value": "string"
            }
          },
          "identityProvider": "string",
          "properties": {},
          "redirectUrl": "string",
          "scopes": [ "string" ]
        },
        "type": "string"
      }
    },
    "description": "string",
    "displayName": "string",
    "iconUri": "string",
    "runtimeUrls": [ "string" ],
    "swagger": {},
    "wsdlDefinition": {
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ApiOAuthSettings

名字 描述 价值
clientId 资源提供程序客户端 ID 字符串
clientSecret OAuth 所需的客户端密码 字符串
customParameters OAuth 参数密钥是参数的名称 ApiOAuthSettingsCustomParameters
identityProvider 标识提供者 字符串
性能 此 oauth 设置的只读属性。 任何
redirectUrl URL 字符串
范围 OAuth 范围 string[]

ApiOAuthSettingsCustomParameters

名字 描述 价值

ApiOAuthSettingsParameter

名字 描述 价值
选项 此参数可用的选项 任何
uiDefinition 每个区域性的 UI 定义,因为调用方可以指定区域性 任何
价值 设置的值 字符串

ApiResourceBackendService

名字 描述 价值
serviceUrl 服务 URL 字符串

ApiResourceDefinitions

名字 描述 价值
modifiedSwaggerUrl 修改后的 swagger URL 字符串
originalSwaggerUrl 原始 Swagger URL 字符串

ConnectionParameter

名字 描述 价值
oAuthSettings 连接提供程序的 OAuth 设置 ApiOAuthSettings
类型 参数的类型 “array”
“bool”
“connection”
“int”
“oauthSetting”
'object'
“secureobject”
“securestring”
“string”

CustomApiPropertiesDefinition

名字 描述 价值
apiDefinitions API 定义 ApiResourceDefinitions
apiType API 类型 “NotSpecified”
“Rest”
“Soap”
backendService API 后端服务 ApiResourceBackendService
brandColor 品牌颜色 字符串
能力 自定义 API 功能 string[]
connectionParameters 连接参数 CustomApiPropertiesDefinitionConnectionParameters
描述 自定义 API 说明 字符串
displayName 显示名称 字符串
iconUri 图标 URI 字符串
runtimeUrls 运行时 URL string[]
斯瓦格 swagger 的 JSON 表示形式 任何
wsdlDefinition WSDL 定义 WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

名字 描述 价值

Microsoft.Web/customApis

名字 描述 价值
apiVersion API 版本 '2016-06-01'
etag 资源 ETag 字符串
位置 资源位置 字符串
名字 资源名称 string (必需)
性能 自定义 API 属性 CustomApiPropertiesDefinition
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Web/customApis”

TagsDictionary

名字 描述 价值

WsdlDefinition

名字 描述 价值
内容 WSDL 内容 字符串
importMethod WSDL 导入方法 “NotSpecified”
“SoapPassThrough”
“SoapToRest”
服务 名称和终结点名称的服务 WsdlService
url The WSDL URL 字符串

WsdlService

名字 描述 价值
endpointQualifiedNames 终结点限定名称的列表 string[]
qualifiedName 服务的限定名称 string (必需)

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

可以使用目标操作部署 customApis 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/customApis@2016-06-01"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      apiDefinitions = {
        modifiedSwaggerUrl = "string"
        originalSwaggerUrl = "string"
      }
      apiType = "string"
      backendService = {
        serviceUrl = "string"
      }
      brandColor = "string"
      capabilities = [
        "string"
      ]
      connectionParameters = {
        {customized property} = {
          oAuthSettings = {
            clientId = "string"
            clientSecret = "string"
            customParameters = {
              {customized property} = {
                options = ?
                uiDefinition = ?
                value = "string"
              }
            }
            identityProvider = "string"
            properties = ?
            redirectUrl = "string"
            scopes = [
              "string"
            ]
          }
          type = "string"
        }
      }
      description = "string"
      displayName = "string"
      iconUri = "string"
      runtimeUrls = [
        "string"
      ]
      swagger = ?
      wsdlDefinition = {
        content = "string"
        importMethod = "string"
        service = {
          endpointQualifiedNames = [
            "string"
          ]
          qualifiedName = "string"
        }
        url = "string"
      }
    }
  })
  tags = {
    {customized property} = "string"
  }
}

属性值

ApiOAuthSettings

名字 描述 价值
clientId 资源提供程序客户端 ID 字符串
clientSecret OAuth 所需的客户端密码 字符串
customParameters OAuth 参数密钥是参数的名称 ApiOAuthSettingsCustomParameters
identityProvider 标识提供者 字符串
性能 此 oauth 设置的只读属性。 任何
redirectUrl URL 字符串
范围 OAuth 范围 string[]

ApiOAuthSettingsCustomParameters

名字 描述 价值

ApiOAuthSettingsParameter

名字 描述 价值
选项 此参数可用的选项 任何
uiDefinition 每个区域性的 UI 定义,因为调用方可以指定区域性 任何
价值 设置的值 字符串

ApiResourceBackendService

名字 描述 价值
serviceUrl 服务 URL 字符串

ApiResourceDefinitions

名字 描述 价值
modifiedSwaggerUrl 修改后的 swagger URL 字符串
originalSwaggerUrl 原始 Swagger URL 字符串

ConnectionParameter

名字 描述 价值
oAuthSettings 连接提供程序的 OAuth 设置 ApiOAuthSettings
类型 参数的类型 “array”
“bool”
“connection”
“int”
“oauthSetting”
'object'
“secureobject”
“securestring”
“string”

CustomApiPropertiesDefinition

名字 描述 价值
apiDefinitions API 定义 ApiResourceDefinitions
apiType API 类型 “NotSpecified”
“Rest”
“Soap”
backendService API 后端服务 ApiResourceBackendService
brandColor 品牌颜色 字符串
能力 自定义 API 功能 string[]
connectionParameters 连接参数 CustomApiPropertiesDefinitionConnectionParameters
描述 自定义 API 说明 字符串
displayName 显示名称 字符串
iconUri 图标 URI 字符串
runtimeUrls 运行时 URL string[]
斯瓦格 swagger 的 JSON 表示形式 任何
wsdlDefinition WSDL 定义 WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

名字 描述 价值

Microsoft.Web/customApis

名字 描述 价值
etag 资源 ETag 字符串
位置 资源位置 字符串
名字 资源名称 string (必需)
性能 自定义 API 属性 CustomApiPropertiesDefinition
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Web/customApis@2016-06-01”

TagsDictionary

名字 描述 价值

WsdlDefinition

名字 描述 价值
内容 WSDL 内容 字符串
importMethod WSDL 导入方法 “NotSpecified”
“SoapPassThrough”
“SoapToRest”
服务 名称和终结点名称的服务 WsdlService
url The WSDL URL 字符串

WsdlService

名字 描述 价值
endpointQualifiedNames 终结点限定名称的列表 string[]
qualifiedName 服务的限定名称 string (必需)