你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Apis interface
表示 Api 的接口。
方法
方法详细信息
createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)
创建新的 API 或更新现有 API。
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, resource: Api, options?: ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
Azure API 中心服务的名称。
- workspaceName
-
string
工作区的名称。
- apiName
-
string
API 的名称。
- resource
- Api
资源创建参数。
- options
- ApisCreateOrUpdateOptionalParams
选项参数。
返回
Promise<ApisCreateOrUpdateResponse>
delete(string, string, string, string, ApisDeleteOptionalParams)
删除指定的 API。
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisDeleteOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
Azure API 中心服务的名称。
- workspaceName
-
string
工作区的名称。
- apiName
-
string
API 的名称。
- options
- ApisDeleteOptionalParams
选项参数。
返回
Promise<void>
get(string, string, string, string, ApisGetOptionalParams)
返回 API 的详细信息。
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisGetOptionalParams): Promise<ApisGetResponse>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
Azure API 中心服务的名称。
- workspaceName
-
string
工作区的名称。
- apiName
-
string
API 的名称。
- options
- ApisGetOptionalParams
选项参数。
返回
Promise<ApisGetResponse>
head(string, string, string, string, ApisHeadOptionalParams)
检查是否存在指定的 API。
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisHeadOptionalParams): Promise<ApisHeadResponse>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
Azure API 中心服务的名称。
- workspaceName
-
string
工作区的名称。
- apiName
-
string
API 的名称。
- options
- ApisHeadOptionalParams
选项参数。
返回
Promise<ApisHeadResponse>
list(string, string, string, ApisListOptionalParams)
返回 API 的集合。
function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
Azure API 中心服务的名称。
- workspaceName
-
string
工作区的名称。
- options
- ApisListOptionalParams
选项参数。