Tag interface
表示标记的接口。
方法
方法详细信息
assignToApi(string, string, string, string, TagAssignToApiOptionalParams)
将标记分配给 Api。
function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagAssignToApiOptionalParams
选项参数。
返回
Promise<TagAssignToApiResponse>
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)
将标记分配给作。
function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- operationId
-
string
API 中的作标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<TagContract>
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)
将标记分配给 Product。
function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- productId
-
string
产品标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagAssignToProductOptionalParams
选项参数。
返回
Promise<TagContract>
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)
创建标记。
function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- parameters
- TagCreateUpdateParameters
创建参数。
- options
- TagCreateOrUpdateOptionalParams
选项参数。
返回
Promise<TagCreateOrUpdateResponse>
delete(string, string, string, string, TagDeleteOptionalParams)
删除 API 管理服务实例的特定标记。
function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。
- options
- TagDeleteOptionalParams
选项参数。
返回
Promise<void>
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)
从 Api 分离标记。
function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagDetachFromApiOptionalParams
选项参数。
返回
Promise<void>
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)
从作中分离标记。
function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- operationId
-
string
API 中的作标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<void>
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)
从 Product 中分离标记。
function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- productId
-
string
产品标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<void>
get(string, string, string, TagGetOptionalParams)
获取由其标识符指定的标记的详细信息。
function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagGetOptionalParams
选项参数。
返回
Promise<TagGetResponse>
getByApi(string, string, string, string, TagGetByApiOptionalParams)
获取与 API 关联的标记。
function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagGetByApiOptionalParams
选项参数。
返回
Promise<TagGetByApiResponse>
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)
获取与作关联的标记。
function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- operationId
-
string
API 中的作标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagGetByOperationOptionalParams
选项参数。
返回
Promise<TagGetByOperationResponse>
getByProduct(string, string, string, string, TagGetByProductOptionalParams)
获取与 Product 关联的标记。
function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- productId
-
string
产品标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagGetByProductOptionalParams
选项参数。
返回
Promise<TagGetByProductResponse>
getEntityState(string, string, string, TagGetEntityStateOptionalParams)
获取由其标识符指定的标记的实体状态版本。
function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagGetEntityStateOptionalParams
选项参数。
返回
Promise<TagGetEntityStateHeaders>
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)
获取由其标识符指定的标记的实体状态版本。
function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<TagGetEntityStateByApiHeaders>
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)
获取由其标识符指定的标记的实体状态版本。
function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- operationId
-
string
API 中的作标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<TagGetEntityStateByOperationHeaders>
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)
获取由其标识符指定的标记的实体状态版本。
function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- productId
-
string
产品标识符。 当前 API 管理服务实例中必须是唯一的。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
选项参数。
返回
Promise<TagGetEntityStateByProductHeaders>
listByApi(string, string, string, TagListByApiOptionalParams)
列出与 API 关联的所有标记。
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- options
- TagListByApiOptionalParams
选项参数。
返回
listByOperation(string, string, string, string, TagListByOperationOptionalParams)
列出与作关联的所有标记。
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- operationId
-
string
API 中的作标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagListByOperationOptionalParams
选项参数。
返回
listByProduct(string, string, string, TagListByProductOptionalParams)
列出与产品关联的所有标记。
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- productId
-
string
产品标识符。 当前 API 管理服务实例中必须是唯一的。
- options
- TagListByProductOptionalParams
选项参数。
返回
listByService(string, string, TagListByServiceOptionalParams)
列出服务实例中定义的标记集合。
function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- options
- TagListByServiceOptionalParams
选项参数。
返回
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)
更新由标识符指定的标记的详细信息。
function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- tagId
-
string
标记标识符。 当前 API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。
- parameters
- TagCreateUpdateParameters
更新参数。
- options
- TagUpdateOptionalParams
选项参数。
返回
Promise<TagUpdateResponse>