ApiTagDescription interface
表示 ApiTagDescription 的接口。
方法
| create |
在 Api 范围内创建/更新标记说明。 |
| delete(string, string, string, string, string, Api |
删除 Api 的标记说明。 |
| get(string, string, string, string, Api |
获取 API 范围内的标记说明 |
| get |
获取由其标识符指定的标记的实体状态版本。 |
| list |
列出 API 范围内的所有标记说明。 类似于 swagger 的模型 - tagDescription 是在 API 级别定义的，但可能会将标记分配给作 |
方法详细信息
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
在 Api 范围内创建/更新标记说明。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagDescriptionId
-
string
标记说明标识符。 为 API/标记关联创建 tagDescription 时使用。 基于 API 和标记名称。
- parameters
- TagDescriptionCreateParameters
创建参数。
选项参数。
返回
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
删除 Api 的标记说明。
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagDescriptionId
-
string
标记说明标识符。 为 API/标记关联创建 tagDescription 时使用。 基于 API 和标记名称。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。
选项参数。
返回
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
获取 API 范围内的标记说明
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagDescriptionId
-
string
标记说明标识符。 为 API/标记关联创建 tagDescription 时使用。 基于 API 和标记名称。
选项参数。
返回
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
获取由其标识符指定的标记的实体状态版本。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
- tagDescriptionId
-
string
标记说明标识符。 为 API/标记关联创建 tagDescription 时使用。 基于 API 和标记名称。
选项参数。
返回
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
列出 API 范围内的所有标记说明。 类似于 swagger 的模型 - tagDescription 是在 API 级别定义的，但可能会将标记分配给作
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- apiId
-
string
API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
选项参数。