ApiDefinitions interface
表示 ApiDefinitions 的介面。
方法
方法詳細資料
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 定義的名稱。
選項參數。
傳回
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 定義的名稱。
選項參數。
傳回
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
動作要求的內容
選項參數。
傳回
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
動作要求的內容
選項參數。
傳回
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
資源建立參數。
選項參數。
傳回
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 定義的名稱。
選項參數。
傳回
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
選項參數。