Group interface

包:

@azure/arm-apimanagement

表示组的接口。

方法

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)	创建或更新组。
delete(string, string, string, string, GroupDeleteOptionalParams)	删除 API 管理服务实例的特定组。
get(string, string, string, GroupGetOptionalParams)	获取由其标识符指定的组的详细信息。
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)	获取由其标识符指定的组的实体状态 （Etag） 版本。
listByService(string, string, GroupListByServiceOptionalParams)	列出服务实例中定义的组的集合。
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)	更新由其标识符指定的组的详细信息。

方法详细信息

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)

创建或更新组。

function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

groupId

string

组标识符。 当前 API 管理服务实例中必须是唯一的。

parameters

GroupCreateParameters

创建参数。

options

GroupCreateOrUpdateOptionalParams

选项参数。

返回

Promise<GroupCreateOrUpdateResponse>

delete(string, string, string, string, GroupDeleteOptionalParams)

删除 API 管理服务实例的特定组。

function delete(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, options?: GroupDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

groupId

string

组标识符。 当前 API 管理服务实例中必须是唯一的。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

options

GroupDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, GroupGetOptionalParams)

获取由其标识符指定的组的详细信息。

function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

groupId

string

组标识符。 当前 API 管理服务实例中必须是唯一的。

options

GroupGetOptionalParams

选项参数。

返回

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

获取由其标识符指定的组的实体状态 （Etag） 版本。

function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

groupId

string

组标识符。 当前 API 管理服务实例中必须是唯一的。

options

GroupGetEntityTagOptionalParams

选项参数。

返回

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

列出服务实例中定义的组的集合。

function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

options

GroupListByServiceOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

更新由其标识符指定的组的详细信息。

function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

groupId

string

组标识符。 当前 API 管理服务实例中必须是唯一的。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

parameters

GroupUpdateParameters

更新参数。

options

GroupUpdateOptionalParams

选项参数。

返回

Promise<GroupUpdateResponse>