你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ApiSchema interface
表示 ApiSchema 的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
创建或更新 API 的架构配置。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订将 ;rev=n 作为后缀，其中 n 是修订号。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- parameters
- SchemaContract
要应用的架构内容。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
创建或更新 API 的架构配置。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订将 ;rev=n 作为后缀，其中 n 是修订号。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- parameters
- SchemaContract
要应用的架构内容。
选项参数。
返回
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
删除 API 中的架构配置。
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订将 ;rev=n 作为后缀，其中 n 是修订号。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 * 。
- options
- ApiSchemaDeleteOptionalParams
选项参数。
返回
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
获取 API 级别的架构配置。
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订将 ;rev=n 作为后缀，其中 n 是修订号。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- options
- ApiSchemaGetOptionalParams
选项参数。
返回
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
获取实体状态 (Etag) 由其标识符指定的架构版本。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订将 ;rev=n 作为后缀，其中 n 是修订号。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
获取 API 级别的架构配置。
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订将 ;rev=n 作为后缀，其中 n 是修订号。
- options
- ApiSchemaListByApiOptionalParams
选项参数。