Share via

Group interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Group.

Methods

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

Creates or Updates a group.
delete(string, string, string, string, GroupDeleteOptionalParams)

Deletes specific group of the API Management service instance.
get(string, string, string, GroupGetOptionalParams)

Gets the details of the group specified by its identifier.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the group specified by its identifier.
listByService(string, string, GroupListByServiceOptionalParams)

Lists a collection of groups defined within a service instance.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Updates the details of the group specified by its identifier.

Method Details

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

Creates or Updates a group.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

groupId

string

Group identifier. Must be unique in the current API Management service instance.

parameters
GroupCreateParameters

Create parameters.

options
GroupCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GroupCreateOrUpdateResponse>

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

Deletes specific group of the API Management service instance.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

groupId

string

Group identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
GroupDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Gets the details of the group specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

groupId

string

Group identifier. Must be unique in the current API Management service instance.

options
GroupGetOptionalParams

The options parameters.

Returns

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the group specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

groupId

string

Group identifier. Must be unique in the current API Management service instance.

options
GroupGetEntityTagOptionalParams

The options parameters.

Returns

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Lists a collection of groups defined within a service instance.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
GroupListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

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

Updates the details of the group specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

groupId

string

Group identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters
GroupUpdateParameters

Update parameters.

options
GroupUpdateOptionalParams

The options parameters.

Returns

Promise<GroupUpdateResponse>