你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
GlobalSchema interface
表示 GlobalSchema 的接口。
方法
begin |
创建新的或更新API 管理服务实例的现有指定架构。 |
begin |
创建新的或更新API 管理服务实例的现有指定架构。 |
delete(string, string, string, string, Global |
删除特定架构。 |
get(string, string, string, Global |
获取由其标识符指定的架构的详细信息。 |
get |
获取实体状态 (Etag) 由其标识符指定的架构版本。 |
list |
列出向服务实例注册的架构的集合。 |
方法详细信息
beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)
创建新的或更新API 管理服务实例的现有指定架构。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- parameters
- GlobalSchemaContract
创建或更新参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)
创建新的或更新API 管理服务实例的现有指定架构。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<GlobalSchemaCreateOrUpdateResponse>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- parameters
- GlobalSchemaContract
创建或更新参数。
选项参数。
返回
Promise<GlobalSchemaCreateOrUpdateResponse>
delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)
删除特定架构。
function delete(resourceGroupName: string, serviceName: string, schemaId: string, ifMatch: string, options?: GlobalSchemaDeleteOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求标头响应中的当前实体状态匹配,或者对于无条件更新,ETag 应为 *。
- options
- GlobalSchemaDeleteOptionalParams
选项参数。
返回
Promise<void>
get(string, string, string, GlobalSchemaGetOptionalParams)
获取由其标识符指定的架构的详细信息。
function get(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetOptionalParams): Promise<GlobalSchemaGetResponse>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
- options
- GlobalSchemaGetOptionalParams
选项参数。
返回
Promise<GlobalSchemaGetResponse>
getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)
获取实体状态 (Etag) 由其标识符指定的架构版本。
function getEntityTag(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetEntityTagOptionalParams): Promise<GlobalSchemaGetEntityTagHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- schemaId
-
string
架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<GlobalSchemaGetEntityTagHeaders>
listByService(string, string, GlobalSchemaListByServiceOptionalParams)
列出向服务实例注册的架构的集合。
function listByService(resourceGroupName: string, serviceName: string, options?: GlobalSchemaListByServiceOptionalParams): PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。