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

ApiDefinitions interface

包:: @azure/arm-apicenter

表示 ApiDefinitions 的接口。

方法

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	导出 API 规范。
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)	导出 API 规范。
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	导入 API 规范。
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)	导入 API 规范。
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)	创建新的或更新现有的 API 定义。
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)	删除指定的 API 定义。
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)	返回 API 定义的详细信息。
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)	检查指定的 API 定义是否存在。
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)	返回 API 定义的集合。

方法详细信息

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

导出 API 规范。

function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

options: ApiDefinitionsExportSpecificationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>

beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

导出 API 规范。

function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

options: ApiDefinitionsExportSpecificationOptionalParams

选项参数。

Promise<ApiSpecExportResult>

beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

导入 API 规范。

function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

body: ApiSpecImportRequest

作请求的内容

options: ApiDefinitionsImportSpecificationOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

导入 API 规范。

function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

body: ApiSpecImportRequest

作请求的内容

options: ApiDefinitionsImportSpecificationOptionalParams

选项参数。

Promise<void>

createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)

创建新的或更新现有的 API 定义。

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

resource: ApiDefinition

资源创建参数。

options: ApiDefinitionsCreateOrUpdateOptionalParams

选项参数。

Promise<ApiDefinitionsCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)

删除指定的 API 定义。

function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

options: ApiDefinitionsDeleteOptionalParams

选项参数。

Promise<void>

get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)

返回 API 定义的详细信息。

function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

options: ApiDefinitionsGetOptionalParams

选项参数。

Promise<ApiDefinitionsGetResponse>

head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)

检查指定的 API 定义是否存在。

function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

definitionName: string

API 定义的名称。

options: ApiDefinitionsHeadOptionalParams

选项参数。

Promise<ApiDefinitionsHeadResponse>

list(string, string, string, string, string, ApiDefinitionsListOptionalParams)

返回 API 定义的集合。

function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

serviceName: string

Azure API 中心服务的名称。

workspaceName: string

工作区的名称。

apiName: string

API 的名称。

versionName: string

API 版本的名称。

options: ApiDefinitionsListOptionalParams

选项参数。

PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>

通过

ApiDefinitions interface

方法

方法详细信息

beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

参数

返回

beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)

参数

返回

beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

参数

返回

beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)

参数

返回

createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)

参数

返回

delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)

参数

返回

get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)

参数

返回

head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)

参数

返回

list(string, string, string, string, string, ApiDefinitionsListOptionalParams)

参数

返回