你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Custom Apis - List
自定义 API 列表
获取订阅 ID 的所有自定义 API 的列表
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/customApis?api-version=2016-06-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/customApis?api-version=2016-06-01&$top={$top}&skiptoken={skiptoken}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
subscription
|
path | True |
string |
订阅 ID |
api-version
|
query | True |
string |
API 版本 |
$top
|
query |
integer int32 |
要包含在结果中的项数 |
|
skiptoken
|
query |
string |
跳过令牌 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
自定义 API 列表 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
List all custom APIs
示例请求
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/customApis?api-version=2016-06-01
示例响应
{
"value": [
{
"properties": {
"runtimeUrls": [
"https://tempuri.org",
"http://tempuri.org"
],
"capabilities": [],
"description": "",
"displayName": "testCustomApi",
"iconUri": "/testIcon.svg",
"apiDefinitions": {
"originalSwaggerUrl": "https://tempuri.org/swagger.json",
"modifiedSwaggerUrl": "https://tempuri.org/modified.json"
},
"apiType": "Rest",
"wsdlDefinition": {}
},
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/customApis/testCustomApi",
"name": "testCustomApi",
"type": "Microsoft.Web/customApis",
"location": "northcentralus"
}
]
}
定义
名称 | 说明 |
---|---|
Api |
连接提供程序的 OAuth 设置 |
Api |
API 的 OAuth 设置 |
Api |
API 后端服务 |
Api |
API 定义 |
Api |
API 类型 |
Connection |
连接提供程序参数 |
Connection |
参数的类型 |
Custom |
自定义 API |
Custom |
自定义 API 定义的列表 |
Custom |
自定义 API 属性 |
Wsdl |
WSDL 定义 |
Wsdl |
WSDL 导入方法 |
Wsdl |
具有名称和终结点名称的服务 |
ApiOAuthSettings
连接提供程序的 OAuth 设置
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
资源提供程序客户端 ID |
clientSecret |
string |
OAuth 所需的客户端密码 |
customParameters |
<string,
Api |
OAuth 参数密钥是参数的名称 |
identityProvider |
string |
标识提供者 |
properties |
object |
此 oauth 设置的只读属性。 |
redirectUrl |
string |
URL |
scopes |
string[] |
OAuth 范围 |
ApiOAuthSettingsParameter
API 的 OAuth 设置
名称 | 类型 | 说明 |
---|---|---|
options |
object |
此参数可用的选项 |
uiDefinition |
object |
每个区域性的 UI 定义作为调用方可以指定区域性 |
value |
string |
设置的值 |
ApiResourceBackendService
API 后端服务
名称 | 类型 | 说明 |
---|---|---|
serviceUrl |
string |
服务 URL |
ApiResourceDefinitions
API 定义
名称 | 类型 | 说明 |
---|---|---|
modifiedSwaggerUrl |
string |
修改后的 swagger URL |
originalSwaggerUrl |
string |
原始 swagger URL |
ApiType
API 类型
名称 | 类型 | 说明 |
---|---|---|
NotSpecified |
string |
|
Rest |
string |
|
Soap |
string |
ConnectionParameter
连接提供程序参数
名称 | 类型 | 说明 |
---|---|---|
oAuthSettings |
连接提供程序的 OAuth 设置 |
|
type |
参数的类型 |
ConnectionParameterType
参数的类型
名称 | 类型 | 说明 |
---|---|---|
array |
string |
|
bool |
string |
|
connection |
string |
|
int |
string |
|
oauthSetting |
string |
|
object |
string |
|
secureobject |
string |
|
securestring |
string |
|
string |
string |
CustomApiDefinition
自定义 API
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
资源 ETag |
id |
string |
资源 ID |
location |
string |
资源位置 |
name |
string |
资源名称 |
properties |
自定义 API 属性 |
|
tags |
object |
资源标记 |
type |
string |
资源类型 |
CustomApiDefinitionCollection
自定义 API 定义的列表
名称 | 类型 | 说明 |
---|---|---|
value |
自定义 API 集合 |
CustomApiPropertiesDefinition
自定义 API 属性
名称 | 类型 | 说明 |
---|---|---|
apiDefinitions |
API 定义 |
|
apiType |
API 类型 |
|
backendService |
API 后端服务 |
|
brandColor |
string |
品牌颜色 |
capabilities |
string[] |
自定义 API 功能 |
connectionParameters |
<string,
Connection |
连接参数 |
description |
string |
自定义 API 说明 |
displayName |
string |
显示名称 |
iconUri |
string |
图标 URI |
runtimeUrls |
string[] |
运行时 URL |
swagger |
object |
swagger 的 JSON 表示形式 |
wsdlDefinition |
WSDL 定义 |
WsdlDefinition
WSDL 定义
名称 | 类型 | 说明 |
---|---|---|
content |
string |
WSDL 内容 |
importMethod |
WSDL 导入方法 |
|
service |
具有名称和终结点名称的服务 |
|
url |
string |
The WSDL URL |
WsdlImportMethod
WSDL 导入方法
名称 | 类型 | 说明 |
---|---|---|
NotSpecified |
string |
|
SoapPassThrough |
string |
|
SoapToRest |
string |
WsdlService
具有名称和终结点名称的服务
名称 | 类型 | 说明 |
---|---|---|
endpointQualifiedNames |
string[] |
终结点的限定名称列表 |
qualifiedName |
string |
服务的限定名称 |